Documentation compiler: Difference between revisions
Jump to navigation
Jump to search
(initial page) |
m (Infobox software: Switch the 'writtenin' parameter to a list separated by '/'.) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{forum|72|Documentation}} | |||
{{Infobox Software | {{Infobox Software | ||
| title = Documentation compiler | | title = Documentation compiler | ||
| Line 7: | Line 9: | ||
| initialrelease = | | initialrelease = | ||
| latestrelease = | | latestrelease = | ||
| writtenin = Python2 | | writtenin = Python2/pdfLaTeX | ||
| os = | | os = | ||
| platform = | | platform = | ||
| Line 16: | Line 18: | ||
}} | }} | ||
The '''Documentation compiler''' is a script that reads FlightGear data such as Aircraft checklists and writes out pdf files using pdfLaTeX. It was first announced on the [http://forum.flightgear.org/viewtopic.php?f=72&t=25119 forum]. | The '''Documentation compiler''' is a script that reads FlightGear data such as [[PropertyList XML File|PropertyList-encoded]] [[Aircraft Checklists|Aircraft checklists]] XML files and writes out pdf files using pdfLaTeX. It was first announced on the [http://forum.flightgear.org/viewtopic.php?f=72&t=25119 forum]. | ||
== Features == | == 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. | 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 [[ | * It takes the aircrafts [[Aircraft Checklists|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 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. | * It takes the thumbnail of the aircraft for using it on the titlepage of the documentation. | ||
== Current Situation == | |||
{{FGCquote | |||
|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/ https://www.gitorious.org/fg/getstart/]. The specific script is getstart/bin/makereadmepdf.pl<br/> | |||
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. | |||
|{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=229556&sid=802fb035a3503cb01444b5434df5235c#p229556 | |||
|title=<nowiki>Re: Automatic documentation generator</nowiki> | |||
|author=<nowiki>stuart</nowiki> | |||
|date=<nowiki>Sun Jan 11</nowiki> | |||
}} | |||
}} | |||
== Usage == | == Usage == | ||
stub | stub | ||
== Feature Requests == | |||
{{FGCquote | |||
|Could you make a specific python script that only displays the checklists? Treat each checklist as a chapter and put each new chapter on a separate page. Perhaps you could also add .pdf files that each contain SIDs and STARs (user has to point your python script to these files or to the directory containing these files) and add them together to your single .pdf file. | |||
|{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=229533&sid=802fb035a3503cb01444b5434df5235c#p229533 | |||
|title=<nowiki>Re: Automatic documentation generator</nowiki> | |||
|author=<nowiki>onox</nowiki> | |||
|date=<nowiki>Sun Jan 11</nowiki> | |||
}} | |||
}} | |||
== Roadmap == | |||
== Related == | |||
* [[Catalog_metadata]] (aircraft categorization) | |||
* [[Airport Diagram Generator]] (Java) | |||
* [http://forum.flightgear.org/viewtopic.php?t=23408 Free, Open-Source Georeferenced Airport Diagrams] (Perl) | |||
* [http://forum.flightgear.org/viewtopic.php?f=6&t=25168 An archive of airport diagrams from A/FD] (Perl) | |||
* [http://forum.flightgear.org/viewtopic.php?f=30&t=15133 Nasal API Docs for $FG_ROOT/Nasal] (Python) | |||
* [http://forum.flightgear.org/viewtopic.php?p=184571#p184571 LaTex wrappers for $FG_ROOT/Docs] (using Nasal/Perl, maintained by Stuart) | |||
[[Category:Documentation]] | |||
Latest revision as of 13:00, 11 September 2020
 |
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
|
|
Could you make a specific python script that only displays the checklists? Treat each checklist as a chapter and put each new chapter on a separate page. Perhaps you could also add .pdf files that each contain SIDs and STARs (user has to point your python script to these files or to the directory containing these files) and add them together to your single .pdf file.
|
|
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)