/|\
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
slackdocs:tutorial [2012/08/30 07:22 (UTC)] gerardo.zamudio [Wiki tutorial and guidelines] |
slackdocs:tutorial [2013/03/12 21:41 (UTC)] (current) alienbob [Wiki Tutorial and Guidelines] getting fed up with the "work in progress" warning if nobody is working on it. |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Wiki Tutorial and Guidelines ====== | ====== Wiki Tutorial and Guidelines ====== | ||
| - | <note warning> | ||
| ===== Namespaces ===== | ===== Namespaces ===== | ||
| - | Please get acquainted with the concepts behind namespaces in DokuWiki: [[http://wiki.splitbrain.org/wiki:namespaces]] | + | Please get acquainted with the concepts behind namespaces in DokuWiki: [[https://www.dokuwiki.org/ |
| - | ==== Plain articles | + | ==== Plain Articles |
| When you are creating just a //single// page then it is OK to use one of our existing namespaces: | When you are creating just a //single// page then it is OK to use one of our existing namespaces: | ||
| Line 17: | Line 16: | ||
| - | ==== Complex | + | ==== Complex |
| If you add new tutorials etc which are split into //multiple articles, contain screenshots etc//, it is advisable that you put these in their own sub-[[https:// | If you add new tutorials etc which are split into //multiple articles, contain screenshots etc//, it is advisable that you put these in their own sub-[[https:// | ||
| Line 33: | Line 32: | ||
| - | ===== Syntax and formatting | + | ===== Syntax and Formatting |
| First make yourself familiar with the [[wiki: | First make yourself familiar with the [[wiki: | ||
| Line 40: | Line 39: | ||
| * A page's main title heading should be in **H1**, the headings under that **H2**, headings under **H2** should be **H3** etcetera. | * A page's main title heading should be in **H1**, the headings under that **H2**, headings under **H2** should be **H3** etcetera. | ||
| * Don't use horizontal rulers unless necessary (for instance they are not necessary if there is a heading right above or beneath where you want to mark a "new section" | * Don't use horizontal rulers unless necessary (for instance they are not necessary if there is a heading right above or beneath where you want to mark a "new section" | ||
| - | * Surround | + | * Surround |
| Here is an example of what a small page could look like, using namespaces for sub pages etc: < | Here is an example of what a small page could look like, using namespaces for sub pages etc: < | ||
| Line 48: | Line 47: | ||
| Remember that you can use sub-pages (sub-namespaces), | Remember that you can use sub-pages (sub-namespaces), | ||
| - | ===== The first section | + | ===== The First Section |
| Some bla bla | Some bla bla | ||
| Line 54: | Line 53: | ||
| [[.subpage: | [[.subpage: | ||
| - | ===== The second section | + | ===== The Second Section |
| More text | More text | ||
| Line 95: | Line 94: | ||
| - | ===== Text template | + | ===== Text Template |
| You will notice that whenever you create a new page, you will already have some text pre-filled. This text comes from one of our templates- every namespace has a slightly different template text. \\ The most important aspect of the template is that it adds default [[https:// | You will notice that whenever you create a new page, you will already have some text pre-filled. This text comes from one of our templates- every namespace has a slightly different template text. \\ The most important aspect of the template is that it adds default [[https:// | ||
| Line 118: | Line 117: | ||
| When you decide to add a comment to a discussion page, there are some guidelines you should follow in order to keep discussions legible and orderly: | When you decide to add a comment to a discussion page, there are some guidelines you should follow in order to keep discussions legible and orderly: | ||
| - | * Sign all your comments by clicking the Insert Signature | + | * Sign all your comments by clicking the **insert signature** |
| - | * Use a Level 2 Headline to add a completely new comment by clicking the blue H on the top WYSIWYG editor toolbar or by using the < | + | * Use a **Level 2 Headline** to add a completely new comment by clicking the blue **H** on the top WYSIWYG editor toolbar or by using the < |
| * Add all comments at the bottom of the page, unless you are replying. In that case, add your comments directly underneath the post you are replying to. Use the ''>'' | * Add all comments at the bottom of the page, unless you are replying. In that case, add your comments directly underneath the post you are replying to. Use the ''>'' | ||
| + | < | ||
| + | ===== Topic ===== | ||
| - | '' | + | Original Comment |
| - | + | > The first reply | |
| - | '' | + | >> The second reply |
| - | + | >>> | |
| - | '' | + | </ |
| - | + | ||
| - | '' | + | |
| - | + | ||
| - | '''' | + | |
| Will look somewhat like this: | Will look somewhat like this: | ||
| Line 137: | Line 133: | ||
| You can subscribe to the talk page's changes if you want to be notified of replies by clicking on the **manage subscriptions** tab while on the talk page. | You can subscribe to the talk page's changes if you want to be notified of replies by clicking on the **manage subscriptions** tab while on the talk page. | ||
| - | ===== Language | + | ===== Language |
| - | + | ||
| - | ==== In English, please ==== | + | |
| - | + | ||
| - | English is the primary language of the Slackware Documentation Project. This seems only natural since Slackware Linux has an english-only installer and english-only documentation. The admin team wants to prevent this project from getting stuck in a Babylonian mess. | + | |
| - | ==== So how are non-english contributions being handled? | + | ==== In English, Please |
| - | That being said, there are many valuable contributors who simply don't want to write a text in a language that is not their native | + | English |
| - | Here's an example. Let's say you're French, and you wish to contribute a HOWTO about OCR text scanning, in French. | + | ==== So How Are non-English Contributions Being Handled? ==== |
| - | - Send a message to the '' | + | Please check [[slackdocs:translation_guide# |
| - | - As soon as you find your translator, or an editor picks one for you - which shouldn' | + | |
| - | - The translated text gets published first, | + | |
| - | - Finally, your original text gets published in the (french) localized section of the site, mentioning you as the author again. | + | |
| <!-- Do not remove this line and the text below. Thanks! slackdocs@--> | <!-- Do not remove this line and the text below. Thanks! slackdocs@--> | ||
| - | {{tag> | + | {{tag> |
