• Friday May 9th 2008
• Do you want fries with that project?

Skip to Content

Mycroft

	Users:	Home | Search | Uninstall | Requests | Contact | Hosting plugins
	Developers:	Contribute | Submit Plugins | Judge Plugins | Broken Plugins | Mailing List | Bugs
	Documentation:	Table of Contents | Quick Start | Introduction | Installing | Header | <SEARCH> | <INPUT> | <INTERPRET> | <BROWSER> | Icons | Additional Documentation

Advanced Mozilla-Search Plugin Documentation.

Back to Main Table of Contents

The Mozilla-Search header information

• Contents
  • The basics
  • Advanced Header information
  • User Contributed Notes for this section

Top^

A basic Mozilla-Search header should contain at least the following information:

You need to comment out all header information. You can do this by using a # symbol at the start of each line. You may also use the # symbol for comments throughout the source file. You should include a mention of what the plugin file was created for use with.
For example:

"Mozilla/Netscape 6+ plugin file"

All plugins should include the name of the author and a way to contact the author. The preferred method is to include the authors e-mail address in the header; however, you may use other forms of contact if you are concerned about spammers or future viruses collecting this e-mail information.
Here are some examples that can be used to protect you from spammers and future viruses collecting your e-mail address:

• Add a "_NO/SPAM_" tag or something similar to your e-mail address.
• Include your web site address only. - Please make sure there is a way for users to contact you through your web site if you do this.
• Provide a link to a service such as an IM or private form mailer that allows users to contact you.

All plugins should include the last modified date
for example:

"Last updated: Month dd, YYYY"

All header information is not read by Mozilla-Search, you can format this date in any way you prefer.
Example of a basic header:

# Mozilla/Netscape 6+ plugin file
# by Your Name<yourname @youraddress.ext>
#
# Last updated: Month dd, YYYY

Top^

Mozilla-Search advanced header information

In this section you will find optional header information that is not found in the basic header section of this document.

A brief summary of the plugins status when last updated:

# Status: Working 

A note as to what the plugin was created for:

for website.ext 

The date the plugin was originally created:

# Created: 

A description of the known issues when plugin was last updated:

# Known issues:

Example of an advanced header:

# Status: working beta
# Mozilla/Netscape 6+ plugin for searchsite.org
# by Your Name<yourname @youraddress.ext>
#  
# Created: Month dd, YYYY
# Last updated: Month dd, YYYY
# Updated by: Name(s)
#
# Known issues:
#
# 1. Something doesn't always work
# 2. Something isn't supported
# 3. Any notes you may have.

Top^

Back to Main Table of Contents

Next>

User Contributed Notes for this section

Have a useful tip or trick to add to this section? You can use the form below to add your comment to the user contributed notes.

If you find something that no longer works, is invalid, or is no longer needed. Please let us know by contacting us through the Mycroft Mailing List.

Please do not place corrections in the user notes section, it is for helpful tips and tricks only.

Have you found and documented a feature that is not documented in these pages? Send it to us for inclusion in these documents and we will add your name to the list of contributors for this document.