Applied Scientific Instrumentation

User Tools

Site Tools

Trace:
getting_started_with_dokuwiki

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
getting_started_with_dokuwiki [2026/07/01 04:52] – [MS Word (docx only) to DokuWiki] remove section asiadmingetting_started_with_dokuwiki [2026/07/01 06:19] (current) – add section about mermaid asiadmin
Line 2: Line 2:
  
 <WRAP center round info 60%> <WRAP center round info 60%>
-At the moment , Creating and editing content on this site is restricted to ASI staff. Please contact ASI if like you like any additions or corrections. +**Note:** Creating and editing content on this site is restricted to ASI. Please contact ASI if like you would like to request additions to the documentation or report errors. 
 </WRAP> </WRAP>
  
Line 9: Line 9:
  
   * Begin by typing the Namespace and name of the new page into the Search field and search   * Begin by typing the Namespace and name of the new page into the Search field and search
-     * Folders in Dokuwiki are called NameSpace. All ASI Manuals, Tech Notes don't require a Namespace and title of the page can be input directly. Commands get the namespace "commands".Further Organising is done thru the Tag system. +     * Folders in DokuWiki are called namespaces. 
-     * In the Picture below , Namespace is ''Documentation'' and new page name is ''new_page_name'' . Dokuwiki doesn't allow Upper Case and Whitespaces in page names.+       * Manuals and Tech Notes __do not require__ a namespace, the [[:crisp_manual|CRISP manual]] uses the name ''crisp_manual'' directly. 
 +       * Commands are in the namespace ''commands'', see the [[:commands:WHO|WHO command]] for an example. 
 +     * In the image below, the namespace is ''documentation'' and the new page name is ''new_page_name''. 
 +     * DokuWiki doesn't allow uppercase or whitespace characters in page names.
  
 {{ create_page1.png |}} {{ create_page1.png |}}
  
-  * Dokuwiki then takes you to the search page, and lists all the pages that are similar or relevant. Press the ''Create This Page'' button to create the page. +  * DokuWiki then takes you to the search page, and lists all the pages that are similar or relevant. Press the ''Create This Page'' button to create the page. 
  
 {{ create_page2.png |}}  {{ create_page2.png |}} 
  
-  * Next, Dokuwiki creates this page and shows you the Editing interface with a toolbar. Remember to save when done. +  * Next, DokuWiki creates this page and shows you the Editing interface with a toolbar. Remember to save when done. 
  
 {{ create_page3.png |}} {{ create_page3.png |}}
Line 26: Line 29:
   * We are using the Tag system to organize pages in this wiki. This is done by adding the following syntax <code> {{tag>tag_name}} </code> or by pressing the {{tag.png|}} button in the above toolbar.    * We are using the Tag system to organize pages in this wiki. This is done by adding the following syntax <code> {{tag>tag_name}} </code> or by pressing the {{tag.png|}} button in the above toolbar. 
   * A Page can have multiple Tags. For example the page [[crisp_manual|CRISP : Continuous Autofocus System]] has the tags'' manual'' and ''crisp''   * A Page can have multiple Tags. For example the page [[crisp_manual|CRISP : Continuous Autofocus System]] has the tags'' manual'' and ''crisp''
-  * Please give the tag '' manual'' only to pages that are considered vital for the user to read inorder to operate or setup the device. +  * Please give the tag '' manual'' only to pages that are considered vital for the users to read in order to operate or setup the device. 
   * Another tag that will be common is ''tech_note''. These pages aren't considered vital for all user to read and are more specific.The following pages are organised with ''tech_note'' tag . [[tech_note_changing_piezo_drive_card_fast_slow_compensation|TN147: Changing Piezo Drive Card's  Fast Slow Compensation]] and [[tech_note_crisp_error_calculation|Technical Note: CRISP Error Calculation Algorithm]]   * Another tag that will be common is ''tech_note''. These pages aren't considered vital for all user to read and are more specific.The following pages are organised with ''tech_note'' tag . [[tech_note_changing_piezo_drive_card_fast_slow_compensation|TN147: Changing Piezo Drive Card's  Fast Slow Compensation]] and [[tech_note_crisp_error_calculation|Technical Note: CRISP Error Calculation Algorithm]]
   * Atm pages that have the ''manual'' or ''tech_note'' tag will automatically be linked on this Wiki's start page.    * Atm pages that have the ''manual'' or ''tech_note'' tag will automatically be linked on this Wiki's start page. 
Line 47: Line 50:
 ===== Formatting Syntax ===== ===== Formatting Syntax =====
  
-Default Dokuwiki syntax can be found here [[wiki:syntax|Formatting Syntax]]+Default DokuWiki syntax can be found here [[wiki:syntax|Formatting Syntax]]
  
 Below are some custom syntax we added to this particular wiki.  Below are some custom syntax we added to this particular wiki. 
Line 79: Line 82:
 ==== Math ==== ==== Math ====
  
-We have the Dokuwiki MathJax plugin installed in this wiki. +We have the DokuWiki MathJax plugin installed in this wiki. 
  
 <code>\begin{equation}R = \frac{(n_1 – n_2)^2}{(n_1 + n_2)^2}\end{equation}</code> <code>\begin{equation}R = \frac{(n_1 – n_2)^2}{(n_1 + n_2)^2}\end{equation}</code>
Line 133: Line 136:
 More info [[https://www.dokuwiki.org/plugin:outliner|here]] More info [[https://www.dokuwiki.org/plugin:outliner|here]]
  
-====Imagebox Plugin ====+==== Imagebox Plugin ====
  
-By Default, dokuwiki doesn't show Captions for images. Example:+By Default, DokuWiki doesn't show Captions for images. Example:
  
 <code>{{ :logo.png |ASI's Logo}}</code> <code>{{ :logo.png |ASI's Logo}}</code>
Line 148: Line 151:
  
 More info [[https://www.dokuwiki.org/plugin:imagebox|here]]  More info [[https://www.dokuwiki.org/plugin:imagebox|here]] 
 +
 +==== Mermaid Charts ====
 +
 +The Mermaid plugin uses [[https://mermaid.ai/open-source/|Mermaid]] to support many different kinds of charts and graphs.
 +
 +<mermaid>
 +
 +graph TD
 +    A[Enter Chart Definition] --> B(Preview)
 +    B --> C{decide}
 +    C --> D[Keep]
 +    C --> E[Edit Definition]
 +    E --> B
 +    D --> F[Save Image and Code]
 +    F --> B
 +
 +</mermaid>
  
Address: 29391 W Enid Rd. Eugene, OR 97402, USA | Phone: +1 (541) 461-8181
getting_started_with_dokuwiki.1782895927.txt.gz · Last modified: by asiadmin