Title: Theory / Unimportant / CS / Descriptive / LaTeX / Companion +29 / 14 Package documintation tools
Tags: computer_to_instruction fromCommandLine hasNotNewEffectReturnsMeaning

Instruction: docstrip
Page: 814
Effect: Extract documentation from LaTeX package
Language: Latex
Chapter: 7
Section: 2.2

Instruction: % (in first column)
Page: 814
Effect: Start a documentation line
Language: Latex
Chapter: 7
Section: 1.1

Instruction: %(four spaces)\begin{macrocode}
foo
%(four spaces)\end{macrocode}
Page: 815
Effect: Put foo both as code and verbatim inside the documentation
Language: Latex
Context: documentation
Chapter: 7
Section: 1.1
Variables: foo some [latex]\LaTeX[/latex] code

Instruction: %(four spaces)\begin{macrocode*}
foo
%(four spaces)\end{macrocode*}
Page: 815
Effect: Similar to macrocode, but replace (space) by
Language: Latex
Context: documentation
Chapter: 7
Section: 1.1

Instruction: \DescribeEnv{\foo}
Page: 815
Effect: takes one argument, which will be shown in the margin and produces a special index entry as an environment
Language: Latex
Context: Latex documentation
Chapter: 7
Section: 1.2

Instruction: \DescribeMacro{\foo}
Page: 815
Effect: takes one argument, which will be shown in the margin and produces a special index entry as a macro
Language: Latex
Context: documentation
Chapter: 7
Section: 1.2

Instruction: % \begin{macro}{\foo}
% bar
% \begin{macrocode}
buz
% \end{macrocode}
% \end{macro}
Page: 816
Effect: Create a macro, named \foo, with documentation bar and code buz
Language: Latex
Context: documentation
Chapter: 7
Section: 1.2