java -jar midscribe.jar generate -s /path/to/objects/directory -o output.adocmidScribe
|
Integral documentation feature
This page is an introduction to Integral documentation midPoint feature.
Please see the feature page for more details.
|
The midscribe is a command-line utility used to generate documentation from midPoint objects. It reads the XML files, extracts relevant information about objects and their relationships, and uses this data to create documentation in various formats.
Studio integration
Midscribe is also integrated within Intellij IDEA MidPoint Studio plugin.
Documentation can be generated directly from the Studio by using action Generate documentation.
For more information see Studio documentation.
Examples
Generate documentation in Asciidoc format
Generate documentation in PDF format
java -jar midscribe.jar generate -s /path/to/objects/directory -o output.pdf -of PDFGenerate documentation in HTML format, but only including xml files from the
users directoryjava -jar midscribe.jar generate -s /path/to/objects/directory -i "users/*.xml" -o output.html -of HTMLCompliance
This feature is related to the following compliance frameworks:
Was this page helpful?
YES
NO
Thanks for your feedback