]> granicus.if.org Git - python/commitdiff
Proposed new macros: see comments. These are not yet used.
authorFred Drake <fdrake@acm.org>
Tue, 20 Jan 1998 05:07:19 +0000 (05:07 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 20 Jan 1998 05:07:19 +0000 (05:07 +0000)
These are intended to support semantic markup.  There are a number
of places in the documentation where the exact meaning of an
indentifier marked \code{} in the running text is ambiguous (could
be a module or a class, a function or a method, etc.).  These are
intended to clarify the intent of the identifier for processing
applications and more intelligent style processing.

Doc/myformat.sty

index 2e782c54792cb02538695d032b41531dadb3bf7d..059816b78416a0886fb7a2662dd2880e0164c145 100644 (file)
 %% {\command}.  This works better with the texinfo translation.
 \newcommand{\ABC}{{\sc abc}}
 \newcommand{\UNIX}{{\sc Unix}}
+\newcommand{\POSIX}{POSIX}
 \newcommand{\ASCII}{{\sc ascii}}
 \newcommand{\Cpp}{C\protect\raisebox{.18ex}{++}}
 \newcommand{\C}{C}
 \newif\iftexi\texifalse
 \newif\iflatex\latextrue
 
+% Proposed new macros:  These should be used for all references to identifiers
+% which are used to refer to instances of specific language constructs.  See
+% the names for specific semantic assignments.
+%
+% For now, don't do anything really fancy with them, but note that \func and
+% \method append trailing parentheses.
+%
+\let\module=\code
+\let\kw=\code
+\let\exc=\code
+\let\class=\code
+\newcommand{\func}[1]{\code{#1()}}
+\newcommand{\method}[1]{\code{#1()}}
+
+\newcommand{\manpage}[2]{{\emph{#1}(#2)}}
+\let\email=\code
+\let\url=\code
+
+
 \newenvironment{tableii}[4]{\begin{center}\def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}\begin{tabular}{#1}\hline#3&#4\\
 \hline}{\hline\end{tabular}\end{center}}