Page Naming Guide

  • Revision slug: Project:Page_Naming_Guide
  • Revision title: Page Naming Guide
  • Revision id: 113823
  • Created:
  • Creator: Dria
  • Is current revision? No
  • Comment /* Content with a non-Unique Title */

Revision Content

WORKING DRAFT, NOT FINAL

Page naming for the DevMo Wiki is relatively straightforward, but it's important you get it correct in order to take full advantage of the custom breadcrumb extension that we have added.

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 colon 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 could either expand my title so it is unique (ie: CSS Optimization) or I could prefix the title with "CSS:" (ie: CSS:Optimization).

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, there are a number of approaches you can take towards page naming.

Unique Associated Page Names

If your multi-page content is relatively short, you could give each page a unique-but-associated name. For example:

These page names don't allow you to take advantage of the breadcrumb extension, but are unique and obviously associated with one another. It's a simple, flat structure for the content.

Associated Page Names that are Breadcrumb-friendly

An alternate way to name the pages discussed above is as follows:

Note the addition of the initial "Learning JavaScript" page. In order for the breadcrumb extension to work, each part of the colon-delimited page names has to exist as a separate and navigable page.

If you want to use the breadcrumb extension in your pages, you must use the colon-delimited page naming system described here.

Revision Source

<p><b>WORKING DRAFT, NOT FINAL</b>
</p><p>Page naming for the DevMo Wiki is relatively straightforward, but it's important you get it correct in order to take full advantage of the custom <a href="en/Extensions/Breadcrumbs">breadcrumb extension</a> that we have added.
</p>
<h3 name="One_Page_Articles"> One Page Articles </h3>
<h4 name="Content_with_a_Unique_Title"> Content with a Unique Title </h4>
<p>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.
</p><p>For example, the page for a one-page article called "A New Approach to JavaScript Rollovers" would be, simply <a href="en/A_New_Approach_to_JavaScript_Rollovers">A New Approach to JavaScript Rollovers</a>.  So long as your content title is unique, this is the easiest and preferred approach.
</p>
<h4 name="Content_with_a_non-Unique_Title"> Content with a non-Unique Title </h4>
<p>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 colon and no spaces.
</p><p>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 could either expand my title so it is unique (ie: <a href="en/CSS_Optimization">CSS Optimization</a>) or I could prefix the title with "CSS:" (ie: <a href="en/CSS/Optimization">CSS:Optimization</a>).  
</p><p><b>It is a best-practice within this wiki to have unique article titles wherever possible.</b>
</p>
<h3 name="Multiple-Page_Content"> Multiple-Page Content </h3>
<p>If the content you are adding to the wiki requires multiple pages, there are a number of approaches you can take towards page naming.
</p>
<h4 name="Unique_Associated_Page_Names"> Unique Associated Page Names </h4>
<p>If your multi-page content is relatively short, you could give each page a unique-but-associated name.  For example:
</p>
<ul><li> <a href="en/Learning_JavaScript_-_Introduction">Learning JavaScript - Introduction</a>
</li><li> <a href="en/Learning_JavaScript_-_A_Layperson's_View">Learning JavaScript - A Layperson's View</a>
</li><li> <a href="en/Learning_JavaScript_-_More_Advanced_Scripting">Learning JavaScript - More Advanced Scripting</a>
</li><li> <a href="en/Learning_JavaScript_-_Next_Steps">Learning JavaScript - Next Steps</a>
</li></ul>
<p>These page names don't allow you to take advantage of the <a href="en/Extensions/Breadcrumbs">breadcrumb extension</a>, but are unique and obviously associated with one another.  It's a simple, flat structure for the content.
</p>
<h4 name="Associated_Page_Names_that_are_Breadcrumb-friendly"> Associated Page Names that are Breadcrumb-friendly </h4>
<p>An alternate way to name the pages discussed above is as follows:
</p>
<ul><li> <a href="en/Learning_JavaScript">Learning JavaScript</a>
</li><li> <a href="en/Learning_JavaScript/Introduction">Learning JavaScript:Introduction</a>
</li><li> <a href="en/Learning_JavaScript/A_Layperson's_View">Learning JavaScript:A Layperson's View</a>
</li><li> <a href="en/Learning_JavaScript/More_Advanced_Scripting">Learning JavaScript:More Advanced Scripting</a>
</li><li> <a href="en/Learning_JavaScript/Next_Steps">Learning JavaScript:Next Steps</a>
</li></ul>
<p>Note the addition of the initial "Learning JavaScript" page.  In order for the <a href="en/Extensions/Breadcrumbs">breadcrumb extension</a> to work, each part of the colon-delimited page names has to exist as a separate and navigable page.
</p><p><b>If you want to use the <a href="en/Extensions/Breadcrumbs">breadcrumb extension</a> in your pages, you must use the colon-delimited page naming system described here.</b>
</p>
Revert to this revision