doc/macros.texi: Fix PDF output issues with @maintenance
doc/macros.texi (@maintstart, @maintend): Add macros. (@maintenance): Use them.master
parent
2ed43ba986
commit
8d09c2d8c3
|
@ -122,7 +122,8 @@ More information about each can be found in their respective section.
|
||||||
|
|
||||||
@node Assertions
|
@node Assertions
|
||||||
@section Assertions
|
@section Assertions
|
||||||
@maintenance{
|
@maintstart
|
||||||
|
@footnote{
|
||||||
Assertions are compiled from the Program XML (@pxref{Program XML}).
|
Assertions are compiled from the Program XML (@pxref{Program XML}).
|
||||||
Rather than using a library,
|
Rather than using a library,
|
||||||
it compiles a mess of largely duplicate code inline.
|
it compiles a mess of largely duplicate code inline.
|
||||||
|
@ -135,6 +136,7 @@ More information about each can be found in their respective section.
|
||||||
system.
|
system.
|
||||||
@emph{The latter option is preferred,
|
@emph{The latter option is preferred,
|
||||||
and would be more powerful with less maintenance.}}
|
and would be more powerful with less maintenance.}}
|
||||||
|
@maintend
|
||||||
|
|
||||||
@helpwanted
|
@helpwanted
|
||||||
|
|
||||||
|
@ -158,7 +160,8 @@ More information about each can be found in their respective section.
|
||||||
|
|
||||||
@node Client
|
@node Client
|
||||||
@section Client
|
@section Client
|
||||||
@maintenance{
|
@maintstart
|
||||||
|
@footnote{
|
||||||
The client is largely managed by a single class,
|
The client is largely managed by a single class,
|
||||||
@srcref{src/client/Client.js, Client},
|
@srcref{src/client/Client.js, Client},
|
||||||
which has grown out of control.
|
which has grown out of control.
|
||||||
|
@ -166,6 +169,7 @@ More information about each can be found in their respective section.
|
||||||
Code is to be extracted out of this class as it is touched.
|
Code is to be extracted out of this class as it is touched.
|
||||||
|
|
||||||
The other system mammoth is @code{Ui} (@pxref{Program UI}).}
|
The other system mammoth is @code{Ui} (@pxref{Program UI}).}
|
||||||
|
@maintend
|
||||||
|
|
||||||
@helpwanted
|
@helpwanted
|
||||||
|
|
||||||
|
@ -246,7 +250,8 @@ Error state is managed by
|
||||||
|
|
||||||
@node Program
|
@node Program
|
||||||
@section Program
|
@section Program
|
||||||
@maintenance{
|
@maintstart
|
||||||
|
@footnote{
|
||||||
The @code{Program} class was one of the first prototypes created,
|
The @code{Program} class was one of the first prototypes created,
|
||||||
and has evolved poorly with the rest of the system.
|
and has evolved poorly with the rest of the system.
|
||||||
It is the base class for all compiled programs,
|
It is the base class for all compiled programs,
|
||||||
|
@ -255,6 +260,7 @@ Error state is managed by
|
||||||
|
|
||||||
With that said, it is one of the least touched classes (thus its
|
With that said, it is one of the least touched classes (thus its
|
||||||
state); developers rarely have the need to touch @code{Program}.}
|
state); developers rarely have the need to touch @code{Program}.}
|
||||||
|
@maintend
|
||||||
|
|
||||||
@mvnotice{
|
@mvnotice{
|
||||||
The core @code{Program} class that causes maintenance concerns needs
|
The core @code{Program} class that causes maintenance concerns needs
|
||||||
|
|
|
@ -76,13 +76,27 @@
|
||||||
|
|
||||||
|
|
||||||
@c maintenance note for developers
|
@c maintenance note for developers
|
||||||
@macro maintenance{desc}
|
@c
|
||||||
|
@c N.B. use @maintstart and @maintend manually if using multiple
|
||||||
|
@c paragraphs otherwise PDF output (TeX) breaks; we'll figure out
|
||||||
|
@c a better solution in the future
|
||||||
|
@macro maintstart{}
|
||||||
@dnindex Maintenance Concern
|
@dnindex Maintenance Concern
|
||||||
@devnotice{This system has maintenance concerns.@footnote{
|
@noticestart{dev}
|
||||||
@maintfoot{\desc\}
|
This system has maintenance concerns.
|
||||||
}}
|
|
||||||
@end macro
|
@end macro
|
||||||
|
|
||||||
|
@macro maintend
|
||||||
|
@noticeend
|
||||||
|
@end macro
|
||||||
|
|
||||||
|
@macro maintenance{desc}
|
||||||
|
@maintstart
|
||||||
|
@footnote{\desc\}
|
||||||
|
@maintend
|
||||||
|
@end macro
|
||||||
|
|
||||||
|
|
||||||
@c encapsulated to avoid bad TeX generation (fails compilation
|
@c encapsulated to avoid bad TeX generation (fails compilation
|
||||||
@c when inlined at call site)
|
@c when inlined at call site)
|
||||||
@macro maintfoot{desc}
|
@macro maintfoot{desc}
|
||||||
|
|
Loading…
Reference in New Issue