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
Last revision Both sides next revision
wiki:conventions [2016/05/22 21:40]
fsckd todo -> to-do
wiki:conventions [2016/11/27 02:29]
fsckd [Pages and Sections]
Line 11: Line 11:
  
 ===== 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 ==== ==== Pages and Sections ====
  
-{{section>wiki:​include:unfinished#​section&​nofooter&​noheader}}+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 ​start with a (brief) description of the topic the page covers. It is followed by a list of links and information for quick reference.+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.
 === Unfinished Pages and Sections === === Unfinished Pages and Sections ===
  
Line 51: Line 58:
 === Including Other Pages === === Including Other Pages ===
  
-Use the [[doku>plugin:​include|include ​plugin]]. Examples can be found in meeting ​agendas.+Use the include ​[[aw-tech:​dokuwiki#​plugins|plugin]]. You can also include sections of another page instead of the entire page. 
 + 
 +Examples: 
 +^ Description ^ Example ^ 
 +| including an entire page | ''​%%{{page>​target_page&​nofooter}}%%''​ | 
 +| including a section without the section title | ''​%%{{section>​target_page#​target_section&​nofooter&​noheader}}%%''​ | 
 +| including a section with the section title | ''​%%{{section>​target_page#​target_section&​nofooter}}%%''​ | 
 + 
 +Examples in the wiki: 
 +^ Example ^ Target ^ Description ^ 
 +| [[wiki:include:​start#​unfinished|Include: Unifinished]] | [[wiki:include:​unfinished#​usage|Unfinished:​ Usage]] | The entire section is included from the usage section of the target
 +| [[projects:​classroom:​start#​upcoming_classes|Classroom:​ Upcoming Classes]] | [[projects:​classroom:​upcoming|Upcoming Classes]] | The entire page is included ​in a section. This particular example uses many options provided by the include plugin. | 
 +| [[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 ====

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