From f0f6d12cd4d2159cbe2473c6ff5aeb5f9d245e02 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Fri, 23 Jan 2004 08:52:28 +0000 Subject: [PATCH] add \guilabel macro to mark labels that occur in user interfaces --- Doc/doc/doc.tex | 14 ++++++++++++++ Doc/html/style.css | 2 +- Doc/perl/python.perl | 7 +++++-- Doc/texinputs/python.sty | 5 ++++- 4 files changed, 24 insertions(+), 4 deletions(-) diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex index aacce2f6ea5..de6390a7a1e 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 f5857447020..33a1380259f 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 89e12d58285..d5d000f6649 100644 --- a/Doc/perl/python.perl +++ b/Doc/perl/python.perl @@ -95,9 +95,12 @@ sub do_cmd_textless{ '<' . $_[0]; } sub do_cmd_textunderscore{ '_' . $_[0]; } sub do_cmd_infinity{ '∞' . $_[0]; } sub do_cmd_plusminus{ '±' . $_[0]; } +sub do_cmd_guilabel{ + return use_wrappers($_[0]. '', ''); } sub do_cmd_menuselection{ - return use_wrappers($_[0], '', ''); } -sub do_cmd_sub{ ' > ' . $_[0]; } + return use_wrappers($_[0], '', ''); } +sub do_cmd_sub{ + return ' > ' . $_[0]; } # words typeset in a special way (not in HTML though) diff --git a/Doc/texinputs/python.sty b/Doc/texinputs/python.sty index ff37ad9b332..0e69587ec8f 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"!