1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
|
# codedoc class
# Matthew Bertucci 11/6/2021 for v0.3
#keyvals:\documentclass/codedoc#c
autoclose
index
noheader
obeystop
tracing0
tracing1
tracing2
%<class name%>
#endkeyvals
### 1 Code & Documentation ###
## 1.1 Writing code ##
\ProduceFile{file}
\ProduceFile{file}[file name]
\ProduceFile{file}[file name][file version]
\ProduceFile{file}[file name][file version][file date]
\FileSource
\FileName
\FileVersion
\FileDate
\CloseFile{file}
\begin{code}#V
\end{code}
\begin{code*}#V
\end{code*}
\CodeFont{font specs}
\LineNumber{envname}{font specs}{width}
\LineNumber{envname}{font specs}{width}[number]
\begin{invisible}
\end{invisible}
\Header{text}
\AddBlankLine
\TabSize{number}
\Gobble{number}
\BoxTolerance{dimen%l}
## 1.2 Macros to describe macros ##
\DescribeMacro{macro}
\DefineMacro{macro}
\DescribeEnvironment{envname}
\DefineEnvironment{envname}
\DescribeIndexFont{font specs}
\DefineIndexFont{font specs}
\PrintMacro{macro}
\DocStripMarginpar
\IgnorePrefix{macro prefix}
\PrintPrefix{macro prefix}
\meta{arg}
\marg{arg}
\oarg{arg}
\parg{arg}
\bslash
\StopHere{code}
## 1.3 Choosing the class ##
#ifOption:memoir
#include:class-memoir
#endif
#ifOption:book
#include:class-book
#endif
#ifOption:ltxdockit
#include:class-ltxdockit
#endif
#ifOption:scrartcl
#include:class-scrartcl
#endif
#ifOption:scrbook
#include:class-scrbook
#endif
#ifOption:scrreprt
#include:class-scrreprt
#endif
#ifOption:scrlttr2
#include:class-scrlttr2
#endif
#ifOption:ltxdoc
#include:class-ltxdoc
#endif
#ifOption:report
#include:class-report
#endif
#ifOption:ltxguide
#include:class-ltxguide
#endif
#ifOption:ltxguidex
#include:class-ltxguidex
#endif
#ifOption:l3doc
#include:class-l3doc
#endif
## 1.4 Dangerous strings ##
\DangerousEnvironment{envname list}
\StartIgnore
\StopIgnore
### 2 Verbatim Madness ###
## 2.1 Example environments ##
\begin{example}
\end{example}
\begin{example*}
\end{example*}
\CodeInput
\CodeOutput
\NewExample{envname}{code input}{code output}{immediate execution}#N
\NewExample[options%keyvals]{envname}{code input}{code output}{immediate execution}#N
\RenewExample{envname}{code input}{code output}{immediate execution}#N
\RenewExample[options%keyvals]{envname}{code input}{code output}{immediate execution}#N
#keyvals:\NewExample,\RenewExample
numbered
continuous
visibleEOL
#endkeyvals
\eTeXOff
\eTeXOn
## 2.2 \ShortVerb and friends ##
\ShortVerb{character}
\UndoShortVerb
\ShortCode{character}
\ShortCode[example name]{character}
\UndoShortCode
\VerbBreak{character}
\UndoVerbBreak
\VerbCommand{escape}{left brace}{right brace}
\UndoVerbCommand
\CodeEscape{character}
\UndoCodeEscape
## Miscellaneous ##
\AtChar#*
#ifOption:index
#include:makeidx
#endif
|