diff options
Diffstat (limited to 'doc.tex')
| -rwxr-xr-x | doc.tex | 72 |
1 files changed, 33 insertions, 39 deletions
@@ -2,9 +2,11 @@ \author{DistressNetwork°} +\newcommand{\cmd}[1]{\mono{\textbackslash #1}} + \begin{document} -\section{Microstructure Documentation} +\resetv{-3\unit}\section{Microstructure Documentation} \hr @@ -20,36 +22,36 @@ \subsection{Commands} \begin{itemize} - \item Preamble: \mono{\textbackslash author\{\}} defines the author name in the page header. + \item Preamble: \cmd{author\{\}} defines the author name in the page header. \end{itemize} \subsubsection{Inline Elements} \begin{table}{x x} -\bold{Command} & \bold{Output/Description} \\ +\bold{Command} & \bold{Output/Description} \\ \cline{1-2} -\mono{\textbackslash bold\{\}} & \bold{Bold Weight} \\ -\mono{\textbackslash italic\{\}} & \italic{Italic Style} \\ -\mono{\textbackslash sout\{\}} & \sout{Strikethrough} \\ -\mono{\textbackslash mono\{\}} & \mono{Monospace Font} \\ -\mono{\textbackslash inmath\{\}} & \inmath{\mathrm{Inline\ Math}} \\ -\mono{\textbackslash link\{\}\{\}} & \link{https://en.wikipedia.org/wiki/Hyperlink}{Link} \\ -\mono{\textbackslash footnote\{\}} & Footnote Reference \\ -\mono{\textbackslash case} & Enable Case-Sensitive Forms +\cmd{bold\{\}} & \bold{Bold Weight} \\ +\cmd{italic\{\}} & \italic{Italic Style} \\ +\cmd{sout\{\}} & \sout{Strikethrough} \\ +\cmd{mono\{\}} & \mono{Monospace Font} \\ +\cmd{inmath\{\}} & \inmath{\mathrm{Inline\ Math}} \\ +\cmd{link\{\}\{\}} & \link{https://en.wikipedia.org/wiki/Hyperlink}{Link} \\ +\cmd{footnote\{\}} & Footnote Reference \\ +\cmd{case} & Enable Case-Sensitive Forms \end{table} \newpage -\subsubsection{Block Elements} +\resetv{-2.5\unit}\subsubsection{Block Elements} \begin{table}{x x} -\bold{Command} & \bold{Output/Description} \\ +\bold{Command} & \bold{Output/Description} \\ \cline{1-2} -\mono{\textbackslash section\{\}} & Header Level One \\ -\mono{\textbackslash subsection\{\}} & Header Level Two \\ -\mono{\textbackslash subsubsection\{\}} & Header Level Three \\ -\mono{\textbackslash hr} & Horizontal Rule \\ -\mono{\textbackslash inputblock\{\}} & Code block from external file \\ -\mono{\textbackslash inputblockenum\{\}} & Code block from external file with line numbering \\ -\mono{\textbackslash reset} & Reset baseline grid alignment +\cmd{section\{\}} & Header Level One \\ +\cmd{subsection\{\}} & Header Level Two \\ +\cmd{subsubsection\{\}} & Header Level Three \\ +\cmd{hr} & Horizontal Rule \\ +\cmd{inputblock\{\}} & Code block from external file \\ +\cmd{inputblockenum\{\}} & Code block from external file with line numbering \\ +\cmd{reset}, (\cmd{resetv\{\}}) & Reset baseline grid alignment (with vertical offset height) \\ \end{table} \reset @@ -60,28 +62,24 @@ \item[description] Description list (arbitrary levels) \item[codeblock] Verbatim code block \item[codeblockenum] Verbatim code block with line numbering - \item[mathblock] Math mode alignment block, similar to \mono{amsmath}'s \mono{align*} + \item[math] Math mode alignment block, equivalent to \mono{amsmath}'s \mono{align*} \end{description} \subsubsection{Tables} -The \mono{table} environment's column specification parameter has two defined symbols: `\mono{x}' for left-aligned paragraphs, and `\mono{X}' for justified paragraphs. Horizontal separators should be specified using \mono{\textbackslash cline\{\}} rather than \mono{\textbackslash hline}. +The \mono{table} environment's column specification parameter has two defined symbols: `\mono{x}' for left-aligned paragraphs, and `\mono{X}' for justified paragraphs. Horizontal separators should be specified using \cmd{cline\{\}} rather than \cmd{hline}. \subsubsection{Figures} -The \mono{figure} environment may contain: -\begin{itemize} - \item One or more instances of \mono{\textbackslash includegraphics\{\}}, - \item Zero or more instances of \mono{\textbackslash caption\{\}}. -\end{itemize} +The \mono{figure} environment may contain one or more instances of \cmd{includegraphics\{\}} and zero or more instances of \cmd{caption\{\}}. \newpage -\section{Usage Notes} +\resetv{-3\unit}\section{Usage Notes} \reset \subsection{Dependencies} \begin{itemize} - \item The XeLaTeX typesetting software system. + \item The XeLaTeX typesetting software system \item The following typefaces: \begin{itemize} \item Neue Haas Grotesk Display @@ -92,30 +90,26 @@ The \mono{figure} environment may contain: \begin{itemize} \item \mono{amsmath, amssymb, datetime2, enumitem, eso-pic, fancyhdr,\\ footmisc, geometry, graphicx, hyperref, lastpage, listings,\\ - mathspec, microtype, realscripts, tabularx, tikz, ulem} - \end{itemize} - \item The following packages which are not included in the \mono{texlive} distribution: - \begin{itemize} - \item \mono{returntogrid} + mathspec, microtype, realscripts, returntogrid, tabularx, \\ + tikz, ulem} \end{itemize} \end{itemize} \subsection{Grid Alignment} -\addfontfeature{Fractions=On} The positioning and spacing of all document elements are strictly defined in terms of a length of 1/6 of an inch, referred to internally as the \italic{unit}. Document elements are to remain aligned with an implicit 1/2-unit grid spanning the entire page. In order to ensure this alignment is preserved surrounding elements of variable height, it is possible to issue a \mono{\textbackslash reset} command immediately preceding paragraphs or block elements to be realigned. It is recommended to temporarily enable the \mono{debug} class option in order to verify consistent alignment during the document preparation process. +\addfontfeature{Fractions=On} The positioning and spacing of all document elements are strictly defined in terms of a length of 1/6 of an inch, referred to internally as the \italic{unit}. Document elements are to remain aligned with an implicit 1/2-unit grid spanning the entire page. In order to ensure that this alignment is preserved surrounding elements of variable height, it is possible to issue a \cmd{reset} command immediately preceding paragraphs or block elements to be realigned. It is recommended to temporarily enable the \mono{debug} class option in order to verify consistent alignment during the document preparation process. \subsection{Caveats} \begin{itemize} - \item Correct realignment of document elements via the \mono{\textbackslash reset} command may require multiple recompilations. + \item Correct realignment of document elements via the \cmd{reset} command may require multiple recompilations. \item Correct typesetting of page numbers and the debug grid may require multiple recompilations. - \item Grid alignments of tables are not well defined and must be corrected manually. - \item Grid alignments of the uppermost element of each page are as of yet unable to be corrected. + \item Grid alignments of tables are not well-defined and must be corrected manually. \end{itemize} \newpage -\section{Implementation} +\resetv{-3\unit}\section{Implementation} \reset (In progress.) |