Copy the following content in a file names project-settings.xml to your Maven folder (.m2) in your user home directory.
Transclusion
document
Project Settings
ids
Sample Project Settings
Warning Box
title
Deploy projectdoc Artifacts to local Artifact Repository
There are some prerequisites you need to check to get going. This involves the configuration of your access to dependencies declared in the POM of the generated project.
Section
title
Create Project
To create a new project (with some sample files) run:
Since there are sample files in the new project, you can now generate blueprint files based on the example files.
Caution Box
Note that there is now rollback! If you run the following command to see the first example, the information in the descriptors will alter a number of files in the project (which is not in the target, but the source folder).
You probably need to start a new project (with -DcreateExamples=false) if you want to exclude the samples.
Code Block
language
text
mvn doctype:generate
Then start your Confluence server locally to test the add-on.
Code Block
language
text
atlas-debug
Section
title
Usage Scenarios
The Usage page lists typical usage scenarios. Pick the ones you are interested in.
Remember: create creates a new project, generate generates files and applies changes based on your descriptors. So to generate blueprint files based on your descriptors type from within your project:
Code Block
language
text
mvn doctype:generate
This will skip descriptor files that have already been generated.
Section
title
Reference Material
The
Wiki Link
label
documentation of the goals
page
Plugin Documentation (V${project-version})
provides detailed information on all parameters.
In projectdoc model descriptors you'll find information on how to write descriptors for the add-on, the spaces, and the doctypes. There is also a link to XML schema files (XSD) that can be installed into XML editors.