Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 1.98 KB

README.md

File metadata and controls

64 lines (38 loc) · 1.98 KB

blockinfo

Block info plugin for dokuwiki

Installation

You can install this plugin by pasting this URL into dokuwiki's plugin manager:

https://github.com/Onyx47/blockinfo/archive/master.zip

You can also manually copy all the files to:

DOKUWIKI_ROOT/lib/plugins/blockinfo

Usage

Use the following syntax on your page:

<blockinfo>
[<_option_name: option_value>]
[<name: Block name>]
[<image: {{ :namespace:image }} or url>]
[<attribute: value>]
</blockinfo>

Only use one attribute: value pair per line.

No attributes are required, but it is recommended to use at least <name> attribute to set the proper header for the box.

You can use as many custom attributes as you want. You can also use dokuwiki syntax for any value or attribute if syntax parsing is enabled in config.

Configuration

See DOKUWIKI_ROOT/lib/plugins/blockinfo/config/default.php for configuration options.

Note that options will not come into effect until you edit and save an article. This has to be done for each article separately.

It's strongly advised that you tweak the options to your liking BEFORE adding lots of contents.

Option overrides

You can override options set in DOKUWIKI_ROOT/lib/plugins/blockinfo/conf/default.php by using following syntax:

<_option_name: option_value>

For example, to override default attribute uppercase rule and set it to all caps:

<_attr_uppercase: all>

For the list of supported options refer to file DOKUWIKI_ROOT/lib/plugins/blockinfo/conf/default.php

Custom CSS

You can set custom CSS styles in following files:

DOKUWIKI_ROOT/lib/plugins/blockinfo/screen.css for regular website display
DOKUWIKI_ROOT/lib/plugins/blockinfo/style.css for other uses