DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:bootnote

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
plugin:bootnote [2016-01-20 15:36]
194.206.55.141 [Configuration and Settings]
plugin:bootnote [2020-10-08 21:03]
Aleksandr
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Bootnote allow you to create note with Bootstrap style+description: Bootnote allow you to create note with Bootstrap style
 author     : Algorythm  author     : Algorythm 
 email      : ttamalfor@gmail.com  email      : ttamalfor@gmail.com 
 type       : syntax type       : syntax
-lastupdate : 2016-01-20 +lastupdate : 2017-08-08 
-compatible : Detritus, Hrun, Ponder Stibbons+compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : wrap, note, box, bootswrapper, alertbox+similar    : wrap, note, box, bootswrapper, alertbox, admnote
 tags       : note, bootstrap, tips tags       : note, bootstrap, tips
  
Line 18: Line 18:
 donationurl:  donationurl: 
  
-screenshot_img : http://s8.postimg.org/quyole85x/bootnote.png+screenshot_img : https://s2.postimg.org/aguld4eah/new-bootnote.png
 ---- ----
  
  
-===== Installation =====+===== Requirements =====
  
-**External requirements:** This plugin needs Bootstrap librairy to work. You need a template like [[template:bootstrap3|Boostrap]] to display it properly in Dokuwiki.+This plugin does not need any requirements but you need a template like [[template:bootstrap3|Boostrap3]] to display icons in Dokuwiki. Otherwise, notes are displayed without icons.
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+===== Installation ===== 
 + 
 +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Syntax ===== ===== Syntax =====
 ====Initial Syntax==== ====Initial Syntax====
  
-The basic syntax is the following : ''<bootnote name_lvl>Your text to display inside the note</bootnote>''+The basic syntax is the following : ''<bootnote argument>Your note</bootnote>''
  
-You can display actually 6 different types of notes :+**Example :** \\ 
 +''<bootnote learn>Do you want to learn something ?</bootnote>'' 
 + 
 +You can use actually 6 different types of argument : 
 + 
 +  * //"nothing"// : if there is no argument, display a simple note with info sign. 
 + 
 + 
 +  * **web** : display a note with an globe sign. 
 +  * **question** : display a note with question sign. 
 +  * **learn** or **tip** : display note with an education sign. 
 +  * **warning**: display a note with a warning sign. 
 +  * **critical** or **important** : display a note with a fire sign.
  
-<code> 
-  * 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> 
-  * "nothing" : display a simple note with info sign : <bootnote>...Note...</bootnote> 
-</code> 
  
 If you want another style of note, please open an [[https://github.com/algorys/bootnote/issues|issue]]. If you want another style of note, please open an [[https://github.com/algorys/bootnote/issues|issue]].
Line 48: Line 54:
 ====Note Syntax==== ====Note Syntax====
  
-If you have activate 'note' in settings, you must use the following syntax : <note>text</note>.+If you have activate 'note' in settings, you must use the following syntax : ''<note>text</note>''.
  
 Arguments of [[plugin:note#usage|note]] are working too. Arguments of [[plugin:note#usage|note]] are working too.
  
 +=== Change Log ===
 +
 + {{rss>https://github.com/algorys/bootnote/commits/master.atom 5 author date}}
  
 =====Preview===== =====Preview=====
-{{ http://s8.postimg.org/quyole85x/bootnote.png}} + 
-\\+{{ https://s2.postimg.org/aguld4eah/new-bootnote.png }} 
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
  
-You can now choose to ovveride the [[plugin:note|plugin note]] syntax if you have already installChoose 'note' to activate this fonctionnality for override the note plugin.+  * **bootnote.note**: You can choose to override the plugin [[plugin:note|note]] in settings to continue using its syntax
 +  * **bootnote.theme**: you can come back to old theme if you want(See below for further informations) 
 +  * **bootnote.position**: defines if you want to display your text beside or below the note title.
  
-You can also deactivate it.+**Old Theme:** The old theme is always available in settings but he's deprecated for Dokuwiki theme and only works properly with a Bootstrap theme ! This theme may be removed in future versions
  
-=== Known Bugs and Issues ===+===== Change Log =====
  
-Please report your issue at [[https://github.com/algorys/bootnote/issues|Bootnote]]+{{rss>https://github.com/algorys/bootnote/commits/master.atom 5 author date}}
  
  
-===== FAQ =====+==== Known Bugs and Issues ====
  
-If you have any question, please ask here\\+Please report your issue at [[https://github.com/algorys/bootnote/issues|Bootnote]]
  
  
plugin/bootnote.txt · Last modified: 2020-10-08 21:03 by Aleksandr