Welcome New Editors

Here is a simplified “Cheat Sheet” focusing on the essentials that will be used 90% of the time.

Headings use equals signs `=`. The more equals signs you use, the larger or higher the heading. The '=' must start on the left margin.

• `====== Top Level Title ======` (Main page title)
• `===== Section Title =====`
• `==== Sub-Section ====`
• Tip: DokuWiki automatically creates a Table of Contents if there areat least three headings on a page.

Think of these as “wrappers” around the words.

• Bold: `Double Asterisks`
• Italic: `Double Slashes`
• Underline:

  __Underscores__

• Monospaced:

  ''Double Single-Quotes''

  (Great for file paths or Tasker variables!)

Building lists is all about the indentation and steps.

• For bullet point: Use two spaces from the left margin and an asterisk '*'
• For numbered list: Use two spaces from the left margin and a dash '-'
• To create further indentation for either: add 2 more spaces to the previous indentation

• First bullet item
• Second bullet item
  • Indented sub-item (four spaces)

1. First numbered item
2. Second numbered item

Linking is the “Wiki” part of DokuWiki. To another page (called a namespace) or to a part of the same page (called a section). Full paths do not use backslashes (\) and Windows or Android, but do use colons (:) with the single colon meaning root and a following subfolder (namespace) using a colon (:) between the two.

• Internal Link within the wiki:
  • To the same page and section heading '== XYZ =='

    [[:pagename#XYZ]]

    or

    [[:pagename#XY|Viewable Clickable Text]]

• External Link outside the wiki:

  [[https://google.com | Link to Google]]

  would show as Link to Google

To display an image, use curly braces.

• 'filename.ext'
• `` — Displays the image at its original size.
• `` — Displays the image at 50 pixels wide (resizing made easy).

Tables are built using vertical bars `|` for (cells) and carets for `^` (headers). Alignment can be specific for each cell or heading: To center contents leave 2 spaces between the beginning and ending cell or header marker, otherwise leave 1 space for left aligned entries.

1. Save often: The preview button is your best friend.
2. Whitespace matters: Always leave a blank line between a paragraph and a list or a table to ensure it renders correctly.

Before you start writing, here are a few “Big Picture” concepts that make managing your documentation much easier.

In DokuWiki, a Namespace is just another word for a Folder.

• Structure: Namespaces are separated by a colon : instead of a slash.
• Example: manual:installation:setup
  • manual = Top folder
  • installation = Sub-folder
  • setup = The actual page name

It is easy to confuse the File Name with the Page Title.

• The Pagename: This is the URL (e.g., manual:start). It should be lowercase and contain no spaces (use underscores or dashes).
• The Heading (Title): The very first line of your page (e.g., ====== My Awesome Manual ======) is what DokuWiki usually displays as the title in searches and navigation.

DokuWiki handles “spacing” differently than a standard word processor.

• New Paragraph: Press Enter twice to leave a blank line. This is the best way to keep text readable.
• Forced New Line: If you want to drop to the next line without starting a new paragraph, type two backslashes followed by a space:

• The “SprintDoc” Rule: Always leave a blank line before and after a list, table, or code block to ensure the layout doesn't “break.”

You don't have to build a menu for your page! As long as you use at least three Headings (the lines starting with ===), DokuWiki will automatically generate a “Table of Contents” box at the top right of your page.

Don't be afraid to make mistakes!

• Old Revisions: Every time you click “Save,” DokuWiki keeps the old version. You can always go back to the “Old Revisions” tab to restore a previous version if something goes wrong.
• Preview: Always use the Preview button before saving to see exactly how your formatting looks.

Editor's Note: DokuWiki is “Plain Text” first. Even if the formatting looks messy in the editor, the final page will look clean and professional!

Welcome! DokuWiki is designed to be simple. You don't need to learn complex code; you just “wrap” your text in a few special characters.

Headings use equals signs '='. Use more for smaller sub-sections. Notice how the number of “=” decreases on both sides as the subheading becomes lower.

• ====== Page Title ======
• ===== Section Title =====
• ==== Sub-Section ====

Headings use equals signs `=`. The more equals signs you use, the larger or higher the heading. The '=' must start on the left margin.

• `====== Top Level Title ======` (Main page title)
• `===== Section Title =====`
• `==== Sub-Section ====`

• Bold: text
• Italic: text
• Underline: text
• Monospaced: text (Useful for file paths or variables)

Important: You must start a list item with two spaces.

• Bullet points use an asterisk: * Item
• Numbered lists use a dash: - Item

To link to another page or a website, use double square brackets.

• Internal: pagename
• Internal with custom name: Clickable Text
• External: Google

Use curly braces to show an image.

• Standard:
• Resized (50px wide):

Tables use the pipe | for regular cells and the caret ^ for headers.

& *Pro Tip:** Always leave one empty line between a paragraph and a list or table to make sure the "SprintDoc" template displays everything perfectly.