Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
menno-pieters-sp committed Jan 19, 2023
1 parent 9e3c6f2 commit 45eb7ad
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

This tool allows customers and implementers to automatically create documentation for their IdentityIQ configuration, based on XML configuration files. These files should be merged into a single XML document.

## Provided Files

The tool is distributed as a zip file named like `identityiq-documentation-generator-<version>-bin.zip`. In this zip file, there are three main folders: `doc` containing this README.md file, `lib` containing the main jar file, and `xslt` containing all the XSLT stylesheets.

The jar file will be named `IdentityIQDocumentationGenerator.jar`. This file contains all the necessary dependencies.

The main stylesheet is `IdentityIQ-Documenter.xsl`, but the file `IdentityIQ-Documenter-Config.xsl` can be used to configure which things should be documented and how detailed the documentation should be.

## File Collection

There are two common ways to get the configuration files for documentation:
Expand Down

0 comments on commit 45eb7ad

Please sign in to comment.