This is an old revision of the document!
Table of Contents
create embedded documentation based on markdown files
With GroIMP 2.1.4 it is possible to use a markdown file to generate the content of the embedded documentation of a GroIMP plugin. The idea is that the README.md file of a git repository is then doubly used. Yet since the pipeline depends on pandoc, it is in theory also possible to use a large number of other import formats including docx,odt or latex.
Requirements
To use this pipeline it is required that pandoc is installed, and that the project contains the files template.docbook and copyfilter.lua in the directory src/main/resources/doc. Both files can be found in the maven template.
Enabling/ disabling the pipeline
By default this pipeline is disabled, since parts of GroIMP contain docbook based documentation. To enable it for a certain plugin the maven property “maven.assembly.generate.docbook” must be defined in the pom.xml.
<properties> <maven.assembly.generate.docbook>generate-resources</maven.assembly.generate.docbook> </properties>