summaryrefslogtreecommitdiffstats
path: root/Doc/doc/doc.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-09-12 17:52:33 (GMT)
committerFred Drake <fdrake@acm.org>2000-09-12 17:52:33 (GMT)
commit48449985f45745b06078c82bf01152daff13498d (patch)
treeb0f47adeae43350c5498fec57db1c6d24b840038 /Doc/doc/doc.tex
parent1349437e4c2bfc6e7f601f5a7c284a00fdbdcd6b (diff)
downloadcpython-48449985f45745b06078c82bf01152daff13498d.zip
cpython-48449985f45745b06078c82bf01152daff13498d.tar.gz
cpython-48449985f45745b06078c82bf01152daff13498d.tar.bz2
\seetitle: New macro for building reference list content.
Diffstat (limited to 'Doc/doc/doc.tex')
-rw-r--r--Doc/doc/doc.tex15
1 files changed, 11 insertions, 4 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index a834ab3..449bb8b 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -803,10 +803,10 @@ distribution, to create or maintain whole documents or sections.
markup used to describe individual references.
\end{envdesc}
- For each of the following macros, \var{why} should be a complete
- sentence, start with a capital letter (unless it starts with an
- identifier, which should not be modified), and end with the
- apropriate punctuation.
+ For each of the following macros, \var{why} should be one or more
+ complete sentences, starting with a capital letter (unless it
+ starts with an identifier, which should not be modified), and
+ ending with the apropriate punctuation.
\begin{macrodesc}{seemodule}{\op{key}\p{name}\p{why}}
Refer to another module. \var{why} should be a brief
@@ -844,6 +844,13 @@ distribution, to create or maintain whole documents or sections.
complete sentences.
\end{macrodesc}
+ \begin{macrodesc}{seetitle}{\op{url}\p{title}\p{why}}
+ Add a reference to an external document named \var{title}. If
+ \var{url} is given, the title is made a hyperlink in the HTML
+ version of the documentation, and displayed below the title in
+ the typeset versions of the documentation.
+ \end{macrodesc}
+
\begin{macrodesc}{seeurl}{\p{url}\p{why}}
References to specific on-line resources should be given using
the \macro{seeurl} macro. No title is associated with the