summaryrefslogtreecommitdiffstats
path: root/Doc/doc/doc.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-04-03 04:51:13 (GMT)
committerFred Drake <fdrake@acm.org>2000-04-03 04:51:13 (GMT)
commite15956b46515dfc5cf258b7109e2b7b330c27e5f (patch)
tree0776ca09eb49808534b37e8f5320af8da5c0290c /Doc/doc/doc.tex
parent20082d92f2e5fc7736b3fb1839380cc7c0133165 (diff)
downloadcpython-e15956b46515dfc5cf258b7109e2b7b330c27e5f.zip
cpython-e15956b46515dfc5cf258b7109e2b7b330c27e5f.tar.gz
cpython-e15956b46515dfc5cf258b7109e2b7b330c27e5f.tar.bz2
Merged changes from the 1.5.2p2 release.
Diffstat (limited to 'Doc/doc/doc.tex')
-rw-r--r--Doc/doc/doc.tex24
1 files changed, 19 insertions, 5 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 7ea9b35..2ce3857 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -226,6 +226,19 @@ distribution, to create or maintain whole documents or sections.
macros. This section contains the reference material for these
facilities.
+ \subsection{Meta-information Markup \label{meta-info}}
+
+ \begin{macrodesc}{sectionauthor}{\p{author}\p{email}}
+ Identifies the author of the current section. \var{author}
+ should be the author's name such that it can be used for
+ presentation (though it isn't), and \var{email} should be the
+ author's email address. The domain name portion of
+ the address should be lower case.
+
+ No presentation is generated from this markup, but it is used to
+ help keep track of contributions.
+ \end{macrodesc}
+
\subsection{Information Units \label{info-units}}
XXX Explain terminology, or come up with something more ``lay.''
@@ -412,7 +425,8 @@ distribution, to create or maintain whole documents or sections.
\begin{macrodesc}{email}{\p{address}}
An email address. Note that this is \emph{not} hyperlinked in
- any of the possible output formats.
+ any of the possible output formats. The domain name portion of
+ the address should be lower case.
\end{macrodesc}
\begin{macrodesc}{emph}{\p{text}}
@@ -689,8 +703,8 @@ distribution, to create or maintain whole documents or sections.
An additional table-like environment is \env{synopsistable}. The
table generated by this environment contains two columns, and each
row is defined by an alternate definition of
- \macro{modulesynopsis}. This environment is not normally use by
- the user, but is created by the \macro{localmoduletable} macro.
+ \macro{modulesynopsis}. This environment is not normally used by
+ authors, but is created by the \macro{localmoduletable} macro.
\subsection{Reference List Markup \label{references}}
@@ -726,7 +740,7 @@ distribution, to create or maintain whole documents or sections.
\subsection{Index-generating Markup \label{indexing}}
Effective index generation for technical documents can be very
- difficult, especially for someone familliar with the topic but not
+ difficult, especially for someone familiar with the topic but not
the creation of indexes. Much of the difficulty arises in the
area of terminology: including the terms an expert would use for a
concept is not sufficient. Coming up with the terms that a novice
@@ -735,7 +749,7 @@ distribution, to create or maintain whole documents or sections.
The truly difficult aspects of index generation are not areas with
which the documentation tools can help. However, ease
- of producing the index once content decisions are make is within
+ of producing the index once content decisions are made is within
the scope of the tools. Markup is provided which the processing
software is able to use to generate a variety of kinds of index
entry with minimal effort. Additionally, many of the environments