Article naming conventions: Difference between revisions

From MozillaZine Knowledge Base
Jump to navigationJump to search
m (→‎Specifying the application: replaced Profile folder with Profile Manager as example of article that does not include the application name)
(→‎Punctuation marks or symbols: added link to http://en.wikipedia.org/wiki/Percent-encoding#Types_of_URI_characters and forum reference)
Line 43: Line 43:


==Punctuation marks or symbols==
==Punctuation marks or symbols==
Avoid using [http://en.wikipedia.org/wiki/Punctuation punctuation marks] or typographical symbols in article names, since exclamation points, parentheses, apostrophes and other characters can cause broken links when the article's [http://en.wikipedia.org/wiki/Uniform_Resource_Locator url] is used on webpage forums or in mail and newsgroup messages.
Avoid using [http://en.wikipedia.org/wiki/Punctuation punctuation marks] or typographical symbols in article names, since exclamation points, parentheses, apostrophes and other characters can cause broken links when the article's [http://en.wikipedia.org/wiki/Uniform_Resource_Locator URL] is used on webpage forums or in mail and newsgroup messages, unless [http://en.wikipedia.org/wiki/Percent-encoding#Types_of_URI_characters percent-encoding] is used. [http://forums.mozillazine.org/viewtopic.php?f=38&t=740765]
*Bad: <nowiki>[[Yahoo! Music videos don't work]] </nowiki>
*Bad: <nowiki>[[Yahoo! Music videos don't work]] </nowiki>
*Bad: <nowiki>[[Standard diagnostic (Thunderbird)]] </nowiki>   
*Bad: <nowiki>[[Standard diagnostic (Thunderbird)]] </nowiki>   


Exceptions include article names that contain  file names, preference names or about:protocols,  as well as those cases [[#Specifying the application |noted above]] in which a dash (hyphen) is used when specifying the application.
Exceptions include article names that contain  file names, preference names or about:protocols,  as well as those cases [[#Specifying the application |noted above]] in which a dash (hyphen) is used when specifying the application.

Revision as of 01:02, 15 July 2008

This page describes the rules you must follow when creating new articles or moving existing ones.

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

Specifying the application

For some articles, you should specify the application to which the article applies by putting "Firefox", "Thunderbird", or "Mozilla Suite" after a dash at the end of the name of the article. Please do this only if the article applies exlusively to one application and needs to be distinguished from similarly titled articles for other applications (see examples below). Do not include the application name if the article applies to two or more applications, or if the article is about a feature that exists in only one application. If you are not sure if the application name should be included in the title, just leave it out and someone else can add it later if necessary.

Examples where the application name is included in the article title:

Examples where the application name is not included in the article title:

Note: this is a change from the old naming convention, in which article titles indicated whether articles were "FAQs", "Tips", or "Issues" (e.g., Thunderbird : FAQs : Global Inbox). Many of the existing articles were created under the old naming system and have not yet been renamed. Please do not follow this old naming system when creating new articles.

Application names

Application name links should only use the application name, such as "Firefox", "Thunderbird", "Nvu", "Sunbird", or "Camino" and not "Mozilla Firefox", "Mozilla Thunderbird" or "Linspire Nvu". The exception is the Mozilla Suite, which should be linked to and called "Mozilla Suite", not "Mozilla", "Suite", or any other name.

  • Bad: [[Bookmarks - Mozilla Firefox]]
  • Bad: [[Profile locked - Suite]]

Layout issues or other things should use Gecko as the application name.

Use short titles, with key words at the beginning

When possible, use short page titles. 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.

  • Good: [[Send page or link - Mozilla Suite]]
  • Bad: [[Use Send Page or Send Link to tell your friends about a great webpage - Mozilla Suite]]

Try to avoid putting a word like "using" or "changing" at the beginning of the title when title will work fine without it. This will help as we move to categories, in which articles will be sorted alphabetically by title.

  • OK: [[Using keyword searches]]
  • Better: [[Keyword searches]]

Capitalization

Do not capitalize The First Letter of Each Main Word in the Title.

  • Good: [[Importing and exporting your mail]]
  • Bad: [[Importing and Exporting Your Mail]]

Exception: terms such as Search Bar and Junk Mail Controls, which refer to named product features and function as proper nouns, should be capitalized in article titles. See In-house style for a list of common terms to be capitalized.

Punctuation marks or symbols

Avoid using punctuation marks or typographical symbols in article names, since exclamation points, parentheses, apostrophes and other characters can cause broken links when the article's URL is used on webpage forums or in mail and newsgroup messages, unless percent-encoding is used. [1]

  • Bad: [[Yahoo! Music videos don't work]]
  • Bad: [[Standard diagnostic (Thunderbird)]]

Exceptions include article names that contain file names, preference names or about:protocols, as well as those cases noted above in which a dash (hyphen) is used when specifying the application.