[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
slackdocs:styleguide [2012/08/30 22:18 (UTC)] – Fix the footnote. alienbob | slackdocs:styleguide [2012/09/05 23:46 (UTC)] – [Translating a Page] redirected install link to community page mfillpot | ||
---|---|---|---|
Line 7: | Line 7: | ||
==== Overview ==== | ==== Overview ==== | ||
- | The Slackware Documentation Project wiki will not be a 100% open wiki. While true that all can contribute, in order to avoid the editing wars and other ill effects experienced by open wikis, | + | The Slackware Documentation Project wiki will not be a 100% open wiki. While true that all can contribute, in order to avoid the editing wars and other ill effects experienced by open wikis, staff reviewing of submissions and major page edits will be standard procedure. A contributor will have ownership of his submissions to the extent that he can have a reasonable expectation that the basic structure and content of the article will not be modified without his knowledge and editorial discussion via the discussion page. The Staff feels that this policy would foster a better atmosphere for positive and constructive data archiving on this wiki. |
---- | ---- | ||
Line 13: | Line 13: | ||
**Major ((For purposes of this rule, a major edit should be considered to be any edit that substantially changes the content, flow, or layout of the article.)) edits should not be performed on a contributor' | **Major ((For purposes of this rule, a major edit should be considered to be any edit that substantially changes the content, flow, or layout of the article.)) edits should not be performed on a contributor' | ||
+ | |||
+ | <note important> | ||
**Exceptions to This Rule** | **Exceptions to This Rule** | ||
- | - Author is unknown or no longer an active participant here | + | |
- | - Editing or reversion is required to correct vandalism | + | - Explicit permission is granted via the discussion page by the original author to allow open editing/ |
- | - Minor grammatical, punctuation, | + | |
- | - Obviously | + | - Editing or reversion is required to correct vandalism. |
+ | - Minor edits are required to correct grammar, punctuation, spelling, wiki formatting, or clarity. | ||
+ | - Editing is required to amend obviously | ||
+ | |||
+ | < | ||
+ | |||
+ | | ||
- | < | ||
---- | ---- | ||
Line 27: | Line 34: | ||
==== Commentary ==== | ==== Commentary ==== | ||
- | And finally, it is easy to understand a contributor' | + | Regarding the Core namespaces **slackware**, |
Thank you for your understanding and cooperation in this matter. | Thank you for your understanding and cooperation in this matter. | ||
Line 60: | Line 67: | ||
{{tag> | {{tag> | ||
- | </ | ||
- | |||
- | |||
- | ===== List of Reserved Words ===== | ||
- | |||
- | There is a list of reserved words used by Dokuwiki as shortcut word. | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | FIXME | ||
- | = footer = (with one or many level ===) | ||
</ | </ | ||
Line 92: | Line 87: | ||
The button bar at the top of the edit window contains buttons for easy creation of these notification boxes. | The button bar at the top of the edit window contains buttons for easy creation of these notification boxes. | ||
+ | |||
+ | |||
+ | =====A General Note on Style==== | ||
+ | |||
+ | This is a wiki so a certain degree of informality is acceptable. This includes, for example, conversational contractions such as " | ||
+ | * Do not use [[wp> | ||
+ | * Write complete sentences and try to avoid grammatical errors. If English is not your native language, you can always get help from an English editor. | ||
+ | * Follow proper [[http:// | ||
+ | * Long passages of plain text are hard to read; always consider if something can be better expressed using a list format. Use numbered lists only for sequential operations, bulleted lists for options or examples (as shown here). Sometimes a table or a flowchart can be useful. | ||
+ | * If quoting computer output, reproduce it exactly, including spelling (which is usually American). Use %%< | ||
+ | * If your text has examples of key presses, use the %%< | ||
+ | * Avoid the passive voice. Use it only when alternatives would be clumsy. | ||
+ | * Try to avoid long-windedness. "To do x, use the -y option" | ||
+ | |||
===== Translating a Page ===== | ===== Translating a Page ===== | ||
Line 99: | Line 108: | ||
* English is the primary language of the Wiki. Every Wiki article must **at least** have an English version. | * English is the primary language of the Wiki. Every Wiki article must **at least** have an English version. | ||
- | * When you want to translate a page, you must not change the name of the page. \\ For example to translate | + | * When you want to translate a page, you must not change the name of the page. \\ For example to translate |
* If you want to create a //new// page in your native language, first create the English version of the page using an English word for the page. A page name like " | * If you want to create a //new// page in your native language, first create the English version of the page using an English word for the page. A page name like " | ||
Line 109: | Line 118: | ||
If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag " | If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag " | ||
- | When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-english | + | When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-English |
+ | |||
+ | ===== See Also ===== | ||
+ | * [[slackdocs: | ||
+ | * [[slackdocs: | ||
+ | * [[slackdocs: | ||
<!-- Please do not add anything below, except additional tags.--> | <!-- Please do not add anything below, except additional tags.--> | ||
<!-- Do not remove this line and the text below. Thanks! slackdocs@ --> | <!-- Do not remove this line and the text below. Thanks! slackdocs@ --> | ||
{{tag> | {{tag> |