2017-03-15 15:31:09 -04:00
|
|
|
@c This document is part of the Liza Data Collection Framework manual.
|
|
|
|
@c Copyright (C) 2017 LoVullo Associates, Inc.
|
|
|
|
@c
|
|
|
|
@c Permission is granted to copy, distribute and/or modify this document
|
|
|
|
@c under the terms of the GNU Free Documentation License, Version 1.3
|
|
|
|
@c or any later version published by the Free Software Foundation;
|
|
|
|
@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
|
|
|
@c Texts. A copy of the license is included in the section entitled ``GNU
|
|
|
|
@c Free Documentation License''.
|
|
|
|
|
2017-03-21 10:27:36 -04:00
|
|
|
|
|
|
|
@c unicode CONSTRUCTION SIGN
|
|
|
|
@macro constructionsign
|
|
|
|
🚧
|
2017-03-15 15:31:09 -04:00
|
|
|
@end macro
|
|
|
|
|
2017-03-21 10:27:36 -04:00
|
|
|
|
|
|
|
@c insert appropriate em dash for mode
|
2017-03-15 15:31:09 -04:00
|
|
|
@ifnottex
|
2017-03-21 10:27:36 -04:00
|
|
|
@macro mdash
|
|
|
|
@inlinefmtifelse{html, @inlineraw{html,—}, —}
|
2017-03-15 15:31:09 -04:00
|
|
|
@end macro
|
|
|
|
@end ifnottex
|
2017-03-16 13:23:19 -04:00
|
|
|
|
2017-03-21 10:27:36 -04:00
|
|
|
@c the macro for TeX for some reason always seems to be followed
|
|
|
|
@c by a space when applied; #1 consumes it and re-adds if it's
|
|
|
|
@c not empty
|
|
|
|
@tex
|
|
|
|
\gdef\mdash#1{%
|
|
|
|
---%
|
|
|
|
\def\next{#1}%
|
|
|
|
\ifx\next\empty\relax\else#1\fi%
|
|
|
|
}
|
|
|
|
@end tex
|
|
|
|
|
|
|
|
|
|
|
|
@c inline documentation notice for some sort of quality
|
|
|
|
@c improvement or warning
|
2017-03-21 15:53:48 -04:00
|
|
|
@macro noticestart{type}
|
2017-03-21 10:27:36 -04:00
|
|
|
@html
|
|
|
|
<div class="doc-notice \type\">
|
|
|
|
@end html
|
2017-03-21 15:53:48 -04:00
|
|
|
@end macro
|
|
|
|
|
|
|
|
@macro noticeend{}
|
2017-03-21 10:27:36 -04:00
|
|
|
@html
|
|
|
|
</div>
|
|
|
|
@end html
|
|
|
|
@end macro
|
|
|
|
|
|
|
|
|
|
|
|
@c vanilla notice
|
|
|
|
@macro notice{text}
|
2017-03-21 15:53:48 -04:00
|
|
|
@noticestart{}
|
|
|
|
@emph{\text\}
|
|
|
|
@noticeend
|
2017-03-21 10:27:36 -04:00
|
|
|
@end macro
|
|
|
|
|
|
|
|
|
|
|
|
@c notice for developers of liza
|
|
|
|
@macro devnotice{text}
|
|
|
|
@ifset DEVNOTES
|
2017-03-21 15:53:48 -04:00
|
|
|
@noticestart{dev}
|
|
|
|
@emph{\text\}
|
|
|
|
@noticeend
|
2017-03-21 10:27:36 -04:00
|
|
|
@end ifset
|
|
|
|
@end macro
|
|
|
|
|
2017-03-16 13:23:19 -04:00
|
|
|
|
|
|
|
@c indicate that help is needed to produce docs
|
|
|
|
@macro helpwanted{}
|
|
|
|
@cindex TODO, Missing Docs
|
2017-03-21 10:27:36 -04:00
|
|
|
@dnindex Missing Docs
|
|
|
|
@notice{There's nothing here yet. Maybe you can help?}
|
|
|
|
@end macro
|
|
|
|
|
|
|
|
|
|
|
|
@c maintenance note for developers
|
|
|
|
@macro maintenance{desc}
|
|
|
|
@dnindex Maintenance Concern
|
|
|
|
@devnotice{This system has maintenance concerns.@footnote{
|
|
|
|
@maintfoot{\desc\}
|
|
|
|
}}
|
|
|
|
@end macro
|
|
|
|
|
|
|
|
@c encapsulated to avoid bad TeX generation (fails compilation
|
|
|
|
@c when inlined at call site)
|
|
|
|
@macro maintfoot{desc}
|
|
|
|
@html
|
|
|
|
<div class="footnote-notice dev">
|
|
|
|
@end html
|
|
|
|
\desc\
|
|
|
|
|
|
|
|
@emph{Developers should evaluate whether extra time should be
|
|
|
|
allocated for tasks involving this system.}
|
|
|
|
@html
|
|
|
|
</div>
|
|
|
|
@end html
|
2017-03-16 13:23:19 -04:00
|
|
|
@end macro
|
2017-03-21 15:57:30 -04:00
|
|
|
|
|
|
|
|
|
|
|
@c simple textual example
|
|
|
|
@macro exnotice{text}
|
|
|
|
@noticestart{ex}
|
|
|
|
@strong{Example:} \text\
|
|
|
|
@noticeend
|
|
|
|
@end macro
|
2017-03-21 16:36:41 -04:00
|
|
|
|
|
|
|
|
2017-03-22 12:15:45 -04:00
|
|
|
@c needs to be moved into liza
|
|
|
|
@macro mvnotice{text}
|
|
|
|
@noticestart{mv}
|
2017-03-22 12:16:03 -04:00
|
|
|
@emph{All or part of this system needs to be moved into Liza.}@footnote{
|
2017-03-22 12:15:45 -04:00
|
|
|
\text\}
|
|
|
|
@noticeend
|
|
|
|
@end macro
|
|
|
|
|
|
|
|
|
2017-03-21 16:36:41 -04:00
|
|
|
@c link to source file if URI is known, otherwise display
|
|
|
|
@c the path to the file
|
|
|
|
@ifset SRCURI
|
|
|
|
@macro srcref{path, display}
|
|
|
|
@url{@value{SRCURI}/\path\, @code{\display\}}
|
|
|
|
@end macro
|
|
|
|
@end ifset
|
|
|
|
|
|
|
|
@ifclear SRCURI
|
|
|
|
@macro srcref{path, display}
|
|
|
|
@file{\path\}
|
|
|
|
@end macro
|
|
|
|
@end ifclear
|