Changes between Version 11 and Version 12 of User Guide/Wiki Style Guide


Ignore:
Timestamp:
May 11, 2020, 6:15:47 PM (5 years ago)
Author:
jkol
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • User Guide/Wiki Style Guide

    v11 v12  
    88=== General Guidelines
    99* '''Page Naming'''
    10   * Use a short and descriptive name using CamelCase (eg. `MyPageName`)
     10  * Use a short and descriptive name using CamelCase (e.g. `MyPageName`)
    1111* '''Headings'''
    12   * Start page titles at depth 1 (ie. `= My Page Title`)
    13   * The number of `=` equals the depth (eg. `===` is depth 3)
     12  * Start page titles at depth corresponding to the page depth:
     13    * /wiki/PageName uses `= My Page Title`
     14    * /wiki/SectionName/PageName uses `== My Page Title`
     15  * The number of `=` equals the depth (e.g. `===` is depth 3)
    1416* '''Links'''
    15   * '''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.
    16   * When linking to pages that are children of the current page, use relative links `[wiki:./page/to/link/to text to display]`
     17  * '''DO NOT''' use full URLs (i.e. !http://wiki.cosmos-lab.org/...) when linking to pages within the wiki. Use the [wiki:WikiFormatting#Links WikiPageNames link syntax] instead.
     18  * When linking to pages that are children of the current page, use relative paths `[wiki:./page/to/link/to text to display]` instead of the absolute wiki path.
    1719* '''Instructions containing shell commands'''
    1820  * Macro for username {{{[[User]]}}}
    19   * For copy and pasting commands, ensure no prompt is present
    20   * For bash scripts, use {{{ {{{#!shell }}}
    21   * For terminal sessions, use {{{ {{{#!shell-session }}}
    22   * On a console: make sure the prompt starts with {{{user@console:path$}}}
    23   * On a compute machine: make sure the prompt starts with {{{root@console:path$}}}
     21  * For commands that will be copy pasted, ensure no prompt is present.
     22  * For bash scripts, start the code block with {{{ {{{#!shell }}}
     23  * For terminal sessions, start the code block with {{{ {{{#!shell-session }}}
     24  * If the command is to be run on a console: make sure the prompt starts with {{{user@console:path$}}}
     25  * If the command is to be run on a compute machine: make sure the prompt starts with {{{root@node-name:path$}}}
    2426
    2527=== Page Specific Formatting