Getting started Creating/Editing Pages in this Wiki

• 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.

• 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.

• Next, Dokuwiki creates this page and shows you the Editing interface with a toolbar. Remember to save when done.

• We are using the Tag system to organize pages in this wiki. This is done by adding the following syntax

   {{tag>tag_name}} 

  or by pressing the button in the above toolbar.

• A Page can have multiple Tags. For example the page 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 . TN147: Changing Piezo Drive Card's Fast Slow Compensation and 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.

For second person should I use “we” or “you”? Should I use active voice or passive voice? When in doubt refer to the Google Style Guide. Its free and accessible, written with technical subject in mind.

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 page. It can be included in your page with the following syntax. These icons are available on the toolbar as Wrap Plugin ()

{{page>safety_notices}}

PanDoc is a command line software you can use to convert MS Word documents into Dokuwiki formatted text.

pandoc -t dokuwiki -o output.txt input.docx --extract-media=%CD%

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.

Default Dokuwiki syntax can be found here Formatting Syntax

Below are some custom syntax we added to this particular wiki.

Here are some options to display Serial commands on your page.

<asi> $ MOVE X=123 Y=-123
:A</asi>

Line beginning with $ is Typeset as command , and lines without $ is typeset as reply.

MOVE X=123 Y=-123
:A

This syntax can be gotten by pressing button also.

<wrap cmd> SERIAL COMMAND </wrap>

SERIAL COMMAND

This syntax can be gotten by pressing button also.

<wrap reply> SERIAL REPLY </wrap>

SERIAL REPLY

This syntax can be gotten by pressing button also.

We have the Dokuwiki MathJax plugin installed in this wiki.

\begin{equation}R = \frac{(n_1 – n_2)^2}{(n_1 + n_2)^2}\end{equation}

\begin{equation}R = \frac{(n_1 – n_2)^2}{(n_1 + n_2)^2}\end{equation}

This syntax can be gotten by pressing button also.

For more MathJax syntax visit www.onemathematicalcat.org

More info here

{{tag>tag_name}}

This syntax can be gotten by pressing button also.

More info here

Give tables the ability to sort, search etc by adding the following syntax

<datatables></datatables>

More info here

Include another wiki page into the current one. More info here

The Outliner Plugin used to add collapsible sections to a wiki page.

--> Nested section opened#

Nested content

<--

Nested section opened

Nested content

Used extensively in Command:AFLIM

More info here

By Default, dokuwiki doesn't show Captions for images. Example:

{{ :logo.png |ASI's Logo}}

The Imagebox plugin lets is add [] around the image syntax to show image caption.

[{{ :logo.png |ASI's Logo}}]

ASI's Logo

More info here