Differences

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

--- plugin:twistienav4bootstrap3 [2019-01-26 19:55] – created 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 21: / Line 21: @@
 ----
-//:!: This template contains various hints on how to fill in data (formatted in italics). Be sure to remove the hints and unwanted sections (Eg. the Syntax/Example section for non-syntax plugins.//
+This plugin is an adaptation of the twistienav plugin, to make it works with the Bootstrap3 template.
-===== Installation =====
+After installation you will find small glyphs after breadcrumbs concerning a namespace that contains more than a start page.
-//[First, last and only chance to warn users before installing (some has already done that before reading this)]//
+Clicking on that glyph will display a small pop-up containing an index of the related namespace.
-:!: **External requirements:** This plugin requires the following additional components that must be installed separately:
+It works both for “you are here” type breadcrumbs and for regular breadcrumbs.
-  * [[A banana]]
-  * [[Another banana]]
-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 =====
+===== Installation =====
-//[Most people learn by example, so this goes first]//
+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.
-See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin.
+After installation you should check the current template and switch to Bootstrap 3 if you're not using it.
-A simple box:
+===== Template requirements =====
-  <box> the box contents </box>
+TwistieNav4Bootstrap3 has been **specifically** developped and tested for Dokuwiki's **Bootstrap 3 template**; it will **not** work with the default template.
-Some more complex boxes
+  * [''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 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 =====
-//[downloadable blocks, development comments]//
 === Change Log ===
-//[preferable GitHub RSS feed or similar]//
+  * **2019-01-26**
-  * **2009-01-01**
     * Initial release
-=== Known Bugs and Issues ===
-//[this section might not be needed in case of external bug manager, or use RSS feed]//
-=== ToDo/Wish List ===
-//[developers roadmap]//
 ===== FAQ =====
-//[discussions should ideally be deleted and turned into FAQ entries along the way]//
+:?: I've installed the plugin but nothing changed ! There are no glyphs near the breadcrumb links ...
-===== Discussion =====
-//Could be placed on an external page (e.g. plugin:pluginname:discussion) to have a distinction between user comments and author docs//
+:!: The glyphs are added searching the DOM for the specific classes used by the Bootstrap 3 template. The plugin will not work when the standard template is used; it should work with any template derived from Bootstrap 3.