Watermark Plugin for DITA Bootstrap

This is a DITA-OT Plug-in to add a watermark to generated HTML. The plugin extends the DITA Bootstrap HTML.

Table of Contents

• Install
  • Installing DITA-OT
  • Installing the Plug-in
• Usage
  • Parameter Reference
• License

Install

The DITA Bootstrap Watermark plug-in has been tested against DITA-OT 3.x. It is recommended that you upgrade to the latest version.

Installing DITA-OT

The DITA Bootstrap Watermark plug-in is a plug-in for the DITA Open Toolkit.

• Full installation instructions for downloading DITA-OT can be found here.

  1. Download the dita-ot-4.1.zip 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.

curl -LO https://github.com/dita-ot/dita-ot/releases/download/4.1/dita-ot-4.1.zip
unzip -q dita-ot-4.1.zip
rm dita-ot-4.1.zip

Installing the Plug-in

• Run the plug-in installation commands:

dita install fox.jason.extend.css
dita install org.dita-bootstrap.html
dita install org.dita-bootstrap.watermark

The dita command line tool requires no additional configuration.

---

Usage

The plugin extends Bootstrap HTML processing:

PATH_TO_DITA_OT/bin/dita -f html5-bootstrap \
  -i document.ditamap \
  --bootstrap.watermark=draft|review|final|none

By default the output HTML will be watermarked as a DRAFT

Parameter Reference

• bootstrap.watermark - Decides which watermark to use:
  • draft - Adds a watermark stating DRAFT DOCUMENT
  • review - Adds a watermark stating Copy for review only
  • final - Adds a sidebar footer only
  • none - Does not add any watermarks

License

Apache 2.0 © 2023-2026 Jason Fox