Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 87f768e

Browse files
committed
Attempted to clarify usage of the \declaremodule macro somewhat;
Michael Hudson's documentation for bytecodehacks exhibits incorrect usage. Added some comments about how to set up the mkhowto script for use with documents not contained in the documentation source tree.
1 parent 3e4c614 commit 87f768e

1 file changed

Lines changed: 25 additions & 7 deletions

File tree

Doc/doc/doc.tex

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,10 @@ \section{Special Markup Constructs}
308308

309309
\subsection{Inline Markup}
310310

311+
The macros described in this section are used to mark just about
312+
anything interesting in the document text. They may be used in
313+
headings (though anything involving hyperlinks should be avoided
314+
there) as well as in the body text.
311315

312316
\begin{macrodesc}{bfcode}{\p{text}}
313317
Like \macro{code}, but also makes the font bold-face.
@@ -501,13 +505,17 @@ \section{\module{spam} ---
501505
\end{verbatim}
502506

503507
\begin{macrodesc}{declaremodule}{\op{key}\p{type}\p{name}}
504-
Requires two parameters: module type (standard, builtin,
505-
extension), and the module name. An optional parameter should be
506-
given as the basis for the module's ``key'' used for linking to or
507-
referencing the section. The ``key'' should only be given if the
508-
module's name contains any underscores, and should be the name
509-
with the underscores stripped. This should be the first thing
510-
after the \macro{section} used to introduce the module.
508+
Requires two parameters: module type (\samp{standard},
509+
\samp{builtin}, \samp{extension}, or \samp{}), and the module
510+
name. An optional parameter should be given as the basis for the
511+
module's ``key'' used for linking to or referencing the section.
512+
The ``key'' should only be given if the module's name contains any
513+
underscores, and should be the name with the underscores stripped.
514+
Note that the \var{type} parameter must be one of the values
515+
listed above or an error will be printed. For modules which are
516+
contained in packages, the fully-qualified name should be given as
517+
\var{name} parameter. This should be the first thing after the
518+
\macro{section} used to introduce the module.
511519
\end{macrodesc}
512520

513521
\begin{macrodesc}{platform}{\p{specifier}}
@@ -894,6 +902,16 @@ \section{Processing Tools}
894902

895903
\begin{description}
896904
\item[\program{mkhowto}]
905+
This is the primary script used to format third-party
906+
documents. It contains all the logic needed to ``get it
907+
right.'' The proper way to use this script is to make a
908+
symbolic link to it or run it in place; the actual script file
909+
must be stored as part of the documentation source tree,
910+
though it may be used to format documents outside the
911+
tree. Use \program{mkhowto --help} for a list of command line
912+
options.
913+
914+
XXX Need more here.
897915
\end{description}
898916

899917

0 commit comments

Comments
 (0)