Kaydet (Commit) 87f768e2 authored tarafından Fred Drake's avatar Fred Drake

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.
üst 3e4c614c
...@@ -308,6 +308,10 @@ distribution, to create or maintain whole documents or sections. ...@@ -308,6 +308,10 @@ distribution, to create or maintain whole documents or sections.
\subsection{Inline Markup} \subsection{Inline Markup}
The macros described in this section are used to mark just about
anything interesting in the document text. They may be used in
headings (though anything involving hyperlinks should be avoided
there) as well as in the body text.
\begin{macrodesc}{bfcode}{\p{text}} \begin{macrodesc}{bfcode}{\p{text}}
Like \macro{code}, but also makes the font bold-face. Like \macro{code}, but also makes the font bold-face.
...@@ -501,13 +505,17 @@ distribution, to create or maintain whole documents or sections. ...@@ -501,13 +505,17 @@ distribution, to create or maintain whole documents or sections.
\end{verbatim} \end{verbatim}
\begin{macrodesc}{declaremodule}{\op{key}\p{type}\p{name}} \begin{macrodesc}{declaremodule}{\op{key}\p{type}\p{name}}
Requires two parameters: module type (standard, builtin, Requires two parameters: module type (\samp{standard},
extension), and the module name. An optional parameter should be \samp{builtin}, \samp{extension}, or \samp{}), and the module
given as the basis for the module's ``key'' used for linking to or name. An optional parameter should be given as the basis for the
referencing the section. The ``key'' should only be given if the module's ``key'' used for linking to or referencing the section.
module's name contains any underscores, and should be the name The ``key'' should only be given if the module's name contains any
with the underscores stripped. This should be the first thing underscores, and should be the name with the underscores stripped.
after the \macro{section} used to introduce the module. Note that the \var{type} parameter must be one of the values
listed above or an error will be printed. For modules which are
contained in packages, the fully-qualified name should be given as
\var{name} parameter. This should be the first thing after the
\macro{section} used to introduce the module.
\end{macrodesc} \end{macrodesc}
\begin{macrodesc}{platform}{\p{specifier}} \begin{macrodesc}{platform}{\p{specifier}}
...@@ -894,6 +902,16 @@ distribution, to create or maintain whole documents or sections. ...@@ -894,6 +902,16 @@ distribution, to create or maintain whole documents or sections.
\begin{description} \begin{description}
\item[\program{mkhowto}] \item[\program{mkhowto}]
This is the primary script used to format third-party
documents. It contains all the logic needed to ``get it
right.'' The proper way to use this script is to make a
symbolic link to it or run it in place; the actual script file
must be stored as part of the documentation source tree,
though it may be used to format documents outside the
tree. Use \program{mkhowto --help} for a list of command line
options.
XXX Need more here.
\end{description} \end{description}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment