Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b441eb8

Browse files
freddrakefreddrake
committed
Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments
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.
1 parent aebc6f3 commit b441eb8

2 files changed

Lines changed: 32 additions & 32 deletions

File tree

‎Doc/lib/libsgmllib.tex‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ \section{Standard Module \sectcode{sgmllib}}
1717

1818
\item
1919
Opening and closing tags of the form
20-
``\code{<\var{tag} \var{attr}="\var{value}" ...>}'' and
21-
``\code{</\var{tag}>}'', respectively.
20+
\samp{<\var{tag} \var{attr}="\var{value}" ...>} and
21+
\samp{</\var{tag}>}, respectively.
2222

2323
\item
24-
Numeric character references of the form ``\code{\&\#\var{name};}''.
24+
Numeric character references of the form \samp{\&\#\var{name};}.
2525

2626
\item
27-
Entity references of the form ``\code{\&\var{name};}''.
27+
Entity references of the form \samp{\&\var{name};}.
2828

2929
\item
30-
SGML comments of the form ``\code{<!--\var{text}-->}''. Note that
30+
SGML comments of the form \samp{<!--\var{text}-->}. Note that
3131
spaces, tabs, and newlines are allowed between the trailing
32-
``\code{>}'' and the immediately preceeding ``\code{--}''.
32+
\samp{>} and the immediately preceeding \samp{--}.
3333

3434
\end{itemize}
3535

@@ -102,7 +102,7 @@ \section{Standard Module \sectcode{sgmllib}}
102102
103103
\begin{funcdesc}{handle_charref}{ref}
104104
This method is called to process a character reference of the form
105-
``\code{\&\#\var{ref};}''. In the base implementation, \var{ref} must
105+
\samp{\&\#\var{ref};}. In the base implementation, \var{ref} must
106106
be a decimal number in the
107107
range 0-255. It translates the character to \ASCII{} and calls the
108108
method \code{handle_data()} with the character as argument. If
@@ -114,7 +114,7 @@ \section{Standard Module \sectcode{sgmllib}}
114114
115115
\begin{funcdesc}{handle_entityref}{ref}
116116
This method is called to process a general entity reference of the form
117-
``\code{\&\var{ref};}'' where \var{ref} is an general entity
117+
\samp{\&\var{ref};} where \var{ref} is an general entity
118118
reference. It looks for \var{ref} in the instance (or class)
119119
variable \code{entitydefs} which should be a mapping from entity names
120120
to corresponding translations.
@@ -128,8 +128,8 @@ \section{Standard Module \sectcode{sgmllib}}
128128
\begin{funcdesc}{handle_comment}{comment}
129129
This method is called when a comment is encountered. The
130130
\code{comment} argument is a string containing the text between the
131-
``\code{<!--}'' and ``\code{-->}'' delimiters, but not the delimiters
132-
themselves. For example, the comment ``\code{<!--text-->}'' will
131+
\samp{<!--} and \samp{-->} delimiters, but not the delimiters
132+
themselves. For example, the comment \samp{<!--text-->} will
133133
cause this method to be called with the argument \code{'text'}. The
134134
default method does nothing.
135135
\end{funcdesc}
@@ -169,21 +169,21 @@ \section{Standard Module \sectcode{sgmllib}}
169169
independent; the \var{tag} occurring in method names must be in lower
170170
case:
171171
172-
\begin{funcdesc}{start_\var{tag}}{attributes}
172+
\begin{funcdescni}{start_\var{tag}}{attributes}
173173
This method is called to process an opening tag \var{tag}. It has
174174
preference over \code{do_\var{tag}()}. The \var{attributes} argument
175175
has the same meaning as described for \code{handle_starttag()} above.
176-
\end{funcdesc}
176+
\end{funcdescni}
177177
178-
\begin{funcdesc}{do_\var{tag}}{attributes}
178+
\begin{funcdescni}{do_\var{tag}}{attributes}
179179
This method is called to process an opening tag \var{tag} that does
180180
not come with a matching closing tag. The \var{attributes} argument
181181
has the same meaning as described for \code{handle_starttag()} above.
182-
\end{funcdesc}
182+
\end{funcdescni}
183183
184-
\begin{funcdesc}{end_\var{tag}}{}
184+
\begin{funcdescni}{end_\var{tag}}{}
185185
This method is called to process a closing tag \var{tag}.
186-
\end{funcdesc}
186+
\end{funcdescni}
187187
188188
Note that the parser maintains a stack of open elements for which no
189189
end tag has been found yet. Only tags processed by

‎Doc/libsgmllib.tex‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ \section{Standard Module \sectcode{sgmllib}}
1717

1818
\item
1919
Opening and closing tags of the form
20-
``\code{<\var{tag} \var{attr}="\var{value}" ...>}'' and
21-
``\code{</\var{tag}>}'', respectively.
20+
\samp{<\var{tag} \var{attr}="\var{value}" ...>} and
21+
\samp{</\var{tag}>}, respectively.
2222

2323
\item
24-
Numeric character references of the form ``\code{\&\#\var{name};}''.
24+
Numeric character references of the form \samp{\&\#\var{name};}.
2525

2626
\item
27-
Entity references of the form ``\code{\&\var{name};}''.
27+
Entity references of the form \samp{\&\var{name};}.
2828

2929
\item
30-
SGML comments of the form ``\code{<!--\var{text}-->}''. Note that
30+
SGML comments of the form \samp{<!--\var{text}-->}. Note that
3131
spaces, tabs, and newlines are allowed between the trailing
32-
``\code{>}'' and the immediately preceeding ``\code{--}''.
32+
\samp{>} and the immediately preceeding \samp{--}.
3333

3434
\end{itemize}
3535

@@ -102,7 +102,7 @@ \section{Standard Module \sectcode{sgmllib}}
102102
103103
\begin{funcdesc}{handle_charref}{ref}
104104
This method is called to process a character reference of the form
105-
``\code{\&\#\var{ref};}''. In the base implementation, \var{ref} must
105+
\samp{\&\#\var{ref};}. In the base implementation, \var{ref} must
106106
be a decimal number in the
107107
range 0-255. It translates the character to \ASCII{} and calls the
108108
method \code{handle_data()} with the character as argument. If
@@ -114,7 +114,7 @@ \section{Standard Module \sectcode{sgmllib}}
114114
115115
\begin{funcdesc}{handle_entityref}{ref}
116116
This method is called to process a general entity reference of the form
117-
``\code{\&\var{ref};}'' where \var{ref} is an general entity
117+
\samp{\&\var{ref};} where \var{ref} is an general entity
118118
reference. It looks for \var{ref} in the instance (or class)
119119
variable \code{entitydefs} which should be a mapping from entity names
120120
to corresponding translations.
@@ -128,8 +128,8 @@ \section{Standard Module \sectcode{sgmllib}}
128128
\begin{funcdesc}{handle_comment}{comment}
129129
This method is called when a comment is encountered. The
130130
\code{comment} argument is a string containing the text between the
131-
``\code{<!--}'' and ``\code{-->}'' delimiters, but not the delimiters
132-
themselves. For example, the comment ``\code{<!--text-->}'' will
131+
\samp{<!--} and \samp{-->} delimiters, but not the delimiters
132+
themselves. For example, the comment \samp{<!--text-->} will
133133
cause this method to be called with the argument \code{'text'}. The
134134
default method does nothing.
135135
\end{funcdesc}
@@ -169,21 +169,21 @@ \section{Standard Module \sectcode{sgmllib}}
169169
independent; the \var{tag} occurring in method names must be in lower
170170
case:
171171
172-
\begin{funcdesc}{start_\var{tag}}{attributes}
172+
\begin{funcdescni}{start_\var{tag}}{attributes}
173173
This method is called to process an opening tag \var{tag}. It has
174174
preference over \code{do_\var{tag}()}. The \var{attributes} argument
175175
has the same meaning as described for \code{handle_starttag()} above.
176-
\end{funcdesc}
176+
\end{funcdescni}
177177
178-
\begin{funcdesc}{do_\var{tag}}{attributes}
178+
\begin{funcdescni}{do_\var{tag}}{attributes}
179179
This method is called to process an opening tag \var{tag} that does
180180
not come with a matching closing tag. The \var{attributes} argument
181181
has the same meaning as described for \code{handle_starttag()} above.
182-
\end{funcdesc}
182+
\end{funcdescni}
183183
184-
\begin{funcdesc}{end_\var{tag}}{}
184+
\begin{funcdescni}{end_\var{tag}}{}
185185
This method is called to process a closing tag \var{tag}.
186-
\end{funcdesc}
186+
\end{funcdescni}
187187
188188
Note that the parser maintains a stack of open elements for which no
189189
end tag has been found yet. Only tags processed by

0 commit comments

Comments
 (0)