Changes between Version 8 and Version 9 of User Guide/Wiki Style Guide

Timestamp:

May 8, 2020, 11:04:39 PM (5 years ago)

Author:

msherman

Comment:

—

User Guide/Wiki Style Guide

@@ -2 +2 @@
 [[TOC(noheading)]]
 
-= Contributing to the Wiki
+== Contributing to the Wiki
 
 For consistent wiki formatting, please adhere to the following style guidelines.
 
-== General Guidelines
+=== General Guidelines
 * '''Page Naming'''
   * Use a short and descriptive name using CamelCase (eg. `MyPageName`)
@@ -16 +16 @@
   * When linking to pages that are children of the current page, use relative links `[wiki:./page/to/link/to text to display]`
 
-== Page Specific Formatting
+=== Page Specific Formatting
 
-=== Section Pages
+==== Section Pages
 Pages that are introductory to larger sections that contain many sub pages (eg. the main [wiki:TestbedInformation Testbed Information] page or the [wiki:tutorials Tutorials] page) should use the following as a starting point:
 
@@ -37 +37 @@
 The default TOC depth should be left at 1, unless it makes sense otherwise.
 
-=== Individual Pages
+==== Individual Pages
 Individual wiki pages should use the following as a starting point:
 {{{
@@ -50 +50 @@
 }}}
 
-=== Tutorial Pages
+==== Tutorial Pages
 
 Please us the following document skeleton when writing a tutorial.
@@ -83 +83 @@
 
 
-== Syntax Highlighting and code blocks
+=== Syntax Highlighting and code blocks
 
 Trac uses [https://pygments.org/docs/lexers/ pygments] to do syntax highlighting in code blocks
@@ -109 +109 @@
 }}}
 
-=== Common formats
+==== Common formats
 
 || language || shortname for codeblock ||
@@ -123 +123 @@
 || docker || docker, dockerfile ||
 
-== Using Markdown or !RestructuredText
+=== Using Markdown or !RestructuredText
 
 Using code blocks like before, Trac can render other markup formats