Differences

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

--- plugin:twistienav4bootstrap3 [2019-01-26 20:06] – [Development] paolo.maggio
+++ plugin:twistienav4bootstrap3 [2020-02-18 19:54] – Aleksandr
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: Adds drop-down navigation menus to breadcrumbs when using Bootstrap 3 template
+description: Adds drop-down navigation menus to breadcrumbs when Bootstrap 3 template is used
 author     : paolo.maggio
 email      : maggio.p@gmail.com
@@ Line 11: / Line 11: @@
 conflicts  :
 similar    : twistienav
-tags       : navigation, menu, breadcrumb, index, breadcrumbs
+tags       : navigation, menu, breadcrumb, index
 downloadurl: https://bitbucket.org/paolo_maggio/dwplugin_twistienav4bootstrap3/get/0b3f99058bd8.zip
@@ Line 34: / Line 34: @@
 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.
-===== Examples/Usage =====
+After installation you should check the current template and switch to Bootstrap 3 if you're not using it.
-//[Most people learn by example, so this goes first]//
+===== Template requirements =====
-See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin.
+TwistieNav4Bootstrap3 has been **specifically** developped and tested for Dokuwiki's **Bootstrap 3 template**; it will **not** work with the default template.
-A simple box:
+  * [''You are here''] has to be a collection of links wrapped into a ''div'' with ''<nowiki>dw__youarehere</nowiki>'' class
+  * [''Breadcrumbs''] has to be a collection of links wrapped into a ''div'' with ''<nowiki>dw__breadcrumb</nowiki>'' class
+  * [''pageId''] has to be wrapped into an HTML element (e.g. `<div>`, `<span>`, ...) with ''pageId'' class
-  <box> the box contents </box>
-Some more complex boxes
-  <box 80% round orange|a title> the box contents</box>
-  <box 50% left blue>the box contents</box|a caption>
-  <box 60% round #f99 #fc9 #fcc #f60|title>the box contents></box|caption>
-//[Pictures showing the rendered result will help users to understand]//
-===== Syntax =====
-//[Complete syntax]//
-Basic syntax:
-<code>{{actionlink>action|title}}</code>
-  * **action** can be one of this:
-    * //edit//    --- edit/create/show
-    * //history// --- old revisions
 ===== Configuration and Settings =====
+The plugin has a reasonable configuration preset and it should be not necessary to set any parameters to get it working.
-//[also CSS style tips]//
 ===== Development =====