MozillaZine

Rules and guidelines

From MozillaZine Knowledge Base

(Difference between revisions)
Revision as of 03:34, 12 February 2005
Firespring (Talk | contribs)
(Superfluous Information)
<-- Previous diff
Revision as of 23:26, 20 February 2005
Asqueella (Talk | contribs)
(add a note that these rules are not actually rules...)
Next diff -->
Line 1: Line 1:
-Please check out [[Talk:Rules]] for a discussion of how and why the rules have changed.+Please check out [[Talk:Rules]] for a discussion of how and why the rules have/will be changed. '''Note that these rules are not current.''' See also [[In-House Style]].
 + 
==Before Creating a New Article== ==Before Creating a New Article==

Revision as of 23:26, 20 February 2005

Please check out Talk:Rules for a discussion of how and why the rules have/will be changed. Note that these rules are not current. See also In-House Style.


Contents

Before Creating a New Article

Before you create a new article in the knowledge base, check to see if the topic hasn't already been covered somewhere. Do a search and browse the relevant sections. Even though it might seem logical to you that a certain topic would be located in [[Firefox : FAQs]], for example, it might actually be located in [[Firefox : Tips]]. Check first before making a new article.

Naming Conventions

In general, try to use Wikipedia's Naming conventions except when these differ from what is described below.

Capitalization

  • Use capital letters for the first letter of each main word in a title.
    • Good: [[Thunderbird : FAQs : Open in Inbox]]
    • Bad: [[Thunderbird : FAQs : Open in inbox]]

Categorization

  • Especially for articles dealing with Firefox, Thunderbird, and the Suite, categorize new articles by using colons (with a space before and after each) rather than with slashes (/) and no spaces.
    • Good: [[Firefox : Tips : Profile]]
    • Bad: [[Firefox/Profile|Profile]]
  • If you are uncertain about what category to use, then look at other articles and try to follow the conventions they use. Because the knowledge base contains articles for the Suite, Firefox, and Thunderbird (and more!), it is generally important to provide some degree of categorization, particularly since users sometimes find articles via search. If the page title does not indicate which product the article is for, it can be confusing for end-users.
  • In some cases, such as when an article applies to two or more products (Firefox, Thunderbird, or the Suite), it may be best to use no categorization at all. The [[Profile Folder]] article is a good example of this.

Use Short Titles

  • When possible, use short page titles. This eases linkability and avoids the current layout bug of long titles overlapping the search box. There's no need for a link to include the entire grammatically complete form of a question, especially when a few descriptive words would suffice.
    • Bad: [[Mozilla Suite : Tips : Use Send Page or Send Link to tell your friends about a great webpage]]
    • Good: [[Mozilla Suite : Tips : Send Page or Link]]

Application Names

  • Application name links should only use the application name, such as "Firefox" or "Thunderbird", not "Mozilla Firefox" or "Mozilla Thunderbird". The exception is the Suite, which should be linked to and called "Mozilla Suite", not "Mozilla", "Suite", "Seamonkey", or any other name.
    • Bad: [[Mozilla Firefox : FAQs : Bookmarks]]
    • Bad: [[Suite : Issues : Profile Locked]]
  • Layout issues or other things should use Gecko as the application name. As noted above, when an article applies to more than one application in a way that it would be wasteful to split up the articles because they would be practically identical, it may be best to dispose of the categories and just have the plain article title.

Editing Courtesy

  • Any time you edit a page, please add a short comment in the "Summary" field about the change you made. This makes it easier for others to see what has changed. Importantly, it can help make it easier for us to distinguish knowledge base spamming/vandalism from legitimate contributions.
  • If you find yourself wanting to change an entry back to an earlier revision, ask yourself if the current version had a useful purpose, and whether it really is necessary to change it back.
  • Document reasons for potentially controversial changes on the Talk pages.
  • Accept changes to your entries in a spirit of helpfulness.
  • If someone consistently makes certain types of mistakes or formatting quirks, consider placing a message in their User page.

Superfluous Information

  • In knowledge base articles, do not insert signatures, links to sites that are not related to Mozilla products, or other superfluous information. If you want to give a link to your own personal website, for example, then put it in your User page, not in the article. In short, if the information or link is not directly related to the topic of the article, then don't include it in the article.
  • Of course, signatures are welcome (even helpful) in the Talk pages, so do not hesitate to use them there.

Test Editing Pages

  • A sandbox for showing off the wiki's features.
  • Another test page - Now with extra markup tests!
  • If you want to do some silly tests using a page use this page.