Differences

This shows you the differences between two versions of the page.

--- dev-guide:markdowndoku [2024/07/05 12:58] – timOb
+++ dev-guide:markdowndoku [2024/07/08 10:50] (current) – timOb
@@ Line 1: / Line 1: @@
-====== create embedded documentation based on markdown files ======
+====== 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 [[https://pandoc.org/chunkedhtml-demo/3.1-general-options.html|large number of other import formats including]] docx,odt or latex.
+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 [[https://pandoc.org/chunkedhtml-demo/3.1-general-options.html|large number of other import formats]] including docx,odt or latex.
@@ Line 7: / Line 7: @@
 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 [[https://gitlab.com/grogra/groimp-template/newplugin-maven|maven template]].
+template.docbook and copyfilter.lua in the directory ''src/main/resources/doc''. Both files can be found in the [[https://gitlab.com/grogra/groimp-template/newplugin-maven|maven template]].
@@ Line 27: / Line 27: @@
 ===== Selecting a source =====
-The source of the pipeline is by default "README.md" (caution its case sensitive), if the source is suppose to be any different file it can be defined in the "MarkdownDocFile" option:
+The source of the pipeline is by default "README.md" (caution it is case sensitive), if the source is suppose to be any different file it can be defined in the "MarkdownDocFile" option:
 <code xml>
@@ Line 37: / Line 37: @@
 </code>
 At this position it would also be possible to set other formats e.g.: ''MarkdownDocFile>docu.odt</MarkdownDocFile>''
+Moreover it is possilbe to set several files (only markdown) as a parameter, this files then will be concatenated and process as one and create one docbook file:  ''<MarkdownDocFile>README.md docu.md extra.md</MarkdownDocFile>''
@@ Line 61: / Line 62: @@
 *panels/explorers/graphobjects*
 *examples:graphexplorer/GraphObjectRef*
-*preferences:/graphExplorer/subGraph*
+*preferences:graphExplorer/subGraph*
 </code>
@@ Line 79: / Line 80: @@
 </code>
+==== Defining the title ====
+By default the title of the chapter of documentation is the name of the plugin in the maven pom.
+This name can be change by adding the variable "ftitle" to the first markdown file:
+<code>
+---
+ftitle: GroIMP user manual
+...
+</code>