DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:instructions

instructions Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

plugin Provides a highly customizable, standardised instruction

Last updated on
2019-11-15
Provides
Syntax

Similar to textinsert

Tagged with formatting, macro, replace

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Examples/Usage

In combination with a special template, this code generates a simple hint:

{{INSTR<cms_hint>|-Hint|-this is a special hint}}

Or with this code:

{{INSTR<warning>
|- Warning
|- Title of the warning
|- Description of the warning
|- Therefore:
|- • make this
|+ • and perhaps this
|+ • and some more things
}}

… the result with a certain template could be like this:

Syntax

Wiki-Syntax

First the syntax within the wiki page:

{{INSTR<[template]>
|- [parameter 1]
|- [parameter 2a]
|+ [parameter 2b]
|- [parameter n]
}}

or the same in one line:

{{INSTR<[template]>|-[parameter 1]|-[parameter 2a]|+[parameter 2b]|-[parameter n]}}

a) The leading syntax tag is INSTR.

b) After this you have to reference to a specific template (see later)

c) The listed parameters can be normal text. Each parameter is defined in one line that is prefixed by |-.

In addition there are some special markups:

  • Marking text with wiki syntax as bold, italic, underline or code is accepted.
  • Two spaces are interpreted as indentation or gap.
  • Wiki-Links are understood with this syntax: [[namespace:page#section|description]] (description is necessary).
  • If you want to have a line break within one parameter you can achieve this by inserting a new line prefixed by |+.

Template

To work correctly you have to define a template. This is built as html-text and defines the look of the instruction.

a) The first line in the template file has to be the code “<html>”, followed by an optional short description (not more than one line).

b) After this the file contains all parameters that should be processed within the wiki page. When a parameter shall be inserted in the html content just insert a new line and write “param-1” (or “param-2” and so on).

c) At the end of the html file you have to append a line with the code “</html>”. With the tags <html> and </html> at the beginning and the end you can test the content in a normal wiki testing page.

The template has to be placed in a subfolder to “…/lib/plugins/instructions/tpl”. The subfolder name will be the name of the template. The html file name in that folder is “html.txt”. Besides this you can provide images in this folder which can be adressed by your html code with “lib/plugins/instructions/tpl/your_template/image_file”

Here is an example with 5 parameters:

<html> WARNING
<table style="width:100%;"> <tbody> <tr> <td style="width:130px; text-align:center; padding:0px; border-left:none; border-bottom:none; border-top:none;"> <img src="lib/plugins/instructions/tpl/warning/symbol.png" alt="" width="35"> </td> <td style="background-color:#E6E6FA; font-size:16pt; text-transform:uppercase; color:black; vertical-align:middle; padding:0px 5px;"> 
<strong>
param-1
</strong> </td> </tr> 
<tr> <td rowspan="5" style="border-left:none; border-top:none;"> </td> <td> <span style="font-size: large;"> 07 <strong>
param-2
</strong> </span> 
<br>
param-3
</td> </tr> 
<tr> <td style="border-bottom:3px inset lightgrey;"> <em>
param-4
</em> 
<br> 
param-5
</td> </tr> 
</tbody> </table>
</html>

This code is placed here: “lib/plugins/instructions/tpl/warning/html.txt”, and in addition there is an image in the same folder: “lib/plugins/instructions/tpl/warning/symbol.png”.

Placeholders

In addition you can use some placeholders in the wiki page:

@PAGE@ page name
@ID@ ID of the page
@NS@ namespace of the page
@CURNS@ current sub-namespace
@URL_DOKU@ base URL of the wiki installation
@URL_PAGE@ complete URL of the current page

Example:

{{INSTR<my_template>
|- @ID@
|- @PAGE@
|- @NS@
|- @CURNS@
|- @URL_DOKU@
|- @URL_PAGE@
}}

Development

Change Log

  • 2019-10-19: Initial release
  • 2019-11-15: Syntax for placeholders added

Known Bugs and Issues

ToDo/Wish List

FAQ

Discussion

plugin/instructions.txt · Last modified: 2019-11-18 09:37 by juergen_aus_zuendorf