Mercurial > cpython-lru_cache-weakref
diff Doc/lib/libcgi.tex @ 5871:ed91cb7d3876 legacy-trunk
Document new 'quote' flag to cgi.escape().
| author | Guido van Rossum <guido@python.org> |
|---|---|
| date | Sat, 19 Jul 1997 20:16:07 +0000 |
| parents | 3468ea8645ca |
| children | 17a26f986007 |
line wrap: on
line diff
--- a/Doc/lib/libcgi.tex Sat Jul 19 20:11:53 1997 +0000 +++ b/Doc/lib/libcgi.tex Sat Jul 19 20:16:07 1997 +0000 @@ -219,10 +219,12 @@ HTML. \end{funcdesc} -\begin{funcdesc}{escape}{}: convert the characters ``\code{\&}'', ``\code{<}'' and ``\code{>}'' to HTML-safe +\begin{funcdesc}{escape}{s\optional{\, quote}}: convert the characters +``\code{\&}'', ``\code{<}'' and ``\code{>}'' in string \var{s} to HTML-safe sequences. Use this if you need to display text that might contain -such characters in HTML. To translate URLs for inclusion in the HREF -attribute of an \code{<A>} tag, use \code{urllib.quote()}. +such characters in HTML. If the optional flag \var{quote} is true, +the double quote character (\code{"}) is also translated; this helps +for inclusion in an HTML attribute value, e.g. in ``\code{<A HREF="...">}''. \end{funcdesc}
