Skip to content

Commit

Permalink
Update syntax and theme
Browse files Browse the repository at this point in the history
  • Loading branch information
algorys committed Aug 8, 2017
1 parent 79aeaad commit 4f674a5
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,29 @@ Download this plugin into your ``${dokuwiki_root}/lib/plugins`` folder and resta

## Requirements

This plugin needs Bootstrap librairy to work. You need a template like [Boostrap 3](https://github.com/LotarProject/dokuwiki-template-bootstrap3/) to display it properly in Dokuwiki.
This plugin does not need any requirements but you need a template like [Boostrap 3](https://github.com/LotarProject/dokuwiki-template-bootstrap3/) to display icons in Dokuwiki. Otherwise, notes are displayed without icons.

## Syntax

You can display actually 6 different types of notes :
* Web : display a note with an globe sign : ``<bootnote lvl="web">...Note...</bootnote>``
* Question : display a note with question sign : ``<bootnote lvl="question">...Note...</bootnote>``
* Learn : display note with an education sign : ``<bootnote lvl="learn">...Note...</bootnote>``
* Warning : display a note with a warning sign : ``<bootnote lvl="warning">...Note...</bootnote>``
* Critical : display a note with a fire sign ``<bootnote lvl="critical">...Note...</bootnote>``
* "nothing" : display a simple note with info sign : ``<bootnote>...Note...</bootnote>``

* "nothing" : display a simple note with info sign : `<bootnote>...Note...</bootnote>`
* Web : display a note with an globe sign : `<bootnote web>...Note...</bootnote>`
* Question : display a note with question sign : `<bootnote question>...Note...</bootnote>`
* Learn : display note with an education sign : ``<bootnote learn>...Note...</bootnote>``
* Warning : display a note with a warning sign : ``<bootnote warning>...Note...</bootnote>``
* Critical : display a note with a fire sign ``<bootnote critical>...Note...</bootnote>``

**Note :** If you want more type of note, please let me know by opening an issue in this repos.

## Current Render

Here is a preview of each note :
![](http://s8.postimg.org/quyole85x/bootnote.png)

![new-bootnote.png](https://s2.postimg.org/aguld4eah/new-bootnote.png)

And here the old theme, always available in settings. this theme is deprecated for Dokuwiki theme and only works properly with a bootstrap thème !

![old-bootnote](http://s8.postimg.org/quyole85x/bootnote.png)

For further information, see also [Bootnote on dokuwiki.org](https://www.dokuwiki.org/plugin:bootnote)

0 comments on commit 4f674a5

Please sign in to comment.