summaryrefslogtreecommitdiffstats
path: root/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
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')
-rw-r--r--Doc/doc/doc.tex14
-rw-r--r--Doc/html/style.css2
-rw-r--r--Doc/perl/python.perl7
-rw-r--r--Doc/texinputs/python.sty5
4 files changed, 24 insertions, 4 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}{}
diff --git a/Doc/html/style.css b/Doc/html/style.css
index f585744..33a1380 100644
--- a/Doc/html/style.css
+++ b/Doc/html/style.css
@@ -123,7 +123,7 @@ div.note .label { margin-right: 0.5em;
.newsgroup { font-family: avantgarde, sans-serif; }
.url { font-family: avantgarde, sans-serif; }
.file { font-family: avantgarde, sans-serif; }
-.menuselection { font-family: avantgarde, sans-serif; }
+.guilabel { font-family: avantgarde, sans-serif; }
.tableheader { background-color: #99ccff;
font-family: avantgarde, sans-serif; }
diff --git a/Doc/perl/python.perl b/Doc/perl/python.perl
index 89e12d5..d5d000f 100644
--- a/Doc/perl/python.perl
+++ b/Doc/perl/python.perl
@@ -95,9 +95,12 @@ sub do_cmd_textless{ '&lt;' . $_[0]; }
sub do_cmd_textunderscore{ '_' . $_[0]; }
sub do_cmd_infinity{ '&infin;' . $_[0]; }
sub do_cmd_plusminus{ '&plusmn;' . $_[0]; }
+sub do_cmd_guilabel{
+ return use_wrappers($_[0]. '<span class="guilabel">', '</span>'); }
sub do_cmd_menuselection{
- return use_wrappers($_[0], '<span class="menuselection">', '</span>'); }
-sub do_cmd_sub{ ' > ' . $_[0]; }
+ return use_wrappers($_[0], '<span class="guilabel">', '</span>'); }
+sub do_cmd_sub{
+ return '</span> &gt; <span class="guilabel">' . $_[0]; }
# words typeset in a special way (not in HTML though)
diff --git a/Doc/texinputs/python.sty b/Doc/texinputs/python.sty
index ff37ad9..0e69587e 100644
--- a/Doc/texinputs/python.sty
+++ b/Doc/texinputs/python.sty
@@ -821,8 +821,11 @@
\newcommand{\NULL}{\constant{NULL}}
\newcommand{\infinity}{\ensuremath{\infty}}
\newcommand{\plusminus}{\ensuremath{\pm}}
+
+% \guilabel{Start}
+\newcommand{\guilabel}[1]{\textsf{#1}}
% \menuselection{Start \sub Programs \sub Python}
-\newcommand{\menuselection}[1]{\textsf{\def\sub{ \ensuremath{>} }#1}}
+\newcommand{\menuselection}[1]{\guilabel{{\def\sub{ \ensuremath{>} }#1}}}
% Also for consistency: spell Python "Python", not "python"!