Wstęp

Poniżej opisane zostały 2 sposoby tworzenia projektu wtyczki:

Tworzenie projektu z archetypu jest szybsze i wygodniejsze. Musimy jedynie uzupełnić wymagane parametry takie jak nazwa, klucz etc.

Tworzenie projektu od podstaw

 

  1. Tworzymy nowy projekt Maven (File -> New -> Maven Project).
  2. Zaznaczamy opcję Create a simple project (skip archetype selection) i klikamy Next

  3. Uzupełniamy informacje o projekcie i tworzymy projekt




    Projekt powinien być stworzony zgodnie z konwencją:

    • groupId: dla wtyczek przyjęto com.suncode.plugin
    • artifactId: identyfikator wtyczki (musi być uniwersalny)
    • version: wersja wtyczki może być niezależna od wersji systemu docelowego
    • packaging: musi zostać ustawione na bundle (wartości nie ma na liście)

     

    Dodajemy niezbędny plik deskryptora wtyczki suncode-plugin.xml do katalogu src/main/resources:

    <?xml version="1.0" encoding="UTF-8"?>
<plugin key="${project.groupId}-${project.artifactId}" name="Tutorial Plugin">
	<plugin-details>
		<description>
			<localized language="en">Description</localized>
			<localized language="pl">Opis</localized>
		</description>
		<author>Suncode</author>
	</plugin-details>
	
	<!-- I18N -->	
	<i18n key="i18n-bundle" location="locale/messages" />
	
	<!-- Web MVC -->
	<web-mvc key="mvc" />
</plugin>

    Plik suncode-plugin.xml jest filtrowany przez Maven'a. Oznacza to, że w miejsca właściwości ${...} dynamicznie wstawiana jest zawartość tych właściwości.

    Zamiast ${project.groupId}-${project.artifactId} możemy wpisać stały identyfikator wtyczki. Wpisanie ${project.groupId}-${project.artifactId} skutkuje dynamicznie tworzonym identyfikatorem z właściwości groupId i artifactId.

  4. Dodajemy plik tłumaczeń messages.properties do katalogu src/main/resources/locale


Ostateczna struktura projektu powinna wyglądać następująco:

Tworzenie projektu wykorzystując gotowy archetyp


  1. Tworzymy nowy projekt Maven (File -> New -> Maven Project).
  2. Zostawiamy opcję Create a simple project (skip archetype selection) odzaznaczoną
  3. Wybieramy interesujący nas archetyp tak jak na rysunku:



  4. Następnie uzupełniamy wszystkie wymagane informacje:



     Opis wszystkich właściwości:

    • plusworkflowVersion: docelowa wersja systemu PlusWorkflow
    • name: nazwa wtyczki
    • author: twórca wtyczki
    • descriptionPL: opis wtyczki w języku polskim
    • descriptionEN: opis wtyczki w języku angielskim

  5. Stworzony projekt bo zbudowaniu może już być zainstalowany w systemie jako wtyczka. Deskryptor tej wtyczki wygląda następująco:

    <?xml version="1.0" encoding="UTF-8"?>
<plugin key="com.suncode.plugin-tutorial" name="Tutorial Plugin">
	<plugin-details>
		<description>
			<localized language="en">Description</localized>
			<localized language="pl">Opis</localized>
		</description>
		<author>Suncode</author>
	</plugin-details>
	
	<!-- I18N -->	
	<i18n key="i18n-bundle" location="locale/messages" />
	
	<!-- Web MVC -->
	<web-mvc key="mvc" />
</plugin>

 

Ostateczna struktura projektu powinna wyglądać następująco: