Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jason-fox/fox.jason.unit-test
Unit Testing and Code Coverage Framework for DITA Open Toolkit Plugins
https://github.com/jason-fox/fox.jason.unit-test
code-coverage coverage dita-ot dita-ot-plugin testing unit-testing
Last synced: 14 days ago
JSON representation
Unit Testing and Code Coverage Framework for DITA Open Toolkit Plugins
- Host: GitHub
- URL: https://github.com/jason-fox/fox.jason.unit-test
- Owner: jason-fox
- License: apache-2.0
- Created: 2018-04-14T17:19:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T07:41:45.000Z (10 months ago)
- Last Synced: 2024-10-21T14:33:15.986Z (2 months ago)
- Topics: code-coverage, coverage, dita-ot, dita-ot-plugin, testing, unit-testing
- Language: XSLT
- Homepage: https://jason-fox.github.io/dita-ot-plugins/unit-test
- Size: 4.88 MB
- Stars: 5
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unit Test Framework for DITA-OT [
](https://unit-test-framework-for-dita-ot.rtfd.io)
[](http://www.apache.org/licenses/LICENSE-2.0)
[](http://www.dita-ot.org/4.2)
[](https://github.com/jason-fox/fox.jason.unit-test/actions?query=workflow%3ACI)
[](https://coveralls.io/github/jason-fox/fox.jason.unit-test?branch=master)
[](https://sonarcloud.io/dashboard?id=fox.jason.unit-test)
This is a Unit Testing framework for the DITA Open Toolkit. This [DITA-OT Plug-in](https://www.dita-ot.org/plugins)
consists of seven DITA-OT transforms and an ANT library:
- Unit Testing
- The `unit-test` transform allows a user to runs a sequence of `dita` commands and checks that the documents
created match the expected output. This is useful for regression testing, and confirming that any custom
plug-ins do not conflict when upgrading the base DITA-OT engine.
- The `resource/antlib.xml` library offers a series of convenience methods for creating DITA-OT unit tests.
- Code Coverage
- The `token-report` transform checks to see if a series of tokens representing all potential output values are
covered by unit tests
- The `xsl-instrument` transform annotates an DITA-OT plug-in to enable code coverage reporting
- The `xsl-deinstrument` transform removes the instrumentation annotation from a specified plug-in
- The `xsl-report` transform displays which templates have been invoked whilst running unit tests
- ANT Profiling
- The `antro` transform runs an ANT script profiler against a specified transform and outputs a profiler JSON file
- The `antro.ui` transform starts up the UI for the ANT script profiler, allowing a user to load a JSON file and
interpret the results.
:arrow_forward: [Video from DITA-OT Day 2018](https://youtu.be/MQRli3XICUo)
[](https://youtu.be/MQRli3XICUo)
Table of Contents
- [Install](#install)
- [Installing DITA-OT](#installing-dita-ot)
- [Installing the Plug-in](#installing-the-plug-in)
- [Usage](#usage)
- [Invocation from the Command line](#invocation-from-the-command-line)
- [Obtaining a unit test report](#obtaining-a-unit-test-report)
- [XSLT coverage report](#xslt-coverage-report)
- [Token coverage report](#token-coverage-report)
- [Obtaining ANT script profile information](#obtaining-ant-script-profile-information)
- [Viewing profiler information](#viewing-profiler-information)
- [Parameter Reference](#parameter-reference)
- [Integration with Travis CI](#integration-with-travis-ci)
- [Integration with Coveralls](#integration-with-coveralls)
- [Unit Test File Structure](#unit-test-file-structure)
- [Test suite files](#test-suite-files)
- [`bootstrap.xml` file](#bootstrapxml-file)
- [`coverage.xml` file](#coveragexml-file)
- [`template-coverage.xml` file](#template-coveragexml-file)
- [`disabled.txt` file](#disabledtxt-file)
- [Overrides for `attributes.xml` `colors.xml` and `fonts.xml`](#overrides-for-attributesxml--colorsxml--and-fontsxml)
- [Overrides for `test.properties`](#overrides-for-testproperties)
- [Individual test files](#individual-test-files)
- [API](#api)
- [Compare-Output](#compare-output)
- [Contains-Text](#contains-text)
- [Exec-HTML5](#exec-html5)
- [Exec-PDF](#exec-pdf)
- [Exec-SVRL](#exec-svrl)
- [Exec-Transtype](#exec-transtype)
- [Get-HTML-Article](#get-html-article)
- [Get-PDF-Article](#get-pdf-article)
- [Contribute](#contribute)
- [License](#license)
## Install
The unit test framework plug-in has been tested against [DITA-OT 4.x](http://www.dita-ot.org/download). It is no longer
compatible with DITA-OT 2.x. and it is recommended that you upgrade to the latest version. The unit test framework
plug-in relies on the use of [AntUnit](http://ant.apache.org/antlibs/antunit/) 1.4 to run tests and ANT jUnit to create
a test report. ANT 1.8 or higher is required, although a later ANT version (1.9 or 1.10) is recommended.
### Installing DITA-OT
The DITA-OT Unit Test Framework is a plug-in for the DITA Open Toolkit.
- Full installation instructions for downloading DITA-OT can be found
[here](https://www.dita-ot.org/4.0/topics/installing-client.html).
1. Download the `dita-ot-4.2.zip` 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.
```console
curl -LO https://github.com/dita-ot/dita-ot/releases/download/4.2/dita-ot-4.2.zip
unzip -q dita-ot-4.2.zip
rm dita-ot-4.2.zip
```
### Installing the Plug-in
- Run the plug-in installation command:
```console
dita -install https://github.com/jason-fox/fox.jason.unit-test/archive/master.zip
```
The `dita` command line tool requires no additional configuration.
---
## Usage
### Invocation from the Command line
A series of test suites can be found within the plug-in at `PATH_TO_DITA_OT/plugins/fox.jason.unit-test/sample`
#### Obtaining a unit test report
To run, use the `unit-test` transform.
```console
PATH_TO_DITA_OT/bin/dita -f unit-test -o out -i PATH_TO_UNIT_TESTS
```
Once the command has run, a test report file is created. Additionally, if any error occurs, the command will fail.
**Sample Test Report** This is the test report from the example tests found within the plug-in `sample` directory. Nine
tests are run over two test suites (PDF and HTML processing) - a third test suite has been disabled.
- If the `-i` input directory is a test suite, all tests within the suite will be run.
- If the `-i` input directory is not a test suite, all test suites directly beneath that directory will be run.
#### XSLT Coverage Report
To run a XSLT Coverage Report, each DITA-OT Plug-In must be **instrumented** - this annotates the XSLT templates within
the plug-in to be able to generate coverage information. A copy of each `*.xsl` file is also saved with the `*.orig`
suffix.
```console
PATH_TO_DITA_OT/bin/dita -f xsl-instrument -i PATH_TO_PLUG_IN
```
To revert back to the original files just run the de-instrument transform as shown:
```console
PATH_TO_DITA_OT/bin/dita -f xsl-instrument -i PATH_TO_PLUG_IN
```
Once a Plug-In has been **instrumented** the test suite should contain a `template-coverage.xml` file which holds a list
of all template decision points. To obtain coverage information, use the `unit-test` transform as stated previously:
```console
PATH_TO_DITA_OT/bin/dita -f unit-test -i PATH_TO_UNIT_TESTS
```
- If the `-i` input directory is a test suite, XSL coverage for that test suite will be reported.
- If the `-i` input directory is not a test suite, XSL coverage for all test suites directly beneath that directory
will be reported.
Once the command has run, both a test report file and an XSL coverage report file are created. Additionally, if any
error occurs, the command will fail.
It is also possible to run XSL coverage over a single test. An individual test can be run directly from the command line
by running the default target within that test. This can be followed by direct invocation of the coverage report
```console
ant -f PATH_TO_PLUGIN/test/TEST_NAME/build.xml
PATH_TO_DITA_OT/bin/dita -f xsl-report -i PATH_TO_PLUGIN
```
##### Sample XSL Report
The XSL coverage report will show a schematic of all template decision points, with covered lines displayed in green,
and uncovered lines displayed in red.
#### Token Coverage Report
This is a quicker alternative report to XSLT instrumentation and code coverage, but it requires the developer to create
the token `coverage.xml` file manually. Each test suite should contain a `coverage.xml` file which holds a series of
tokens representing all potential output values. To obtain coverage information, use the `test-coverage` transform.
```console
PATH_TO_DITA_OT/bin/dita -f token-report -i PATH_TO_UNIT_TESTS
```
Once the command has run, a coverage report is created
##### Sample Token Report
This is the token report from the example tests found within the plug-in `sample` directory.
- Coverage for the Spell-checker is looking to ensure that all rules have been run. Uncovered rules are highlighted in
RED.
- Coverage for HTML processing is looking for the presence of ``, `` and `
` tags being rendered
in the tests.
- If the `-i` input directory is a test suite, coverage for that test suite will be reported.
- If the `-i` input directory is not a test suite, coverage for all test suites directly beneath that directory will
be reported.
#### Obtaining ANT script profile information
**Antro** is a hierarchical and line-level profiler for Ant build scripts. It can be run to check which ANT scripts have
been invoked and how long they took.
To obtain profile information, use the `antro` transform and supply an additional test transtype
```console
PATH_TO_DITA_OT/bin/dita -f antro --test.transform=TRANSFORM_TO_PROFILE -i document.ditamap
```
A profiler JSON file will be generated.
#### Viewing profiler information
To run the UI for the Antro profiler, use the `antro-ui` transform. The `-i` parameter is mandatory for all DITA-OT
plug-ins, and should point to a real file, but is not used for this transform.
```console
PATH_TO_DITA_OT/bin/dita -f antro-ui -i document.ditamap
```
The Antro UI is the displayed, load the profiler json file from to display a bar graph showing how long each ANT target
took:
**Sample Antro Display** The Profiler was run against the `pdf` transform, FOP processing took 16s
You can drill down to an individual line to see if it has been invoked and how long it took:
### Parameter Reference
- `test.copy` - Specifies whether regenerated expectations should be copied. Default is `false`
- `test.transtype` - The real transtype to run the antro profiler against
- `test.propertyfile` - A properties file to use when running the unit tests or antro profiler
### Integration with GitHub Actions.
**GitHub Actions** are a CI/CD environment integrated directly with GitHub. More information about how to set up GitHub Actions can be found on the
[GitHub website](https://docs.github.com/en/free-pro-team@latest/actions)
A GitHub Action has been created to automate your [DITA-OT Plugin testing](https://github.com/jason-fox/dita-unit-test-action). To add automated CI/CD testing of your DITA-OT plug-ins, place your tests under a `test` directory under the root of the repository
along with the `ci.yml` in the `.github/workflows` directory.
```yaml
name: CI
'on':
push:
branches:
- master
pull_request:
branches:
- master
jobs:
unit-test:
name: Unit Tests
runs-on: ubuntu-latest
steps:
- name: Git checkout
uses: actions/checkout@v2
- name: Run DITA-OT Unit Test
uses: jason-fox/dita-unit-test-action@master
with:
plugin: 'com.oxygenxml.editlink'
```
- `plugin` - **Required** The name of the DITA-OT plugin to install and test.
- `setup-script` - The name of an optional bash script to run to install any dependencies prior to run the test. Defaults to `test-setup.sh` if not supplied.
- `prerequisites` - Comma separated list of additional DITA-OT plugins to install prior to installing the plugin under test.
### Integration with Travis CI
**Travis CI** is a hosted, distributed continuous integration service used to build and test software projects hosted at
GitHub. More information about how to set up Travis integration can be found on the
[Travis website](https://docs.travis-ci.com/).
For automated testing of DITA-OT plug-ins, place your tests under a `test` directory under the root of the repository
along with the `.travis.yml` in the root itself.
For example to test against DITA-OT 3.4.1 use the following `.travis.yml`:
```yml
language: java
jdk:
- oraclejdk8
env:
- DITA_OT=3.4.1
before_install:
- zip -r PLUGIN-NAME.zip . -x *.zip* *.git/* *temp/* *out/*
- curl -LO https://github.com/dita-ot/dita-ot/releases/download/$DITA_OT/dita-ot-$DITA_OT.zip
- unzip -q dita-ot-$DITA_OT.zip
- mv dita-ot*/ dita-ot/
- chmod +x dita-ot/bin/dita
install:
- dita-ot/bin/dita install https://github.com/jason-fox/fox.jason.unit-test/archive/master.zip
- dita-ot/bin/dita install PLUGIN-NAME.zip
script:
- dita-ot/bin/dita --input dita-ot/plugins/PLUGIN-NAME -f unit-test -v
```
This will do the following:
- Zip up the files in the plug-in under test
- install the specified DITA-OT version
- install the unit-testing framework (repeat this for other dependencies)
- install the plug-in under test
- Run the tests
Unit tests will be run whenever a commit occurs.
The output will appear within the log as follows:
```text
[UNIT002I][INFO] Running tests for 'PLUGIN-NAME'
[antunit] Build File: /tmp/temp20180420185923919/unit-test/fixtures/PLUGIN-NAME/fixture.xml
[antunit] Tests run: 3, Failures: 0, Errors: 0, Time elapsed: 31.063 sec
[antunit] Target: test: Expect that ... took 7.202 sec
[antunit] Target: test: Expect that ... took 17.596 sec
...etc
[SUCCESS] All tests have passed
dita2unit-test:
clean-temp:
The command "dita-ot/bin/dita --input dita-ot/plugins/PLUGIN-NAME -f unit-test -v" exited with 0.
```
### Integration with Coveralls
**Coveralls** is a web service to help you track your code coverage over time, and ensure that all your new code is
fully covered. More information about how to set up Coveralls-Travis integration can be found on the
[Coveralls website](https://docs.coveralls.io/).
If a plug-in has been instrumented (using the `xsl-instrument` transform) and unit tests are run, a Cobertura style
`coverage.xml` file will be created along with the test results and a coverage report. This can be forwarded to
Coveralls using the standard maven plug-in as shown:
```yml
language: java
jdk:
- oraclejdk8
env:
- DITA_OT=3.4.1
before_install:
- zip -r PLUGIN-NAME.zip . -x *.zip* *.git/* *temp/* *out/*
- curl -LO https://github.com/dita-ot/dita-ot/releases/download/$DITA_OT/dita-ot-$DITA_OT.zip
- unzip -q dita-ot-$DITA_OT.zip
- chmod +x dita-ot-$DITA_OT/bin/dita
install:
- dita-ot-$DITA_OT/bin/dita install https://github.com/jason-fox/fox.jason.unit-test/archive/master.zip
- dita-ot-$DITA_OT/bin/dita install PLUGIN-NAME.zip
before_script:
- dita-ot-$DITA_OT/bin/dita --input dita-ot-$DITA_OT/plugins/PLUGIN-NAME -f xsl-instrument
script:
- dita-ot-$DITA_OT/bin/dita --input dita-ot-$DITA_OT/plugins/PLUGIN-NAME -f unit-test --output . -v
after_success:
- cp dita-ot-$DITA_OT/plugins/fox.jason.unit-test/resource/pom.xml pom.xml
- mvn clean org.eluder.coveralls:coveralls-maven-plugin:report
```
## Unit Test File Structure
The unit tests are organized in the following manner:
```
├── test-suite-A
│ └── test
│ ├── unit-test-1
│ ├── unit-test-2
│ ├── ... etc
│ ├── bootstrap.xml
│ └── coverage.xml
│
├── test-suite-B
│ └── test
│ ├── unit-test-1
│ ├── unit-test-2
│ ├── ... etc
│ ├── bootstrap.xml
│ └── coverage.xml
```
Each suite of tests (identified by a directory called `test`) can be found in a separate directory. Each test within the
suite can be found in a separate sub-directory. A `coverage.xml` file should be added to each test suite to enable the
framework to calculate coverage.
This structure means that an integration test of multiple plug-ins can be run by adding a `test` directory to each
plug-in and invoking the tests as shown:
```console
PATH_TO_DITA_OT/bin/dita --input ./plugins -f unit-test
```
### Test suite files
#### `bootstrap.xml` file
At the root of the tests lies a `bootstrap.xml` file which references the `antlib.xml` library as shown:
```xml
```
- The location of `test.root.dir` must be set - this allows the expectation of a single test to be updated directly
from the command line independently of the test harness.
- The location of `dita.dir` must be set - this allows a single test to be run directly from the command line
independently of the test harness.
- The functions from the unit-test `antlib.xml` must be loaded using the `` task.
#### `coverage.xml` file
A token coverage file consists of a list of XML elements or string literals which should be present in a test-suite's
outputs. For example, PDF tests should cover all possible fop element and attributes.
```xml
font-family="STANDARD"
font-family="MONOSPACE"
fo:block font-family="MONOSPACE"
fo:inline font-family="MONOSPACE"
fo:table-column
fo:table-column column-width
```
#### `template-coverage.xml` file
An XSL coverage file consists of a list of XSL elements which are present within a plug-in. This file is generated by
the `xsl-instrument` transform
```xml
d6e3:xsl/order.xsl
```
#### `disabled.txt` file
If a `disabled.txt` file is present within a test suite directory, none of the tests within the directory will be run.
#### Overrides for `attributes.xml` `colors.xml` and `fonts.xml`
The `cfg` directory of the plug-in holds standard lists of fonts, colors and attributes to replace when running PDF
tests - this can be overridden by individuals test or test suites if necessary by placing an equivalent override file in
the test directory or test-suite directory.
#### Overrides for `test.properties`
Additional test properties can be passed to DITA-OT when each test is run if a `test.properties` file is present in the
test directory or test-suite directory. The name of the file to search for can also be altered. See
[Setting build parameters with `.properties` files](http://www.dita-ot.org/3.0/topics/using-dita-properties-file.html)
for more details.
### Individual test files
Each unit test is organized in the following manner:
```
├── build.xml
├── document.ditamap
├── expected.html
├── test.properties (optional)
└── topics
└── *.dita files
```
- An ANT `build.xml` file to invoke the test
- A `document.ditamap` referring to the individual `*.dita` files
- An optional `test.properties` file if passing any additional properties to DITA-OT
- A test expectation (usually called `expected.html` or `expected.fo`)
- Any further `*.dita` files or source files, graphics etc. required for the test.
The `build.xml` must consist of a single default target, and `import` the `bootstrap.xml` file as shown. The
`description` is used within the test report.
```xml
Body text should be displayed in the standard font
```
- An individual test can be run directly from the command line by running the default target.
- Adding the comment `` within the `build.xml` file will disable a test
## API
The following ANT tasks are available from the DITA-OT Unit Test Framework
### Compare-Output
#### Description
Fail the test if the test output file does not match the expectation file
#### Parameters
| Attribute | Description | Required |
| ----------- | --------------------------------------------------------------------------- | --------------------------------- |
| expectation | Location of the file that the output should match | No; defaults to `expected.fo` |
| os | Only make the comparison if the current operating system is of a given type | No; defaults to `any` |
| result | Location of the file output by the test | No; defaults to `out/fragment.fo` |
| suffix | File suffix used by the test expectation | No; defaults to `.fo` |
#### Examples
```xml
```
compares the file `out/fragment.fo` with `expected.fo` and fails if they do not match.
```xml
```
compares the file `out/fragment.html` with `expected.html` and fails if they do not match.
```xml
```
if running on a Windows system, compares the file `out/fragment.svrl` with `expected.svrl.win` and fails if they do not
match.
if running on a UNIX system, no comparison is made.
### Contains-Text
#### Description
Fail the test if the log from the test does not contain the given string
#### Parameters
| Attribute | Description | Required |
| --------- | --------------------------------------------------------------------------- | ----------------------------------- |
| actual | The text actually output by the test | No; defaults to output from DITA-OT |
| expected | The expected fragment of text | Yes |
| os | Only make the comparison if the current operating system is of a given type | No; defaults to `any` |
#### Examples
```xml
```
compares the output of DITA-OT and fails if the text "Lorem Ipsum" cannot be found
```xml
```
if running on a Windows system, compares the output of DITA-OT and fails if the text "This is running on Windows" cannot
be found
if running on a UNIX system, no comparison is made.
### Exec-HTML5
#### Description
Execute the HTML5 DITA-OT transform in verbose mode The test will fail if the result was not as expected or took too
long
#### Parameters
| Attribute | Description | Required |
| -------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| ditamap | The `*.ditamap` file specifying which topics and other resources to use to create a document | No; defaults to `document.ditamap` |
| expectedresult | The expected result when invoking the transform | No; defaults to `0` = success |
| maxwait | The maximum time to create a document | No; defaults to 100 seconds |
| propertyfile | The name of a file holding additional properties | No; defaults to `test.properties` |
| transtype | The transtype to invoke when creating the document | No; this can be `html5` or any DITA-OT transform that extends `base-html`; defaults to `html5` |
#### Examples
```xml
```
runs DITA-OT using the `custom-html` HTML transtype. the output will be placed in the `/out/html` directory
### Exec-PDF
#### Description
Execute the PDF DITA-OT transform in verbose mode
#### Parameters
| Attribute | Description | Required |
| -------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| ditamap | The `*.ditamap` file specifying which topics and other resources to use to create a document | No; defaults to `document.ditamap` |
| expectedresult | The expected result when invoking the transform | No; defaults to `0` = success |
| maxwait | The maximum time to create a document | No; defaults to 100 seconds |
| propertyfile | The name of a file holding additional properties | No; defaults to `test.properties` |
| transtype | The transtype to invoke when creating the document | No; this can be `pdf2` or any DITA-OT transform that extends `pdf2`; defaults to `pdf2` |
#### Examples
```xml
```
runs DITA-OT using the `custom-pdf` PDF transtype. `topic.fo` and `document.pdf` will be placed in the `/out` directory
### Exec-SVRL
#### Description
Execute the HERE Validator SVRL DITA-OT transform in verbose mode. The test will fail if the result was not as expected
or took too long.
#### Parameters
| Attribute | Description | Required |
| -------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| ditamap | The `*.ditamap` file specifying which topics and other resources to use to create a document | No; defaults to `document.ditamap` |
| expectedresult | The expected result when invoking the transform | No; defaults to `0` = success |
| maxwait | The maximum time to create a document | No; defaults to 100 seconds |
| propertyfile | The name of a file holding additional properties | No; defaults to `test.properties` |
| transtype | The transtype to invoke when creating the document | No; this can be `svrl` or any DITA-OT transform that extends `svrl`; defaults to `svrl` |
#### Examples
```xml
```
runs DITA-OT using the `text-rules` SVRL transtype
```xml
```
runs DITA-OT using the `svrl-echo` SVRL transtype - the invocation is expected to fail with validation errors.
### Exec-Transtype
#### Description
Execute an arbitrary DITA-OT transform in verbose mode. The test will fail if the result was not as expected or took too
long.
#### Parameters
| Attribute | Description | Required |
| -------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| ditamap | The `*.ditamap` file specifying which topics and other resources to use to create a document | No; defaults to `document.ditamap` |
| expectedresult | The expected result when invoking the transform | No; defaults to `0` = success |
| maxwait | The maximum time to create a document | No; defaults to 100 seconds |
| propertyfile | The name of a file holding additional properties | No; defaults to `test.properties` |
| transtype | The transtype to invoke when creating the document | No; this can be `svrl` or any DITA-OT transform that extends `svrl`; defaults to `svrl` |
#### Examples
```xml
```
runs DITA-OT using the `custom` transtype
```xml
```
runs DITA-OT using the `custom` SVRL transtype - the invocation is expected to fail.
### Get-HTML-Article
#### Description
Loads a given HTML file and extracts the first `` element (which corresponds to a DITA topic) for further
examination.
#### Parameters
| Attribute | Description | Required |
| --------- | ---------------------------------------------------------------- | ----------------------------------- |
| dir | Location of the files output by the test | No; defaults to `out/html` |
| from | the name of the file to extract an HTML fragment from | Yes |
| to | Location of the output file holding the fragment of HTML to test | No; defaults to `out/fragment.html` |
#### Examples
```xml
```
creates a file called `fragment.html` holding the `` element from the `topics/body-text.html` file.
### Get-PDF-Article
#### Description
Loads a given `topic.fo` file and extracts the last `fo.flow` element (which corresponds to a DITA topic) for further
examination. Also remove colors, fonts and excess attributes
#### Parameters
| Attribute | Description | Required |
| --------- | --------------------------------------------------------------- | --------------------------------- |
| from | Location of the file to extract an HTML fragment from | No; defaults to `out/topic.fo` |
| to | Location of the output file holding the fragment of FOP to test | No; defaults to `out/fragment.fo` |
#### Examples
```xml
```
creates a file called `fragment.fo` holding the final `` element from the `topics.fo` file.
## Contribute
PRs accepted.
## License
[Apache 2.0](LICENSE) © 2018 - 2024 Jason Fox
The Program includes the following additional software components which were obtained under license:
- ant-antunit.jar - https://ant.apache.org/antlibs/antunit/ - **Apache 2.0 license**
- ant-contrib.jar - http://ant-contrib.sourceforge.net/ - **Apache 2.0 license**
- ant-junit.jar - https://ant.apache.org/ - **Apache 2.0 license**
- Saxon-9.1.0.8.jar - http://saxon.sourceforge.net/ - **Mozilla Public license 1.0**
- Saxon-9.1.0.8-dom.jar - http://saxon.sourceforge.net/ - **Mozilla Public license 1.0**
- xmltask.jar - http://www.oopsconsultancy.com/software/xmltask/ - **Apache 1.1 license**
- antro.jar - https://github.com/jkff/antro/ - **Gnu General Public License 3**
- swingx-2008_03_09.jar - http://swingx.dev.java.net/ - **Gnu General Public License 3**
- json.jar- http://www.json.org/ - **Gnu General Public License 3**