summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-01-20 05:07:19 (GMT)
committerFred Drake <fdrake@acm.org>1998-01-20 05:07:19 (GMT)
commit311c19688d0bc79fbe718de7c277e9f08c3664da (patch)
tree384742ababd6d4afe95aefa9ce633711adcf1008 /Doc
parentcb42f7c2956b51f02dc2355615858deefc119743 (diff)
downloadcpython-311c19688d0bc79fbe718de7c277e9f08c3664da.zip
cpython-311c19688d0bc79fbe718de7c277e9f08c3664da.tar.gz
cpython-311c19688d0bc79fbe718de7c277e9f08c3664da.tar.bz2
Proposed new macros: see comments. These are not yet used.
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.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/myformat.sty20
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/myformat.sty b/Doc/myformat.sty
index 2e782c5..059816b 100644
--- a/Doc/myformat.sty
+++ b/Doc/myformat.sty
@@ -182,6 +182,7 @@
%% {\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}
@@ -208,6 +209,25 @@
\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}}