L10n:Documentation

This page is intended to lay out guidelines to help keeping the documentation consistent in content and style, easy to find and up-to-date.

Information models and doc purposes

Wikimo

Documents that are on wiki.mozilla.org

• should be related to project management
• should be specific to Mozilla project

Note that this is the first proposed information model for the WikiMo l10n doc.

MDN

Documents that are on developer.mozilla.org

• should be related to development
• you should be able to abstract them from the Mozilla project

Note that this is the first proposed information model for the MDN l10n doc.

Style Guide

As each wiki tool provides different features for character and paragraph styles, this will attempt to address styles that are compatible between the two and identify uses for those which are unique to each wiki

'''Note''': Please include a brief summary of your changes when editing a page. To do this, enter your changes in the text field found below the editor box.

Page naming guidelines

WikiMo

1. Always use the L10n: namespace.
   • Bad: Firefox_productization_guidelines
   • Bad: L10n_Firefox_Productization
   • Good: L10n:Firefox/Productization
2. For hierarchies, use /, not :. This will create breadcrumbs automatically.
   • Bad: L10n:Firefox:Productization
   • Good: L10n:Firefox/Productization
3. Prefer hierarchies than longer names if you need to disambiguate.
   • Bad: L10n:Firefox_Productization
   • Good: L10n:Firefox/Productization
4. If not ambiguous, simplify.
   • Bad: L10n:Product/Firefox/Namoroka
   • Good: L10n:Namoroka
   • Good: L10n:Firefox/Productization and L10n:Mobile/Productization are OK, because L10n:Productization is a more general document.
5. Don't repeat yourself:
   • Bad: L10n:Firefox/Firefox_Productization
   • Good: L10n:Firefox/Productization
6. Add localization-related categories.
   • Use [[Category:L10n]] anywhere in the contents of the page.

MDN

1. Always use the format langcode/Localization/yourpage.
   • Bad: /en/Create_a_new_localization
     
   • Good: /en/Localization/Create_a_new_localization
2. Prefer hierarchies to longer names to avoid ambiguity.
   • Bad: /en/Localization/Tools_Narro
   • Good: /en/Localization/Tools/Narro
3. Wherever possible, simplify.
4. No repetitions.
   • See #4 above.
5. Add any of the following localization-related tags by selecting the "Edit tags" button and enter the tag name in the field provided.
   
   • Localization, Internationalization, Localisation, Localizability, Translation, Language
6. See the MDN topic on page naming for more information.

Paragraph & character styles

WikiMo

For most style information, see the Mozilla WikiMedia Editing Guide. This includes the appropriate uses for toolbar styles, templates, tables, hyperlink formats, anchors, and categories. Before you begin editing or creating pages, please familiarize yourself with these styles and use them where appropriate.

MDN

For most style information, see the MDC Editing Guide and the MDN Writer's Guide. This includes the appropriate uses for toolbar styles, templates, tables, hyperlink formats, anchors, tags, and deleting pages. Before you begin editing or creating pages, please familiarize yourself with these styles and use them where appropriate.

Misc.

Documents updated on branching

• L10n:Branches

Background information

In the second half of 2009, we conducted an overhaul of the localization-related documentation in Mozilla. You can find more information about it on the project's page at L10n:Better Documentation.