[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/23 14:54 (UTC)] – Added: Pages that require attention from an admin alienbob | slackdocs:styleguide [2012/09/05 16:13 (UTC)] – [A General Note on Style] hazel | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style guide for articles published | + | ====== Style Guide for Articles Published |
A few basic rules should be kept in mind when editing pages in this Wiki. | A few basic rules should be kept in mind when editing pages in this Wiki. | ||
- | ===== Page editing etiquette | + | ===== Editing Policy |
- | ==== Release the lock ==== | + | ==== 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, 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. | ||
+ | ---- | ||
+ | |||
+ | ==== Policy Rule ==== | ||
+ | |||
+ | **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** | ||
+ | |||
+ | - Core documents in these namespaces that require more exacting editorial overview: **slackware**, | ||
+ | - Explicit permission is granted via the discussion page by the original author to allow open editing/ | ||
+ | - Author is unknown or no longer an active participant here. | ||
+ | - Editing or reversion is required to correct vandalism. | ||
+ | - Minor edits are required to correct grammar, punctuation, | ||
+ | - Editing is required to amend obviously incorrect information. | ||
+ | |||
+ | < | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Commentary ==== | ||
+ | |||
+ | Regarding the Core namespaces **slackware**, | ||
+ | |||
+ | Thank you for your understanding and cooperation in this matter. | ||
+ | |||
+ | ===== Page Editing Etiquette ===== | ||
+ | |||
+ | ==== Release the Lock ==== | ||
When you click on the " | When you click on the " | ||
- | ==== Edit a section, not the whole page ==== | + | ==== Edit a Section, Not the Whole Page ==== |
On the right of each page section header, you see the word [edit]. If you click on it to edit the section, you only lock this section of the page which allows other contributors to edit different sections of the page. This is the recommended way for translating pages, fixing typos or just some sentences/ | On the right of each page section header, you see the word [edit]. If you click on it to edit the section, you only lock this section of the page which allows other contributors to edit different sections of the page. This is the recommended way for translating pages, fixing typos or just some sentences/ | ||
- | ==== Add a summary | + | ==== Add a Summary |
In " | In " | ||
- | ==== Minor modifications | + | ==== Minor Modifications |
When you only fix a typo, change a word, or make global minor modifications, | When you only fix a typo, change a word, or make global minor modifications, | ||
- | ==== Add a footer | + | ==== Add a Footer |
Every page may end with this wiki code, especially if you copied a text from an external source: | Every page may end with this wiki code, especially if you copied a text from an external source: | ||
Line 35: | Line 70: | ||
- | ===== List of reserved words ===== | + | ===== Note About "Notes" ===== |
- | + | ||
- | There is a list of reserved words used by Dokuwiki as shortcut word. | + | |
- | + | ||
- | < | + | |
- | + | ||
- | < | + | |
- | FIXME | + | |
- | = footer = (with one or many level ===) | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | ===== Note about "notes" ===== | + | |
You can use several visual boxes, like : | You can use several visual boxes, like : | ||
Line 65: | 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. | ||
- | ===== Translating a page ===== | + | |
+ | =====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 ===== | ||
The multi-language capability of this Wiki requires that you stick to a few rules: | The multi-language capability of this Wiki requires that you stick to a few rules: | ||
- | * English is the primary language of the Wiki. Every Wiki article must **at least** have an english | + | * English is the primary language of the Wiki. Every Wiki article must **at least** have an English |
- | * 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 | + | * If you want to create a //new// page in your native language, first create the English |
- | < | + | < |
- | ===== Pages that require attention | + | ===== Pages That Require Attention |
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> |