User Tools

Site Tools


getting_started_with_dokuwiki

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
getting_started_with_dokuwiki [2018/08/24 17:22]
melissa
getting_started_with_dokuwiki [2019/04/18 23:34] (current)
Line 1: Line 1:
 +====== Getting started Creating/​Editing Pages in this Wiki ======
 +
 +<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. ​
 +</​WRAP>​
 +
 +
 +===== Creating a New Page =====
 +
 +  * 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.
 +     * 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.
 +
 +{{ 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. 
 +
 +{{ create_page2.png |}} 
 +
 +  * Next, Dokuwiki creates this page and shows you the Editing interface with a toolbar. Remember to save when done. 
 +
 +{{ create_page3.png |}}
 +
 +===== Organizing the Wiki =====
 +
 +  * 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''​
 +  * Please give the tag ''​ manual''​ only to pages that are considered vital for the user to read inorder 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]]
 +  * Atm pages that have the ''​manual''​ or ''​tech_note''​ tag will automatically be linked on this Wiki's start page. 
 +
 +===== Style Guide =====
 +
 +For second person should I use "​we"​ or "​you"? ​
 +Should I use active voice or passive voice?
 +When in doubt refer to the [[https://​developers.google.com/​style/​highlights|Google Style Guide]]. Its free and accessible, written with technical subject in mind. 
 +
 +===== CE Compliance =====
 + To Comply with CE we need to provide user with safety notices, and where possible define them to the user. This is the [[safety_notices|Safety Notices]] page. It can be included in your page with the following syntax. These icons are available on the toolbar as Wrap Plugin ({{:​documentation:​picker.png?​nolink|}})
 +
 +<​code>​{{page>​safety_notices}}</​code>​
 +
 +{{page>​safety_notices}}
 +
 +===== MS Word (docx only) to DokuWiki =====
 +
 +[[http://​pandoc.org/​|PanDoc]] is a command line software you can use to convert MS Word documents into Dokuwiki formatted text. 
 +
 +<​code>​pandoc -t dokuwiki -o output.txt input.docx --extract-media=%CD%</​code>​
 +
 +When this program finishes running , it will generate a file called ''​output.txt''​ that has the Dokuwiki formatted text. Then in the Parent directory a new folder ''​\wiki\''​ is created with all the images in the word file extracted. ​
 +
 +Contents of The ''​output.txt''​ can be cut pasted into dokuwiki , the images will need to be renamed (because all images are image1,2,3 etc the names will clash, so rename to word_file_name1.jpg etc) uploaded , and relinked in the document. ​
 +
 +
 +<WRAP center round tip 60%>
 +Tip: Pandoc isn't perfect and makes a lot of formatting mistakes. It might sometimes be easier to cut paste directly from word into dokuwiki and manually format the text.
 +</​WRAP>​
 + 
 +
 +===== Formatting Syntax =====
 +
 +Default Dokuwiki syntax can be found here [[wiki:​syntax|Formatting Syntax]]
 +
 +Below are some custom syntax we added to this particular wiki. 
 +
 +==== Serial Block ====
 +
 +Here are some options to display Serial commands on your page. 
 +
 +<​code><​asi>​ $ MOVE X=123 Y=-123
 +:​A</​asi></​code>​
 +
 +Line beginning with ''​ $''​ is Typeset as command , and lines without ''​$''​ is typeset as reply. ​
 +
 +<asi> $ MOVE X=123 Y=-123
 +:​A</​asi>​
 +
 +This syntax can be gotten ​ by pressing {{sb.png|}} button also. 
 +
 +<​code><​wrap cmd> SERIAL COMMAND </​wrap></​code>​
 +
 +<wrap cmd> SERIAL COMMAND </​wrap>​
 +
 +This syntax can be gotten ​ by pressing {{cmd.png|}} button also. 
 +
 +<​code><​wrap reply> SERIAL REPLY </​wrap></​code>​
 +
 +<wrap reply> SERIAL REPLY </​wrap>​
 +
 +This syntax can be gotten ​ by pressing {{reply.png|}} button also.
 +
 +==== Math ====
 +
 +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>​
 +
 +\begin{equation}R = \frac{(n_1 – n_2)^2}{(n_1 + n_2)^2}\end{equation}
 +
 +This syntax can be gotten ​ by pressing {{math.png|}} button also.
 +
 +For more MathJax syntax visit [[http://​www.onemathematicalcat.org/​MathJaxDocumentation/​TeXSyntax.htm
 +|www.onemathematicalcat.org]]
 +
 +
 +More info [[https://​www.dokuwiki.org/​plugin:​mathjax|here]]
 +
 +==== Tags ====
 +
 +<​code>​{{tag>​tag_name}}</​code>​
 +
 +This syntax can be gotten ​ by pressing {{tag.png|}} button also.
 +
 +More info [[https://​www.dokuwiki.org/​plugin:​tag|here]]
 +
 +==== Table ====
 +
 +Give tables the ability to sort, search etc by adding the following syntax
 +
 +<​code><​datatables></​datatables></​code>​
 +
 +More info [[https://​www.dokuwiki.org/​plugin:​datatables|here]]
 +
 +==== Include ====
 +
 +Include another wiki page into the current one. More info [[https://​www.dokuwiki.org/​plugin:​include|here]]
 +
 +==== Collapsible sections ====
 +
 +The [[https://​www.dokuwiki.org/​plugin:​outliner|Outliner Plugin]] used to add collapsible sections to a wiki page. 
 +
 +<​code>​-->​ Nested section opened#
 +
 +Nested content
 +
 +<​--</​code>​
 +
 +--> Nested section opened#
 +
 +Nested content
 +
 +<--
 +
 +Used extensively in [[commands:​aflim|Command:​AFLIM]]
 +
 +More info [[https://​www.dokuwiki.org/​plugin:​outliner|here]]
 +
 +====Imagebox Plugin ====
 +
 +By Default, dokuwiki doesn'​t show Captions for images. Example:
 +
 +<​code>​{{ :logo.png |ASI's Logo}}</​code>​
 +
 +{{ :logo.png |ASI's Logo}}
 +
 +The Imagebox plugin lets is add ''​[]''​ around the image syntax to show image caption.
 +
 +<​code>​[{{ :logo.png |ASI's Logo}}]</​code>​
 +
 +[{{ :logo.png |ASI's Logo}}]
 +
 +More info [[https://​www.dokuwiki.org/​plugin:​imagebox|here]] ​
  
getting_started_with_dokuwiki.txt · Last modified: 2019/04/18 23:34 (external edit)