Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jelovirt/org.lwdita
LwDITA parser for DITA-OT
https://github.com/jelovirt/org.lwdita
dita dita-ot dita-ot-plugin html5 markdown
Last synced: 20 days ago
JSON representation
LwDITA parser for DITA-OT
- Host: GitHub
- URL: https://github.com/jelovirt/org.lwdita
- Owner: jelovirt
- License: apache-2.0
- Created: 2017-10-03T06:54:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T15:47:34.000Z (3 months ago)
- Last Synced: 2024-10-12T19:48:17.519Z (about 1 month ago)
- Topics: dita, dita-ot, dita-ot-plugin, html5, markdown
- Language: XSLT
- Homepage: http://lwdita.org/
- Size: 1.48 MB
- Stars: 25
- Watchers: 14
- Forks: 19
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Lightweight DITA for DITA-OT [](https://github.com/jelovirt/org.lwdita/actions/workflows/test.yml)
The DITA-OT LwDITA plug-in supersedes the previously released [Markdown
plug-in for DITA-OT](https://github.com/jelovirt/dita-ot-markdown) and
adds additional features to support Lightweight DITA.
> **Note**
> The LwDITA plug-in is included in DITA Open Toolkit 3.0 and
newer.
It contains:
- a custom parser for Markdown and HTML to allow using MDITA and HDITA
as a source document format,
- and a transtype to generate Markdown from DITA source.
The Markdown DITA files need to use a subset of Markdown constructs for
compatibility with DITA content models.
## Usage
### Using LwDITA files as input
Markdown DITA or HTML DITA topics can only be used by linking to them in
map files.
```xml
```
The `format` attribute value must be set to `mdita` or `hdita` in order
to recognize files as Markdown DITA or HTML DITA, respectively; the file
extension is not used to recognize format.
See the [syntax
reference](https://github.com/jelovirt/org.lwdita/wiki/Markdown-Syntax-reference)
for XML and Markdown DITA correspondence.
### Generating Markdown output
The DITA-OT LwDITA plug-in extends the DITA Open Toolkit with additional
output formats *(transformation types)* that can be used to publish DITA
content as Markdown.
- To publish Markdown DITA files, use the `markdown` transtype.
- To generate [GitHub Flavored
Markdown](https://help.github.com/categories/writing-on-github/)
files, use the `markdown_github` transtype.
- To publish GitHub Flavored Markdown and generate a `SUMMARY.md` table
of contents file for publication via
[GitBook](https://www.gitbook.com), use the `markdown_gitbook`
transtype.
## Requirements
| LwDITA plug-in | DITA-OT | Java |
|----------------|----------|------|
| ≤ 2.5 | 2.4 | 1.8 |
| ≥ 3.0 | 3.4 | 1.8 |
| ≥ 4.0 | 3.4 | 11 |
| ≥ 5.2 | 3.4 [^1] | 11 |
[^1]: Support MDITA map requires DITA-OT version 4.1.
## Install
1. Run the plug-in installation command:
On DITA-OT version 3.5 and newer:
``` shell
$ dita install org.lwdita
```
On DITA-OT version 3.2–3.4:
``` shell
$ dita --install org.lwdita
```
On DITA-OT version 3.1 and older:
``` shell
$ dita --install https://github.com/jelovirt/org.lwdita/releases/download/2.3.2/org.lwdita-2.3.2.zip
```
The `dita` command line tool requires no additional configuration;
running DITA-OT using Ant requires adding plug-in contributed JAR files
to the `CLASSPATH` with e.g. `-lib plugins/org.lwdita`.
## Build
To build the DITA-OT Markdown plug-in from source:
1. Run the Gradle distribution task to generate the plug-in
distribution package:
``` shell
./gradlew dist
```
The distribution ZIP file is generated under `build/distributions`.
## Release
To release and build distribution:
1. Tag release in `master` branch using semantic version as tag name,
e.g. `1.2.3`.
[GitHub Actions](.github/workflows/dist.yml) will create
* a distribution ZIP and upload it to GitHub Release for the tag,
* a JAR release that is published to [github.com/jelovirt/org.lwdita/packages](https://github.com/jelovirt/org.lwdita/packages/),
* a pull request to [github.com/dita-ot/registry](https://github.com/dita-ot/registry)
to update the release to DITA-OT plug-in registry.
## Donating
Support this project and others by
[@jelovirt](https://github.com/jelovirt) via [GitHub
Sponsors](https://github.com/sponsors/jelovirt).
## License
DITA-OT LwDITA is licensed for use under the [Apache License
2.0](http://www.apache.org/licenses/LICENSE-2.0).