Next: Language_specific
Prev: notation-tut
Up: Top
Top: Top
0.3. LaTeX-like markup commands: reference
This section assumes you are familiar with the
tutorial-ish material in section See notation-tut. It also assumes
some familiarity with LaTeX, in that I may say say, "It works as
in LaTeX".
The lists below catalog the environments
(`\begin{...}/\end{...}' things) and commands
(backslashed `\things') of our Glasgow literate-programming notation.
[For this clunky implementation, the `\begin{...}' and `\end{...}'
delimiters should be on lines by themselves, beginning in the leftmost
column.]
Occasional mention is made of the main programs used to process
literate files: `lit2pgm', which extracts the code from a file;
`lit2latex', which creates real LaTeX source from a file; and
`lit2texi', which creates Texinfo source from a file (from which
Info files can be made with `makeinfo').
Little things first:
- • In text, you should use the TeX style of double quotes:
```foo'''.
- • In text, backslashed magic characters, e.g., `\& \_ \# \$', will
produce the self-same de-backslashed magic characters in the output.
- • Accents on characters (e.g., `\'e') are fine; they are tossed from
Info files.
- • You may safely use the italic correction `\/'.
- • At least the font-fiddling declarations `\sc' and `\tt' will
work; they are heartily unrecommended.
APRIL91: see the comments in section See diff-fonts-in-text.
Also, make them commands, not declarations?
Commands and environments (in alphabetical order):
Menu
- \appendix
- \appendix.
- \author
- \author{<text>}.
- center_environment
- center environment.
- \centerline
- \centerline{<text>}.
- \caption
- \caption{<text>}.
- \clearpage-etc
- \clearpage and \cleardoublepage.
- code_environment
- code environment.
- comment_environment
- comment environment.
- \date
- \date{<text>}.
- \define
- \define{<command>}{<replacement>}.
- description_environment
- description environment.
- display_environment
- display environment.
- \documentstyle
- \documentstyle[<style-options>]{<doc-type>}.
- \em
- {\em <text>}.
- enumerate_environment
- enumerate environment.
- figure_environment
- figure environment.
- flushdisplay_environment
- flushdisplay environment.
- flushverbatim_environment
- flushverbatim environment.
- \footnote
- \footnote{<text>}.
- \heading
- \heading{<title>}.
- \index
- \index{<entry>}.
- \input
- \input{<filename>}.
- \inputnow
- \inputnow{<filename>}.
- \insertribbon
- \insertribbon{<ribbon-name>}.
- itemize_environment
- itemize environment.
- \label
- \label.
- \listoffigures-etc
- \listoffigures and \listoftables.
- \makeindex
- \makeindex.
- \maketitle
- \maketitle.
- menu_environment
- menu environment.
- \menuentry
- \menuentry{<tag>}{<description>}.
- \node
- \node{<node-spec>}.
- \pounds
- \pounds<something-like-a-number>.
- onlyinfo_environment
- onlyinfo environment.
- onlylatex_environment
- onlylatex environment.
- onlypartofdoc_environment
- onlypartofdoc environment.
- onlystandalone_environment
- onlystandalone environment.
- \pageref
- \pageref{<label-or-node-name>}.
- \pl
- \pl.
- \printindex
- \printindex.
- pseudocode_environment
- pseudocode environment.
- quotation_environment
- quotation environment.
- rawlatex_environment
- rawlatex environment.
- \ref
- \ref{<label-or-node-name>}.
- \rootsectiontype
- \rootsectiontype{<real-sectioning-command>}.
- \sectiontype
- \sectiontype{<nodename>}.
- \sectionref
- \sectionref{<nodename>}.
- \standaloneornot
- \standaloneornot{<ifso>}{<ifnot>}.
- \suppresscomments
- \suppresscomments.
- table_environment
- table environment.
- \tableofcontents
- \tableofcontents.
- tabular_environment
- tabular environment.
- \title
- \title{<text>}.
- \tr
- \tr.
- verbatim_environment
- verbatim environment.