This shows you the differences between two versions of the page.
docs:adminman [2017/09/19 14:31] |
docs:adminman [2022/03/23 16:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Admin manual ====== | ||
+ | ===== Design ===== | ||
+ | Loki was designed as an extension of the [[http:// | ||
+ | There are several kinds of plugins avaliable in DokuWiki: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | Loki is implemented as a syntax plugin and renderer plugin. Figure below shows how Loki works: | ||
+ | |||
+ | {{ .: | ||
+ | |||
+ | According to the standard operation procedure of DokuWiki, text received on input is fed to lexical analyser (Lexer) which identifies the special wiki markups. Found markups are translated into instructions for renderer and parsed by the parser. The processed text is displayed by the renderer so that the page can be viewed by the user. Loki is integrated with this system at the phase of the lexical and renderer analysis. Loki extends basic DokuWiki syntax by adding ''< | ||
+ | |||
+ | ===== Implementation ===== | ||
+ | **Syntax plugin** - '' | ||
+ | |||
+ | ^ Name ^ Description^ | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |||
+ | **Renderer plugin** - '' | ||
+ | |||
+ | ^ Name ^ Description^ | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |||
+ | Moreover, both classes includes following method: | ||
+ | * '' | ||
+ | |||
+ | **Prolog rules** - '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | '' | ||
+ | '' | ||
+ | |||
+ | **Wiki text editor toolbar** - '' | ||
+ | |||
+ | {{ .: | ||
+ | |||
+ | **Action plugin** - '' | ||
+ | < | ||
+ | Loki action plugin uses the '' | ||
+ | |||
+ | **Used directories**. | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | ===== Files created by users ===== | ||
+ | Sometimes there is possibility to create aditional file on the server hard drive. | ||
+ | ==== Prolog ==== | ||
+ | First possibility is to create file related with current DokuWiki page. It can help to built the knowledge base. All code between ''< | ||
+ | < | ||
+ | <pl cache=" | ||
+ | woman(kate). | ||
+ | woman(ann). | ||
+ | man(eric). | ||
+ | </pl> | ||
+ | </ | ||
+ | |||
+ | To refer to created file use scope option in ''< | ||
+ | |||
+ | < | ||
+ | |||
+ | This code will be replaced with a result as in the first example from [[http:// | ||
+ | |||
+ | ==== Debugging ==== | ||
+ | Sometimes there could be useful to save result of debugging in file. Using debugging functions was described in [[http:// | ||
+ | * '' | ||
+ | Example: | ||
+ | < | ||
+ | Result will be saved on file located in '' | ||
+ | |||
+ | ===== Download and Installation ===== | ||
+ | Loki is developed as a plugin to the [[http:// | ||
+ | ==== Requirements ==== | ||
+ | * Working [[http:// | ||
+ | * SWI [[http:// | ||
+ | ==== Download ==== | ||
+ | Avaliable Loki sources: | ||
+ | * Public URL: http:// | ||
+ | * CVS: **For authorized users** the Loki may be obtained from [[http:// | ||
+ | ==== Installation ==== | ||
+ | You can install Loki using [[http:// | ||
+ | ==== Configuration ==== | ||
+ | * In [[http:// | ||
+ | * Put the **loki.php** and **smw.php** files in the **$DOKUWIKI_HOME$/ |