Differences

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

--- dev-guide:creating-own-plugin [2024/06/25 16:12] – [Linking an example] gaetan
+++ dev-guide:creating-own-plugin [2025/04/02 15:30] (current) – gaetan
@@ Line 1: / Line 1: @@
-===== Creating a new Plugin =====
+===== GroIMP Plugin =====
 ==== Plugin structure ====
@@ Line 291: / Line 291: @@
 ===== Embedded documentation =====
-Gr
+The embedded documentation of GroIMP is based on the docbook format with the htmlhelp template.
+The docbook file must be created in src/main/resources/manual.xml.
+There are several docbook editors available online.
+With GroIMP 2.1.4 it is also possible to use a markdown file as a source of documentation, this file is then turned in to a docbook file and forwarded to the normal pipeline.
+A documentation on the Markdown based approach can be found [[dev-guide:markdownDoku|here]].
+The compilation including the embedded help is described [[maintainer-guide:making-a-groimp-maven#compile_with_help_panel|here]]
+The linking of the embedded documentation  to the help buttons of the panels is explained [[dev-guide:linking-help-button|here]]
 ===== Linking an example =====
-In order to make your plugin easier to get started with, it is recommended to add an example project with it. The example projects are available in GroIMP from the [[user-guide:common_panels#project_explorer|example panel]].
+In order to make your plugin easier to get started with, it is recommended to add an example project with it. The example projects are available in GroIMP from the [[user-guide:common_panels#project_explorer|project panel]].
-To include an example project in the plugin the project needs to be referenced in the ''plugin.xml'' file with:
+To include an example project,the gsz file needs to be placed in 'src/main/resources' and in the plugin the project needs to be referenced in the ''plugin.xml'' file with:
 <code xml>
@@ Line 343: / Line 349: @@
 /examples/CATEGORYNAME/PROJECTNAME.Tags = ...
 </code>
+===== Linking a Template =====
+Similar to the examples a FilterSourceFactory can be used to add new templates. Templates are the files that can be selected by creating a new project 'File/new/...'.
+To add a gsz file stored in 'src/main/resources' as a template it must be  added in the template directory:
+<code xml>
+  <ref name="ui">
+	<ref name="templates">
+		<FilterSourceFactory name="myTemplate">
+		 	<resource name="my_template.gsz"/>
+		</FilterSourceFactory>
+	</ref>
+  </ref>
+</code>
+Additionally the name shown in the menu can be set in the properties file.
 See more: