Welcome

This is where the more would be added like

Search

Left Sidebar

Right Sidebar

Toby Quick Help

Namespaces and Folders

The location of files, which represent dokuwikil pages, use linking. In Dokuwiki, a Namespace is just another word for a Folder. So keep these thoughts in mind when deciding 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, adding an ext of .txt is not accepted

File Naming and Creation

Naming the Location / Pagename

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.

File Creation

Registered users have 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)
• enter the desired pagesname (make the wiki search 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
    • A new page will open ready for text entry.

Table of Contents for Pages

A Table of Contents (TOC) will automatically be created for a page long as it has least three Headings (the lines starting with at least 2 “='s= (==), DokuWiki will automatically generate a “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.

Non-Destructive Editing

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

• Old Revisions: Every time “Save” is clicked, DokuWiki keeps the old version. To go back click the “Old Revisions” icon on the right side of the editing window and select a previous, time-based, version from the list.
• Preview: Using the Preview button at the bottom of editing window before saving is a good way to see exactly how the page appears.
  • If it looks acceptable tap Save
  • or scroll up to the editing window to make more changes
  • Forgetting to Save* will cause a notification to pop-up and ask * “Leave site? Changes to your page will not be saved” * Tap Cancel to return to the editing page (scrolling to the editing location may be necessary) * Or, to Not Save all changes since the last save, just tap OK. > A Supporting Note: DokuWiki is “Plain Text” first. Even if the formatting looks messy in the editor, the final page will look clean and professional! ++++

    ---

    ===== DokuWiki Syntax: The Essentials ===== 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 ==== 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 ====` ==== Formatting Text ==== * Bold: text * Italic: text * Underline: text * Monospaced: text (Useful for file paths or variables) ==== Paragraphs and New Lines ==== 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.” ==== Lists ==== Important: You must start a list item with two spaces. * Bullet points use an asterisk: * Item * Numbered lists use a dash: - Item ==== Links ==== To link to another page or a website, use double square brackets. * Internal: pagename * Internal with custom name: Clickable Text * External: Google ==== Images ==== Use curly braces to show an image. * Standard: * Resized (50px wide): ==== Simple Tables ==== Tables use the pipe | for regular cells and the caret ^ for headers. ^ Header 1 ^ Header 2 ^ | Content A | Content B | | Content C | Content D | & *Pro Tip: Always leave one empty line between a paragraph and a list or table to make sure the “SprintDoc” template displays everything perfectly.

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

Headings

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.

Text

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!)

Lists

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

File Paths

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.

Links: To Pages or Sections on the Same Page

• 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

Media (Images)

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).

Simple Tables

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.

Special Note for the "SprintDoc" Template

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.