Instructions for Wiki Editors

This is a short guide for the wiki editors.

The editor can be set in two modes: CKG mode (CKG Editor) or DokuWiki mode (DW Editor).

CKG mode - is a WYSIWYG editor ( i.e. when editing everything is display as it will be displayed in reality once editing is completed). In other words, this is a visual mode of the editor, in which you will immediately see what will happen once you are done.

DW mode - is an editor of bare text, and in it you edit with text only with native DokuWiki syntax (https://www.dokuwiki.org/ru:wiki:syntax). To see what happens in reality, you need to save the page (or section) and look at the result in the viewing mode. Here, for example, what does the beginning of this page look like in the editor in DW mode:

====== Instructions for Wiki Editors ======

Here is a brief guide for the wiki editors.

===== Editing in general =====

The editor can be in two modes: CKG mode (CKG editor) or DokuWiki Mode (DW editor).

CKG mode - is a WYSIWYG editor ( i.e. when editing everything is display as it will be displayed in reality once editing is completed). In other words, this is a visual mode of the editor, in which you will immediately see what will happen once you are done.

Clearly, CKG mode is preferred option, but sometimes it may be necessary to switch from one mode to another. To do this, in the edit mode, there is a button at the button at the bottom that allows you to switch from mode to mode (the third one on the left, the name of the button changes from version to version, but you will understand, since there will be text mentioning CKG, CKG Editor, DW Edit, DokuWiki Editor and variations depending on the current language of the wiki interface).

In general, editing does not cause complications. At the top of the editor there are buttons for basic editing tasks and they have pop-up hings that explains the purpose of the button.

You can start editing the whole page, for this, in the page view mode, you need to click on the “Pen” icon on the right of the viewing area. But it is preferable to edit a certain section (section beginning with the title and until the next header). To do this, click on the “Edit” button, which is displayed on the right side in the preview area at the end of each section.

Do not forget to periodically click on the “Save” button located at the bottom of the editor and look at your work.

If something went wrong, you can always undo the changes made (the icon with the clock on the right) and go back to the previous/earlier version of the wiki. Therefore, the advice: Do not try to do all work in one sitting, save often, so that if necessary, you can roll back to previous state, and not lose much of the work done by you.

Important Information.

Our DokuWiki – is multilingual and its root directory consists of several sub-directories (namespaces), one for each language. When adding media files to DokuWiki, you must strictly follow the following rules.

  1. Media files which are available or planned in different languages should be placed in aapropriate language folder (en_English, ru-Russian,etc).
    1. The media files should have the same name and type (extensions) in all language folders.
    2. If adding a file to a specific language directory and doesnot have same for other languages, then for other languages you need to copy this file to all folders, if it exists.
  2. Media files that are neutral with respect to the language (or exists only in one language version, but will be linked from the pages of the documents in different languages) should be placed in root directory. For examples, unique photos, videos, certificates, etc.
  3. The name of the media file should reflect the contents of the file. The name should give meaning. You should not create files with names like ‘image1213.png’!, it us unambiguous and doesnot give any meaning.

Adding and updating media files via FTP.

The easiest way is to upload the files to the desired sub-directory of the media folder on the site, for example via FTP. Therefore, if you need to do a big update, you need to prepare the necessary pictures and ask the site administrator to upload them to the website via FTP.

Adding and updating media files through "Manage Media Files".

If you are not able to add files via FTP, it is recommended to use DokuWiki tool called “Manage media files”. This way is simpler and less prone to accidental errors, compared to similar operations from the editor of the DokuWiki or CKG editor. In the browser, with the DokuWiki open, click on the link “Manage your media files”:

dokuwiki_media_control.png

In the left part of the “Manage media files” window, select the desired language or root directory:

Formatting the content (+css)

Screenshots should be inserted with the option [No Link], centering the alternative text (it will be displayed when the mouse is hovered of the screenshot), for reference the alternative text doesnot work currently.

With CSS, only the following elements are formatted:

Paragraph - width and indentation of the the line is 1.5 em

Headings 1-3 levels in the center and bold.

If necessary, add CSS for other elements.


For Word documents, its better to insert the text without formatting, press Ctrl+C in the Word to copy and Ctrl+Shift+V to paste it into the DokuWiki.

When editing, you will most likely come across designs of the form

{{anchor:anchor_identifier}}

These are called Anchors, which specify the place on which you can make references from the same or other pages on the documentations.

For example, before this section of the documentation there is an anchor with the name “Anchors”, and sho it can be referenced using anchors, hyperlink that will open the desired page at the right place.

Never delete or modify these anchors, since they have links from many pages of the documentation (Including ASTER control panel which is installed by thousents of our users)!

You can create anchors yourself if you need to create a reference point from another (or same page to specific place). Just keep in mind- the anchor_identifier must be unique inside the page and consist of English letters and have meaning to it.

To refer to the anchor use the standard template

 [[path_to_page#anchor_identifier | Text link]]

Where path_to_page - is the path to the page (See more) anchor_identifier - is the name of the anchor in this page Text link- is the text that will be displayed as a link.

Example of inserting a link through the “Insert/Edit Link” dialog box

Insert Link

To insert link, click “Insert/Edit Link” button in the editor's toolbar and fill in the fields in the window that opens.

Select the link type - in the screenshot this is “Internal Link”.

Select on the server or enter the link manually.

Enter the text of the link, if you leave the field blank, then the link text will be title of the page you are referring to.

After done, click “ОК” button.

As a reseult, we get links like;

[[.:ugd:ugd_installation|]] //link to the page
[[.:ugd:ugd_config#ugd_config_view|View Devices]] //reference to the anchor.

Important: To immediately open the page for editing, in the standard editor of DOkuWiki, just double click on the screenshot..

You should have notices some warning texts in the previous section on anchors.

To insert such a well formatted note, we use the Note plug-in. You, too can do this to highlight an important part of the text, To do this create the following lines in the editor:

<note type>
Text to be highlighted.
</note>

Here, there are several values a type can have. Some of them are listed below:

<note>
This is default note.</note>

This is tip (tip). </note>

</note>

<note warning>
This is warning.

To create notes, you can also use Wrap plugin. Just select a piece of thext, open the wrap toolbar, select the type of note you want. And then click “:

<WRAP center round tip 60%>
For example: So in the code the block of the help file will be assigned.</WRAP>

The block size can be changed if necessary by writing it in percent, of by other units, for example - px (Pixel).

Another interesting design that occur at the beginning of each page is

{{indexmenu_n>N}}

Where N is a number for the page.

The number specifies the sequence number of the page in the list of pages shown on the left of the main text (in the sidebar). This list is ordered in ascending order of page numbers (N). The number is not global, but within the current namespace (Documentation directory). Those, for the User's Guide, one list, for GUI another list and so on. Numbers do not have to be consistent, only relative order is important. Therefore, it is desirable to make this initial number with a margin, so that afterwards it is possible to change the order of the pages with minimal effort and add page to the desired place in the list and so on.

Edit this section to ask a question.

1. Spaces are removed from the text by themselves.

All the text are converted to html and in it spaces are unwanted. They are not particularly taken in to account, they are usually shurnk to just 1 space. Even a line break may disappear. All line breaks and the required number of spaces must be explicitly specific.

For example, I copied a piece of word doc, formatted and saved it. and it turned out to be without any spaces. It deleted all spaces, but the bulleted list (blank space after *) is left as it is and the formatting is spoiled.

You may have worked in DokuWiki editor mode, Try switching to CKG and copy from word.

Now, I have tried a piece:

The contents of ASTER report

The contents of the ASTER technical report, by default is selected based on the type of query you have selected. However, you can adjust this content in three ways:

  • Select the standard type using the radio button in the lower left part of the dialog
  • Add to the report files from your computer that you think (or at the request of ASTER support agent) will help to resolve the problem.
  • Add the contents of the windows clipboard to the editor with standard copy paste operation (example, some screenshots).

This also works from the internet browser<font inherit/inherit;;inherit;;rgb(251, 250, 249)>The following doesnot always happen. THere is the link for wiki page for installing ASTER : - https://dokwiki.ibik.ru/ru/dev/core/ugd/ugd_installation#%D1%83%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B0%D1%81%D1%82%D0%B5%D1%80</font]]|[[https://dokwiki.ibik.ru/ru/dev/core/ugd/ugd_installation#%D1%83%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B0%D1%81%D1%82%D0%B5%D1%80</font]]|https://dokwiki.ibik.ru/ru/dev/core/ugd/ugd_installation#%D1%83%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B0%D1%81%D1%82%D0%B5%D1%80</font]]> this was copy pasted in editor.

And you can do more. From where you copied, how, what browser version, etc. If you look carefully, there are garbage content from the tags <font>.

If you copied from work word2013 / Ctrl+C / Ctrl+V / in latest version of Google Chrome, you can paste the contents without any formatting from the word document. To do that, right click on the editor and choose “Paste without formatting”. This will fix any issue with garbage tags when copy pasting from word document.

2. Is it possible to format the text in paragraph and add the list spacing (For example in a list)?

Is it really necessary? Actually, I have only started using this editor recently so i have not checked much of it.

The paragraphs looks more beautiful. I didnot insist, but if i found a couple of plugins (DivAlign2 and Wrap), which can be useful.

divalign adds buttons for alignment.