====== Bootstrap Wrapper Plugin ======

---- plugin ----
description: Useful plugin for add several Bootstrap components (Jumbotron, Alerts, Panels, Nav & Tabs, etc) to DokuWiki especially in combination with a Bootstrap template
author     : Giuseppe Di Terlizzi 
email      : giuseppe.diterlizzi@gmail.com 
type       : syntax, action
lastupdate : 2022-09-22
compatible : Igor, Hogfather, Greebo, Frusterick Manners, Elenor of Tsort, Detritus, Weatherwax, Hrun
depends    : 
conflicts  : caption, alertbox
similar    : mikioplugin, wrap
tags       : alert, annotations, bootstrap, boxes, button, dropdown, formatting, grids, hide, highlight, icons, jumbotron, language, nav, printing, style, tabs, thumbnail, typography, wrap, callouts, modal, popover

downloadurl: https://github.com/LotarProject/dokuwiki-plugin-bootswrapper/zipball/master
bugtracker : https://github.com/LotarProject/dokuwiki-plugin-bootswrapper/issues
sourcerepo : https://github.com/LotarProject/dokuwiki-plugin-bootswrapper/
donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9LJDLVSNGYSA2

screenshot_img : 
----

Useful plugin for adding several Bootstrap components (Jumbotron, Alert, Panel) to DokuWiki especially in combination with a Bootstrap template ([[:template:bootstrap3|Bootstrap3]]).

:!: **Note**: This plugin will only work with Bootstrap-compatible templates, of which the default DokuWiki template is not one.

This plugin adds to your DokuWiki, several Bootstrap components:

  * [[#Jumbotron]]
  * [[#button|Buttons]]
  * [[#alert|Alerts]]
  * [[#Text]]
  * [[#tooltip|Tooltips]]
  * [[#Grids]]
  * [[#thumbnail|Thumbnails]]
  * [[#panel|Panels]]
  * [[#well|Wells]]
  * Labels
  * [[#nav|Nav & Tabs (with dropdown)]]
  * Page heading
  * Lead
  * Badges
  * List Group
  * Progress Bars
  * Affix
  * Carousel
  * [[#accordion|Accordion]]
  * Callouts
  * Modal (with ''remote'' attribute)
  * Popover


===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

**NOTE**: This plugin require ''SimpleXML'' PHP module. You can install it using a package manager of your Linux distribution.

Run this command to check if the module is installed in your system:

<code>
php -m | grep -i simplexml
</code>

===== Examples/Usage =====

===== Syntax =====

For complete samples and syntax, visit http://www.lotar.altervista.org/dokuwiki/wiki/plugin/bootswrapper.

==== Jumbotron ====

<code>
<jumbotron>
===== Hello, world! =====

This is a simple hero unit, a simple jumbotron-style 
component for calling extra attention to featured
content or information.
</jumbotron>
</code>

==== Panel ====

<code>
<panel type="default" title="Title of Panel" subtitle="Subtitle" icon="fa fa-home">
Panel content
</panel>
</code>

==== Alert ====

<code><alert type="success" icon="glyphicon glyphicon-user" dismiss="true">
**Well done!** You successfully read this important alert message.
</alert></code>

==== Text ====

<code>
  * <text type="muted">muted</text>
  * <text type="primary">primary</text>
  * <text type="success">success</text>
  * <text type="info">info</text>
  * <text type="warning">warning</text>
  * <text type="danger">danger</text>
</code>

==== Tooltip ====

<code><tooltip title="Sample Text" placement="bottom">Lorem ipsum</tooltip> dolor sit amet...</code>

==== Grids ====

<code><grid>
<col sm="6">.col-sm-6</col>
<col sm="6">.col-sm-6</col>
</grid></code>

<code><grid>
<col xs="12" sm="6" lg="8">.col-xs-12 .col-sm-6 .col-lg-8</col>
<col xs="6" lg="4">.col-xs-6 .col-lg-4</col>
</grid></code>

==== Thumbnail ====

<code><grid>
...
<col xs="6" md="3">
<thumbnail>
{{ wiki:dokuwiki-128.png }}
</thumbnail>
</col>
...
</grid></code>

<code><grid>
...
<col xs="6" md="3">
<thumbnail>
{{ wiki:dokuwiki-128.png }}
<caption>
=== DokuWiki ===

//DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.//
</caption>
</thumbnail>
...
</col>
</grid></code>

==== Well ====

<code><well>Look, I'm in a well!</well></code>

==== Button ====

<code><button type="success" size="lg" icon="glyphicon glyphicon-edit">[[:wiki:welcome]]</button></code>

==== Nav ====

<code><nav>
  * [[:start]]
  * [[:plugin:bootswrapper|Plugin]]
  * [[playground:playground]]
  * DokuWiki
    * [[:wiki:welcome]]
    * [[:wiki:syntax]]
</nav></code>

==== Accordion ====
<code><accordion>
<panel title="First panel">
First panel content
</panel>
<panel title="Second panel">
Second panel content
</panel>
</accordion></code>


===== Development =====

[[https://travis-ci.org/LotarProject/dokuwiki-plugin-bootswrapper|{{  https://travis-ci.org/LotarProject/dokuwiki-plugin-bootswrapper.png?nocache|Build Status}}]]

=== Change Log ===

{{rss>https://github.com/LotarProject/dokuwiki-plugin-bootswrapper/commits/master.atom author date}}

=== Known Bugs and Issues ===

Please report bugs or feature requests at the [[https://github.com/LotarProject/dokuwiki-plugin-bootswrapper/issues|Bug tracker]].

=== ToDo/Wish List ===

  * <del>Add support to Nav</del>
  * <del>Improve support to Tab</del>
  * <del>Add support to Collapse / Accordion</del>
  * Add support to PopupOver
  * Add support to DropDown
  * <del>Add support to Progress Bar</del>
  * Add support to Breadcrumbs
  * <del>Add support to Badges</del>
  * <del>Add support to List Group</del>
  * <del>Add support to Carousel</del>

===== FAQ =====

===== Discussion =====

==== Image sizes ====

What image sizes should we use for jumbotron background?

==== Jumbotron and dw2pdf ====

Printing the web page makes appear jumbotron. But building the PDF with dw2pdf does it not. What should I do to make it work?

Further to this, could full support for dw2pdf be added so that all the feature styles map across?

==== Accordion collapsible function ====

Hello, thank you for your plugin, it's really useful. I wondering whether there is an option to start the accordion so that **all** the panels are collapsed by default? Using the collapsible function the first panel in the accordion is always open and the rest is collapsed. I was thinking about a workaround with the "collapse button" function but maybe there is another way? - Thanks, Arkul

===== See also =====

  * [[http://glyphicons.com/|Glyphicons]]