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 revision Previous revision
Next revision
Previous revision
slackdocs:tutorial [2012/08/24 18:04 (UTC)]
alienbob That section does not belong in the example text for a template.
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>​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 ​====
  
 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 ​articles ​====+==== Complex ​Articles ​====
  
 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://​www.dokuwiki.org/​namespaces|namespace]]. Otherwise you will flood the current namespace and maintaining uploaded files will become a mess for the users and admins alike. 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://​www.dokuwiki.org/​namespaces|namespace]]. Otherwise you will flood the current namespace and maintaining uploaded files will become a mess for the users and admins alike.
Line 33: Line 32:
  
  
-===== Syntax and formatting ​=====+===== Syntax and Formatting ​=====
  
 First make yourself familiar with the [[wiki:​syntax|DokuWiki syntax]]. It is not the same as MediaWiki syntax. First make yourself familiar with the [[wiki:​syntax|DokuWiki syntax]]. It is not the same as MediaWiki syntax.
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 example commands 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 inserts ​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 48: Line 47:
 Remember that you can use sub-pages (sub-namespaces),​ where appropriate. Remember that you can use sub-pages (sub-namespaces),​ where appropriate.
  
-===== The first section ​=====+===== The First Section ​=====
  
 Some bla bla Some bla bla
Line 54: Line 53:
 [[.subpage:​start | My in depth article]] [[.subpage:​start | My in depth article]]
  
-===== 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://​www.dokuwiki.org/​plugin:​tag|tags]] to your page. These tags will allow us to populate our Table Of Contents automatically. 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://​www.dokuwiki.org/​plugin:​tag|tags]] to your page. These tags will allow us to populate our Table Of Contents automatically.
Line 109: Line 108:
 {{tag>​howtos template}} {{tag>​howtos template}}
 </​code>​ </​code>​
- 
  
 ===== Use of Discussion Pages ===== ===== Use of Discussion Pages =====
  
 It is a good idea to use the "​discussion"​ pages (linked as a tab at the top of each article) to discuss the content of the article, point out errors, clarify doubts, bring something to the attention of the author, and/or propose any major changes. It is a good idea to use the "​discussion"​ pages (linked as a tab at the top of each article) to discuss the content of the article, point out errors, clarify doubts, bring something to the attention of the author, and/or propose any major changes.
 +
 +If you want to add a comment to a discussion page, take a few moments to think about what you want to write //before// clicking the **edit this page** tab. Try to keep the time during which you keep the page locked as short as possible, so that you are not an obstacle to other people who also want to comment.
 +
 +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
 +  * 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:
 +<​code>​
 +===== Topic =====
 +
 +Original Comment
 +> The first reply
 +>> The second reply
 +>>>​The third reply
 +</​code>​
 +Will look somewhat like this:
 +
 +{{ :​slackdocs:​threaded-talk-page.png?​640 |}}
 +
 +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 Considerations ===== 
 +
 +==== 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 [[wp>​Confusion_of_tongues|a Babylonian mess]].
 +
 +==== So How Are non-English Contributions Being Handled? ====
 +
 +Please check [[slackdocs:​translation_guide#​creating_a_page_in_your_own_language|Creating a Page in Your Own Language]] in the Translation Guidelines.
  
  
 <!-- 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}}

In Other Languages
QR Code
QR Code slackdocs:tutorial (generated for current page)