Add documentation for how to create template PDF files

Currently, there is only the documentation for the AttributionDocumentGenerator which describes how to create a template bundle JAR file. This adds a further documentation for how to create those template PDF files. Resolves #546. Signed-off-by: Onur Demirci <[email protected]>
eclipse-archived · Jun 24, 2020 · d30a408 · d30a408
1 parent 07bcd53
commit d30a408
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/antenna-documentation/src/site/markdown/template-bundle-development.md b/antenna-documentation/src/site/markdown/template-bundle-development.md
@@ -4,6 +4,24 @@ automatically when no other bundle is configured. This guide will show how to cr
 integrate it in the Antenna workflow run. 
 
 ## Custom Template Bundle
+
+### How to create the template PDF files
+
+First, the template has to be developed with a tool like Microsoft Word / Open Office / Libre Office. The corresponding 
+document will consist of 4 pages which will represent the 4 templates PDF files:
+* cover.pdf
+* copyright.pdf 
+* content.pdf 
+* back.pdf
+
+The page size is A4 at 72 PPI with 595x842 pixels. The cover.pdf file will be the cover page of the attribution document 
+which will contain the project name and version starting at 80x547. The copyright.pdf file will be the second page of 
+the attribution document which will contain the project copyright notes starting at 70x659. The content.pdf file will be
+used several times which will be list the used dependencies with PURL, file name, license and copyright notes. The 
+back.pdf file is the last page of the attribution document which is appended without any changes.  
+
+After the document is finished, each individual page is exported as the respective template PDF file. 
+
 ### Basic folder structure
 
 ```