FFA Wiki

User Tools

Site Tools

Trace:
wiki:style

Warning: Undefined array key 3 in /home/public/inc/html.php on line 1453

Warning: Undefined array key -1 in /home/public/inc/html.php on line 1458

Differences

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

Link to this comparison view

Next revision 		Previous revision
wiki:style [2021/08/23 23:12]
FFA Wiki Mod created 		wiki:style [2021/08/29 17:02] (current)
FFA Wiki Mod update naming conventions; add request re internal links
Line 5: Line 5:
 Here are some tips on how to write a good wiki page. Here are some tips on how to write a good wiki page.
  
-===== Page naming conventions =====+===== Naming conventions =====
  
-  * Namespaces +This applies to page names, tag names and media filenames: 
-    * Use only lowercase alphanumeric characters and '-'. + 
-    * Use '-' (dash) to replace spaces. +  * Use only lower case alpha numeric characters and '-'. 
-  * Page Names +  * Use '-' (dash) to replace spaces. 
-    * Use only lower case alpha numeric characters and '-'. +  * Don't start a name with a special character. 
-    * Use '-' (dash) to replace spaces.+  * Ditch articles (i.e. 'the', 'a' and 'an') unless they're absolutely necessary, especially if the name is more than 20 characters long. By default, Dokuwiki doesn't index them or any word less than three characters long, so all they do is lengthen the resulting URL.
  
  
 ===== Organization ===== ===== Organization =====
  
-This wiki primarily uses **tags** for organization. Tag any newly created page with one of the [[wiki:tags|default site tags]], and the new page will show up on the appropriate tag listing pages.+This wiki primarily uses **tags** for organization. Tag any newly created page with one of the [[wiki:tags|top level site tags]], and the new page will show up on one or more of the appropriate tag listing pages.
  
 By default, neither new users nor editors have the access to create pages or upload images in anything other than the root namespace. Please contact [[[email protected]|the wiki mod]] if you create a page in a namespace by mistake so it can be fixed. By default, neither new users nor editors have the access to create pages or upload images in anything other than the root namespace. Please contact [[[email protected]|the wiki mod]] if you create a page in a namespace by mistake so it can be fixed.
Line 25: Line 25:
  
   * Every page must have a heading at the very top, //before// any page content.   * Every page must have a heading at the very top, //before// any page content.
-  * Headings should be concise and+  * Headings should be concise and meaningful.
  
 ===== Links ===== ===== Links =====
 +
 +Avoid writing simple internal links, e.g.:
 +
 +  [[nonnywork]]
 +  [[nonnywork#poetry]]
 +  [[wiki:syntax]]
 +
 +At the minimum, please make sure internal links have //link text//, like so:
 +
 +  [[nonnywork|stuff made by meme]]
 +  [[nonnywork#poetry|meme poetry]]
 +  [[wiki:syntax|syntax page]]
 +  
 +This is purely to make page renames and other administrative stuff easier. It also means that editing a link doesn't mean needing to change the text the page displays.
  
 ==== Site-specific link shortcuts ==== ==== Site-specific link shortcuts ====
Line 45: Line 59:
 === Dokuwiki shortcuts === === Dokuwiki shortcuts ===
  
-| %%[[wp>InterWiki]]%%    | [[wp>InterWiki]]    | links to the English language Wikipedia                                                                                                                                                                     | +| %%[[wp>InterWiki]]%%    | [[wp>InterWiki]]    | links to the English language Wikipedia                | 
-| %%[[go>Wiki]]%%     | [[go>Wiki]]     | links to a Google search                                                                                                                                                                                    | +| %%[[go>Wiki]]%%     | [[go>Wiki]]     | links to a Google search                                  | 
-| %%[[this>feed.php]]%%   | [[this>feed.php]]   | links to your wiki's URL. The example links to the local [[syndication|XML feed]].   |+| %%[[do>DokuWiki-command]]%%     | [[do>DokuWiki-command]]     | links to a DokuWiki command                                  | 
 +| %%[[this>feed.php]]%%   | [[this>feed.php]]   | links to your wiki's URL. The example links to the local [[syndication|XML feed]].   | |
  
  
wiki/style.1629760334.txt.gz · Last modified: 2021/08/23 23:12 by FFA Wiki Mod

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki