Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionShows how to add a new doctype to an existing project.
Doctypetopichide
NameAdd new Doctype
Short Name
Parent
Parent Property
propertyParent
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience

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

Expected Duration
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags
hide
Iteration

Iteration
valuefinished

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

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

Sort Key0020hide
Content Marker
hidetrue
idhide

Cheese

Section
show-titlefalse
titleDescription

The information architecture is a moving target. New requirements can call for a new document type (template) to make it easier for team members to write down the essential information that is relevant for the project.

...

Section
titleRun Generation Process

The generation process is run from within the project (that is from the base folder that contains the pom.xml file) using

Code Block
mvn doctype:generate

All information is derived from the configuration in the pom.xml file that has been created by the Doctypes Archetype.

Code Block Placeholder
code-languageHTML and XML
      <plugin>
        <groupId>${project.groupId}</groupId>
        <artifactId>${project.artifactId}</artifactId>
        <version>${project.version}</version>
        <executions>
          <execution>
            <id>doctype</id>
            <goals>
              <goal>generate</goal>
            </goals>
            <phase>generate-resources</phase>
          </execution>
        </executions>
        <configuration>
          <shortId>myshortid</shortId>
        </configuration>
      </plugin>

In create mode (default), already existing templates will not be overridden.

...