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.

Location of files which represent dokuwikil pages will use linking. In Dokuwiki, a Namespace is just another word for a Folder. So, keep these thoughts in mind when wishing to refer to a specific wiki page or it's section:

• 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 (since all pages are in .txt format, add an ext of .txt is not accepted)

Registered users are at a permission level to create new pages (not delete pages). The established method to create a new page is to locate the Search Bar (open it if on mobile) and enter the desired pagesname. In essence, the wiki is searching to make sure that location and pagename does not exist. If not found, the response will show the pagename in red. Click the red URL and a new page will open ready for text entry.

A page needs a location (it's street) and pagename (it' address). When combined it becomes a namespace (it's home). Some visitors may be more familiar with Windows or Android naming conventions, so these will be used for a familiarity comparison to that used here in Dokuwiki.

It is easy to confuse the Page Name, File Name and Page Title.

• The Pagename: This is the URL or location of the file (usually a .txt) such as manual:start. It must be lowercaseuse. Use underscores or dashes for any spaces.
• 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.”

A Table of Contents (TOC) will automatically be for page long as it has least three Headings (the lines starting with ===), DokuWiki will automatically generate this “Table of Contents” box at the top right of thepage. The TOC can be a drop-down or left extended while scrolling a page. To roll-up the TOC, just click Table of Contents banner.

Don't be afraid to make mistakes! Dokuwiki and SprintDoc will remember your revisions if the Save has been tapped.

• Old Revisions: Every time you click “Save,” DokuWiki keeps the old version. To go back to the “Old Revisions” icon on the right side of the editing window and select a previous time-based version if something goes wrong.
• Preview: Always use the Preview button at the bottom of editing window before saving to see exactly the formatting looks. If it looks acceptable tap Save, otherwise a notification will pop-up and ask

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.