Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

Editor window

    1 Editor menubar
       1.1 Reload the wiki
       1.2 Options menu
       1.3 Generation menu
    2 Editor toolbar
    3 Editor tree
    4 Editor content panel
    5 Notes
    6 See also

The editor window has the following panels:

The top of the window presents a menubar and a toolbar allowing to manage the content of the wiki and navigate in the wiki content
The left panel shows the tree of the wiki roots
The right panel shows the content of the currently selected element in the tree
The bottom panel is a message area showing potential parsing errors on the selected element in the tree

Editor menubar

The menubar has three menus:

The Tool menu allows to refresh the reload of the wiki.
The Options menu shows options to configure the usage of the editor
The Generation menu allow to generate the wiki directly through the editor

Reload the wiki

The "Reload" item allows to parse and reload the whole content of the wiki in the editor with the current content of the roots on the file system. The entire content of the articles tree in the editor will be updated.

If you update the content of the wiki (for example updating articles, adding articles, etc...), the editor will perform an incremental update only for the elements which are concerned by the update (the element and the elements which are using this element), but not the whole wiki.

For example if you remove an article, and this article is referenced by another article by a ref, the article which has the reference will show an error because the reference now leads nowhere.

Performing a "Reload" will update all the content of the wiki and will syncrhonize the content of all its content with what is currently on the file system.

Options menu

Main Article: Editor options

The "Options" menu allows to:

Automatically save the content of XML elements when navigating in the tree. For eaxmple, if you modify the content of an article in the editor, and you select another file in the tree, it will automatically save your changes before switching to the other element
Change the way the dependency window will work

Generation menu

The "Generate" menu allows to Generate the wiki through the editor .

The option to generate will be disabled if the output directory is not defined in the GUI interface:
editor-generate-disabled

Editor toolbar

The toolbar on top of the window allow to manage the content of the wiki and navigate in the wiki content. The toolbar has the following buttons:

: The trash button allows to manage the trash. The trash allows to recover deleted files exactly as in any graphical user interface system
: The Home button allows to navigate to the index article
: The back and forward button allows to navigate back or forward in the articles
: The autocomplete field is an auto-complete Search allowing to search in the articles exactly as in the search box as in the generated wiki
: The editor search button allows to search for elements in the wiki
: The errors navigation buttons allows to navigate in errors in the wiki

The autocomplete field and the editor search work differently:

The autocomplete field is an auto-complete search box as in the generated wiki. It only search for articles, and does not allow to apply filters for the search
The search button allows to specify which element you want to search, and to apply regular expression on the name of element

Editor tree

Main Article: Editor tree

The left panel shows the tree of the Editor window shows the wiki roots.

Editor content panel

Main Article: Editor content panel

The right panel of the Editor window shows the content of the currently selected element in the tree.

Notes

^ Without having to exit the editor