mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-13 15:40:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments

Browse source 
in the running text.

For computed method names (where there's a \var{} part to the name), use
the non-indexing form of \funcdesc{}.  This doesn't change the printed
output, but removes 3 rejections from the makeindex run and allows the
LaTeX2HTML support to exclude these from the index.
This commit is contained in:
Fred Drake 1998-02-13 14:37:12 +00:00
parent aebc6f399e
commit b441eb84d3
2 changed files with 32 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

32
Doc/lib/libsgmllib.tex
View file

@ -17,19 +17,19 @@ constructs:
\item \item
Opening and closing tags of the form Opening and closing tags of the form
``\code{<\var{tag} \var{attr}="\var{value}" ...>}'' and \samp{<\var{tag} \var{attr}="\var{value}" ...>} and
``\code{</\var{tag}>}'', respectively. \samp{</\var{tag}>}, respectively.
\item \item
Numeric character references of the form ``\code{\&\#\var{name};}''. Numeric character references of the form \samp{\&\#\var{name};}.
\item \item
Entity references of the form ``\code{\&\var{name};}''. Entity references of the form \samp{\&\var{name};}.
\item \item
SGML comments of the form ``\code{<!--\var{text}-->}''. Note that SGML comments of the form \samp{<!--\var{text}-->}. Note that
spaces, tabs, and newlines are allowed between the trailing spaces, tabs, and newlines are allowed between the trailing
``\code{>}'' and the immediately preceeding ``\code{--}''. \samp{>} and the immediately preceeding \samp{--}.
\end{itemize} \end{itemize}
@ -102,7 +102,7 @@ nothing.
\begin{funcdesc}{handle_charref}{ref} \begin{funcdesc}{handle_charref}{ref}
This method is called to process a character reference of the form This method is called to process a character reference of the form
``\code{\&\#\var{ref};}''. In the base implementation, \var{ref} must \samp{\&\#\var{ref};}. In the base implementation, \var{ref} must
be a decimal number in the be a decimal number in the
range 0-255. It translates the character to \ASCII{} and calls the range 0-255. It translates the character to \ASCII{} and calls the
method \code{handle_data()} with the character as argument. If method \code{handle_data()} with the character as argument. If
@ -114,7 +114,7 @@ character entities.
\begin{funcdesc}{handle_entityref}{ref} \begin{funcdesc}{handle_entityref}{ref}
This method is called to process a general entity reference of the form This method is called to process a general entity reference of the form
``\code{\&\var{ref};}'' where \var{ref} is an general entity \samp{\&\var{ref};} where \var{ref} is an general entity
reference. It looks for \var{ref} in the instance (or class) reference. It looks for \var{ref} in the instance (or class)
variable \code{entitydefs} which should be a mapping from entity names variable \code{entitydefs} which should be a mapping from entity names
to corresponding translations. to corresponding translations.
@ -128,8 +128,8 @@ defines translations for \code{\&amp;}, \code{\&apos}, \code{\&gt;},
\begin{funcdesc}{handle_comment}{comment} \begin{funcdesc}{handle_comment}{comment}
This method is called when a comment is encountered. The This method is called when a comment is encountered. The
\code{comment} argument is a string containing the text between the \code{comment} argument is a string containing the text between the
``\code{<!--}'' and ``\code{-->}'' delimiters, but not the delimiters \samp{<!--} and \samp{-->} delimiters, but not the delimiters
themselves. For example, the comment ``\code{<!--text-->}'' will themselves. For example, the comment \samp{<!--text-->} will
cause this method to be called with the argument \code{'text'}. The cause this method to be called with the argument \code{'text'}. The
default method does nothing. default method does nothing.
\end{funcdesc} \end{funcdesc}
@ -169,21 +169,21 @@ processing of specific tags. Tag names in the input stream are case
independent; the \var{tag} occurring in method names must be in lower independent; the \var{tag} occurring in method names must be in lower
case: case:
\begin{funcdesc}{start_\var{tag}}{attributes} \begin{funcdescni}{start_\var{tag}}{attributes}
This method is called to process an opening tag \var{tag}. It has This method is called to process an opening tag \var{tag}. It has
preference over \code{do_\var{tag}()}. The \var{attributes} argument preference over \code{do_\var{tag}()}. The \var{attributes} argument
has the same meaning as described for \code{handle_starttag()} above. has the same meaning as described for \code{handle_starttag()} above.
\end{funcdesc} \end{funcdescni}
\begin{funcdesc}{do_\var{tag}}{attributes} \begin{funcdescni}{do_\var{tag}}{attributes}
This method is called to process an opening tag \var{tag} that does This method is called to process an opening tag \var{tag} that does
not come with a matching closing tag. The \var{attributes} argument not come with a matching closing tag. The \var{attributes} argument
has the same meaning as described for \code{handle_starttag()} above. has the same meaning as described for \code{handle_starttag()} above.
\end{funcdesc} \end{funcdescni}
\begin{funcdesc}{end_\var{tag}}{} \begin{funcdescni}{end_\var{tag}}{}
This method is called to process a closing tag \var{tag}. This method is called to process a closing tag \var{tag}.
\end{funcdesc} \end{funcdescni}
Note that the parser maintains a stack of open elements for which no Note that the parser maintains a stack of open elements for which no
end tag has been found yet. Only tags processed by end tag has been found yet. Only tags processed by

32
Doc/libsgmllib.tex
View file

@ -17,19 +17,19 @@ constructs:
\item \item
Opening and closing tags of the form Opening and closing tags of the form
``\code{<\var{tag} \var{attr}="\var{value}" ...>}'' and \samp{<\var{tag} \var{attr}="\var{value}" ...>} and
``\code{</\var{tag}>}'', respectively. \samp{</\var{tag}>}, respectively.
\item \item
Numeric character references of the form ``\code{\&\#\var{name};}''. Numeric character references of the form \samp{\&\#\var{name};}.
\item \item
Entity references of the form ``\code{\&\var{name};}''. Entity references of the form \samp{\&\var{name};}.
\item \item
SGML comments of the form ``\code{<!--\var{text}-->}''. Note that SGML comments of the form \samp{<!--\var{text}-->}. Note that
spaces, tabs, and newlines are allowed between the trailing spaces, tabs, and newlines are allowed between the trailing
``\code{>}'' and the immediately preceeding ``\code{--}''. \samp{>} and the immediately preceeding \samp{--}.
\end{itemize} \end{itemize}
@ -102,7 +102,7 @@ nothing.
\begin{funcdesc}{handle_charref}{ref} \begin{funcdesc}{handle_charref}{ref}
This method is called to process a character reference of the form This method is called to process a character reference of the form
``\code{\&\#\var{ref};}''. In the base implementation, \var{ref} must \samp{\&\#\var{ref};}. In the base implementation, \var{ref} must
be a decimal number in the be a decimal number in the
range 0-255. It translates the character to \ASCII{} and calls the range 0-255. It translates the character to \ASCII{} and calls the
method \code{handle_data()} with the character as argument. If method \code{handle_data()} with the character as argument. If
@ -114,7 +114,7 @@ character entities.
\begin{funcdesc}{handle_entityref}{ref} \begin{funcdesc}{handle_entityref}{ref}
This method is called to process a general entity reference of the form This method is called to process a general entity reference of the form
``\code{\&\var{ref};}'' where \var{ref} is an general entity \samp{\&\var{ref};} where \var{ref} is an general entity
reference. It looks for \var{ref} in the instance (or class) reference. It looks for \var{ref} in the instance (or class)
variable \code{entitydefs} which should be a mapping from entity names variable \code{entitydefs} which should be a mapping from entity names
to corresponding translations. to corresponding translations.
@ -128,8 +128,8 @@ defines translations for \code{\&amp;}, \code{\&apos}, \code{\&gt;},
\begin{funcdesc}{handle_comment}{comment} \begin{funcdesc}{handle_comment}{comment}
This method is called when a comment is encountered. The This method is called when a comment is encountered. The
\code{comment} argument is a string containing the text between the \code{comment} argument is a string containing the text between the
``\code{<!--}'' and ``\code{-->}'' delimiters, but not the delimiters \samp{<!--} and \samp{-->} delimiters, but not the delimiters
themselves. For example, the comment ``\code{<!--text-->}'' will themselves. For example, the comment \samp{<!--text-->} will
cause this method to be called with the argument \code{'text'}. The cause this method to be called with the argument \code{'text'}. The
default method does nothing. default method does nothing.
\end{funcdesc} \end{funcdesc}
@ -169,21 +169,21 @@ processing of specific tags. Tag names in the input stream are case
independent; the \var{tag} occurring in method names must be in lower independent; the \var{tag} occurring in method names must be in lower
case: case:
\begin{funcdesc}{start_\var{tag}}{attributes} \begin{funcdescni}{start_\var{tag}}{attributes}
This method is called to process an opening tag \var{tag}. It has This method is called to process an opening tag \var{tag}. It has
preference over \code{do_\var{tag}()}. The \var{attributes} argument preference over \code{do_\var{tag}()}. The \var{attributes} argument
has the same meaning as described for \code{handle_starttag()} above. has the same meaning as described for \code{handle_starttag()} above.
\end{funcdesc} \end{funcdescni}
\begin{funcdesc}{do_\var{tag}}{attributes} \begin{funcdescni}{do_\var{tag}}{attributes}
This method is called to process an opening tag \var{tag} that does This method is called to process an opening tag \var{tag} that does
not come with a matching closing tag. The \var{attributes} argument not come with a matching closing tag. The \var{attributes} argument
has the same meaning as described for \code{handle_starttag()} above. has the same meaning as described for \code{handle_starttag()} above.
\end{funcdesc} \end{funcdescni}
\begin{funcdesc}{end_\var{tag}}{} \begin{funcdescni}{end_\var{tag}}{}
This method is called to process a closing tag \var{tag}. This method is called to process a closing tag \var{tag}.
\end{funcdesc} \end{funcdescni}
Note that the parser maintains a stack of open elements for which no Note that the parser maintains a stack of open elements for which no
end tag has been found yet. Only tags processed by end tag has been found yet. Only tags processed by