org
所属分类:collect
开发工具:XSLT
文件大小:0KB
下载次数:0
上传日期:2023-07-01 12:36:33
上 传 者:
sh-1993
说明: DITA-OT的LwDITA解析器,
(LwDITA parser for DITA-OT,)
文件列表:
.prettierignore (6, 2023-12-26)
.prettierrc (16, 2023-12-26)
.sdkmanrc (124, 2023-12-26)
Gemfile (49, 2023-12-26)
LICENSE (11325, 2023-12-26)
NOTICES (439, 2023-12-26)
build.gradle (7274, 2023-12-26)
gradle/ (0, 2023-12-26)
gradle/wrapper/ (0, 2023-12-26)
gradle/wrapper/gradle-wrapper.jar (51018, 2023-12-26)
gradle/wrapper/gradle-wrapper.properties (202, 2023-12-26)
gradlew (5080, 2023-12-26)
gradlew.bat (2314, 2023-12-26)
licenses/ (0, 2023-12-26)
licenses/autolink-license.txt (1081, 2023-12-26)
licenses/flexmark-license.txt (1372, 2023-12-26)
licenses/htmlparser-license.txt (4643, 2023-12-26)
package-lock.json (2406, 2023-12-26)
package.json (179, 2023-12-26)
settings.gradle (33, 2023-12-26)
src/ (0, 2023-12-26)
src/main/ (0, 2023-12-26)
src/main/build-html_template.xml (7815, 2023-12-26)
src/main/build-markdown_template.xml (6988, 2023-12-26)
src/main/conductor.xml (131, 2023-12-26)
src/main/java/ (0, 2023-12-26)
src/main/java/com/ (0, 2023-12-26)
src/main/java/com/elovirta/ (0, 2023-12-26)
src/main/java/com/elovirta/dita/ (0, 2023-12-26)
src/main/java/com/elovirta/dita/html/ (0, 2023-12-26)
src/main/java/com/elovirta/dita/html/HDitaReader.java (250, 2023-12-26)
src/main/java/com/elovirta/dita/html/HtmlReader.java (4878, 2023-12-26)
... ...
# Lightweight DITA for DITA-OT [![Test](https://github.com/jelovirt/org.lwdita/actions/workflows/test.yml/badge.svg)](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).
近期下载者:
相关文件:
收藏者: