[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/09/03 16:20 (UTC)] – [A General note on Style] hazel | slackdocs:styleguide [2012/09/05 23:46 (UTC)] – [Translating a Page] redirected install link to community page mfillpot | ||
---|---|---|---|
Line 34: | Line 34: | ||
==== Commentary ==== | ==== Commentary ==== | ||
- | Regarding the Core namespaces **slackware**, | + | 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 67: | 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 100: | Line 88: | ||
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 " | + | =====A General Note on Style==== |
- | * Do not use slang or " | + | |
+ | 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. | * 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. | ||
- | * Capitalise | + | * Follow |
- | * 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 here) | + | * 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). | + | * If quoting computer output, reproduce it exactly, including spelling (which is usually American). |
+ | * 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 115: | 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 125: | 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 ===== | ===== See Also ===== |