GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace: • xl-queries-and-operators • add-templates-and-examples • create-module-lib
dev-guide:creating-own-plugin

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dev-guide:creating-own-plugin [2024/07/05 11:49] – [Embedded documentation] timObdev-guide:creating-own-plugin [2025/04/02 15:30] (current) – gaetan
Line 1: Line 1:
-===== Creating a new Plugin =====+===== GroIMP Plugin =====
  
 ==== Plugin structure ==== ==== Plugin structure ====
Line 297: Line 297:
 A documentation on the Markdown based approach can be found [[dev-guide:markdownDoku|here]]. A documentation on the Markdown based approach can be found [[dev-guide:markdownDoku|here]].
  
-In both cased the creation of the documentation can be triggered with the additional maven parameter '-P app-with-doc', for instance: 'mvn package -P app-with-doc'+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 ===== ===== 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|project 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> <code xml>
Line 346: Line 349:
 /examples/CATEGORYNAME/PROJECTNAME.Tags = ... /examples/CATEGORYNAME/PROJECTNAME.Tags = ...
 </code> </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: See more:
dev-guide/creating-own-plugin.1720172966.txt.gz · Last modified: 2024/07/05 11:49 by timOb