Ticket #411 (closed defect: fixed)
Printable Documentation
| Reported by: | dclark | Owned by: | desai |
|---|---|---|---|
| Priority: | minor | Milestone: | Bcfg2 0.9.5 Release |
| Component: | bcfg2-doc | Version: | 0.9.x |
| Keywords: | doc, documentation | Cc: |
Description
Now that the doc is moving from XML files to the Wiki, there needs to be some way of printing out the Wiki documentation, as there is 50+ pages of docs, and reading large docs on surfaces other than paper can be annoying.
The easiest solution I have found involves 2 Trac plugins and HTMLDOC:
- apt-get install htmldoc
- Install the WikiIncludePlugin
- Install the PageToPdfPlugin, after patching it it to allow a TOC to be generated with the patch in this ticket
- Modify the trac.ini with the [pagetopdf] options in the above ticket, as well as with these lines in the [components] section:
pagetopdf.* = enabled wikiinclude.* = enabled
- /etc/init.d/apache2 reload
I like doing (2) and (3) like this to maintain easy compatibility with bcfg2:
- fakeroot python setup.py bdist_rpm
- cd dist; fakeroot alien -d *noarch*rpm
- install .deb via bcfg2
This solution will get you something that looks like this. The one downside of this is that there will not be a title page - that should be relatively easy to patch PageToPdfPlugin to do; the code to get the title info from Trac itself is already in the CombineWikiPlugin. I have an example of bcfg2 doc created with this; it was running from another trac wiki, and so pulled in the crap that frames the content text; that would not be the case within a wiki using the include plugin.
Attachments
Change History
comment:3 Changed 16 years ago by dclark
- Status changed from closed to reopened
- Resolution fixed deleted
(From IRC 2007-05-01)
- So concatenated doc is now up at http://trac.mcs.anl.gov/projects/bcfg2/wiki/Bcfg2Doc ; there are some obvious problems (see pink boxes), and also the PDF creation doesn't look like it is working (may just be my comp, will try from another soon)
- Also need to figure out how to strip the [[TracNav]] elements.
- Specifically the problems are:
- Strip [[TracNav]]
- Change WikiInclude to properly deal with image attachments (i.e. rewrite to refer to origin page, not page from which it is included)
- Add [[TOC]] macro to Trac instance
- Fix PDF creation
I just enabled those 2 plugins for the bcfg2 trac site. Please test them out to ensure they are working properly. The test I had fail in the past just worked, but it isn't complicated.
Rick