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/23 19:22] – dorepswiki:contribution_guide [2026/05/10 19:27] (current) – external edit 127.0.0.1
Line 1: Line 1:
-====== Welcome New Editors ======+====== Welcome ====== 
 +===== to the world of uiTotalLauncherManual and It's Dokuwiki =====
  
-Here is a simplified "Cheat Sheet" focusing on the essentials that will be used **90%** of the time.+uiTLM is glad you decided to visit this page. It's a first step for many in deciding whether to **Register**, what **Benefits** are to be gained, and answer some questions about Total Launcher and lessen it's learning curve with the uiTLM "Easier Easy" guide ... even contribute with error correction and learning tips for other users.
  
------+So, let's get started with what can be helpful in this next step. 
 +===== Benefits of Registration ===== 
 +Why register? ++++Click here.|
  
-==== Headings ====+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 ===== 
 +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 ==== 
 +==== Left Sidebar ==== 
 +Sitemap: Suggests including the "Sitemap" as a primary navigation tool for viewing the entire namespace hierarchy.
  
-Headings use equals signs `=`. The more equals signs you use, the **larger** or **higher** the heading. The '=' must start on the left margin. +==== Right Sidebar ==== 
-  * `====== Top Level Title ======` (Main page title) +==== Toby Quick Help ==== 
-  * `===== Section Title =====` +  * Toby Quick Help: Defines this tool more clearly. If it is an AI assistant or a specific plugin, the functional interaction should be described (e.g., "Accesses the automated assistance tool..."). 
-  * `==== Sub-Section ====` +++++ 
-  ***Tip:** DokuWiki automatically creates a Table of Contents if there areat least three headings on a page.+===== Wiki Concepts: Getting Started =====
  
------+Before starting to edit and contribute to pages, a few "Big Picture" concepts for more easily managing documentation is shown ++++here|
  
-==== Text ==== +==== Namespaces and Folders ==== 
-Think of these as "wrappers" around the words. +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: 
-  * **Bold:** `**Double Asterisks**` +  * **Structure:** Namespaces are separated by a colon '':'' instead of a slash ''\''. 
-  * **//Italic//:** `//Double Slashes//` +  * **Example:** ''manual:installation:setup''  
-  * **__Underline__:** <code>__Underscores__</code> +    * ''manual'' = Top folder 
-  * **''Monospaced'':** <code>''Double Single-Quotes''</code> (Great for file paths or Tasker variables!)+    * ''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.
  
-==== Lists ==== +^  In Windows or Android filename  ^  In Dokuwiki a .txt  ^ 
-Building lists is all about the **indentation** and **steps**. +|  \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.  |
-  * 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 +=== File Creation === 
-  * Second bullet item +Registered users have a "permission level" to **create new pages** (not delete pages). 
-    * Indented sub-item (four spaces) +
-  - First numbered item +
-  - Second numbered item+
  
------+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.
  
-==== File Paths ==== +== Case Sensitivity == 
-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.+  * 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
  
-^  In Windows or Android filename  ^  In Dokuwiki a .txt or .png  ^ +<WRAP center round tip> 
-|  \root\subdirectory\filename.ext  |  :root_namespace:sub_namespace:text_filename (not extension needed for .txt (text files)  | +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.
-==== Links: To Pages or Sections on the Same Page ==== +
-  * **Internal Link within the wiki:**  +
-    * To the same page and section heading '== XYZ ==' <code>[[:pagename#XYZ]]</code> or <code>[[:pagename#XY|Viewable Clickable Text]]</code> +
-  * **External Link outside the wiki:** <code>[[https://google.com | Link to Google]]</code> would show as [[https://google.com | Link to Google]] +
- +
------ +
- +
-## 5\. Media (Images) +
- +
-To display an image, use curly braces. +
- +
-  * `{{wiki:logo.png}}` — Displays the image at its original size. +
-  * `{{wiki:logo.png?50}}` — Displays the image at **50 pixels** wide (resizing made easy). +
- +
------ +
- +
-## 6\. Simple Tables +
- +
-Tables are built using vertical bars `|` (cells) and carets `^` (headers). +
- +
-| Goal | Syntax | +
-| :--- | :--- | +
-| **Header Row** | `^ Header 1 ^ Header 2 ^` | +
-| **Standard Row** | `| Content 1 | Content 2 |` | +
- +
------ +
- +
-### A Note for the "SprintDoc" Template +
- +
-Since we know that certain plugins (like `imapmarkers` or `foldplugin`) can be sensitive to formatting, remind your users: +
- +
-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. +
- +
----- +
- +
-====== DokuWiki Concepts: Getting Started ====== +
- +
-Before you start writing, here are a few "Big Picture" concepts that make managing your documentation much easier. +
- +
-===== 1. Namespaces and Folders ===== +
-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 +
- +
-===== 2. Page Names vs. Headings ===== +
-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.   * **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>
  
-===== 3. Paragraphs and New Lines ===== +==== Table of Contents for Pages ==== 
-DokuWiki handles "spacing" differently than a standard word processor. +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.  
-  * **New Paragraph:** Press **Enter twice** to leave a blank line. This is the best way to keep text readable. +  * 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.
-  * **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." +
- +
-===== 4. Automatic Table of Contents ===== +
-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.+
  
-===== 5. Non-Destructive Editing ===== +==== Non-Destructive Editing ==== 
-Don't be afraid to make mistakes! +Don't be afraid to make mistakes! Dokuwiki and SprintDoc will remember any revisions **//if// Save** has been tapped. 
-  * **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. +  * **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:** Always use the **Preview** button before saving to see exactly how your formatting looks.+  * **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''.
  
-> **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!+> **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]]
  
 ---- ----
  
-```text +===== 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 in a few special characters. To learn more ++++click here.|
  
-===== 1. Headings ===== +==== Headings ==== 
-Headings use equals signs. Use more for smaller sub-sections.+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 ======   * ====== Page Title ======
   * ===== Section Title =====   * ===== Section Title =====
   * ==== Sub-Section ====   * ==== Sub-Section ====
  
-===== 2. Formatting Text =====+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) 
 +  * `===== Section Title =====` 
 +  * `==== Sub-Section ====` 
 +</WRAP> 
 + 
 +==== Formatting Text ====
   * **Bold:** ''**text**''   * **Bold:** ''**text**''
   * //Italic:// ''//text//''   * //Italic:// ''//text//''
Line 132: Line 115:
   * ''Monospaced:'' '' ''text'' '' (Useful for file paths or variables)   * ''Monospaced:'' '' ''text'' '' (Useful for file paths or variables)
  
-===== 3. Lists ===== +==== Paragraphs and New Lines ==== 
-**Important:** You must start a list item with **two spaces**. +DokuWiki handles "spacing" differently than a standard word processor. 
-  * Bullet points use an asterisk: ''  * Item'' +  * **New Paragraph:** Press **Enter twice** to leave a blank line. This is the best way to keep text readable. 
-  * Numbered lists use a dash: ''  - Item''+  * **Forced New Line:** If you want to drop to the next line without starting a new paragraph, type two backslashes followed by a space: ''\\ '' 
 +<WRAP centered round tip> 
 +<WRAP centeralign>**Special Note for the "SprintDoc" Template**</WRAP> 
 +  - **Save often:** The preview button is your best friend. 
 +  - **Whitespace matters:** Always leave one empty line between a paragraph and a list or table to make sure the "SprintDoc" template displays everything perfectly. 
 +</WRAP> 
 + 
 +==== 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** 
 +<WRAP indent> 
 +  * First bullet item 
 +  * Second bullet item 
 +    * Indented sub-item (four spaces) 
 +  - First numbered item 
 +  - Second numbered item 
 +</WRAP> 
 + 
 +==== Links ==== 
 +To link to another **page**, a **section** on the eisting 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> 
 + 
 +=== Media ===
  
-===== 4. Links ===== +To display any media use opening and closing curly braces (''{{...}}'') 
-To link to another page or a website, use double square brackets. +  * Images (PNG, jpg gif, webp) 
-  * Internal: ''[[pagename]]'' +  * Video (animated gifs  mp4((mp4 format is discouraged due to file size))), use curly braces. 
-  * Internal with custom name: ''[[pagename | Clickable Text]]'' +  * All  media on a page must be located in the ''medi'' namespace  
-  * External: ''[[https://google.com | Google]]''+  * Media for a page is to be located in 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}}''
  
-===== 5. Images ===== +  * ''{{namespace:filename.ext}}'' 
-Use curly braces to show an image. +  * ''{{wiki:logo.png}}'' — Displays the image at its original size. 
-  * Standard: ''{{image.png}}'' +  * ''{{wiki:logo.png?50}}'' — Displays the image at **50 pixels** wide (resizing made easy).
-  * Resized (50px wide): ''{{image.png?50}}''+
  
-===== 6. Simple Tables ===== +=== Simple Tables ===
-Tables use the pipe ''|'' for regular cells and the caret ''^'' for headers.+
  
-^ Header 1 ^ Header 2 ^ +Tables are built using vertical bars ''|'' for (cells) and carets for ''^'' (headers). Alignment can be specific **for each cell or heading**:  
-| Content A | Content B | +  * To **center** contents leave 2 spaces between the beginning and ending cell or header marker,  
-| Content C | Content D |+  * leave 1 space for left aligned entries.
  
-> **Pro Tip:** Always leave one empty line between a paragraph and a list or table to make sure the "SprintDoc" template displays everything perfectly. +| Goal |  Syntax  | 
-```+^  **Header 1**  ^  **Header 2**  ^ 
 +| Content A | |  Content B  | 
 +++++ 
 +<WRAP noprint>{{page>site:site-footer-comment_feedback_block}}</WRAP>