summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-09-25 18:44:21 (GMT)
committerFred Drake <fdrake@acm.org>2002-09-25 18:44:21 (GMT)
commite134158f236b7821ec92aa61cc5fe46e2a77170f (patch)
treef8743ce665f499fb172d37f0182294644c4a13a9 /Doc
parentb7a88e533da68906c1bb12f0b209e562b770e793 (diff)
downloadcpython-e134158f236b7821ec92aa61cc5fe46e2a77170f.zip
cpython-e134158f236b7821ec92aa61cc5fe46e2a77170f.tar.gz
cpython-e134158f236b7821ec92aa61cc5fe46e2a77170f.tar.bz2
Finish & commit some docs for markup that's been in use for a while.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/doc/doc.tex31
1 files changed, 29 insertions, 2 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 8c5f338..e62af44 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -1641,10 +1641,37 @@ This \UNIX\ is also followed by a space.
\end{verbatim}
-\section{Graphical Interface Components \label{gui-markup}}
+\subsection{Graphical Interface Components \label{gui-markup}}
The components of graphical interfaces will be assigned markup, but
- the specifics have not been determined.
+ most of the specifics have not been determined.
+
+ \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
+ a complete sequence of menu selections, including selecting
+ submenus and choosing a specific operation, or any subsequence of
+ such a sequence. The names of individual selections should be
+ separated by occurances of \macro{sub}.
+
+ For example, to mark the selection ``\menuselection{Start \sub
+ Programs}'', use this markup:
+
+\begin{verbatim}
+\menuselection{Start \sub Programs}
+\end{verbatim}
+
+ When including a selection that includes some trailing indicator,
+ 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.
+ \end{macrodesc}
+
+ \begin{macrodesc}{sub}{}
+ Separator for menu selections that include multiple levels. This
+ macro is only defined within the context of the
+ \macro{menuselection} macro.
+ \end{macrodesc}
\section{Processing Tools \label{tools}}