Mycroft Project

Submission Utility

Bugs / Suggestions - please file a bug or email mycroft.mozdev.org AT googlemail.com

If you would like to use a plugin already on Mycroft as a starting point, enter its numeric id here - available by mousing over a plugin name (no number means this feature is unavailable). All fields will be filled if you refer to an OpenSearch plugin - limited fields will be filled for a Sherlock ref:

If you would like to base a plugin on an OpenSearch description on your computer it can be uploaded here and most of the details should be parsed into the form:

Please fill all fields and hit 'Generate Plugin'. It is then possible to review the OpenSearch description.
When you are ready, press 'Submit Plugin'.

Show full instructions?
There is detailed documentation at OpenSearch.org and with reference to Firefox at the Mozilla Developer Center.

Choose Icon:Filetype (ico,png,gif,jpg):

Please select a 16x16 ICO (preferred), PNG, GIF or JPG icon from your computer. It is currently not possible to paste a URL here.

Reference:

This is used as the key for updates. If you are submitting an update please use the same reference as the existing plugin - available by mousing over the plugin in search results. If you are submitting a new plugin it must be a unique reference so please be descriptive eg 'googleuk_web' rather than 'favicon'. By default the filename of your icon is used but this may need to be altered.

Your name:

This is how you would like to be credited on this website and also in the <Developer> tag of the plugin. By all means use a nickname but please don't consider it an advert.

Your email: Include email in Plugin?

(Not required) Your email will not be displayed on the site. It will form the <Contact> tag in the plugin if you tick the box and will also be used to inform you if the plugin is removed for any reason and in future if your plugin is broken.

Plugin Name:

This is the name of the plugin displayed on Mycroft and also the name that will be displayed in the searchbox of the browser. Please standardise where appropriate and omit 'search' and 'plugin' unless part of the brand. It is possible to alter the name after generating the plugin but this is only necessary where the site uses one format and another format is more appropriate for the searchbox (mainly Google et al.)

Plugin Description:

This is currently underused but is part of the spec. Please include a brief description of the search performed.

Search URL: GET POST

This is the most important element of the plugin - if it is not correct the plugin will not function. The best way to construct this is by examining the <form> elements in the source code of the webpage. But for simple cases it will be possible to search for, say, 'TEST' and copy and paste the url from the location bar substituting {searchTerms} for TEST. Unfortunately IE7 does not support the POST method so GET is preferred where it works even if the site specifies POST. For GET the url will be similar to http://mycroft.mozdev.org/search-engines.html?name={searchTerms}&opensearch=yes&submitform=Search while for POST it is likely to just be http://mycroft.mozdev.org/search-engines.html Both here and in the POST parameters {searchTerms} is where the term that is searched for will be entered by the browser.

POST Parameters:

A list name=value POST parameter pairs with pairs separated by an ampersand. For example query={searchTerms}&examplename2=examplevalue2&examplename3=examplevalue3

Input Encoding:

The encoding that should be used when the search query is sent by the browser. Typically this will be UTF-8, ISO-8859-1, ISO-8859-2, ISO-8859-5, windows-1251, Big5, GB2312, Shift_JIS, etc. Wrong values will lead to errors of the type: "you searched for ????"

Suggestions URL: Search suggestions supported?

This is currently only supported by a few of the largest websites. An example of a working value is: http://suggestqueries.google.com/complete/search?output=firefox&client=firefox&hl=en&q={searchTerms}

Search Form URL:

This is where Firefox will direct the browser when the user searches with no term selected and it is also displayed on and indexed by Mycroft. It should point to the location where a user would normally go to access the search function of a webpage. That might be the front page or it might be a special page with advanced options where that is more useful. It should not always be the same page as the Search URL as this may lead to errors of the type: "you didn't search for anything"

Plugin category: (Category discussion bug)

Plugin country: (Request new country)

Language of the results: (Request new language)

Comment:

This comment will not be public. Please use it to describe updates or to say that this replaces another plugin, etc.

server monitoring