====== Welcome ====== ===== to the world of uiTotalLauncherManual and It's Dokuwiki ===== 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.| 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. ==== Right Sidebar ==== ==== Toby Quick Help ==== * 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..."). ++++ ===== 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| ==== 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: * **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. ^ 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. | === 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 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. ==== 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! ++++ 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 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.| ==== 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. * `====== 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: ''\\ '' **Special Note for the "SprintDoc" Template** - **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. ==== 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) - First numbered item - Second numbered item ==== 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: [[pagename]] * Internal with custom name: [[pagename | Clickable Text]] * External: [[https://google.com | Google]] === Media === To display any media use opening and closing curly braces (''{{...}}'') * 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 ''medi'' namespace * 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}}'' * ''{{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 === 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 | ^ **Header 1** ^ **Header 2** ^ | Content A | | Content B | ++++ {{page>site:site-footer-comment_feedback_block}}