Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

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

Link to this comparison view

Next revision		Previous revision
wiki:best_practices [2010/02/24 01:00] – created digitalmanwiki:best_practices [2022/03/14 20:37] (current) – [Tagging] Instruction for not using symbols in tags. Andre
Line 1: Line 1:
 ====== Best Practices ====== ====== Best Practices ======
 +Follow these guidelines when editing the wiki.
  
-  - Do not create pages in the root (:) namespace +===== How to Use DokuWiki ==== 
-  - Try to use existing namespaces (see index if necessary) for new pages + 
-  - When creating namespaces, use short singular names (e.g. "person", not "people")  +[[https://www.dokuwiki.org/manual|DokuWiki Manual]] 
-  - When creating namespaces, create a namespace:index page with a list of child pages/namespaces + 
-    - Tip: use the nslist or indexmenu plugin for dynamic child listings +[[https://www.dokuwiki.org/screencast|Video Tutorials]] 
-  - Begin page with H1 section (page title in Normal Title Case) and a summary of the page  + 
-  - End with an H2 "See Also" section that, at minimum, points back to the parent namespace +===== Creating Pages ===== 
-  - Use the "discussion" tab (talk page) for page discussions + 
-  - Use your user page for experimentation (not playground or sandbox) +[[https://www.dokuwiki.org/page|DokuWiki Page Manual]] 
-  + 
- +  * Begin page with H1 section. 
 +    * Capitalize the page title properly. Unsure? Use AMA style at: [[https://capitalizemytitle.com/|Capitalize My Title]] 
 +    * Add a summary of the page after the title. 
 +  * End the page with an H2 "See Also" section that, at a minimum, has a link back to the parent page. 
 +  * Use the "discussion" tab (talk page) for page discussion. 
 +    * Do not write comments onto the actual page. 
 +  * Use your user page for experimentation. 
 +    * Do not experiment on the page, and don't experiment in the playground or sandbox.  
 + 
 + 
 +===== Namespaces ===== 
 +Namespaces are the wiki sections that pages live in. 
 + 
 +[[https://www.dokuwiki.org/namespaces|DokuWiki Namespace Manual]] 
 + 
 +  * Create pages in the proper namespace. 
 +    * Do not create pages in the root (:) namespace 
 +  * Try to use existing namespaces for new pages (see: [[wiki:site_index|index]]). 
 +  * If you must create a new namespace 
 +    * Use short singular names (e.g., "person", not "people"). 
 +    * Create a namespace:index page with a list of child pages/namespaces. 
 +    * Tip: use the [[https://www.dokuwiki.org/plugin:nslist|nslist]] or [[https://www.dokuwiki.org/plugin:indexmenu|indexmenu]] plugin for dynamic child listings. 
 + 
 + 
 +===== Tagging ===== 
 +Tag your pages using the tag [[https://www.dokuwiki.org/plugin:tag|plugin]]. 
 + 
 +  * Page tags should be: 
 +    * Lowercase 
 +    * Singular, not plural 
 +    * Not include any symbols (e.g., tcpip vs tcp/ip, ini vs .ini) 
 +    * Have a tag for overall page topic (e.g., fidonet, mail_server) 
 +    * Have a tag for the type of page (e.g., customization, development)
  

Trace: