Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/infotexture/dita-bootstrap.extension
Add the Bootstrap Extension library to support additional features that are not included in the DITA Bootstrap plug-in
https://github.com/infotexture/dita-bootstrap.extension
Last synced: 2 days ago
JSON representation
Add the Bootstrap Extension library to support additional features that are not included in the DITA Bootstrap plug-in
- Host: GitHub
- URL: https://github.com/infotexture/dita-bootstrap.extension
- Owner: infotexture
- License: apache-2.0
- Created: 2024-01-02T09:29:00.000Z (11 months ago)
- Default Branch: develop
- Last Pushed: 2024-11-10T20:35:19.000Z (6 days ago)
- Last Synced: 2024-11-10T21:18:22.611Z (6 days ago)
- Language: XSLT
- Homepage: https://infotexture.github.io/dita-bootstrap.extension/
- Size: 451 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DITA Bootstrap Extension
_DITA Bootstrap Extension_ is a [DITA Open Toolkit plug-in](https://www.dita-ot.org/plugins) that extends the [DITA Bootstrap](https://infotexture.github.io/dita-bootstrap/) HTML output with additional features from the [Bootstrap Extension](https://bootstrapextensions.com) library.
- [Installation](#installation)
- [Installing DITA-OT](#installing-dita-ot)
- [Installing the Plug-in](#installing-the-plug-in)
- [Using](#using)
- [Optional elements](#optional-elements)
- [Common Bootstrap utility classes](#common-bootstrap-utility-classes)
- [License](#license)
## Installation
The _DITA Bootstrap Extension_ plug-in has been tested with [DITA-OT 4.x](https://www.dita-ot.org/download). 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](https://www.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](https://www.dita-ot.org/dev/topics/installing-client.html) for detailed installation instructions.
### Installing the Plug-in
- Run the plug-in installation commands:
```console
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:
```console
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](LICENSE) © 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](https://bootstrapextensions.com/) 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.