Welcome

Discuss and …

• List benefits here
• Media Uploads: Mentions that only registered users can upload images to the media manager.
• Subscription Services: Explains the ability to “Subscribe” to namespaces or pages to receive email notifications when changes occur.
• User Profile: Mentions the ability to track personal contributions via the “Recent Changes” or user profile link.

This is where more would be added, like…

Search

• Full-Text Deep Scanning: It indexes every word on every page. Enter a term or concept and the engine will find it even if it is buried deep inside a paragraph.
• Instant Live Suggestions: The moment typing is started, a “Quicksearch” dropdown splits results into matching Page Names and Content Text. There is no need to wait. Just jump straight to a topic in one click.
• Exact Phrase Matching: By wrapping a search in quotes (e.g., “global variables”), the clutter is eliminated by forcing the system to find that exact phrase rather than loose keywords scattered across a page.
• Wildcard Flexibility: Adding an asterisk (e.g., launch*) allows the catching of all variations of a term, instantly pulling in results for launcher, launching, and launched.

Left Sidebar

• Table of Contents: List of major Total Launcher concepts and features found in the wiki.
• Toby Quick Help: Toby is an automated assistant built right into the sidebar of the wiki. When a bug or typo is found, have a formatting question, or want to pitch a suggestion, there is no need to hunt down an email address. Just use Toby's form.
• Site Tools Hub:
  • Recent Changes: Track the latest edits, updates, and contributions across the wiki in chronological order.
  • Media Manager: A centralized dashboard to manage images or media assets.
  • Stale the Cache: Automatically refreshes the page rendering, clearing out old cached data so new formatting changes show up instantly.
  • Sitemap: Generates a complete, hierarchical overview of all namespaces and pages, offering an alternative bird's-eye-view navigation paths.
• User Tools Panel: Houses account-specific shortcuts based on individual login permissions:
  • Update Profile: Allows users and contributors to quickly manage passwords, display names, and email preferences.
  • Admin Desk: Gives authorized administrators immediate access to back-end plugin configurations, user managers, and system settings.
  • Log Out: Provides a secure, single-click exit to terminate the active user session.
• Last Visited Pages (Breadcrumbs): Tracks chronological navigation history at the bottom of the sidebar. It acts as a localized trail of digital breadcrumbs, allowing users to instantly retrace their steps through recently viewed manuals.

Right Sidebar

• Page Edit (Pencil Icon): Opens the native wiki editor for the active page, allowing authorized contributors to instantly modify text, update formatting, or fix errors.
• Old Revisions (Clock Icon): Serves as a version control safety net. It displays a historical log of every edit made to the page, allowing comparison of changes or rolling back mistakes with a single click.
• Backlinks (Chain Link Icon): Scans the entire wiki database to show you exactly which other pages are linking to the current page. This is highly useful for tracing how different topics interconnect or navigating back to the previous page.
• Manage Subscriptions (Envelope Icon): Allows users to opt in to email notifications for the page or entire namespace, whenever changes or manual updates occur.
• Add a Book (Book/Plus Icon): Allows users to bundle the current page into a custom collection or localized manual for specialized printing.
• Export to PDF (PDF Icon): Compiles and downloads the active page as a cleanly formatted PDF document, making it easy to save or read offline on desktop or mobile.
• Fold / Unfold (Double Arrow Icon): Instantly collapses or expands all text headers and toggle boxes on the page at once, allowing for rapid scanning of long technical documents.
• Back to Top (Up Arrow Icon): Provides a quick scroll shortcut that snaps the user straight back to the very top of the page, eliminating tedious scrolling on long articles or mobile screens.

Namespaces and Folders

The location of files representing DokuWiki pages uses 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 its 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 (its street) and pagename (its address). When combined, it becomes a namespace (its 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.

Case Sensitivity

• While DokuWiki converts pagenames to lowercase, the server system for uiTLM is case-sensitive:
  • Lower Case: All filenames for pages created, media, and internal/external links

Table of Contents for Pages

A Table of Contents (TOC) will automatically be created for a page as long as it has at 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 the page.

• The TOC can be a drop-down or left extended while scrolling a page. To roll up the TOC, just click the 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, then select a previous time-based version from the list.
• Preview: Using the Preview button at the bottom of the 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!

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 equal signs used, the larger or higher the heading. The '=' must start on the left margin.

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: ''
  ''

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

Links

To link to another page, a section on the existing or other page, or a website, use opening and closing double square brackets around the pagename

• Internal:

  [[pagename]]

• Internal with custom name:

  [[pagename | Clickable Text]]

• External:

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

Media

To display any media, use opening and closing curly braces (wiki)

• Images (PNG, jpg gif, webp)
• Video (animated gifs mp4¹⁾), use curly braces.
• All media on a page must be located in the media '' namespace * Media for a page is to be located in the page namespace for the media * Example: write about a fish and insert a fish.webp. The page is fish.tx * The fish lives in a “pond” (namespace/folder) * The link would be ''

• 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,
• leave 1 space for left-aligned entries.