Differences

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

--- plugin:twistienav4bootstrap3 [2019-01-26 20:07] – [Syntax] paolo.maggio
+++ plugin:twistienav4bootstrap3 [2020-06-06 15:34] – trailjeep
@@ 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
+author     : Traailjeep
-email      : maggio.p@gmail.com
+email      : trailjeep@gmail.com
 type       : Action
-lastupdate : 2019-01-26
+lastupdate : 2020-06-06
-compatible : Greebo
+compatible : Greebo, hogfather
-depends    :
+depends    : bootstrap3 template
 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
+downloadurl: https://github.com/trailjeep/dokuwiki-plugin-twistienav4bootstrap3/archive/master.zip
-bugtracker : https://bitbucket.org/paolo_maggio/dwplugin_twistienav4bootstrap3/issues
+bugtracker : https://github.com/trailjeep/dokuwiki-plugin-twistienav4bootstrap3/issues
-sourcerepo : https://bitbucket.org/paolo_maggio/dwplugin_twistienav4bootstrap3/downloads/
+sourcerepo : https://github.com/trailjeep/dokuwiki-plugin-twistienav4bootstrap3
 donationurl:
@@ Line 23: / Line 23: @@
 This plugin is an adaptation of the twistienav plugin, to make it works with the Bootstrap3 template.
-After installation you will find small glyphs after breadcrumbs concerning a namespace that contains more than a start page.
+After installation you will find small glyphs after breadcrumbs concerning a namespace that contains more than a start page. Clicking on that glyph will display a small pop-up containing an index of the related namespace. It works both for “you are here” type breadcrumbs and for regular breadcrumbs.
-Clicking on that glyph will display a small pop-up containing an index of the related namespace.
+===== Previous Authors =====
-It works both for “you are here” type breadcrumbs and for regular breadcrumbs.
+  * paolo.maggio <maggio.p@gmail.com> [[https://bitbucket.org/paolo_maggio/dwplugin_twistienav4bootstrap3/downloads/|Source]]
+===== Changes =====
+{{rss>https://github.com/trailjeep/dokuwiki-plugin-twistienav4bootstrap3/commits/master.atom date 5}}
 ===== Installation =====
@@ Line 34: / Line 37: @@
 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:
-  <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]//
+  * [''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
 ===== Configuration and Settings =====
-//[also CSS style tips]//
+The plugin has a reasonable configuration preset and it should be not necessary to set any parameters to get it working.
-===== Development =====
-=== Change Log ===
-  * **2019-01-26**
-    * Initial release
 ===== FAQ =====