diff --git a/duckduckhack/assets/air_quality.png b/duckduckhack/assets/air_quality.png new file mode 100644 index 000000000..4c8ad2ca4 Binary files /dev/null and b/duckduckhack/assets/air_quality.png differ diff --git a/duckduckhack/assets/alternative_spotify.png b/duckduckhack/assets/alternative_spotify.png new file mode 100644 index 000000000..53c6458c0 Binary files /dev/null and b/duckduckhack/assets/alternative_spotify.png differ diff --git a/duckduckhack/assets/blue_pill.png b/duckduckhack/assets/blue_pill.png new file mode 100644 index 000000000..ffc2a7404 Binary files /dev/null and b/duckduckhack/assets/blue_pill.png differ diff --git a/duckduckhack/assets/bpm_ms.png b/duckduckhack/assets/bpm_ms.png new file mode 100644 index 000000000..af1d8fa92 Binary files /dev/null and b/duckduckhack/assets/bpm_ms.png differ diff --git a/duckduckhack/assets/diagrams/goodie_answerbar.png b/duckduckhack/assets/diagrams/goodie_answerbar.png new file mode 100644 index 000000000..18daa2be9 Binary files /dev/null and b/duckduckhack/assets/diagrams/goodie_answerbar.png differ diff --git a/duckduckhack/assets/heads_tails.png b/duckduckhack/assets/heads_tails.png new file mode 100644 index 000000000..3db7b6de3 Binary files /dev/null and b/duckduckhack/assets/heads_tails.png differ diff --git a/duckduckhack/assets/parking_ny.png b/duckduckhack/assets/parking_ny.png new file mode 100644 index 000000000..1a012ff77 Binary files /dev/null and b/duckduckhack/assets/parking_ny.png differ diff --git a/duckduckhack/assets/sales_tax.png b/duckduckhack/assets/sales_tax.png new file mode 100644 index 000000000..967fb2a25 Binary files /dev/null and b/duckduckhack/assets/sales_tax.png differ diff --git a/duckduckhack/assets/template_groups/bulbasaur_pokemon.png b/duckduckhack/assets/template_groups/bulbasaur_pokemon.png new file mode 100644 index 000000000..a59351d40 Binary files /dev/null and b/duckduckhack/assets/template_groups/bulbasaur_pokemon.png differ diff --git a/duckduckhack/assets/template_groups/dogo_news.png b/duckduckhack/assets/template_groups/dogo_news.png new file mode 100644 index 000000000..72c85b506 Binary files /dev/null and b/duckduckhack/assets/template_groups/dogo_news.png differ diff --git a/duckduckhack/assets/template_groups/dogobooks.png b/duckduckhack/assets/template_groups/dogobooks.png new file mode 100644 index 000000000..dbc5426ca Binary files /dev/null and b/duckduckhack/assets/template_groups/dogobooks.png differ diff --git a/duckduckhack/assets/template_groups/duck_images.png b/duckduckhack/assets/template_groups/duck_images.png new file mode 100644 index 000000000..f9547c9a2 Binary files /dev/null and b/duckduckhack/assets/template_groups/duck_images.png differ diff --git a/duckduckhack/assets/template_groups/events_ny.png b/duckduckhack/assets/template_groups/events_ny.png new file mode 100644 index 000000000..ef5b2b33b Binary files /dev/null and b/duckduckhack/assets/template_groups/events_ny.png differ diff --git a/duckduckhack/assets/template_groups/gopro_videos.png b/duckduckhack/assets/template_groups/gopro_videos.png new file mode 100644 index 000000000..1a79af74a Binary files /dev/null and b/duckduckhack/assets/template_groups/gopro_videos.png differ diff --git a/duckduckhack/assets/template_groups/jiro_dreams.png b/duckduckhack/assets/template_groups/jiro_dreams.png new file mode 100644 index 000000000..a84fef770 Binary files /dev/null and b/duckduckhack/assets/template_groups/jiro_dreams.png differ diff --git a/duckduckhack/assets/template_groups/keira_movies.png b/duckduckhack/assets/template_groups/keira_movies.png new file mode 100644 index 000000000..a87108707 Binary files /dev/null and b/duckduckhack/assets/template_groups/keira_movies.png differ diff --git a/duckduckhack/assets/template_groups/saudi_oil.png b/duckduckhack/assets/template_groups/saudi_oil.png new file mode 100644 index 000000000..1ee149f31 Binary files /dev/null and b/duckduckhack/assets/template_groups/saudi_oil.png differ diff --git a/duckduckhack/assets/url_encode.png b/duckduckhack/assets/url_encode.png new file mode 100644 index 000000000..fd1f040f6 Binary files /dev/null and b/duckduckhack/assets/url_encode.png differ diff --git a/duckduckhack/getting-started/contributing.md b/duckduckhack/getting-started/contributing.md index b55fb517a..bb34f223b 100644 --- a/duckduckhack/getting-started/contributing.md +++ b/duckduckhack/getting-started/contributing.md @@ -1,12 +1,16 @@ # How Can I Contribute? -There are several options for contributing to DuckDuckHack, explained below. If you have any questions at any point, feel free to ask on one of our community channels: +Contributing to DuckDuckHack - at any level - by nature makes a huge impact. + +## Reach Out + +If you have any questions at any point, feel free to ask on one of our community channels: - [Request invite to our Slack team](mailto:QuackSlack@duckduckgo.com?subject=AddMe) - [DuckDuckHack mailing list](https://duck.co/redir/?u=https%3A%2F%2Fwww.listbox.com%2Fsubscribe%2F%3Flist_id%3D197814) - Do not hesitate to email us directly at [open@duckduckgo.com](mailto:open@duckduckgo.com). -## New? Make Your First Contribution Today +## New? Get Your First Taste Today If this is your first time contributing to [DuckDuckHack](http://www.duckduckhack.com), you have two great ways to quickly make your first commit: @@ -18,9 +22,9 @@ Cheat sheets are a super-easy way to contribute to the live DuckDuckGo AnswerBar This short tutorial will lead you through all the parts of building a full-loop Goodie. This is a perfect place to start if you have an idea for an original Instant Answer. -## Create a New Instant Answer +## Feeling Good? Create a New Instant Answer -Once you're comfortable with the workflow and how Goodies work, we're excited to have you create your own original Instant Answer: +Once you're comfortable with the workflow and how Goodies work, we're excited to have you create your own original Instant Answer. **1. Choose an idea** @@ -62,7 +66,9 @@ Thanks! PS: DuckDuckGo is awesome! ``` -## Improve an Existing Instant Answer +P.S. To see just how simple it is to contribute an Instant Answer, check out David Farrell's PerlTricks post: [Writing Instant Answers is Easy](http://perltricks.com/article/169/2015/4/20/Writing-DuckDuckGo-instant-answers-is-easy). + +## Share Your Wisdom: Improve an Existing Instant Answer Another great way to contribute is to improve an existing, live Instant Answer. It's a great way to get further acquainted with Instant Answers, as well as get implementation ideas. (Many contributors report completing their first fix within two hours of forking the repository!) diff --git a/duckduckhack/getting-started/ddh-intro.md b/duckduckhack/getting-started/ddh-intro.md index 09658c7f7..78aa76ca1 100644 --- a/duckduckhack/getting-started/ddh-intro.md +++ b/duckduckhack/getting-started/ddh-intro.md @@ -1,24 +1,53 @@ -# Welcome to DuckDuckHack! +# Welcome to DuckDuckHack -We are a community of DuckDuckGo users who help improve the search engine with, "Instant Answers". To get started, please [request an invite to our Slack team](mailto:QuackSlack@duckduckgo.com?subject=AddMe). You may join multiple Slack channels to discuss your Instant Answer ideas with others who may have the same interests! +We are a community of DuckDuckGo users who invent and maintain "Instant Answers". -- [Request Slack invite](mailto:QuackSlack@duckduckgo.com?subject=AddMe) +*Find out [how to contribute](https://duck.co/duckduckhack/contributing), how to [contact us](https://duck.co/duckduckhack/contributing#reach-out) and get involved.* -You may also wish to join our DuckDuckHack Dev's email list (low traffic): +## What are Instant Answers? -- [DuckDuckHack developer mailing list](https://www.listbox.com/subscribe/?list_id=197814) +**Instant Answers present what you were seeking in zero clicks:** +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Falternative_spotify.png) -## What are Instant Answers? +Instant Answers go right at the top of DuckDuckGo's search results - above ads and even search results. They have the potential to show up on millions of searches every day. -Instant Answers help you find what you're looking for in few or zero clicks. They're placed above ads and regular search results, and they're created/maintained by you (the community). Some Instant Answers are built from pure code and others require external sources (API requests), databases, or key-value stores. The possibilities are endless but the point is to provide a perfect result for every search. +Our mission as a community is to cover every topic with an Instant Answer. We're well on our way: you can browse the [full list of Instant Answers](https://duck.co/ia) and see what's been contributed. -![App search Instant Answer example](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fapp_search_example.png&f=1) +They can be really complicated and dynamic... + +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fparking_ny.png) + +...or super simple yet convenient. + +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fsales_tax.png) + +Some are just cool: + +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fheads_tails.png) + +Many are absolutely delightful and unexpected: -In the above example, [Quixey](http://quixey.com/) was a source that our own DuckDuckHack Community suggested for mobile app search. Now, any time someone searches for apps on DuckDuckGo, we request information directly from Quixey to help answer the search. +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fbpm_ms.png) + +Many are super practical... + +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fair_quality.png) + +...in ways we never imagined: + +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fblue_pill.png) + +Some Instant Answers are built from pure code: + +![](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Furl_encode.png) + +Other Instant Answers channel external sources (API requests), databases, or key-value stores. + +![App search Instant Answer example](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fapp_search_example.png&f=1) -To see just how simple it is to contribute an Instant Answer, check out David Farrell's PerlTricks post: [Writing Instant Answers is Easy](http://perltricks.com/article/169/2015/4/20/Writing-DuckDuckGo-instant-answers-is-easy). +**The [possibilities are endless](https://duck.co/ideas) but the point is to provide a perfect result for every search.** -In these docs, we'll show you how to build Instant Answers that can do this and more. Start by reading about [ways to contribute](https://duck.co/duckduckhack/contributing). +In these docs, we'll show you how to build Instant Answers that can do this and more. Let's get started with [ways to contribute](https://duck.co/duckduckhack/contributing). diff --git a/duckduckhack/getting-started/setup_dev_environment.md b/duckduckhack/getting-started/setup_dev_environment.md index 4e9c7324c..afdd050cc 100644 --- a/duckduckhack/getting-started/setup_dev_environment.md +++ b/duckduckhack/getting-started/setup_dev_environment.md @@ -6,30 +6,29 @@ Before moving forward, you **must** know which Instant Answer type you will be u ## Before you start... -We highly recommend that everyone uses Codio, a web-based IDE that simplifies the setup and development process greatly. If you prefer using a local text editor, that's alright, but using Codio is still beneficial because we already have the required software installed and ready to go. This page will show you how to set up Codio and then it's on to creating Instant Answers! You can also watch a [video screencast of this tutorial](https://vimeo.com/132712266). +We highly recommend that everyone uses Codio, a web-based IDE that simplifies the setup and development process greatly. Codio is beneficial because we already have the required software installed and ready to go. -### Alternative Development Environments +This page will show you how to set up Codio and then it's on to creating Instant Answers! You can also watch a [video screencast of this tutorial](https://vimeo.com/132712266). -Codio is the preferred choice of most DuckDuckHack contributors for its ease and speed. However, you may also [develop and test locally](https://duck.co/duckduckhack/other_development_environments), or install a [pre-configured virtual machine](https://duck.co/duckduckhack/other_development_environments). These options do require more time and effort than using Codio. +For those who prefer local development, there are more involved options to [develop and test locally](https://duck.co/duckduckhack/other_development_environments), or install a [pre-configured virtual machine](https://duck.co/duckduckhack/other_development_environments). These options require significantly more time and effort than using Codio. ## Sign up for a GitHub Account *Already have a GitHub Account? Perfect, move on to [the next step](#sign-up-for-a-codio-account)!* -If you're new to programming, GitHub is a well known, popular tool that many individuals and companies use to save their code. Many open-source projects (such as DuckDuckHack) are hosted on GitHub and anyone with an account can contribute. GitHub is a great tool that you will likely be using long after this tutorial. To get started, let's sign up! +If you're new to programming, GitHub is a well known, popular tool that many individuals and companies use to save their code. Many open-source projects (such as DuckDuckHack) are hosted on GitHub. The only requirement to contribute is an account - which is free! GitHub is a great tool that you will likely be using long after this tutorial. To get started, let's sign up! 1. Go to https://github.com/join and enter the required information, then click "**Create an Account**" 2. Click "**Finish Signup**" to continue with a **Free** GitHub account. **Congrats!** You now have a GitHub account. - ## Sign up for a Codio Account -Next, you'll need to get an account for Codio: - *Already have a Codio Account? Perfect, move on to [the next step](#fork-the-duckduckhack-project-on-codio)!* +Next, you'll need to get an account for Codio. Codio allows contributors to spawn identical development environments, allowing us to focus on the fun parts, rather than installing tools. + 1. Go to https://codio.com and click "**Get Started**", at the top right corner. 2. Click "**Sign Up via GitHub**". 3. If you aren't already signed into GitHub, enter your GitHub login details and then click "**Sign In**". @@ -38,7 +37,7 @@ Next, you'll need to get an account for Codio: **Congrats!** You now have a Codio account. You'll notice that you didn't need to provide a password, that's because you've logged in to Codio using your GitHub account. As long as you can login to your GitHub account, you can also login to Codio. Now let's get started with setting up your Codio environment! -## Join the DuckDuckGo Organization +## Join the DuckDuckGo Codio Organization 1. **After logging into Codio,** [click this link](https://codio.com/p/signup?orgToken=Ax-OB3tU4sdNAG8axJBYcjNqR04) and you'll be added to our organization, which gives you a professional Codio setup free of charge. You should see a confirmation message at the bottom of your Codio screen after clicking. diff --git a/duckduckhack/goodie/goodie_cheat_sheets.md b/duckduckhack/goodie/goodie_cheat_sheets.md index 260f04d00..dd9dce927 100644 --- a/duckduckhack/goodie/goodie_cheat_sheets.md +++ b/duckduckhack/goodie/goodie_cheat_sheets.md @@ -4,7 +4,21 @@ A popular (and perfect) use of Goodies is to create cheat sheets which are avail ![tmux cheat sheet](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftmux_cheat_sheet.png&f=1) -Looking for ideas for your cheat sheet? Check our [inspiration list](#cheat-sheet-ideas) below. +Looking for ideas for your cheat sheet? Check out the wide variety of [existing cheat sheets](https://duck.co/ia?q=cheat+sheet) to get a taste. You can also take a look at our [inspiration list](#cheat-sheet-ideas) below. + +## Cheat Sheet Ideas + +Keyboard shortcuts, video game cheat codes, meanings, and other reference information are wonderfully useful as a cheat sheet. Get inspired by [seeing what other contributors have done](https://duck.co/ia?q=cheat+sheet) with cheat sheets. Here are some other cheat sheet Instant Answers we love: + +- [Regex help](https://duckduckgo.com/?q=regex+help&ia=cheatsheet) +- [Anniversary meanings](https://duckduckgo.com/?q=anniversary+help&ia=cheatsheet) +- [Cryptography terms and help](https://duckduckgo.com/?q=cryptography+cheat+sheet&ia=cheatsheet) +- [Harry Potter spells](https://duckduckgo.com/?q=harry+potter+spells+cheat+sheet&ia=cheatsheet) +- [Tennis info](https://duckduckgo.com/?q=tennis+cheat+sheet&ia=cheatsheet) + +You can also [search our ideas forum for cheat sheets](https://duck.co/ideas/search?q=cheat+sheet), or [submit one of your own](https://duck.co/ideas/newidea)! + +Of course, a cheat sheet is not always the best representation for your data. Sometimes, an Instant Answer is better built as a full [Goodie](https://duck.co/duckduckhack/goodie_overview) or another type of Instant Answer. When thinking about your idea, think about what would be most useful to a searcher. ## How to Add Your Cheat Sheet @@ -216,15 +230,3 @@ We recommend displaying alternatives as follows: We've found the best way to express arrow keys is directly using arrow ASCII characters (←, ↑, →, ↓). Feel free to copy and paste the characters from here. For example, instead of **[Shift] [Up]** we recommend **[Shift] [↑]**. - -## Cheat Sheet Ideas - -A cheat sheet is not always the best representation for your data. Sometimes, an Instant Answer is better built as a full Goodie or another type of Instant Answer. When thinking about your cheat sheet idea, think about what is useful to a searcher. Keyboard shortcuts, video game cheat codes, and similar data can be wonderfully useful as a cheat sheet. Here are some other cheat sheet Instant Answers we love: - -[Regex help](https://duckduckgo.com/?q=regex+help&ia=cheatsheet) -[Anniversary meanings](https://duckduckgo.com/?q=anniversary+help&ia=cheatsheet) -[Cryptography terms and help](https://duckduckgo.com/?q=cryptography+cheat+sheet&ia=cheatsheet) -[Harry Potter spells](https://duckduckgo.com/?q=harry+potter+spells+cheat+sheet&ia=cheatsheet) -[Tennis info](https://duckduckgo.com/?q=tennis+cheat+sheet&ia=cheatsheet) - -You can also [search our ideas forum for cheat sheets](https://duck.co/ideas/search?q=cheat+sheet), or [submit one of your own](https://duck.co/ideas/newidea)! diff --git a/duckduckhack/goodie/goodie_displaying.md b/duckduckhack/goodie/goodie_displaying.md index 4503c46e5..dc85dec09 100644 --- a/duckduckhack/goodie/goodie_displaying.md +++ b/duckduckhack/goodie/goodie_displaying.md @@ -2,6 +2,8 @@ The final step of providing your Goodie results is displaying them in the DuckDuckGo AnswerBar. +![goodieanswerbar](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Fdiagrams%2Fgoodie_answerbar.png&f=1) + ## Setting Display Properties in a Goodie Goodies are displayed according to a set of properties which can (mostly) be defined in each Goodie's Perl file. These options are returned as a hash called `structured_answer` when the Perl file finishes running. This hash is returned alongside the `$plaintext` string version of your Goodie result, used for the API): diff --git a/duckduckhack/instant-answer-display/template_groups.md b/duckduckhack/instant-answer-display/template_groups.md index d35a51a6e..3f68395fb 100644 --- a/duckduckhack/instant-answer-display/template_groups.md +++ b/duckduckhack/instant-answer-display/template_groups.md @@ -18,7 +18,13 @@ A quick way to get a feel for the different template groups is to [browse the In ### My Instant Answer returns "things" where visuals are important -The [Media](#media-template-group) template group works well when an image is a significant part of the display of an item, as might be a title and a rating. Also consider the [Movies](#movies-template-group) template group. +The [Media](#media-template-group) template group works well when an image is a significant part of the display of an item, as might be a title and a rating. + +![DuckDuckGo search for "dogo news"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fdogo_news.png&f=1) + +Also consider the [Movies](#movies-template-group) template group: + +![DuckDuckGo search for "movies with keira knightley"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fkeira_movies.png&f=1) Examples that make a great fit for the Media or Movies template groups include: @@ -26,12 +32,16 @@ Examples that make a great fit for the Media or Movies template groups include: - Games - [Courses](https://duckduckgo.com/?q=computer+science+online+course) -If your Instant Answer results *are* themselves images or videos, consider the [Images](#images-template-group) or [Videos](#videos-template-group) template groups. +**If your Instant Answer results *are* themselves images or videos, consider the [Images](#images-template-group) or [Videos](#videos-template-group) template groups.** These provide extra media-specific functionality. ### My Instant Answer returns detailed "lookup" information The [Info](#info-template-group) template group is designed for Instant Answers that feature in-depth information about one item. It also provides an auxiliary section to display further detail in table or list format. +![DuckDuckGo search for "green day band"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fgreen_day_band.png&f=1) + +![DuckDuckGo search for "bulbasaur pokemon"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fbulbasaur_pokemon.png&f=1) + Examples include: - [Recipes](https://duckduckgo.com/?q=how+to+mix+a+tom+collins&ia=recipes) @@ -49,6 +59,10 @@ The [List](#list-template-group) template group works well for lookups that don' The [Text](#text-template-group) and [Icon](#icon-template-group) template groups are simple templates for presenting text results. They both share the same `item` template, while the Icon group's `detail` template is better suited to displaying an icon image. +![DuckDuckGo search for "what rhymes with awesome"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fwhat_rhymes_with_awesome.png&f=1) + +![DuckDuckGo search for "alternative to photoshop"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Falternative_to_photoshop.png&f=1) + These results fit this format well: - [Software](https://duckduckgo.com/?q=alternative+to+notepad&ia=software) @@ -60,7 +74,11 @@ These results fit this format well: ### My Instant Answer returns products with prices, ratings, and brands/authors/artists -The [Products](#product-template-group) template group is great for items characterized by a price, brand, and rating. This is a good template group where images are important. +The [Products](#product-template-group) template group is great for items characterized by a price, brand, and rating. This is also a good template group where images are important. + +![DuckDuckGo search for "buy batman lego"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fbuy_batman_lego.png&f=1) + +![DuckDuckGo search for "flight tracking apps"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fflight_tracking_apps.png&f=1) Examples of results that work well with the Products template group include: @@ -75,6 +93,8 @@ Examples of results that work well with the Products template group include: The [Places](#places-template-group) template group is perfect for results where location is an important aspect. This template group displays single and multiple items on a map. +![DuckDuckGo search for "events in new york"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fevents_ny.png&f=1) + Results that would make a good fit for the Places template group include: - [Parking](https://duckduckgo.com/?q=parking+in+philadelphia&ia=parking) @@ -190,12 +210,15 @@ See the **[important notes](#important-notes)** for making this template display ### Example Uses - ["github duckduckgo"](https://duckduckgo.com/?q=github+duckduckgo) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/github/github.js)) + ![DuckDuckGo search for "github duckduckgo"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fgithub_duckduckgo.png&f=1) - ["what rhymes with awesome"](https://duckduckgo.com/?q=what+rhymes+with+awesome) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/rhymes/rhymes.js)) + ![DuckDuckGo search for "what rhymes with awesome"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fwhat_rhymes_with_awesome.png&f=1) - ["reddit duckduckgo"](https://duckduckgo.com/?q=reddit+duckduckgo) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/reddit_search/reddit_search.js)) + ![DuckDuckGo search for "reddit duckduckgo"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Freddit_duckduckgo.png&f=1) @@ -242,12 +265,19 @@ See the **[important notes](#important-notes)** for making this template display ### Example Uses - ["green day band"](https://duckduckgo.com/?q=green+day+band) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/lastfm/artist/lastfm_artist.js)) + ![DuckDuckGo search for "green day band"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fgreen_day_band.png&f=1) +- ["bulbasaur pokemon"](https://duckduckgo.com/?q=bulbasaur+pokemon&ia=about) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/pokemon/data/pokemon_data.js)) + +![DuckDuckGo search for "bulbasaur pokemon"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fbulbasaur_pokemon.png&f=1) + - ["bitcoin price"](https://duckduckgo.com/?q=bitcoin+price) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/bitcoin/bitcoin.js)) + ![DuckDuckGo search for "bitcoin price"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fbitcoin_price.png&f=1) - ["gravatar matt"](https://duckduckgo.com/?q=gravatar+matt) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/gravatar/gravatar.js)) + ![DuckDuckGo search for "gravatar matt"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fgravatar_matt.png&f=1) @@ -299,12 +329,15 @@ See the **[important notes](#important-notes)** for making this template display ### Example Uses - ["buy batman lego"](https://duckduckgo.com/?q=buy+batman+lego) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/amazon/amazon.js)) + ![DuckDuckGo search for "buy batman lego"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fbuy_batman_lego.png&f=1) - ["flight tracking apps"](https://duckduckgo.com/?q=flight+tracking+apps) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/quixey/quixey.js)) + ![DuckDuckGo search for "flight tracking apps"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fflight_tracking_apps.png&f=1) - ["octopart 1770019-2"](https://duckduckgo.com/?q=octopart%201770019-2) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/octopart/octopart.js)) + ![DuckDuckGo search for "octopart 1770019-2"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Foctopart_1770019-2.png&f=1) @@ -356,10 +389,7 @@ See the **[important notes](#important-notes)** for making this template display - ["dogo news"](https://duckduckgo.com/?q=dogo+news&ia=kidsnews&iai=2) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/dogo_news/dogo_news.js)) - +![DuckDuckGo search for "dogo news"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fdogo_news.png&f=1) ------ @@ -402,9 +432,13 @@ See the **[important notes](#important-notes)** for making this template display ### Example Uses - ["alternative to photoshop"](https://duckduckgo.com/?q=alternative+to+photoshop) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/alternative_to/alternative_to.js)) + ![DuckDuckGo search for "alternative to photoshop"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Falternative_to_photoshop.png&f=1) + - ["oil production in Saudi Arabia"](https://duckduckgo.com/?q=oil+production+in+saudi+arabia&ia=answer) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/zanran/zanran.js)) +![DuckDuckGo search for "oil production in Saudi Arabia"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fsaudi_oil.png&f=1) + ------ ## Images Template Group @@ -442,6 +476,8 @@ Using the Images template group also automatically makes the Image [model](https - ["duck images"](https://duckduckgo.com/?q=duck+images&ia=images) (built-in images search) +![DuckDuckGo search for "duck images"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fduck_images.png&f=1) + ------ ## Movies Template Group @@ -494,9 +530,18 @@ templates: { ### Example Uses - ["dogobooks harry potter"](https://duckduckgo.com/?q=dogobooks+harry+potter&ia=kidsbooks) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/dogo_books/dogo_books.js)) + +![DuckDuckGo search for "dogobooks harry potter"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fdogobooks.png&f=1) + - ["movies with keira knightley"](https://duckduckgo.com/?q=movies%20with%20Keira%20Knightley&ia=movies) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/kwixer/kwixer.js)) + +![DuckDuckGo search for "movies with keira knightley"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fkeira_movies.png&f=1) + - ["jiro dreams of sushi rotten tomatoes"](https://duckduckgo.com/?q=jiro+dreams+of+sushi+rotten+tomatoes&ia=movies)([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/ea61d47ef8639cf4fb282b51e2185e3a807d1bd5/share/spice/movie/movie.js)) +![DuckDuckGo search for "jiro dreams of sushi rotten tomatoes"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fjiro_dreams.png&f=1) + + ------ ## Videos Template Group @@ -536,6 +581,8 @@ Setting the Videos template group also automatically makes the Video [model](htt - ["gopro videos"](https://duckduckgo.com/?q=gopro+videos&ia=videos&iai=hCsigWVqA-M) (built-in videos search) +![DuckDuckGo search for "gopro videos"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fgopro_videos.png&f=1) + ------ ## Places Template Group @@ -576,7 +623,17 @@ Specify these *item* templates to replace the default `places_item` template, wh - [`basic_flipping_item`](https://duck.co/duckduckhack/templates_reference#codebasicflippingitemcode-template) - [`base_flipping_item`](https://duck.co/duckduckhack/templates_reference#codebaseflippingitemcode-template) -#### Places Model and View +### Example use of the 'places' template group + +- ["events in new york"](https://duckduckgo.com/?q=events+in+new+york&ia=events) + + ![DuckDuckGo search for "events in new york"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fevents_ny.png&f=1) + +- ["parking panda"](https://duckduckgo.com/?q=parking+in+philadelphia) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/parking/parking.js)) + + ![DuckDuckGo search for "parking in philadelphia"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fparking_panda.png&f=1) + +### Places Model and View The Places template group works together with the Places **model** and Places **view**. The Places model and view enable special map functionality and behaviors that make Instant Answers using Places valuable and delightful. @@ -712,11 +769,6 @@ Spice.add({ }); ``` -### Example use of the 'places' template group - -- ["events in new york"](https://duckduckgo.com/?q=events+in+new+york&ia=events) -- ["parking panda"](https://duckduckgo.com/?q=parking+in+philadelphia) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/parking/parking.js)) - ![DuckDuckGo search for "parking in philadelphia"](https://images.duckduckgo.com/iu/?u=https%3A%2F%2Fraw.githubusercontent.com%2Fduckduckgo%2Fduckduckgo-documentation%2Fmaster%2Fduckduckhack%2Fassets%2Ftemplate_groups%2Fparking_panda.png&f=1) ------ diff --git a/duckduckhack/instant-answer-display/templates_reference.md b/duckduckhack/instant-answer-display/templates_reference.md index 782ce1864..3d0c62fb3 100644 --- a/duckduckhack/instant-answer-display/templates_reference.md +++ b/duckduckhack/instant-answer-display/templates_reference.md @@ -83,10 +83,10 @@ footer ### Example Usage -- [GitHub](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/github/github.js) -- [RubyGems](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/ruby_gems/ruby_gems.js) -- [RedditSearch](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/reddit_search/reddit_search.js) -- [AlternativeTo](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/alternative_to/alternative_to.js) +- [GitHub](https://duckduckgo.com/?q=github+todo&ia=about) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/github/github.js)) +- [RubyGems](https://duckduckgo.com/?q=ruby+gems+http&ia=software) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/ruby_gems/ruby_gems.js)) +- [RedditSearch](https://duckduckgo.com/?q=reddit+cats&ia=social) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/reddit_search/reddit_search.js)) +- [AlternativeTo](https://duckduckgo.com/?q=alternative+to+photoshop&ia=software) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/alternative_to/alternative_to.js)) ### Template Groups @@ -128,8 +128,8 @@ content ### Example Usage -- [Rhymes](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/rhymes/rhymes.js) -- [Thesaurus](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/thesaurus/thesaurus.js) +- [Rhymes](https://duckduckgo.com/?q=what+rhymes+with+day&ia=rhymes) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/rhymes/rhymes.js) +- [Thesaurus](https://duckduckgo.com/?q=synonym+for+warm&ia=thesaurus) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/thesaurus/thesaurus.js) ### Template Groups @@ -175,8 +175,7 @@ ratingText ### Example Usage -- [Movie](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/movie/movie.js) -- [BBC](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/bbc/bbc.js) +- [BBC](https://duckduckgo.com/?q=bbc+two+schedule+yesterday&ia=tv&iai=1) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/bbc/bbc.js) ### Template Groups @@ -225,8 +224,8 @@ rating ### Example Usage -- [Amazon](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/amazon/amazon.js) -- [Octopart](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/octopart/octopart.js) +- [Amazon](https://duckduckgo.com/?q=batman+products&ia=products) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/amazon/amazon.js)) +- [Octopart](https://duckduckgo.com/?q=octopart+stm32f205zgt6&ia=parts) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/octopart/octopart.js)) ### Template Groups @@ -283,8 +282,8 @@ A detail template where image is emphasized, suited to feature for an item that ### Example Usage -- [Amazon](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/amazon/amazon.js) -- [Octopart](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/octopart/octopart.js) +- [Amazon](https://duckduckgo.com/?q=batman+products&ia=products) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/amazon/amazon.js)) +- [Octopart](https://duckduckgo.com/?q=octopart+stm32f205zgt6&ia=parts) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/octopart/octopart.js)) ### Template Groups @@ -344,8 +343,7 @@ A template for drilling-down into a particular item on the same page. Emphasizes ### Example Usage -- [BBC](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/bbc/bbc.js) -- [Movie](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/movie/movie.js) +- [BBC](https://duckduckgo.com/?q=bbc+two+schedule+yesterday&ia=tv&iai=1) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/bbc/bbc.js) ### Template Groups @@ -440,9 +438,8 @@ The same template, with the `aux` feature: ### Example Usage -- [Bitcoin](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/bitcoin/bitcoin.js) -- [Gravatar](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/gravatar/gravatar.js) -- [Drinks](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/drinks/drinks.js) +- [Gravatar](https://duckduckgo.com/?q=gravatar+matt&ia=avatar) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/gravatar/gravatar.js)) +- [Urban Dictionary](https://duckduckgo.com/?q=urban%20dictionary%20ROTFL&ia=dictionary) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/tree/master/share/spice/urban_dictionary/urban_dictionary.js)) ### Template Groups @@ -646,6 +643,7 @@ This view is displayed when the 'front' is clicked, together with the 'back' (ab ### Example Usage - Local results (built-in to DDG): search for [cafes near Ann Arbor](https://duckduckgo.com/?q=cafes+near+ann+arbor). +- [Parking](https://duckduckgo.com/?q=parking+philadelphia&ia=parking) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/parking/parking.js)) ### Template Groups @@ -914,6 +912,7 @@ A detail template for displaying information about a single location on a map ba ### Example Usage - Local results (built-in to DDG): search for [a particular business](https://duckduckgo.com/?q=espresso+italiano+maui). +- [Parking](https://duckduckgo.com/?q=parking+philadelphia&ia=parking) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/parking/parking.js)) ### Template Groups @@ -975,7 +974,7 @@ When displaying a bulleted list, the simplest case would be to pass `list` an ar ### Example Usage -- [Whois](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/whois/whois.js) (search for ['whois mozilla.org'](https://duckduckgo.com/?q=whois+mozilla.org)) +- [Whois](https://duckduckgo.com/?q=whois+mozilla.org) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/whois/whois.js)) ### Template Groups @@ -1043,10 +1042,9 @@ templates: { ### Example Usage -- [UrbanDictionary](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/urban_dictionary/urban_dictionary.js) -- [MetaCpan](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/meta_cpan/meta_cpan.js) -- [CodeSearch](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/code_search/code_search.js) -- [Whois](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/whois/whois.js) +- [UrbanDictionary](https://duckduckgo.com/?q=urban%20dictionary%20ROTFL&ia=dictionary) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/urban_dictionary/urban_dictionary.js)) +- [MetaCpan](https://duckduckgo.com/?q=metacpan+WWW%3A%3ADuckDuckGo&ia=software) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/meta_cpan/meta_cpan.js)) +- [Whois](https://duckduckgo.com/?q=whois+mozilla.org) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/whois/whois.js)) ### Template Groups @@ -1088,7 +1086,7 @@ dateBadge ### Example Usage -- [Dogo News](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/dogo_news/dogo_news.js) +- [Dogo News](https://duckduckgo.com/?q=dogo+news&ia=kidsnews&iai=2) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/dogo_news/dogo_news.js)) ### Template Groups @@ -1121,7 +1119,7 @@ dateBadge ### Example Usage -- [Dogo News](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/dogo_news/dogo_news.js) +- [Dogo News](https://duckduckgo.com/?q=dogo+news&ia=kidsnews&iai=2) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/dogo_news/dogo_news.js)) ### Template Groups @@ -1301,7 +1299,7 @@ dateBadge ### Example Usage -- ["gopro videos"](https://duckduckgo.com/?q=gopro+videos&ia=videos&iai=vutn7IUCKck) and click on any item (built-in videos Instant Answer) +- Search for ["gopro videos"](https://duckduckgo.com/?q=gopro+videos&ia=videos&iai=vutn7IUCKck) and click on any item (built-in videos Instant Answer) ### Template Groups @@ -1377,9 +1375,7 @@ A detail template for containing fully customized markup. ### Example Usage -- [FlashVersion](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/flash_version/flash_version.js) -- [NPM](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/npm/npm.js) -- [XKCD](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/xkcd/xkcd.js) +- [XKCD](https://duckduckgo.com/?q=xkcd+120&ia=comics) ([code](https://github.com/duckduckgo/zeroclickinfo-spice/blob/master/share/spice/xkcd/display/xkcd_display.js)) ### Complex Example diff --git a/duckduckhack/submitting-your-instant-answer/preparing_for_a_pull_request.md b/duckduckhack/submitting-your-instant-answer/preparing_for_a_pull_request.md index 92acae5a3..f061208ec 100644 --- a/duckduckhack/submitting-your-instant-answer/preparing_for_a_pull_request.md +++ b/duckduckhack/submitting-your-instant-answer/preparing_for_a_pull_request.md @@ -1,4 +1,14 @@ -# Preparing for Pull Request +# Preparing to Submit + +Any contribution to DuckDuckHack is a significant and impressive undertaking. Your contribution has the potential to appear on hundreds of devices, across millions of searches. + +Our mission as a community is to cover every topic with an Instant Answer. *Every topic.* That involves an enormous number of people, contributors, and submissions. + +To support as many contributors as possible, we've evolved a review process that is stringent and efficient. To undergo review, contributions must first satisfy a non-negotiable set of prerequisites. **The fastest way to get your contribution approved is to follow these requirements carefully.** + +Don't worry if that sounds daunting - we're always going to be as transparent as possible about any requirements. Also, the community is chock-full of leaders and contributors happy to pair up and help you prepare for review. Overall, this leads to a productive, interconnected DuckDuckHack community. + +## Pull Request Checklist The culmination of your contribution comes in the form of a pull request to the Github repository for your Instant Answer type.