DeforaNetworks/pentext
DeforaNetworks/pentext
3
0
Fork 0
Code Releases Activity

Update README.md

Browse Source 
added compiling example
This commit is contained in:
Deborah Maayen 2016-08-02 00:21:15 +02:00 committed by GitHub
parent 25c92a6c40
commit a3e625f5dc
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -5,10 +5,6 @@ The PenText XML documentation project is a collection of XML templates, XML sche
### How it Works
The OWASP PenText project is based on XML. A PenText Report, Offer, Invoice or Generic Document is in fact a (modular) XML document, conforming to an XML Schema. The XML Schema ensures that the documents are structured correctly, so that they can then be transformed into other formats using XSLT and the SAXON XSLT processor. Currently there is only one target format: PDF. To produce the PDF document, the report, offer, invoice or generic document XML is first transformed into XSL-FO (XSL Formatting Objects), which is then converted to PDF using Apache FOP.
### Software Requirements
An XML editor -which could be any text editor like JEdit, to a full IDE- for editing of course ;). Preferably something that can check XML file validity. The FOP library for building a PDF document and a PDF reader for the result are the bare minimum.
It is also possible to set up the whole system with Ansible scripts or Docker.
### The Structure
The directories are used as follows:
- scripts: contains misc scripts. Currently has a script for importing github issues into XML format suited for PenText.
@ -18,3 +14,12 @@ The directories are used as follows:
- your report or quote goes in source
- contains a graphics map for your company logo
- the *findings* and *non-findings* maps are reserved for finding templates for reports.
## Getting Started
### Software Requirements
An XML editor -which could be any text editor like JEdit, to a full IDE- for editing of course ;). Preferably something that can check XML file validity. The FOP library for building a PDF document and a PDF reader for the result are the bare minimum and lastly the Java library Saxon.
It is also possible to set up the whole system with Ansible scripts or Docker.
### Compiling
Manually compiling a quotation, report or other document can be done with *java -jar <path-to-Saxon-jar> -s:<name-of-xml-file> -xsl:<name-of-xsl-file-in-xsl-directory> -o:<name-for-pdf-output>*
Of course this is tedious to write manually. Therefore it would be easier to script this or use one of the Hubot scripts in the chatops directory to build a document in a chatroom.