Page naming guide: Difference between revisions
No edit summary |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
You can add your comment, additions etc. | You can add your comment, additions etc. | ||
{{color|red|'''Warning:'''}} '''This is | {{Note|#E8F7FC|{{color|red|'''Warning:'''}} '''This is project 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.''' }} | ||
---- | ---- | ||
<h1>Page Naming Guide</h1> | <h1>Page Naming Guide</h1> | ||
| Line 23: | Line 21: | ||
</ul> | </ul> | ||
<div class="note">For the time being these capitalization rules for page names apply only to new pages. There are a large number of pages in our wiki that do not conform to these rules, but please do not correct those at this time, as links could be broken. This will have to be corrected when whole wiki will be recovered and then only fixed together in one point of time. What generaly means we will have to do it somwhere in fututre. </div> | <div class="note">For the time being these capitalization rules for page names apply only to new pages. There are a large number of pages in our wiki that do not conform to these rules, but please do not correct those at this time, as links could be broken. This will have to be corrected when whole wiki will be recovered and then only fixed together in one point of time. What generaly means we will have to do it somewhere in future. </div> | ||
<h4 name="Characters_between_words">Characters between words</h4> | |||
<p>Page names should use underscores "_" between words and describing text spaces " ". This characters are treated by wiki transparently, like they would not be there. These are following: "_", " ", ":", "/". This allow single words in page name to be found during wiki searching, what is important when effective searching, so user-friendliness is taken under consideration. Underscores "_" forces not forgetting about needed characters or accidental double characters, and also shows that this is page name, but not describing text, and where page name begins/ends, so allow to make less mistakes in addressing links in wiki, especially in translated pages. So finnaly:</p> | |||
<ul> | |||
<li><font color="green"><strong>Correct</strong></font>: for page name - "A_new_method_for_creating_Shareaza_plugins" and for describing text - "A new method for creating Shareaza plugins</li> | |||
<li><font color="red"><strong>Incorrect</strong></font>: "ANewMethodForCreatingShareazaPlugins" </li> | |||
</ul> | |||
<div class="note">For the time being these inter-characters, joining characters, rules for page names apply only to new pages. There are a large number of pages in our wiki that do not conform to these rules, but please do not correct those at this time, as links could be broken. This will have to be corrected when whole wiki will be recovered and then only fixed together in one point of time. What generaly means we will have to do it somwhere in fututre. </div> | |||
<h4 name="Translated_page">Translated page</h4> | <h4 name="Translated_page">Translated page</h4> | ||
<p>Translated page is named as English one followed by "/LanguageSufix":</p> | <p>Translated page is named as English one followed by "/LanguageSufix":</p> | ||
| Line 30: | Line 36: | ||
<li><font color="red"><strong>Incorrect</strong></font>: "plMain" or "pl/Main</li> | <li><font color="red"><strong>Incorrect</strong></font>: "plMain" or "pl/Main</li> | ||
</ul> | </ul> | ||
<p>Sufixes are used by [[Template:Languages]] to generate box like this one:{{languages|Page_naming_guide}} for identification of page language and displaying link in box created by template on page. | |||
Every language got own and unique sufix: | |||
* /de - German | |||
* /fr - French | |||
* /it - Italian | |||
* /nl - Dutch | |||
* /pl - Polish | |||
* /pt - Portuguese | |||
* /ru - Russian | |||
* /sp - Spanish | |||
* /zh-hunt - Chinese | |||
>>>> there is ISO standard describing this names with 2 letters, all of them, we should follow it. | |||
(this list ought to be completed) | |||
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> | |||
<p> 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. </p> | <p> 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. </p> | ||
<h3 name="One-page_articles">One-page articles</h3> | <h3 name="One-page_articles">One-page articles</h3> | ||
<h4 name="Content_with_a_unique_title">Content with a unique title</h4> | <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> 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> | ||
<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 77: | ||
== Comments == | == 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) | 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) | ||
: Because I am lazy, should do it. Have you seen how list look like? Underscores in page names? 13:19, 8 March 2010 (UTC) | |||
:: Underscores in page names: [[Shareaza Settings]] and [[Shareaza_Settings]] link to the same page... If you create a new page, use underscores; when linked from within the Wiki, these underscores are not needed however... BTW, to sign your comments, you can type 4 tides ('~') in a row. mfg, [[User:Old death|Old death]] 01:42, 8 March 2010 (UTC) | |||
::: I think underscores force not to loose any character as it could lead to wrong linking. If they are transparent then it is good, and also they shows this is link address, not a text. If that works for searching so give the same search result then it is ok IMHO. [[User:Ocexyz|Ocexyz]] 13:20, 8 March 2010 (UTC) | |||
There is a question I can't find good rule. Example is name of "magnet link". Wheather "Magnetlink" or "MagnetLink" or just "Magnet". I am pretty sure there will be some cases when 2 or more words should be written together as describe something, a term or conception, just better. | |||
: As for whether this should be written in one or in two words, I think it should be written in two words separated by a space to allow to be found when either searching for "link", "magnet" and "magnet link". | |||
: In this case, "Magnet" is a proper name, so it should be capitalized. "link" however, is a normal English word that should be written small. The name should therefore be "Magnet link". But note that in the Wiki, this does not change anything, as the Wiki automatically capitalizes every page name. | |||
: mfg, [[User:Old death|Old death]] 11:52, 9 March 2010 (UTC) | |||
Latest revision as of 11:52, 9 March 2010
Page naming guide (project)(alpha test)
You can add your comment, additions etc.
Warning: This is project 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.
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"
Characters between words
Page names should use underscores "_" between words and describing text spaces " ". This characters are treated by wiki transparently, like they would not be there. These are following: "_", " ", ":", "/". This allow single words in page name to be found during wiki searching, what is important when effective searching, so user-friendliness is taken under consideration. Underscores "_" forces not forgetting about needed characters or accidental double characters, and also shows that this is page name, but not describing text, and where page name begins/ends, so allow to make less mistakes in addressing links in wiki, especially in translated pages. So finnaly:
- Correct: for page name - "A_new_method_for_creating_Shareaza_plugins" and for describing text - "A new method for creating Shareaza plugins
- Incorrect: "ANewMethodForCreatingShareazaPlugins"
Translated page
Translated page is named as English one followed by "/LanguageSufix":
- Correct: "Main/pl"
- Incorrect: "plMain" or "pl/Main
Sufixes are used by Template:Languages to generate box like this one:
 Languages: |
English • Deutsch • Español • Français • עברית • Italiano • Nederlands • Polski • Português • Русский • 中文(繁體) | e |
for identification of page language and displaying link in box created by template on page.
Every language got own and unique sufix:
- /de - German
- /fr - French
- /it - Italian
- /nl - Dutch
- /pl - Polish
- /pt - Portuguese
- /ru - Russian
- /sp - Spanish
- /zh-hunt - Chinese
>>>> there is ISO standard describing this names with 2 letters, all of them, we should follow it.
(this list ought to be completed)
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.
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.
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)
- Because I am lazy, should do it. Have you seen how list look like? Underscores in page names? 13:19, 8 March 2010 (UTC)
- Underscores in page names: Shareaza Settings and Shareaza_Settings link to the same page... If you create a new page, use underscores; when linked from within the Wiki, these underscores are not needed however... BTW, to sign your comments, you can type 4 tides ('~') in a row. mfg, Old death 01:42, 8 March 2010 (UTC)
- I think underscores force not to loose any character as it could lead to wrong linking. If they are transparent then it is good, and also they shows this is link address, not a text. If that works for searching so give the same search result then it is ok IMHO. Ocexyz 13:20, 8 March 2010 (UTC)
- Underscores in page names: Shareaza Settings and Shareaza_Settings link to the same page... If you create a new page, use underscores; when linked from within the Wiki, these underscores are not needed however... BTW, to sign your comments, you can type 4 tides ('~') in a row. mfg, Old death 01:42, 8 March 2010 (UTC)
There is a question I can't find good rule. Example is name of "magnet link". Wheather "Magnetlink" or "MagnetLink" or just "Magnet". I am pretty sure there will be some cases when 2 or more words should be written together as describe something, a term or conception, just better.
- As for whether this should be written in one or in two words, I think it should be written in two words separated by a space to allow to be found when either searching for "link", "magnet" and "magnet link".
- In this case, "Magnet" is a proper name, so it should be capitalized. "link" however, is a normal English word that should be written small. The name should therefore be "Magnet link". But note that in the Wiki, this does not change anything, as the Wiki automatically capitalizes every page name.
- mfg, Old death 11:52, 9 March 2010 (UTC)