Documentation compiler
Jump to navigation
Jump to search
![]() |
The FlightGear forum has a subforum related to: Documentation |
Developed by | Ruben De Smet (rubdos) |
---|---|
Written in | Python2, pdfLaTeX |
Development status | Active |
Type | Documentation generator |
License | GNU GPL v2 |
Website |
The Documentation compiler is a script that reads FlightGear data such as PropertyList-encoded Aircraft checklists XML files and writes out pdf files using pdfLaTeX. It was first announced on the forum.
Features
The Documentation compiler takes Flightgear data and render a pdf file. It currently handles only aircraft data, but different other things have been suggested.
- It takes the aircrafts checklists and outputs them to LaTeX
- It takes the extra LaTeX data in the Docs/ subdirectory of the aircraft and puts it before the checklists.
- It takes the thumbnail of the aircraft for using it on the titlepage of the documentation.
Current Situation
![]() |
For reference, the current Latex creator that parses and packages up all the Docs/README files is available as part of the "getstart" git repository: https://www.gitorious.org/fg/getstart/. The specific script is getstart/bin/makereadmepdf.pl I re-run that script for each release and check in the resulting PDF into FGDATA. If you'd like to do so, we could include your script in the getstart repository and I would re-run it for each release as well, so each release would include a set of Aircraft PDF files as well. |
![]() |
Usage
stub
Feature Requests
Roadmap
Related
- Catalog_metadata (aircraft categorization)
- Airport Diagram Generator (Java)
- Free, Open-Source Georeferenced Airport Diagrams (Perl)
- An archive of airport diagrams from A/FD (Perl)
- Nasal API Docs for $FG_ROOT/Nasal (Python)
- LaTex wrappers for $FG_ROOT/Docs (using Nasal/Perl, maintained by Stuart)