Difference between revisions of "Help:Editing"
m (bugfix) |
(introduced the policies) |
||
| Line 1: | Line 1: | ||
| − | + | ==general help== | |
| + | |||
| + | For general help in editing please read [[Wikipedia:How_to_edit_a_page | Wikipedias "How to edit a page" page]]. | ||
| + | |||
| + | ==ThinkWiki editing policies== | ||
| + | |||
| + | ===write with other users in your mind=== | ||
| + | When you write an article, keep the following things in mind... | ||
| + | *Respect others. Try sticking to a [http://en.wikipedia.org/wiki/Npov neutral point of view]. Respect the work of other writers. Respect your (potential) readers. | ||
| + | *ThinkWiki is not only about the newest models. Try to write in a way that is open for older, newer and future models. This especially regards the structuring of the information you provide. | ||
| + | *ThinkWiki is not only about your Distro. Try to make clear if something you write is valid only for your specific linux distribution. | ||
| + | *Even though the article is written by you, it is a piece of information others might work on later. Try to avoid personal remarks in your articles. | ||
| + | |||
| + | ===naming policies for new pages=== | ||
| + | If you create a new page, please consider the following page naming policies. This is important to keep a persistent page naming scheme and hence to ensure that ThinkWiki still works well when it has grown more complex. | ||
| + | |||
| + | Page names (the links you create to point to the page) are used as the page Title. Considering these policies has the following advantages: | ||
| + | *the pages will have self-explaining titles | ||
| + | *in Category views like the Model view the links to the pages are expressively labeled and similar pages are sorted together | ||
| + | *the pages are more easily found in search engines like google | ||
| + | |||
| + | ====general policies==== | ||
| + | *It is allowed and in fact wanted that you use spaces within your page titles. | ||
| + | *The name you choose for the page should be as specific as its content will be. In other words...it should not be possible to write another page with more general content about the topic that your page title indicates. | ||
| + | |||
| + | ====specific kinds of pages==== | ||
| + | To sort similar pages together in the Model views, we start specific pages in defined ways. | ||
| + | The following table shows the naming schemes for several kinds of pages... | ||
| + | {| border="1" cellspacing="0" cellpadding="2" | ||
| + | |+page naming schemes | ||
| + | ! page type !! naming scheme !! example | ||
| + | |- | ||
| + | | Installation instructions overview for a model || Installation instructions for the <model> || Installation instructions for the Thinkpad T41p | ||
| + | |- | ||
| + | | Installation instructions for a specific distro on a model || Installing <distro> on a <model> || Installing Gentoo on a Thinkpad T41p | ||
| + | |- | ||
| + | | other HowTos || How to ... || How to get special keys to work | ||
| + | |- | ||
| + | | Problem descriptions || Problem with ... || Problem with lm-sensors | ||
| + | |- | ||
| + | | Drivers and Tools pages || <name of driver/tool> || ibm-acpi | ||
| + | |- | ||
| + | | Patches || Patch ... || Patch disabling ACPI C3 | ||
| + | |- | ||
| + | | Distro pages || Category:<distro> || Category:SuSE | ||
| + | |- | ||
| + | | Thinkpad Models || Category:<Model without "Thinkpad"> || Category:T41p | ||
| + | |- | ||
| + | | Specifications || <type number-model number> || 2373-GHG | ||
| + | |- | ||
| + | |} | ||
Revision as of 16:01, 29 December 2004
Contents
general help
For general help in editing please read Wikipedias "How to edit a page" page.
ThinkWiki editing policies
write with other users in your mind
When you write an article, keep the following things in mind...
- Respect others. Try sticking to a neutral point of view. Respect the work of other writers. Respect your (potential) readers.
- ThinkWiki is not only about the newest models. Try to write in a way that is open for older, newer and future models. This especially regards the structuring of the information you provide.
- ThinkWiki is not only about your Distro. Try to make clear if something you write is valid only for your specific linux distribution.
- Even though the article is written by you, it is a piece of information others might work on later. Try to avoid personal remarks in your articles.
naming policies for new pages
If you create a new page, please consider the following page naming policies. This is important to keep a persistent page naming scheme and hence to ensure that ThinkWiki still works well when it has grown more complex.
Page names (the links you create to point to the page) are used as the page Title. Considering these policies has the following advantages:
- the pages will have self-explaining titles
- in Category views like the Model view the links to the pages are expressively labeled and similar pages are sorted together
- the pages are more easily found in search engines like google
general policies
- It is allowed and in fact wanted that you use spaces within your page titles.
- The name you choose for the page should be as specific as its content will be. In other words...it should not be possible to write another page with more general content about the topic that your page title indicates.
specific kinds of pages
To sort similar pages together in the Model views, we start specific pages in defined ways. The following table shows the naming schemes for several kinds of pages...
| page type | naming scheme | example |
|---|---|---|
| Installation instructions overview for a model | Installation instructions for the <model> | Installation instructions for the Thinkpad T41p |
| Installation instructions for a specific distro on a model | Installing <distro> on a <model> | Installing Gentoo on a Thinkpad T41p |
| other HowTos | How to ... | How to get special keys to work |
| Problem descriptions | Problem with ... | Problem with lm-sensors |
| Drivers and Tools pages | <name of driver/tool> | ibm-acpi |
| Patches | Patch ... | Patch disabling ACPI C3 |
| Distro pages | Category:<distro> | Category:SuSE |
| Thinkpad Models | Category:<Model without "Thinkpad"> | Category:T41p |
| Specifications | <type number-model number> | 2373-GHG |
