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
plugin:bootnote [2016-01-20 15:36] – [Configuration and Settings] 194.206.55.141plugin:bootnote [2023-08-14 21:59] (current) – old revision restored (2023-05-02 19:17) schplurtz
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
  
-downloadurl: https://github.com/algorys/bootnote/archive/master.zip +downloadurl : https://github.com/algorys/bootnote/archive/master.zip 
-bugtracker : https://github.com/algorys/bootnote/issues +bugtracker  : https://github.com/algorys/bootnote/issues 
-sourcerepo : https://github.com/algorys/bootnote/ +sourcerepo  : https://github.com/algorys/bootnote 
-donationurl: +donationurl : 
  
-screenshot_img : http://s8.postimg.org/quyole85x/bootnote.png+screenshot_img : https://trello.com/1/cards/645142b2d02f2519a8ac515b/attachments/6451431753c92c8b8277fd1c/download/dokuwiki-plugin-bootnote.png
 ---- ----
  
 +===== Requirements =====
 +
 +This plugin does not need any requirements but you need a template like [[template:Bootstrap3]] to display icons in DokuWiki. Otherwise, notes are displayed without icons.
  
 ===== Installation ===== ===== Installation =====
  
-**External requirements:** This plugin needs Bootstrap librairy to work. You need a template like [[template:bootstrap3|Boostrap]] 3 to display it properly in Dokuwiki. +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
- +
-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.+
  
 ===== Syntax ===== ===== Syntax =====
-====Initial Syntax==== 
  
-The basic syntax is the following : ''<bootnote name_lvl>Your text to display inside the note</bootnote>''+==== Initial Syntax ====
  
-You can display actually 6 different types of notes :+The basic syntax is the following:
  
-<code> +  <bootnote argument>Your 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> +
-  * "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]].+**Example:**
  
-====Note Syntax====+  <bootnote learn>Do you want to learn something?</bootnote>
  
-If you have activate 'note' in settings, you must use the following syntax <note>text</note>.+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.
  
-Arguments of [[plugin:note#usage|note]] are working too.+If you want another style of note, please open an [[https://github.com/algorys/bootnote/issues|issue]].
  
 +==== Note Syntax ====
  
-=====Preview===== +If you have activate 'note' in settings, you must use the following syntax''<note>text</note>''.
-{{ http://s8.postimg.org/quyole85x/bootnote.png}} +
-\\ +
-===== Configuration and Settings =====+
  
-You can now choose to override the [[plugin:note|plugin note]] syntax if you have already install. Choose 'note' to activate this fonctionnality for override the note plugin.+Arguments of [[plugin:note#usage|note]] are working too.
  
-You can also deactivate it.+===== Change Log =====
  
-=== Known Bugs and Issues ===+ {{rss>https://github.com/algorys/bootnote/commits/master.atom 5 author date}}
  
-Please report your issue at [[https://github.com/algorys/bootnote/issues|Bootnote]]+===== Preview =====
  
 +{{https://trello.com/1/cards/645142b2d02f2519a8ac515b/attachments/6451431753c92c8b8277fd1c/download/dokuwiki-plugin-bootnote.png?recache|Screenshot}}
 +
 +===== Configuration and Settings =====
  
-===== FAQ =====+  * **bootnote.note**: you can choose to override the [[plugin:Note]] plugin 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.
  
-If you have any question, please ask here. \\+**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
  
 +===== Change Log =====
  
 +{{rss>https://github.com/algorys/bootnote/commits/master.atom 5 author date}}
  
 +===== Known Bugs and Issues =====
  
 +Please report your issue at the [[https://github.com/algorys/bootnote/issues|GitHub]].
  
plugin/bootnote.1453300596.txt.gz · Last modified: 2016-01-20 15:36 by 194.206.55.141

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki