PageRenderTime 31ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/documentation/faq.md

https://github.com/a-West/duckduckgo
Markdown | 71 lines | 48 code | 23 blank | 0 comment | 0 complexity | e8cd921b7df442c8b40b6daac3312f77 MD5 | raw file
  1. #FAQ
  2. [Index](https://github.com/duckduckgo/duckduckgo/) / **FAQ**
  3. ---
  4. ### Why should I make plugins?
  5. We hope you will consider making DuckDuckGo plugins to:
  6. * Improve results in areas you personally search and care about, e.g. [programming documentation](https://duckduckgo.com/?q=perl+split), [gaming](https://duckduckgo.com/?q=roll+3d12+%2B+4) or [entertainment](https://duckduckgo.com/?q=xkcd).
  7. * Increase usage of your own projects, e.g. data and [APIs](https://duckduckgo.com/?q=cost+of+living+nyc+philadelphia).
  8. * Learn something new.
  9. * Attribution [on our site](https://duckduckgo.com/goodies.html) and [Twitter](https://twitter.com/duckduckhack) (working on more).
  10. * See your code live on a [growing](https://duckduckgo.com/traffic.html) search engine!
  11. ### What if I'm not a coder at all?
  12. If you don't code at all and you've ended up here, please go over to our [ideas companion site](http://ideas.duckduckhack.com/) where you can suggest and comment on plugin ideas such as identifying the best sites and data sources to draw from. Similarly, you can submit [issues about current plugins](https://github.com/duckduckgo/duckduckgo/issues?direction=desc&sort=created&state=open). Both of these activities are very valuable and will help direct community efforts.
  13. If you're a business and want your data to be utilized, adding your service to [ideas.duckduckhack.com](http://ideas.duckduckhack.com) is a great way for your API to get picked up by a developer and integrated into the search engine.
  14. ### Can you help me?
  15. Of course! Here are the easiest ways to contact someone who can help answer your questions:
  16. * Write us publicly on the [discussion list](https://www.listbox.com/subscribe/?list_id=197814).
  17. * Write us privately at open@duckduckgo.com.
  18. ### What if I don't know Perl?
  19. If you don't know Perl, that's OK! Several <a href="README.md#overview">plugin types</a> are not in Perl. Also, if you know PHP, Ruby, or Python you should be able to write Goodies in Perl pretty easily using [this awesome cheat sheet](http://hyperpolyglot.org/scripting).
  20. ### Do you have any plugin ideas?
  21. Yup! We maintain [a growing list](http://ideas.duckduckhack.com/). There are also improvement ideas for [Goodies](https://github.com/duckduckgo/zeroclickinfo-goodies/issues), [Spice](https://github.com/duckduckgo/zeroclickinfo-spice/issues), [Fathead](https://github.com/duckduckgo/zeroclickinfo-fathead/issues) and [Longtail](https://github.com/duckduckgo/zeroclickinfo-longtail/issues).
  22. ### How do I note that I've started on something?
  23. In your initial pull request, please note the link on the [idea list](http://ideas.duckduckhack.com/). We'll move it to the "in process" bucket for you.
  24. ### Where I can report plugin bugs?
  25. Submit GitHub issues in the [appropriate repo](http://github.com/duckduckgo).
  26. ### What if there are plugin conflicts?
  27. The ultimate arbiter is the user, and that's the perspective we take. In other words, we ask "what is best for the user experience?" That said, it often makes sense to combine ideas into one, better plugin.
  28. ### Why isn't my plugin in the [DuckDuckGo Instant Answers API](https://api.duckduckgo.com)?
  29. If your plugin is spice or longtail, sometimes we can't expose it through the API for licensing reasons (e.g. the WolframAlpha plugin), but our
  30. over-arching goal is to make all of our instant answers available on their own.
  31. ### Can I do something more complicated?
  32. Maybe. There are a bunch more internal interfaces we haven't exposed yet, and we'd love to hear your ideas to influence that roadmap.
  33. ### What's the roadmap?
  34. Here's what we're working on (in roughly in this order):
  35. * better testing/file structure for spice plugins.
  36. * better JS interface for spice plugin callback functions.
  37. * better attribution.
  38. * embedding plugins.
  39. * better testing/file structure for fathead plugins.
  40. * more defined structure for longtail plugins.
  41. * better testing for longtail plugins.
  42. ### Are there other open source projects?
  43. Yes! Check out the other repositories in [our GitHub account](https://github.com/duckduckgo). You can email open@duckduckgo.com if you have any questions on those.
  44. ### Can I get the instant answers through an API?
  45. Yes! Check out the [DuckDuckGo API](https://api.duckduckgo.com). Our goal is to make as many plugins as possible
  46. available through this interface. Fathead and goodie plugins are automatically syndicated through the API, and Spice and Longtail are selectively (due to licensing complications) mixed in.
  47. ### Can I talk to you about a partnership idea?###
  48. Sure -- check out [our partnerships page](http://help.duckduckgo.com/customer/portal/articles/775109-partnerships).