User Tools

Site Tools


maintainer-guide:making-a-groimp-maven

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
maintainer-guide:making-a-groimp-maven [2024/08/16 11:29] – [Compile with help panel] gaetanmaintainer-guide:making-a-groimp-maven [2024/12/18 10:55] (current) gaetan
Line 1: Line 1:
 ===== Compile a GroIMP plugin ===== ===== Compile a GroIMP plugin =====
 +
 +==== Requirements ====
 +
 +To compile GroIMP you will need the following additional tools:
 +  * [[https://maven.apache.org/install.html|Maven]]
 +  * [[https://www.oracle.com/java/technologies/downloads/|Java 17]] or newer
 +  * [[https://www.perl.org/get.html|Perl]]
  
 It is possible to compile and package one specific plugin. The plugin have to follow the template of [[https://gitlab.com/grogra/groimp-template/newplugin-maven|new plugin]].  It is possible to compile and package one specific plugin. The plugin have to follow the template of [[https://gitlab.com/grogra/groimp-template/newplugin-maven|new plugin]]. 
Line 10: Line 17:
 Then, the plugin can be compiled with ''mvn compile'', or package with ''mvn package''. The packaging create a repository at ../app/plugin/NAME_OF_YOUR_PLUGIN based on the root of the plugin. This repository can be added to an existing installation of GroIMP by simple copy paste.  Then, the plugin can be compiled with ''mvn compile'', or package with ''mvn package''. The packaging create a repository at ../app/plugin/NAME_OF_YOUR_PLUGIN based on the root of the plugin. This repository can be added to an existing installation of GroIMP by simple copy paste. 
    
-==== Compile with help panel ====+==== Compile with help panels ====
  
 The documentation inside GroIMP is written in docbook which can be compiled into the html layout seen in the help panel.  The documentation inside GroIMP is written in docbook which can be compiled into the html layout seen in the help panel. 
Line 17: Line 24:
 ''sudo apt install xsltproc docbook docbook-xsl'' ''sudo apt install xsltproc docbook docbook-xsl''
  
-This require to have ''pandoc'' installed on your device. It can be installed on debian with ''sudo apt install pandoc''.+This require to have ''pandoc'' version > 3.3 installed on your device. 
  
 Afterwards the maven command: ''mvn package -P app-with-doc'' can be executed. Afterwards the maven command: ''mvn package -P app-with-doc'' can be executed.
maintainer-guide/making-a-groimp-maven.1723800564.txt.gz · Last modified: 2024/08/16 11:29 by gaetan