Versions Compared

Old Version 14

changes.mady.by.user Cezary Kozar

Saved on

compared with

New Version 15

changes.mady.by.user Agnieszka Bochenek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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


 





 

Polish

Wstęp

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

  • ręcznie
  • maven archetype

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

Tworzenie projektu od podstaw

Warning

Każda tworzona wtyczka nie może współdzielić jednego pakietu z inną wtyczką.

  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

    Image Added


    Info
    titleParametry projektu

    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:

    Code Block
    languagehtml/xml
    titlesuncode-plugin.xml
    <?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>
    Info

    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:

Image Added

Tworzenie projektu wykorzystując gotowy archetyp

Przed stworzeniem projektu należy skonfigurować katalogi archetypów. W tym celu otwieramy Window->Preferences oraz dodajemy Remote Catalog z adresem URL repozytorium Suncode: http://192.168.1.51:8081/nexus/content/groups/public/

Image Added


  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:

    Image Added

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

    Image Added

    Info
    titleWłaściwości

     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:

    Code Block
    languagehtml/xml
    titlesuncode-plugin.xml
    <?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:

Image Added