Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionInformation on use scenarios of the Apptools Maven Plugin.
Doctypetopichide
NameUsage
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
value

facade

filled

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience

Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Section
titleDescription

You can use the macro either as part of an app project or define an environment with a POM file. This page shows a collection of usage scenarios for the Apptools Maven Plugin.

Section
titleSummary

Section
titlePrerequisites

Section
titleConfigure App Project

Simply add the configuration to the POM file of your project.

Code Block Placeholder
code-languageHTML and XML
code-titlepluginManagement in pom.xml
<build>
  ...
  <pluginManagement>
    <plugins>
      ...
      <plugin>
        <groupId>de.smartics.maven.plugin</groupId>
        <artifactId>apptools-maven-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <sourceFolder>\${basedir}/target</sourceFolder>
          <includes>
            <include>\${project.artifactId}$</include>
          </includes>
          <acceptedFilenameExtensions>
            <extension>obr</extension>
          </acceptedFilenameExtensions>
        </configuration>
      </plugin>
    </plugins>
  </pluginManagement>
  ...
</build>

Then add profiles to configure the Confluence servers you want to deploy to. The following shows the deployment to the locally started Confluence on a developer machine (with default password and user admin).

Then deploy the OBR artifact to the local server by specifying the profile.

Code Block
mvn apptools:deploy -PLOCAL

In case you want to deploy to a remote test server, add a profile like this:

Code Block
    <profile>
      <id>TEST</id>
      <build>
        <pluginManagement>
          <plugins>
            <plugin>
              <groupId>de.smartics.maven.plugin</groupId>
              <artifactId>apptools-maven-plugin</artifactId>
              <configuration>
                <serverId>confluence-test</serverId>
                <serverUrl>${my.server.url.TEST}</serverUrl>
              </configuration>
            </plugin>
          </plugins>
        </pluginManagement>
      </build>
    </profile>

Provide the credentials and the URL to access the TEST server in your settings.xml.

Code Block
languagexml
title~/.m2/settings.xml
<settings>
  ...
  <servers>
    ...
    <server>
      <id>confluence-test</id>
      <username>jane.doe</username>
      <password>{HllO1A....}</password>
    </server>
  </servers>
...
  <profiles>
    <profile>
        <my.server.url.TEST>https://www.mycorp.example.com/confluence</my.server.url.TEST>
      </properties>
    </profile>
    ...
  </profiles>
</settings>
Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...