Page naming guide: Difference between revisions
(Page naming guide, proposal poject of a part of wiki rules for discussion) |
No edit summary |
||
Line 3: | Line 3: | ||
You can add your comment, additions etc. | You can add your comment, additions etc. | ||
''' | {{color|red|'''Warning:'''}} '''This is porject of page by OCE with help of external (CC) and (C) sources not mentioned yet, so this page CAN'T be launched before completing this or will break rules. For now for editing purposed only.''' | ||
'''This is porject of page by OCE with help of external (CC) and (C) sources not mentioned yet, so this page CAN'T be launched before completing this or will break rules. For now for editing purposed only.''' | |||
Line 15: | Line 14: | ||
<p>Page naming for the Shareaza Wiki is relatively straightforward, but it's important you get it correct.</p> | <p>Page naming for the Shareaza Wiki is relatively straightforward, but it's important you get it correct.</p> | ||
<h3 name="General_conventions">General conventions</h3> | <h3 name="General_conventions">General conventions</h3> | ||
Line 23: | Line 21: | ||
<li><font color="green"><strong>Correct</strong></font>: "A new method for creating Shareaza plugins"</li> | <li><font color="green"><strong>Correct</strong></font>: "A new method for creating Shareaza plugins"</li> | ||
<li><font color="red"><strong>Incorrect</strong></font>: "A New Method for Creating Shareaza Plugins"</li> | <li><font color="red"><strong>Incorrect</strong></font>: "A New Method for Creating Shareaza Plugins"</li> | ||
</ul> | </ul> | ||
Line 39: | Line 35: | ||
<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> 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 Shareaza plugins" would be, simply [[A new approach to Shareaza plugins]]. So long as your content title is unique, this is the easiest and preferred approach, but please remember only in that case.</p> | <p>For example, the page for a one-page article called "A new approach to Shareaza plugins" would be, simply [[A new approach to Shareaza plugins]]. So long as your content title is unique, this is the easiest and preferred approach, but please remember only in that case.</p> | ||
<p>Please note that in case you are creating a page with a unique title in a non-English language, this title should be in English and be followed by the correct language suffix in order to make translations possible at a later time.</p> | |||
<h4 name="Content_with_a_non-unique_title">Content with a non-unique title</h4> | <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>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> | ||
Line 55: | Line 52: | ||
<p><strong>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.<br /> | <p><strong>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.<br /> | ||
</strong></p> | </strong></p> | ||
== Comments == | |||
Added one necessary line. BTW, Oce, why don't you use Wiki formatting in here? Any special reason for that? [[User:Old death|Old death]] 21:41, 7 March 2010 (UTC) |
Revision as of 21:41, 7 March 2010
Page naming guide (project)(alpha test)
You can add your comment, additions etc.
Warning: This is porject of page by OCE with help of external (CC) and (C) sources not mentioned yet, so this page CAN'T be launched before completing this or will break rules. For now for editing purposed only.
to jest jakis tekst
Page Naming Guide
Page naming for the Shareaza Wiki is relatively straightforward, but it's important you get it correct.
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 Shareaza plugins"
- Incorrect: "A New Method for Creating Shareaza Plugins"
Translated page
Translated page is named as English one followed by "/LanguageSufix":
- Correct: "Main/pl"
- Incorrect: "plMain" or "pl/Main
Translation of page ought to be done translating from English page. In case of doubts in content English version prevails, and normally translated page should be corrected according to English one.
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 Shareaza plugins" would be, simply A new approach to Shareaza plugins. So long as your content title is unique, this is the easiest and preferred approach, but please remember only in that case.
Please note that in case you are creating a page with a unique title in a non-English language, this title should be in English and be followed by the correct language suffix in order to make translations possible at a later time.
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 download, I would expand my title so it is unique (ie: download 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, use the following page naming method.
- Learning plugin - Main table-of-contents page
- Learning plugin/Introduction
- Learning plugin/A user's view
- Learning plugin/More advanced scripting
- Learning plugin/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.
Comments
Added one necessary line. BTW, Oce, why don't you use Wiki formatting in here? Any special reason for that? Old death 21:41, 7 March 2010 (UTC)