[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.

Welcome to the Slackware Documentation Project

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
slackdocs:tutorial [2012/08/30 07:25 (UTC)] – some capitalization changes gerardo.zamudioslackdocs:tutorial [2023/11/30 18:41 (UTC)] (current) – [Text Template] advise use of author tag. alienbob
Line 1: Line 1:
 ====== Wiki Tutorial and Guidelines ====== ====== Wiki Tutorial and Guidelines ======
-<note warning>This page is a WIP (work in progress)</note>+
  
 ===== 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/namespaces]]
  
 ==== Plain Articles ==== ==== Plain Articles ====
Line 39: 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 texst strings containing example commands, filenames and computer text with a "code text" markup. For example: ''man rc.inet1.conf''. There is a "TT" button in the button bar above which will insert exactly that markup.+  * Surround text strings containing example commands, filenames and computer text with a "code text" markup. For example: ''man rc.inet1.conf''. There is a "TT" button in the button bar above which will insert exactly that markup.
  
 Here is an example of what a small page could look like, using namespaces for sub pages etc: <code> Here is an example of what a small page could look like, using namespaces for sub pages etc: <code>
Line 108: Line 108:
 {{tag>howtos template}} {{tag>howtos template}}
 </code> </code>
 +
 +We advise to add a tag '//author_yourname//' with of course 'yourname' being replaced by your wiki username. The use of this tag facilitates automated generation of a page list for which you are the author (or one of the authors).
 +
 +As an example, embedding '%%{{topic>author_alienbob nodate&desc&sort&table&tags}}%%' in a page will automatically generate an overview of articles written by AlienBOB. 
  
 ===== Use of Discussion Pages ===== ===== Use of Discussion Pages =====
Line 117: Line 121:
 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 button on the top WYSIWYG editor toolbar or by using <key>ALT</key>+<key>SHIFT</key>+<key>Y</key> keyboard shortcut +  * Sign all your comments by clicking the **insert signature** button on the top WYSIWYG editor toolbar or by using <key>ALT</key>+<key>SHIFT</key>+<key>Y</key> keyboard shortcut 
-  * 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 <key>ALT</key>+<key>SHIFT</key>+<key>2</key> keyboard shortcut+  * 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 <key>ALT</key>+<key>SHIFT</key>+<key>2</key> keyboard shortcut
   * 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 ''>'' characters to thread your discussions, adding as many as needed. For example:   * 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 ''>'' characters to thread your discussions, adding as many as needed. For example:
 +<code>
 +===== Topic =====
  
-''===== Topic ====='' +Original Comment 
- +> The first reply 
-''Original Comment'' +>> The second reply 
- +>>>The third reply 
-''> The first reply'' +</code>
- +
-''>''>'' The second reply'' +
- +
-''''>''''>''''>'' The third reply'' +
 Will look somewhat like this: Will look somewhat like this:
  
Line 140: Line 141:
 ==== In English, Please ==== ==== 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.+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 [[wp>Confusion_of_tongues|a Babylonian mess]].
  
 ==== So How Are non-English Contributions Being Handled? ==== ==== So How Are non-English Contributions Being Handled? ====
  
-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 language. We don't want to frustrate all these potential writers, the more so since we count on all of you for making this project happen. After some discussion on the admin list, we found a viable solution for this dilemma.  +Please check [[slackdocs:translation_guide#creating_a_page_in_your_own_language|Creating Page in Your Own Language]] in the Translation Guidelines.
- +
-Here's an example. Let's say you're French, and you wish to contribute a HOWTO about OCR text scanning, in French.  +
- +
-  - Send a message to the ''slackdocs@alienbase.nl'' mailing list, asking for a translator for your language. Something in the line of"Hello everybody, I'm busy writing HOWTO about OCR text scanning in French. Can anybody translate my article into English once it's finished?"  +
-  - As soon as you find your translator, or an editor picks one for you - which shouldn't be too hard, since our numbers seem to grow daily - you continue the discussion off-list, until both the text and the translation are finished. +
-  - The translated text gets published first, in the main section of the site. The Sources section mentions you as the author, and the translator as well. +
-  - 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>slackdocs tutorial}}+{{tag>slackdocs tutorial needs_attention}}
 slackdocs:tutorial ()