summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-08-03 18:36:17 (GMT)
committerFred Drake <fdrake@acm.org>2001-08-03 18:36:17 (GMT)
commit7eac0cb04c35529f17b797fa6e5a0872ff1a6a86 (patch)
treebb597022de250b83d61a6ec5e0d49c245d30e3be
parent30cf118cf73cef3c870f90b24d1574975cb2140e (diff)
downloadcpython-7eac0cb04c35529f17b797fa6e5a0872ff1a6a86.zip
cpython-7eac0cb04c35529f17b797fa6e5a0872ff1a6a86.tar.gz
cpython-7eac0cb04c35529f17b797fa6e5a0872ff1a6a86.tar.bz2
Define the \mailheader macro and document conventions for using it.
-rw-r--r--Doc/doc/doc.tex11
-rw-r--r--Doc/perl/python.perl2
-rw-r--r--Doc/texinputs/python.sty1
3 files changed, 14 insertions, 0 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 9cf1d77..afb59f7 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -834,6 +834,17 @@ This \UNIX\ is also followed by a space.
used.
\end{macrodesc}
+ \begin{macrodesc}{mailheader}{\p{name}}
+ The name of an \rfc{822}-style mail header. This markup does
+ not imply that the header is being used in an email message, but
+ can be used to refer to any header of the same ``style.'' This
+ is also used for headers defined by the various MIME
+ specifications. The header name should be entered in the same
+ way it would normally be found in practice, with the
+ camel-casing conventions being preferred where there is more
+ than one common usage. For example: \mailheader{Content-Type}.
+ \end{macrodesc}
+
\begin{macrodesc}{mimetype}{\p{name}}
The name of a MIME type.
\end{macrodesc}
diff --git a/Doc/perl/python.perl b/Doc/perl/python.perl
index 91c7632..dabab66 100644
--- a/Doc/perl/python.perl
+++ b/Doc/perl/python.perl
@@ -212,6 +212,8 @@ sub do_cmd_longprogramopt{
return use_wrappers(@_[0], '<b class="programopt">---', '</b>'); }
sub do_cmd_email{
return use_wrappers(@_[0], '<span class="email">', '</span>'); }
+sub do_cmd_mailheader{
+ return use_wrappers(@_[0], '<tt class="mimeheader">', '</tt>'); }
sub do_cmd_mimetype{
return use_wrappers(@_[0], '<span class="mimetype">', '</span>'); }
sub do_cmd_var{
diff --git a/Doc/texinputs/python.sty b/Doc/texinputs/python.sty
index 498fc3b..6b892cb 100644
--- a/Doc/texinputs/python.sty
+++ b/Doc/texinputs/python.sty
@@ -833,6 +833,7 @@
\newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name
\newcommand{\cdata}[1]{\texttt{#1}} % C variable, typically global
+\newcommand{\mailheader}[1]{\texttt{#1}}
\newcommand{\mimetype}[1]{{\small\textsf{#1}}}
% The \! is a "negative thin space" in math mode.
\newcommand{\regexp}[1]{%