Issue Details (XML | Word | Printable)

Key: NUCACCESS-88
Type: Improvement Improvement
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Andy Jefferson
Reporter: Andy Jefferson
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
DataNucleus AccessPlatform

Replace documentation generation process with something that reliably can create PDF

Created: 30/Mar/11 09:10 AM   Updated: 15/Nov/12 03:38 PM   Resolved: 14/Nov/12 04:28 PM
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.2.0.m1


 Description  « Hide
The current documentation generation process uses Maven1 "site" since we need horizontal and vertical navigation in a templated documentation system. We also use the Maven1 PDF plugin (which uses Apache FOP). Sadly Apache FOP has bad memory issues, particularly with the docs in AccessPlatform 3.0 and now just runs out of memory (probably) ... giving error "-2" whatever that means.

This process needs replacing with something that
1. Provides templated docs with horizontal and vertical navigation.
2. Provides PDF output
3. Optionally provides HTML docs in a single page

Sort Order: Ascending order - Click to sort in descending order
Andy Jefferson added a comment - 14/Nov/12 09:36 AM
Maven 3 Site plugin works with the "skin" that is in DataNucleus SVN.
Maven 3 PDF plugin works with all except numbering of sections using DataNucleus SVN branches/maven3 for AccessPlatform.

Still would need to migrate main "datanucleus.org" site at some point but dont need PDF for that

Andy Jefferson added a comment - 14/Nov/12 04:28 PM
SVN trunk now provides Maven3 site/pdf for accessplatform. Will raise the migration of datanucleus.org as a separate issue.

Note that there are outstanding bugs in Maven SITE/PDF plugins
https://jira.codehaus.org/browse/MPDF-10
https://jira.codehaus.org/browse/MSITE-664