Skip to content

Commit e134158

Browse files
committed
Finish & commit some docs for markup that's been in use for a while.
1 parent b7a88e5 commit e134158

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

Doc/doc/doc.tex

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1641,10 +1641,37 @@ \section{\module{bar.foo} ---
16411641
\end{verbatim}
16421642

16431643

1644-
\section{Graphical Interface Components \label{gui-markup}}
1644+
\subsection{Graphical Interface Components \label{gui-markup}}
16451645

16461646
The components of graphical interfaces will be assigned markup, but
1647-
the specifics have not been determined.
1647+
most of the specifics have not been determined.
1648+
1649+
\begin{macrodesc}{menuselection}{\p{menupath}}
1650+
Menu selections should be marked using a combination of
1651+
\macro{menuselection} and \macro{sub}. This macro is used to mark
1652+
a complete sequence of menu selections, including selecting
1653+
submenus and choosing a specific operation, or any subsequence of
1654+
such a sequence. The names of individual selections should be
1655+
separated by occurances of \macro{sub}.
1656+
1657+
For example, to mark the selection ``\menuselection{Start \sub
1658+
Programs}'', use this markup:
1659+
1660+
\begin{verbatim}
1661+
\menuselection{Start \sub Programs}
1662+
\end{verbatim}
1663+
1664+
When including a selection that includes some trailing indicator,
1665+
such as the ellipsis some operating systems use to indicate that
1666+
the command opens a dialog, the indicator should be omitted from
1667+
the selection name.
1668+
\end{macrodesc}
1669+
1670+
\begin{macrodesc}{sub}{}
1671+
Separator for menu selections that include multiple levels. This
1672+
macro is only defined within the context of the
1673+
\macro{menuselection} macro.
1674+
\end{macrodesc}
16481675

16491676

16501677
\section{Processing Tools \label{tools}}

0 commit comments

Comments
 (0)