Backend Attributes

Name Description

navinfo, navinfo1, navinfo2

These three attributes control which navigation information files will be included in the output file:

navinfo
Include <filename>-navinfo.html
navinfo1
Include navinfo.html
navinfo2
Include navinfo.html and <filename>-navinfo.html

Where <filename> is the file name (without extension) of the AsciiDoc input file.

The following example will include a navinfo.html and mydoc-navinfo.html navinfo files in the HTML output file:

$ asciidoc -b bootstrap -a navinfo2 mydoc.txt

jumboinfo, jumboinfo1, jumboinfo2

These three attributes control which jumbotron information files will be included in the output file:

jumboinfo
Include <filename>-jumboinfo.html
jumboinfo1
Include jumboinfo.html
jumboinfo2
Include jumboinfo.html and <filename>-jumboinfo.html

Where <filename> is the file name (without extension) of the AsciiDoc input file.

The following example will include a jumboinfo.html and mydoc-jumboinfo.html jumboinfo files in the HTML output file:

$ asciidoc -b bootstrap -a jumboinfo2 mydoc.txt

footer

This attribute control which footer informations will be included in the output file:

If not defined, then it will be the default footer with the version and last updated informations.

footer
Include footer.html

The following example will include the footer.html file in the HTML output file:

$ asciidoc -b bootstrap -a footer mydoc.txt

totop

This attribute control which back to top system you want to include in the output file.

when attribute unset
Include a Back to top standard html href link
when attribute set
Used the UItoTop jQuery plugin.

The following example will include a dynamic clickable area in the HTML output file:

$ asciidoc -b bootstrap -a totop mydoc.txt

themeswitcher

This attribute allow to used a Bootstrap Theme Switcher with the jQuery plugin.

brandver

This attribute control whether you want to include a dynamic versions list in the output file. A versions.html file must exists.

The following example will not include a static versions list, identified by the navinfo.html, in the HTML output file (default behavior):

$ asciidoc -b bootstrap -a brandver! mydoc.txt

Examples

Jumbotron

Learn more at the Jumbotron Bootstrap Component page.

Navigation bar

Example of left navigation menu: document-structure-navinfo.html
            <ul class="nav navbar-nav">
                <li>
                    <a href="callouts.html"><span class="glyphicon glyphicon-forward"></span> Callouts</a>
                </li>
            </ul>
Example of right navigation menu: navinfo.html
            <ul class="nav navbar-nav">
                <li class="dropdown">
                    <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-tag"></span> Versions <b class="caret"></b></a>
                    <ul class="dropdown-menu" id="dropdown-menu-versions" role="menu" aria-labelledby="drop1">
                    </ul>
                </li>
            </ul>
            <ul class="nav navbar-nav">
                <li>
                    <a href="index.html"><span class="glyphicon glyphicon-home"></span> Home</a>
                </li>
            </ul>
            <ul class="nav navbar-nav navbar-right hidden-xs hidden-sm">
                <li>
                    <a href="http://laurent-laville.org/asciidoc/bootstrap/expo/"><span class="glyphicon glyphicon-tint"></span> Expo</a>
                </li>
                <li>
                    <a href="http://laurent-laville.org/asciidoc/bootstrap/blog/"><span class="glyphicon glyphicon-bullhorn"></span> Blog</a>
                </li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-leaf"></span> Themes <b class="caret"></b></a>
                    <ul class="dropdown-menu" id="ThemeList">
                    </ul>
                </li>
            </ul>

Footer

Example of footer file: footer.html
<div class="row">
    <div class="col-md-5">
        <h3>Social</h3>
        <ul class="fa-ul">
            <li>
                <span class="fa-stack fa-lg">
                    <i class="fa fa-github fa-stack-2x"></i>
                </span>
                <a href="{gitproject}/issues">Report an issue</a>
            </li>
            <li>
                <span class="fa-stack fa-lg">
                    <i class="fa fa-bullhorn fa-stack-2x"></i>
                </span>
                <a href="http://www.laurent-laville.org/asciidoc/bootstrap/blog/">Blog</a>
            </li>
        </ul>
    </div>
    <div class="col-md-7">
        <h3>About Us</h3>
        <ul class="fa-ul">
            <li>
                <span class="fa-stack fa-lg">
                    <i class="fa fa-star-o fa-stack-2x"></i>
                </span>
Thanks to Dan Allen who wrote the <a href="https://github.com/mojavelinux/asciidoc-bootstrap-docs-backend">first version</a>
on December 2012, and do my dream a reality.
            </li>
            <li>
                <span class="fa-stack fa-lg">
                    <i class="fa fa-star fa-stack-2x"></i>
                </span>
<a href="https://github.com/llaville">Laurent Laville</a> is current lead developer since release 1.1.0 on December 17th 2012.
            </li>
        </ul>
    </div>
</div>
<div class="row">&nbsp;</div>
<div class="row">
    <div class="col-md-9">
        <div id="footer-text">
            Version <span class="badge">{revnumber}</span><br>
            Last updated {docdate} {doctime}<br>
            Built with <a href="{brandref}">AsciiDoc-Bootstrap backend</a> {bootstrap-backend-version}
        </div>
    </div>
    <div class="col-md-3">
        <div id="footer-badges">
            Valid <a href="http://validator.w3.org/check?uri=referer">XHTML</a>
            and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a>.
        </div>
    </div>
</div>