20,741
edits
Documentation compiler: Difference between revisions
Jump to navigation
Jump to search
m
→Usage
m (→Roadmap) |
m (→Usage) |
||
| Line 26: | Line 26: | ||
* 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 == | == Roadmap == | ||