meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
wiki:contribution_guide [2026/04/24 11:00] – dorepswiki:contribution_guide [2026/07/08 23:23] (current) – doreps
Line 6: Line 6:
 So, let's get started with what can be helpful in this next step. So, let's get started with what can be helpful in this next step.
 ===== Benefits of Registration ===== ===== Benefits of Registration =====
 +Why register? ++++Click here.|
  
 +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.
 +++++
 ===== Navigation Around the Wiki ===== ===== Navigation Around the Wiki =====
-There are many aids available with uiTLM to research and find areas of interest related to the Total Launcher application. Learn more ++++below.|This is where the more would be added like+There are many aids available with uiTLM to research and find areas of interest related to the Total Launcher application. Learn more ++++below.|This is where more would be added, like...
 ==== Search ==== ==== 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 ==== ==== 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 ==== ==== Right Sidebar ====
-==== Toby Quick Help ====+  * **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.
 ++++ ++++
 ===== Wiki Concepts: Getting Started ===== ===== Wiki Concepts: Getting Started =====
Line 19: Line 50:
  
 ==== Namespaces and Folders ==== ==== Namespaces and Folders ====
-The location of files, which represent dokuwikil pages, use [[#links|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:+The location of files representing DokuWiki pages uses [[#links|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 ''\''.   * **Structure:** Namespaces are separated by a colon '':'' instead of a slash ''\''.
   * **Example:** ''manual:installation:setup''    * **Example:** ''manual:installation:setup'' 
Line 25: Line 56:
     * ''installation'' = Sub-folder     * ''installation'' = Sub-folder
     * ''setup'' = The actual page name      * ''setup'' = The actual page name 
-        * since all pages are in .txt format, adding an ext of .txt is **not** accepted+        * Since all pages are in .txt format, adding an ext of .txt is **not** accepted
  
 ==== File Naming and Creation ==== ==== File Naming and Creation ====
 === Naming the Location / Pagename === === 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.+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.
  
 ^  In Windows or Android filename  ^  In Dokuwiki a .txt  ^ ^  In Windows or Android filename  ^  In Dokuwiki a .txt  ^
-|  \root\subdirectory\filename.ext  |  :root_namespace:sub_namespace:text_filename\\ (no extension needed for .txt (text files)\\ See [[#media|Media]] for how images such as .png's are added.  |+|  \root\subdirectory\filename.ext  |  :root_namespace:sub_namespace:text_filename\\ (no extension needed for .txt (text files)\\ See [[#media|Media]] for how images such as .pngs are added.  |
  
 === File Creation === === File Creation ===
Line 39: Line 70:
 The established method to create a new page is to The established method to create a new page is to
   * Locate the **Search Bar** (open it if on mobile)   * 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+  * 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**     * If **not found**, the response will show the pagename in **red**
       * Click the red URL       * Click the red URL
       * A new page will open ready for text entry.       * 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
  
 <WRAP center round tip> <WRAP center round tip>
 It is easy to confuse the **Page Name**, **File Name** and **Page Title**. 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 Pagename:** This is the URL or location of the file (usually a .txt) such as ''manual:start''. It must be lowercase. 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.   * **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.
 </WRAP> </WRAP>
  
 ==== Table of Contents for Pages ==== ==== 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.  +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 ''Table of Contents'' banner.+  * 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 ==== ==== Non-Destructive Editing ====
 Don't be afraid to make mistakes! Dokuwiki and SprintDoc will remember any revisions **//if// Save** has been tapped. 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. +  * **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 editing window before saving is a good way to see exactly how the page appears.  +  * **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**+    * If it looks acceptable, tap **Save**
     * or scroll up to the editing window to make more changes     * or scroll up to the editing window to make more changes
-    * Forgetting to **Save** will cause a notification to pop-up and ask +    * Forgetting to **Save** will cause a notification to pop up and ask 
       * "Leave site? Changes to your page will not be saved"       * "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)       * Tap ''Cancel'' to return to the editing page (scrolling to the editing location may be necessary)
Line 67: Line 102:
 > **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! > **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!
 ++++ ++++
 +After becoming acquainted with Wiki Concepts and Syntax, visit the **Playground** namespace where new users can practice syntax without affecting live documentation. Navigate there in either of 2 ways:
 +  - If registered, the **left sidebar** offers
 +    * **Sitemap**: Click the item ''Sitemap''
 +    * A listing of all namespaces will scroll (alphabetical order)
 +    * **Playground**: Click ''Playground'' and the namespace will open to list all pages
 +    * **Playground Page**: Click ''Playground'' to open the page ... Enjoy!
 +  - Use this link to navigate there directly: [[:playground:playground|Playground]]
 +
 ---- ----
  
 ===== DokuWiki Syntax: The Essentials ===== ===== 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.+DokuWiki is designed to be simple. There is no need to learn complex code... just "wrap" text with a few special characters. To learn more ++++click here.|
  
 ==== Headings ==== ==== Headings ====
Line 79: Line 122:
   * ==== Sub-Section ====   * ==== 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.+Headings use equals signs `=`. 
 +  * The more equal signs used, the **larger** or **higher** the heading. The '=' must start on the left margin. 
 +<WRAP indent>
   * `====== Top Level Title ======` (Main page title)   * `====== Top Level Title ======` (Main page title)
   * `===== Section Title =====`   * `===== Section Title =====`
   * `==== Sub-Section ====`   * `==== Sub-Section ====`
 +</WRAP>
  
 ==== Formatting Text ==== ==== Formatting Text ====
Line 95: Line 140:
   * **New Paragraph:** Press **Enter twice** to leave a blank line. This is the best way to keep text readable.   * **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: ''\\ ''   * **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." +<WRAP centered round tip> 
- +<WRAP centeralign>**Special Note for the "SprintDoc" Template**</WRAP> 
-==== Lists ==== +  - **Save often:** The preview button is your best friend. 
-**Important:** You must start a list item with **two spaces**. +  - **Whitespace matters:** Always leave one empty line between a paragraph and a list or table to make sure the "SprintDoc" template displays everything perfectly. 
-  * Bullet points use an asterisk: ''  * Item'' +</WRAP>
-  * 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: ''[[pagename | Clickable Text]]'' +
-  * External: ''[[https://google.com | Google]]'' +
- +
-==== Images ==== +
-Use curly braces to show an image. +
-  * Standard: ''{{image.png}}'' +
-  * Resized (50px wide): ''{{image.png?50}}'' +
- +
-==== 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__:** <code>__Underscores__</code> +
-  * **''Monospaced'':** <code>''Double Single-Quotes''</code> (Great for file paths or Tasker variables!) +
- +
------+
  
 ==== Lists ==== ==== Lists ====
 Building lists is all about the **indentation** and **steps**. Building lists is all about the **indentation** and **steps**.
-  * For bullet point: Use **two spaces** from the left margin and an **asterisk** '*' +  * 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** '-'+  * 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**   * To create further indentation for either: add 2 more spaces to the previous **indentation**
 +<WRAP indent>
   * First bullet item   * First bullet item
   * Second bullet item   * Second bullet item
Line 157: Line 157:
   - First numbered item   - First numbered item
   - Second numbered item   - Second numbered item
 +</WRAP>
  
------+==== 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: <code>[[pagename]]</code> 
 +  * Internal with custom name: <code>[[pagename | Clickable Text]]</code> 
 +  * External: <code>[[https://google.com | Google]]</code>
  
-==== File Paths ==== +=== Media ===
-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.+
  
-^  In Windows or Android filename  ^  In Dokuwiki a .txt or .png  ^ +To display any media, use opening and closing curly braces (''{{...}}'') 
-|  \root\subdirectory\filename.ext  |  :root_namespace:sub_namespace:text_filename (not extension needed for .txt (text files)  |+  * Images (PNG, jpg gif, webp) 
 +  * Video (animated gifs  mp4((mp4 format is discouraged due to file size))), 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 ''{{:media:pond:fish:fish.webp}}''
  
-==== Links: To Pages or Sections on the Same Page ==== +  * ''{{namespace:filename.ext}}'' 
-  * **Internal Link within the wiki:**  +  * ''{{wiki:logo.png}}'' — Displays the image at its original size. 
-    * To the same page and section heading '== XYZ ==' <code>[[:pagename#XYZ]]</code> or <code>[[:pagename#XY|Viewable Clickable Text]]</code> +  * ''{{wiki:logo.png?50}}'' — Displays the image at **50 pixels** wide (resizing made easy).
-  * **External Link outside the wiki:** <code>[[https://google.com | Link to Google]]</code> would show as [[https://google.com | Link to Google]] +
- +
------ +
- +
-=== Media (Images) === +
- +
-To display an image, use curly braces. +
- +
-  * '{{namespace:filename.ext}}' +
-  * `{{wiki:logo.png}}` — Displays the image at its original size. +
-  * `{{wiki:logo.png?50}}` — Displays the image at **50 pixels** wide (resizing made easy). +
- +
------+
  
 === Simple Tables === === 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.+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.
  
 | Goal |  Syntax  | | Goal |  Syntax  |
-| **Header Row** | `^ Header 1 ^ Header 2 ^` | +^  **Header 1**  ^  **Header 2**  ^ 
-| **Standard Row** | `| Content 1 | Content 2 || +| Content A | |  Content B  | 
- +++++ 
------ +<WRAP noprint>{{page>site:site-footer-comment_feedback_block}}</WRAP>
- +
-=== Special Note for the "SprintDoc" Template === +
- +
-  - **Save often:** The preview button is your best friend. +
-  - **Whitespace matters:** Always leave a blank line between a paragraph and a list or a table to ensure it renders correctly. +
- +
----- +
- +