Differences

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

--- plugin:bootnote [2017-07-18 09:58] – [bootnote Plugin] Algorythm
+++ plugin:bootnote [2023-08-14 21:59] (current) – old revision restored (2023-05-02 19:17) schplurtz
@@ Line 2: / Line 2: @@
 ---- 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 : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
+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 =====
-**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 =====
-====Initial Syntax====
-The basic syntax is the following : ''<bootnote argument>Your note</bootnote>''
+==== Initial Syntax ====
-**Example :** \\
+The basic syntax is the following:
-''<bootnote learn>Do you want to learn something ?</bootnote>''
-You can use actually 6 different types of argument :
+  <bootnote argument>Your note</bootnote>
-  * //"nothing"// : if there is no argument, display a simple note with info sign.
+**Example:**
+  <bootnote learn>Do you want to learn something?</bootnote>
-  * **web** : display a note with an globe sign.
+You can use actually 6 different types of **argument:**
-  * **question** : display a note with question sign.
+  - //"nothing"//: if there is no argument, display a simple note with info sign.
-  * **learn** or **tip** : display note with an education sign.
+  - **web**: display a note with an globe sign.
-  * **warning**: display a note with a warning sign.
+  - **question**: display a note with question sign.
-  * **critical** or **important** : display a note with a fire 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.
 If you want another style of note, please open an [[https://github.com/algorys/bootnote/issues|issue]].
-====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.
-=== Change Log ===
+===== Change Log =====
  {{rss>https://github.com/algorys/bootnote/commits/master.atom 5 author date}}
-=====Preview=====
+===== Preview =====
-{{ http://s8.postimg.org/quyole85x/bootnote.png}}
+{{https://trello.com/1/cards/645142b2d02f2519a8ac515b/attachments/6451431753c92c8b8277fd1c/download/dokuwiki-plugin-bootnote.png?recache|Screenshot}}
 ===== 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.
+  * **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.)
-You can also deactivate it.
+  * **bootnote.position**: defines if you want to display your text beside or below the note title.
-=== Known Bugs and Issues ===
-Please report your issue at [[https://github.com/algorys/bootnote/issues|Bootnote]]
-===== FAQ =====
-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]].