improve documentation generation #4751
Comments
Forgon uploaded file patch file created with |
Forgon uploaded file patch file created with |
Forgon uploaded file patch file created with |
Forgon uploaded file patch file created with |
Forgon uploaded file command line output when generating JavaScript API reference before applying this patch series |
Forgon uploaded file command line output when generating JavaScript API reference after applying this patch series |
Forgon2100 <forgon2100@...> changed status from |
Forgon2100 <forgon2100@...> changed owner from `` to |
Forgon2100 <forgon2100@...> changed resolution from `` to |
Forgon2100 <forgon2100@...> committed [35245] In Warzone2100/warzone2100@35245d9:
|
Forgon2100 <forgon2100@...> committed [15] In Warzone2100/warzone2100@15fa86d:
|
Forgon2100 <forgon2100@...> committed [3] In Warzone2100/warzone2100@3fb2dc2:
|
Forgon2100 <forgon2100@...> commented In Warzone2100/warzone2100@a8a5955:
|
resolution_fixed
type_patch (an actual patch, not a request for one)
| by ForgonMan page
When executing
a2x -f manpage -D . ./warzone2100.6.asciidoc
, Asciidoc prints a warning:This is an inconsequential error, which can be suppressed by instead executing
a2x -f manpage ./warzone2100.6.asciidoc
, which is functionally equivalent.JavaScript API reference
The JavaScript API reference is generated with the following commands:
Sed substitution commands are now delimited with a colon rather than a dash, which renders escape characters obsolete and improves readability.
The command '\lstloadlanguages' is not found because HeVea implements only a subset of the LaTeX package "listings" (read this section for more details) to which it belongs.
All references to programming languages have been removed since JavaScript, JSON and INI are not in the list of languages supported by "listings" (read page 13 of its documentation). These languages could be defined (read section 3.2 of the User's guide in the documentation), yet this would unlikely be worth the necessary effort since the JavaScript API documentation will soon be converted from LaTeX to Markdown.
In 3 cases, literal square brackets were confused with optional environment arguments, as in this example:
The problem was solved by declaring the "lstlisting" environment with an empty set of optional arguments.
The warning about no author being given was suppressed by declaring '\author{}' with an empty set of names.
Warnings about undefined labels commonly occur in LaTeX even in the absence of syntax errors. In such cases, the proper way to fix them when using HeVeA is to execute
hevea -fix <file>
rather than running the program several times.The only label used in the JavaScript API documentation was renamed from "objects:structure" to "subsec:Structure", which is more in line with LaTeX conventions.
Issue migrated from trac:4751 at 2022-04-16 13:03:35 -0700
The text was updated successfully, but these errors were encountered: