New markup: \note{...} and \warning{...}

freddrake · freddrake · commit 92350b3a1f74 · 2001-10-09T18:01:23.000Z
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
@@ -859,6 +859,14 @@ \section{Special Markup Constructs \label{special-constructs}}
       The name of a Usenet newsgroup.
     \end{macrodesc}
 
+    \begin{macrodesc}{note}{\p{text}}
+      An especially important bit of information about an API that a
+      user should be aware of when using whatever bit of API the
+      note pertains to.  This should be the last thing in the
+      paragraph as the end of the note is not visually marked in
+      any way.
+    \end{macrodesc}
+
     \begin{macrodesc}{pep}{\p{number}}
       A reference to a Python Enhancement Proposal.  This generates
       appropriate index entries.  The text \samp{PEP \var{number}} is
@@ -989,6 +997,15 @@ \section{Special Markup Constructs \label{special-constructs}}
       explanation makes sense and may vary as needed.
     \end{macrodesc}
 
+    \begin{macrodesc}{warning}{\p{text}}
+      An important bit of information about an API that a user should
+      be very aware of when using whatever bit of API the warning
+      pertains to.  This should be the last thing in the paragraph as
+      the end of the warning is not visually marked in any way.  This
+      differs from \macro{note} in that it is recommended over
+      \macro{note} for information regarding security.
+    \end{macrodesc}
+
 
   \subsection{Module-specific Markup \label{module-markup}}
 
diff --git a/Doc/perl/python.perl b/Doc/perl/python.perl
@@ -236,6 +236,16 @@ sub do_cmd_textbf{
     return use_wrappers(@_[0], '<b>', '</b>'); }
 sub do_cmd_textit{
     return use_wrappers(@_[0], '<i>', '</i>'); }
+sub do_cmd_note{
+    return use_wrappers(
+        @_[0],
+        "<span class=\"note\"><b class=\"label\">Note:</b>\n",
+        '</span>'); }
+sub do_cmd_warning{
+    return use_wrappers(
+        @_[0],
+        "<span class=\"warning\"><b class=\"label\">Warning:</b>\n",
+        '</span>'); }
 
 sub do_cmd_moreargs{
     return '...' . @_[0]; }
diff --git a/Doc/texinputs/python.sty b/Doc/texinputs/python.sty
@@ -881,6 +881,9 @@
   \end{center}
 }
 
+\newcommand{\note}[1]{\strong{Note:} #1}
+\newcommand{\warning}[1]{\strong{Warning:} #1}
+
 % Deprecation stuff.
 % Should be extended to allow an index / list of deprecated stuff.  But
 % there's a lot of stuff that needs to be done to make that automatable.
diff --git a/Doc/tools/sgmlconv/conversion.xml b/Doc/tools/sgmlconv/conversion.xml
@@ -55,6 +55,12 @@
     <content/>
     </macro>
   <macro name="shortversion"/>
+  <macro name="note">
+    <content/>
+    </macro>
+  <macro name="warning">
+    <content/>
+    </macro>
   <!-- These are broken:  we need to re-order the optional and required
        parameters, making the optional parameter the content for the
        element.  latex2esis.py is not powerful enough to handle this.

Original file line number	Diff line number	Diff line change
`@@ -881,6 +881,9 @@`
`881`	`881`	`\end{center}`
`882`	`882`	`}`
`883`	`883`
	`884`	`+\newcommand{\note}[1]{\strong{Note:} #1}`
	`885`	`+\newcommand{\warning}[1]{\strong{Warning:} #1}`
	`886`	`+`
`884`	`887`	`% Deprecation stuff.`
`885`	`888`	`% Should be extended to allow an index / list of deprecated stuff. But`
`886`	`889`	`% there's a lot of stuff that needs to be done to make that automatable.`