summaryrefslogtreecommitdiffstats
path: root/Doc/doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2004-01-23 08:52:28 (GMT)
committerFred Drake <fdrake@acm.org>2004-01-23 08:52:28 (GMT)
commitf0f6d12cd4d2159cbe2473c6ff5aeb5f9d245e02 (patch)
treedec64d0de926fa60eca7813d640433d3dedbf819 /Doc/doc
parent226f697560af74985ee5ecf2fc4f6b1c991006dc (diff)
downloadcpython-f0f6d12cd4d2159cbe2473c6ff5aeb5f9d245e02.zip
cpython-f0f6d12cd4d2159cbe2473c6ff5aeb5f9d245e02.tar.gz
cpython-f0f6d12cd4d2159cbe2473c6ff5aeb5f9d245e02.tar.bz2
add \guilabel macro to mark labels that occur in user interfaces
Diffstat (limited to 'Doc/doc')
-rw-r--r--Doc/doc/doc.tex14
1 files changed, 14 insertions, 0 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index aacce2f..de6390a 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -1654,6 +1654,16 @@ This \UNIX\ is also followed by a space.
The components of graphical interfaces will be assigned markup, but
most of the specifics have not been determined.
+ \begin{macrodesc}{guilabel}{\p{label}}
+ Labels presented as part of an interactive user interface should
+ be marked using \macro{guilabel}. This includes labels from
+ text-based interfaces such as those created using \code{curses} or
+ other text-based libraries. Any label used in the interface
+ should be marked with this macro, including button labels, window
+ titles, field names, menu and menu selection names, and even
+ values in selection lists.
+ \end{macrodesc}
+
\begin{macrodesc}{menuselection}{\p{menupath}}
Menu selections should be marked using a combination of
\macro{menuselection} and \macro{sub}. This macro is used to mark
@@ -1673,6 +1683,10 @@ This \UNIX\ is also followed by a space.
such as the ellipsis some operating systems use to indicate that
the command opens a dialog, the indicator should be omitted from
the selection name.
+
+ Individual selection names within the \macro{menuselection} should
+ not be marked using \macro{guilabel} since that's implied by using
+ \macro{menuselection}.
\end{macrodesc}
\begin{macrodesc}{sub}{}