From 066c6886c7d01b78f0007a397365d81eee0598b2 Mon Sep 17 00:00:00 2001 From: Mark Wooding Date: Mon, 7 Sep 2020 14:33:17 +0100 Subject: [PATCH] strayman.dtx: Switch to an article structure for the documentation. --- strayman.dtx | 114 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/strayman.dtx b/strayman.dtx index 0ba5069..8796d2c 100644 --- a/strayman.dtx +++ b/strayman.dtx @@ -46,7 +46,7 @@ % \begin{meta-comment} % %<*driver> -\documentclass[10pt,a4paper,book]{strayman} +\documentclass[10pt,a4paper,article]{strayman} \input{mdwtools} \usepackage{mdwlist} \describesclass{strayman} @@ -62,7 +62,7 @@ % % \end{meta-comment} % -% \chapter{About the \strayman\ document class} +% \section{About the \strayman\ document class} % % The standard \LaTeX\ document classes are all very well for simple % documents, but the style isn't appropriate for works like manuals. @@ -74,7 +74,7 @@ % than I can describe it. % % -% \section{Document class options} +% \subsection{Document class options} % % The document class provides many options, most of which are taken from % the standard \LaTeX\ classes. @@ -132,7 +132,7 @@ % \end{description} % % -% \section{The \texttt{text} option} +% \subsection{The \texttt{text} option} % % In order to facilitate creation of attractively formatted text files % from \LaTeX\ documents, \strayman\ provides a |text| option. This will @@ -147,7 +147,7 @@ % otherwise. % % -% \section{That's it} +% \subsection{That's it} % % That's all I'm writing for now. It's a document class. It defines the % style. What more do you expect? @@ -155,9 +155,9 @@ % % \implementation % -% \chapter{Implementation} +% \section{Implementation} % -% \section{Options handling} +% \subsection{Options handling} % % From here on, a lot of the code is shamelessly borrowed from % \file{book.cls} and other places. This is what code re-use is for. @@ -166,7 +166,7 @@ % altering our own internal arguments, or loading other packages as % appropriate. % -% \subsection{Set up some defaults} +% \subsubsection{Set up some defaults} % % We create some variables to hold the settings, and initialise them to % sensible values. @@ -195,7 +195,7 @@ } % \end{macrocode} % -% \subsection{Declare the options we support} +% \subsubsection{Declare the options we support} % % This is just a tedious list of all the options. % @@ -280,7 +280,7 @@ \DeclareOption{nohyperref}{\@hyperreffalse} % \end{macrocode} % -% \subsection{Set up the options} +% \subsubsection{Set up the options} % % We set up some default options, and then read the user's. % @@ -315,7 +315,7 @@ \fi % \end{macrocode} % -% \subsection{Read in the text size option} +% \subsubsection{Read in the text size option} % % The text sizing is rather messy. We store this in a separate file. To % keep this stuff away from other classes, we use the file \emph{extension} @@ -329,7 +329,7 @@ % % \end{macrocode} % -% \section{Package loading} +% \subsection{Package loading} % % \begin{macrocode} %<*strayman> @@ -339,7 +339,7 @@ % % \end{macrocode} % -% \section{Page layout} +% \subsection{Page layout} % % This is largely the domain of the size option files. % @@ -353,7 +353,7 @@ %<+text>\ProvidesFile{strayman.text} % \end{macrocode} % -% \subsection{Font sizes} +% \subsubsection{Font sizes} % % These are fairly standard, and mainly copied from the original size % options. @@ -607,7 +607,7 @@ % % \end{macrocode} % -% \subsection{Paragraph layout} +% \subsubsection{Paragraph layout} % % Here we define various paragraph layout parameters. % @@ -637,7 +637,7 @@ % % \end{macrocode} % -% \subsection{Page layout} +% \subsubsection{Page layout} % % Our layout is a bit different to the standard \LaTeX\ ones: we leave a lot % of space down the left hand side: this is reserved for headings and @@ -782,7 +782,7 @@ % % \end{macrocode} % -% \subsection{Float placement} +% \subsubsection{Float placement} % % First, we determine how we position the floats on the page. % @@ -829,7 +829,7 @@ % % \end{macrocode} % -% \section{Headers and footers} +% \subsection{Headers and footers} % % This part defines the standard page styles. By default, \strayman\ % imports \package{fancyheadings} and uses them, although this section is @@ -857,7 +857,7 @@ } % \end{macrocode} % -% \section{Titles} +% \subsection{Titles} % % \begin{macro}{\maketitle} % This is a bit of a thorny issue at the moment. Really, these titles need @@ -1018,13 +1018,13 @@ % \end{macrocode} % \end{macro} % -% \section{Sectioning commands} +% \subsection{Sectioning commands} % % In \strayman, quite a lot of the sectioning is different. We % don't tend to number sections much. Also, the chapter heading style has % been completely rewritten (several times). % -% \subsection{Setting up the counters} +% \subsubsection{Setting up the counters} % % This is pretty simple stuff. % @@ -1051,7 +1051,7 @@ \renewcommand\thesubparagraph {\theparagraph.\arabic{subparagraph}} % \end{macrocode} % -% \subsection{Frontmatter, mainmatter and backmatter} +% \subsubsection{Frontmatter, mainmatter and backmatter} % % We start off thinking we're in the main matter. The user ought to put a % |\frontmatter| command at the beginning of the document if this is not @@ -1082,7 +1082,7 @@ \fi % \end{macrocode} % -% \subsection{Abstracts} +% \subsubsection{Abstracts} % % \begin{environment}{abstract} % @@ -1123,7 +1123,7 @@ % \end{macrocode} % \end{environment} % -% \subsection{Appendices} +% \subsubsection{Appendices} % % \begin{macro}{\appendix} % @@ -1145,7 +1145,7 @@ % \end{macrocode} % \end{macro} % -% \subsection{Parts} +% \subsubsection{Parts} % % Part headings are typeset on completely unadorned sheets, devoid of page % numbers and suchlike. Because of the strange page layout, we have to @@ -1290,7 +1290,7 @@ % \end{macro} % \end{macro} % -% \subsection{Chapters} +% \subsubsection{Chapters} % % The chapter typesetting has been more-or-less rewritten. We'll follow this % in a reasonable amount of detail. @@ -1520,7 +1520,7 @@ % \end{macro} % \end{macro} % -% \subsection{The other sectioning commands} +% \subsubsection{The other sectioning commands} % % These are all defined through |\@startsection|. They've been modified % to typeset sections and subsections hanging into the left margin, and to @@ -1602,7 +1602,7 @@ \fi % \end{macrocode} % -% \subsection{Section number formatting} +% \subsubsection{Section number formatting} % % \begin{macro}{\@seccntformat} % @@ -1613,7 +1613,7 @@ \llap{\csname the#1\endcsname{\normalsize\quad}\hfil}% } % -% \subsection{Top level sectioning} +% \subsubsection{Top level sectioning} % % \begin{macro}{\@topsect} % @@ -1633,7 +1633,7 @@ % \end{macro} % % -% \section{List handling} +% \subsection{List handling} % % A surprising number of \LaTeX's environments are defined in terms of % lists, many of which hide the fact by putting the entire text in one big @@ -1643,7 +1643,7 @@ % This is largely the same as the standard classes, altered slightly to cope % with the different paragraph spacing. % -% \subsection{General list parameters} +% \subsubsection{General list parameters} % % Default left margins for lists: % @@ -1738,7 +1738,7 @@ } % \end{macrocode} % -% \subsection{Numbering things} +% \subsubsection{Numbering things} % % \begin{macro}{\numberwithin} % @@ -1779,7 +1779,7 @@ % % \end{macro} % -% \subsection{Enumerated lists} +% \subsubsection{Enumerated lists} % % We busily redefine all the counters for enumerated lists, and how to % typeset them. @@ -1810,7 +1810,7 @@ \renewcommand\p@enumiv{\p@enumiii\theenumiii} % \end{macrocode} % -% \subsection{Itemized lists} +% \subsubsection{Itemized lists} % % We set up the various bullet shapes for the itemized lists. % @@ -1821,7 +1821,7 @@ \newcommand\labelitemiv{$\m@th\cdot$} % \end{macrocode} % -% \subsection{Description lists} +% \subsubsection{Description lists} % % This has been redefined a little to make it more sensible. The old version % had a weird |\hspace\labelsep| in the labelling macro. This has now been @@ -1857,7 +1857,7 @@ % \end{macro} % \end{environment} % -% \subsection{Other list-based environments} +% \subsubsection{Other list-based environments} % % Several other standard environments are defined in terms of lists. These % are all dealt with here. @@ -1943,7 +1943,7 @@ % % And some quick hacking of the theorem environment. % -% \section{Other parameters} +% \subsection{Other parameters} % % We define some miscellaneous parameters for standard environments. % @@ -1965,7 +1965,7 @@ \fi % \end{macrocode} % -% \section{Floats} +% \subsection{Floats} % % Since raw \LaTeX\ doesn't actually define any floating objects, we have % to do some of the work here. This isn't actually terribly arduous. For @@ -1992,7 +1992,7 @@ % We must also define |\@makecaption|, which typesets a float caption in % an appropriate way, and an environment for each type of float. % -% \subsection{Figures} +% \subsubsection{Figures} % % This is all fairly straightforward stuff. First, we create a counter for % figures: @@ -2027,7 +2027,7 @@ % \end{environment} % \end{environment} % -% \subsection{Tables} +% \subsubsection{Tables} % % This is pretty similar to the figure handling. % @@ -2048,7 +2048,7 @@ \newenvironment{table*}{\@dblfloat{table}}{\end@dblfloat} % \end{macrocode} % -% \subsection{Other float parameters} +% \subsubsection{Other float parameters} % % \begin{macro}{\@makecaption} % @@ -2076,7 +2076,7 @@ % \end{macrocode} % \end{macro} % -% \section{Font commands} +% \subsection{Font commands} % % We allow the `old' font commands to do sensible \textsf{NFSS} things, since % we don't have any legacy documents. This means that we have proper @@ -2107,11 +2107,11 @@ \DeclareRobustCommand\pmit{\@fontswitch{\relax}{\mathnormal}} % \end{macrocode} % -% \section{Tables of contents} +% \subsection{Tables of contents} % % This section deals with tables of contents, and lists of figures. % -% \subsection{Contents} +% \subsubsection{Contents} % % First, we have to define some parameters. % @@ -2350,7 +2350,7 @@ % \end{macrocode} % \end{macro} % -% \subsection{Lists of figures and tables} +% \subsubsection{Lists of figures and tables} % % These macros are terribly similar to the other ones. % @@ -2361,7 +2361,7 @@ \let\l@table\l@figure % \end{macrocode} % -% \section{Bibliography} +% \subsection{Bibliography} % % This isn't actually terribly interesting. % @@ -2404,7 +2404,7 @@ % \end{macrocode} % \end{environment} % -% \section{Index} +% \subsection{Index} % % Defines the \env{theindex} environment. % @@ -2471,7 +2471,7 @@ \def\Index#1{#1\index{#1}} % \end{macrocode} % -% \section{Footnotes} +% \subsection{Footnotes} % % \begin{macro}{\footnoterule} % @@ -2598,12 +2598,12 @@ % \end{macrocode} % \end{macro} % -% \section{Tidying up} +% \subsection{Tidying up} % % This section gathers together various other useful bits of standard % document class setting. % -% \subsection{Item names} +% \subsubsection{Item names} % % These commands typeset bits of text. They can then be redefined by % \package{babel} and suchlike. @@ -2627,7 +2627,7 @@ \space\number\year} % \end{macrocode} % -% \subsection{Final fiddling for two columns} +% \subsubsection{Final fiddling for two columns} % % \begin{macrocode} \columnsep10\p@ @@ -2643,7 +2643,7 @@ \fi % \end{macrocode} % -% \section{The \protect\env{central} environment} +% \subsection{The \protect\env{central} environment} % % Because of the strange layout of the pages, text which is centred using % normal \LaTeX\ commands is centred in the text area, not on the page, @@ -2672,7 +2672,7 @@ % \end{macrocode} % \end{environment} % -% \section{Headers and footers} +% \subsection{Headers and footers} % % The \strayman\ class uses \package{fancyheadings} for its headers % and footers. This has already been included in the preamble. We now @@ -2769,7 +2769,7 @@ \pagestyle{headings} % \end{macrocode} % -% \section{Parbox alteration} +% \subsection{Parbox alteration} % % The standard \LaTeX\ |\parbox| command, and the \env{minipage} environment, % reset |\parskip| to zero, which is inconsistent with the document style. @@ -2802,11 +2802,11 @@ % \end{macrocode} % % -% \section{Other features} +% \subsection{Other features} % % At the end is a miscellany of useful features. % -% \subsection{Other typesetting conventions} +% \subsubsection{Other typesetting conventions} % % Some items need typesetting in particular ways. % @@ -2818,7 +2818,7 @@ \def\file#1{\mbox{\itshape #1\/}} % \end{macrocode} % -% \subsection{And finally} +% \subsubsection{And finally} % % \begin{macrocode} \sloppy -- 2.11.0