Table of contents
- How to help: contents
- Lists
- Documentation wishlist
- Editing/review to do list
- Migration list
- Guides
- Getting started
- Writer's guide
- How to document Mozilla
- Writing interface reference documentation
- Page naming guide
- Disambiguation pages
- Localizing MDC
- Copyrights and licensing
- References
- MDC formatting guide
- Custom CSS classes
- Custom templates
- External redirects
- Needs redirect
Page naming for the MDC Wiki is relatively straightforward, but it's important you get it correct in order to take full advantage of the breadcrumb list at the top of the page.
Please also refer to the Writer's guidelines when choosing a page name.
General conventions
Capitalization
Page names should use sentence style capitalization (only capitalize the first word and any proper nouns) rather than headline style capitalization:
- Correct: "A new method for creating JavaScript rollovers"
- Incorrect: "A New Method for Creating JavaScript Rollovers"
One-page articles
Content with a unique title
If you are adding an article or other content that only requires a single page in the wiki, simply use the name of that article as the page name.
For example, the page for a one-page article called "A new approach to JavaScript rollovers" would be, simply A new approach to JavaScript rollovers. So long as your content title is unique, this is the easiest and preferred approach.
Content with a non-unique title
Wherever possible, you should try to create content with unique titles, in order to simplify the page naming as much as possible. If this is impossible, prefix the title with the topic, followed by a slash and no spaces.
For example, if I needed to add a page called "Optimization", simply calling the page "Optimization" would create a possible conflict as Optimization can apply to a wide variety of topics within the wiki. If my Optimization article was specifically about CSS, I would expand my title so it is unique (ie: CSS optimization).
If there are two or more pages which have the same "natural" title, a disambiguation page should be created.
It is a best-practice within this wiki to have unique article titles wherever possible.
Multiple-page content
If the content you are adding to the wiki requires multiple pages, use the following page naming method. This allows MindTouch Deki to build the breadcrumbs list at the top of the page correctly.
- Learning JavaScript - Main table-of-contents page
- Learning JavaScript/Introduction
- Learning JavaScript/A layperson's view
- Learning JavaScript/More advanced scripting
- Learning JavaScript/Next steps
If you don't use the pathname-like hierarchy depicted here, your articles will all be located at the top of the hierarchy, instead of nested.