Changes between Initial Version and Version 1 of User Guide/Wiki Style Guide

Timestamp:

Apr 29, 2020, 8:21:28 PM (5 years ago)

Author:

jkol

Comment:

—

User Guide/Wiki Style Guide

@@ +1 @@
+[[TOC(noheading)]]
+
+= Wiki Editing Guide
+
+For consistent wiki formatting, please following the following style guidelines.
+
+== General Guidelines
+* '''Page Naming'''
+  * Use a short and descriptive name using CamelCase (eg. `MyPageName`)
+* '''Headings'''
+  * Start page titles at depth 1 (ie. `= My Page Title`)
+    * The number of `=` equals the depth (eg. `===` is depth 3)
+* '''Links'''
+  * '''DO NOT''' use full URLs (ie. !http://wiki.cosmos-lab.org/...) when linking to pages within the wiki. Use the [wiki:WikiFormatting#Links WikiPageNames link syntax] instead.
+  * 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
+
+=== 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:
+
+{{{
+[[TOC(SectionPageName/SubsectionPageName/*, depth=2, noheading)]]
+
+= Section Title
+Brief description of the section.
+}}}
+
+'''NOTE:''' Please remember to put the wiki URL corresponding to the page name in the TOC macro. You can see the wiki URL at the top of the page during editing.
+
+  ''Example:'' For this page, the top of the page says "''Editing test/ExperimenterInformation/WikiStyleGuide''", so the TOC macro should then be `[[TOC(test/ExperimenterInformation/WikiStyleGuide/*,depth=1)]]`. Don't forget to add the `/*` at the end of the wiki URL.
+
+The default TOC depth should be left at 2, unless it makes sense otherwise.
+
+=== Individual Pages
+Individual wiki pages should use the following as a starting point:
+{{{
+[[TOC, noheading]]
+
+= Page Title
+Brief description of the page.
+
+== Sub Section Title
+Sub section content.
+}}}