DITA Bootstrap Extension

DITA Bootstrap Extension is a DITA Open Toolkit plug-in that extends the DITA Bootstrap HTML output with additional features from the Bootstrap Extension library.

• Installation
  • Installing DITA-OT
  • Installing the Plug-in
• Using
  • Optional elements
  • Common Bootstrap utility classes
• License

Installation

The DITA Bootstrap Extension plug-in has been tested with DITA-OT 4.x. Use the latest version for best results.

Installing DITA-OT

1. Download the latest distribution package from the project website at dita-ot.org/download.

2. Extract the contents of the package to the directory where you want to install DITA-OT.

3. Optional: Add the absolute path for the bin directory to the PATH system variable.

   This defines the necessary environment variable to run the dita command from the command line.

See the DITA-OT documentation for detailed installation instructions.

Installing the Plug-in

• Run the plug-in installation commands:

dita install fox.jason.extend.css
dita install dita-bootstrap
dita install https://github.com/infotexture/dita-bootstrap.extension/archive/develop.zip

Using

Specify the html5-bootstrap format when building output with the dita command:

dita --input=path/to/your.ditamap \
     --format=html5-bootstrap

Optional elements

The optional toTop button can be included with the following parameter:

• to-top.include – add a toTop button that scrolls to the top of the page

Common Bootstrap utility classes

The HTML output can be annotated with common Bootstrap utility classes using additional command line parameters:

• bootstrap.css.to-top – common Bootstrap utility classes for the toTop button

License

Apache 2.0 © 2024 Jason Fox

The generated HTML created by this software includes the following additional software components which are obtained under license:

• Bootstrap Extension – https://github.com/bootstrapextension/bootstrap-extension – MIT license

Within the documentation, where necessary, the texts describing the Bootstrap Extension usage of each component have been copied directly from the Bootstrap Extension documentation however DITA markup is used throughout the examples describing how to implement these components correctly using outputclass. The text is therefore a derivative of "Bootstrap Extension docs" by AKK IT, Inc, and used under MIT.