From f23035163f1b2d5405253d80028a10e3233c61b9 Mon Sep 17 00:00:00 2001 From: Mike Gerwitz Date: Thu, 22 Aug 2013 09:14:33 -0400 Subject: [PATCH] Began a LaTeX Tips appendix --- lvspec.cls | 1 + lvspec.tex | 31 ++++++++++++++++++++++++++++++- 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/lvspec.cls b/lvspec.cls index 64ed241..e323cfe 100644 --- a/lvspec.cls +++ b/lvspec.cls @@ -387,6 +387,7 @@ \def\rfc#1{{\tt RFC #1}} \def\hex#1{{\tt 0x#1}} \def\code#1{{\tt#1}} +\def\cmd{\path} \def\func#1{{\tt #1()}} \def\set#1{% \ifmmode% diff --git a/lvspec.tex b/lvspec.tex index ccaefda..efd8357 100644 --- a/lvspec.tex +++ b/lvspec.tex @@ -89,8 +89,9 @@ \end{center} +\appendix \chapter{Creating Specifications with \LaTeX} -This chapter is an example of an implementation of the specifications and is +This appendix is an example of an implementation of the specifications and is useful as an API reference, but \shallnot be used in place of formal specifications with regards to implementation. @@ -226,4 +227,32 @@ command \verb|\incompletei|, which also includes the name of the department. \end{ex} \enddeptgroup + + +\pnumoff +\chapter{\LaTeX\ Tips} +This appendix is by no means comprehensive. + +\section{Generating PDF} +A PDF can be generated from the~\TeX\ source files by issuing the command +\cmd{pdflatex}; indexes are generated using the command \cmd{makeidx}; and +bibliographies are generated using \cmd{bibtex}. First, \cmd{pdftex} must be run +to determine the page numbers and gather all the references. Then, after each of +the latter two commands are run, \cmd{pdftex} must be re-run in order to update +the document. Since the act of updating the document may alter the references, +it is recommended to run \cmd{pdftex} multiple times at the end:\footnote{See +\path{lvspec.git/Makefile} for an example.} + +\begin{ex} + \begin{verbatim} +$ pdftex src.tex \ +> && bibtex src.tex \ +> && makeindex src \ +> && pdftex src.tex \ +> && pdftex src.tex + \end{verbatim} +\end{ex} + +\noindent You may decide to omit \cmd{bibtex} if you are not using a +bibliography (but you probably should cite your information and rationale). \end{document}