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
wiki:conventions [2016/05/22 22:45]
fsckd [Including Other Pages]
wiki:conventions [2016/11/27 02:37]
fsckd conform to capitalization rule
Line 1: Line 1:
-====== Conventions for Wiki Structure ​and Content ​======+====== Conventions for wiki structure ​and content ​======
  
 Guide for editing pages on the Arch Women wiki. Guide for editing pages on the Arch Women wiki.
Line 10: Line 10:
   * [[aw-tech:​dokuwiki#​plugins|(Some) Installed Plugins]]   * [[aw-tech:​dokuwiki#​plugins|(Some) Installed Plugins]]
  
-===== Wiki Structure ​=====+===== Wiki structure ​===== 
 + 
 +{{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}}
  
 This is a list with descriptions of the namespaces and some important pages in this wiki. This is a list with descriptions of the namespaces and some important pages in this wiki.
Line 26: Line 28:
   * user   * user
   * tag   * tag
 +
 +FIXME fill in description\\
 +FIXME make names into links
  
 ===== Formatting ===== ===== Formatting =====
-==== Pages and Sections ==== 
  
-{{section>wiki:​include:unfinished#​section&​nofooter&​noheader}}+==== Pages and sections ==== 
 + 
 +In a page's URL, use an underscore '​_'​ in place of spaces and not a hyphen-minus '​-'​. Many parts of DokuWiki assume an underscore stands for a space, such as [[doku>namespace_templates]] and [[doku>​plugin:pagelist]].
  
 The first headline is the page title. It should be level 1 (six '​='​ characters). All other headlines in the page are of higher levels and designate the sections of the page. The first headline is the page title. It should be level 1 (six '​='​ characters). All other headlines in the page are of higher levels and designate the sections of the page.
  
-FIXME capitalization of page and section ​titles+For capitalization of page titles ​and section ​headlines, use [[wp>​Letter_case#​Usage|sentence case]]. "Title for new page" is fine, while "Title for New Page" is not. This rule does not apply to agendas of old meetings (before the 54th meeting), pages in :wiki from upstream ([[:​wiki:​DokuWiki]],​ [[:​wiki:​Syntax]],​ [[wiki:​Welcome]]),​ and any page in the namespaces :todo, :user, :​playground,​ :tag. 
 + 
 +A page should begin with a (brief) description of the topic the page covers. It is followed by a list of links and information for quick reference. 
 + 
 +The primary page of a [[doku>​namespaces|namespace]] is the :start page and has information about the namespace, such as a description and an index of the pages in the namespace. The title of the namespace is taken from the title of its :start page.
  
-A page should start with a (brief) description of the topic the page covers. It is followed by a list of links and information for quick reference. +=== Unfinished ​pages and sections ​===
-=== Unfinished ​Pages and Sections ​===+
  
 If a page is unfinished, tag it as a [[tag:​stub|stub]]. Do not make any banner or announcement that the page incomplete. If a page is unfinished, tag it as a [[tag:​stub|stub]]. Do not make any banner or announcement that the page incomplete.
Line 49: Line 58:
 You can find a list of all stubs [[tag:​stub|here]] and a list of pages with unfinished sections [[wiki:​include:​unfinished?​do=backlink|here]]. You can find a list of all stubs [[tag:​stub|here]] and a list of pages with unfinished sections [[wiki:​include:​unfinished?​do=backlink|here]].
  
-=== Including ​Other Pages ===+=== Including ​other pages ===
  
 Use the include [[aw-tech:​dokuwiki#​plugins|plugin]]. You can also include sections of another page instead of the entire page. Use the include [[aw-tech:​dokuwiki#​plugins|plugin]]. You can also include sections of another page instead of the entire page.
Line 65: Line 74:
 | [[meetings:​2015_february|Meetings:​ 2015 February]] | [[meetings:​common:​archive]] and [[meetings:​common:​bracket_old]] | When a meeting is over, the same text is added to the meeting pages. | | [[meetings:​2015_february|Meetings:​ 2015 February]] | [[meetings:​common:​archive]] and [[meetings:​common:​bracket_old]] | When a meeting is over, the same text is added to the meeting pages. |
  
-==== Notes and Warnings ​====+==== Notes and warnings ​====
  
 {{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}} {{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}}
Line 73: Line 82:
 Tags are listed at the bottom of a page. Tags are listed at the bottom of a page.
  
-===== Conventions of Specific Namespaces ​=====+===== Conventions of specific namespaces ​=====
  
-==== aw-tech ====+==== aw-tech====
  
-The aw-tech namespace is for the technologies used by Arch Women. Pages in the aw-tech namespace document procedures and checklists as well as useful information and links to resources.+The aw-technamespace is for the technologies used by Arch Women. Pages in the aw-tech namespace document procedures and checklists as well as useful information and links to resources.
  
 The goal is to have notes on, The goal is to have notes on,
Line 99: Line 108:
 For many technologies one page is sufficient for all their notes. If the notes are too much for a single page, the technology can be assigned its own namespace under aw-tech. Place usage and commonly needed informkation in :start. Things are needed //very// rarely, like setup, should go in their own subpages. Things which are small enough can go in :start but otherwise go into their own subpages if long and complex. For many technologies one page is sufficient for all their notes. If the notes are too much for a single page, the technology can be assigned its own namespace under aw-tech. Place usage and commonly needed informkation in :start. Things are needed //very// rarely, like setup, should go in their own subpages. Things which are small enough can go in :start but otherwise go into their own subpages if long and complex.
  
-=== List of Information ​===+=== List of information ​===
  
 A list which is a quick reference to information and links to useful resources. Some things to consider: A list which is a quick reference to information and links to useful resources. Some things to consider:
Line 115: Line 124:
 A list of information can be put at the top of a page or at the top of a section. A list of information can be put at the top of a page or at the top of a section.
  
-=== To-Do Table ===+=== To-do table ===
  
 {{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}} {{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}}
Line 123: Line 132:
 {{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}} {{section>​wiki:​include:​unfinished#​section&​nofooter&​noheader}}
  
-==== projects ====+==== projects====
  
 Each project gets its own namespace under the projects: namespace. A project namespace has at least two pages, :start and :admin. The :start page is the landing page for people not familiar with the project wanting to know what the project is and how to participate. It gives an overview of the project. The :admin page is the internal administrative page and is the nexus for volunteers of the project. Each project gets its own namespace under the projects: namespace. A project namespace has at least two pages, :start and :admin. The :start page is the landing page for people not familiar with the project wanting to know what the project is and how to participate. It gives an overview of the project. The :admin page is the internal administrative page and is the nexus for volunteers of the project.
Line 130: Line 139:
  
 The :admin page will have the to-do list/table for the project, a list of team members, notes on procedures and common periodic tasks, and other administrative notes. If the :admin page becomes too large, it can be split up as needed. The :admin page will have the to-do list/table for the project, a list of team members, notes on procedures and common periodic tasks, and other administrative notes. If the :admin page becomes too large, it can be split up as needed.
- 

wiki/conventions.txt · Last modified: 2016/11/27 02:37 by fsckd