See DuckDuckHack for an overview of the DuckDuckGo plugin system.
This repository is for contributing longtail plugins. Each longtail plugin produces a (generally large) data file that gets used for showing answers in long tail queries.
Longtail plugins are in alpha and both the interface and testing procedure are not yet well defined. However, you can work away without worrying about what any changes might do to your plugins -- we'll take care of all that.
First off, thank you!
-
Pick a longtail project (or add one) and comment that you're working on it.
-
Develop your plugin using the structure below in a fork.
-
Submit a pull request.
Please feel free to ask us questions!
Longtails consist of two primary files. The first is a metadata file that describes the plugin you are building. Its structure is identical to the Fathead metadata file, described here. The second, which can be generated using a language of your choosing, contains the data set in a format ready for us to deploy:
<!-- This XML declaration can be simply copied and is necessary for all longtail. -->
<?xml version="1.0" encoding="UTF-8"?>
<add allowDups="true">
<!-- Each result is contained inside a <doc> element. -->
<doc>
<!-- The title field is used in the zeroclickinfo header, and is the heaviest weighted string used for query matching. -->
<!-- The CDATA entity is used for all content that might contain unsafe data -->
<field name="title"><![CDATA[U.S. House Bill #289]]></field>
<!-- The lx_sec fields are also used for query matching, with decreasing precedence. They can be omitted. -->
<field name="l2_sec"><![CDATA[Recognizing the 50th anniversary of the National Institute of Dental Research.]]></field>
<field name="l3_sec"><![CDATA[House Committee on Commerce]]></field>
<field name="l4_sec"><![CDATA[Anniversaries, Commemorations, Congress, Congressional tributes, Dental care, Dentistry, Department of Health and Human Services, Government operations and politics, Health, Legislation, Medical research, Research centers, Science, technology, communications]]></field>
<!-- The paragraph field contains the text/HTML that will be displayed inside the zeroclickinfo box. -->
<field name="paragraph"><![CDATA[Commemorates the creation of the National Institute of Dental Research, through the National Dental Research Act, and its significant national leadership role.]]></field>
<!-- The p_count field is used to break ties on exact title matches. This should be used when the data is too long to be displayed without being broken into separate paragraphs. It can be omitted. -->
<field name="p_count">1</field>
<!-- The source field contains the address of the data source. If possible, it should reference the particular resource that this snippet was taken from. -->
<field name="source"><![CDATA[http://www.govtrack.us/]]></field>
</doc>