diff --git a/README.pdf b/README.pdf index dd676a4ed6192128444fc835a2d35eddac5d31b9..69f35cc74ce72b1d3bccaa0853fa239335396aa7 100644 Binary files a/README.pdf and b/README.pdf differ diff --git a/Rebuilding.tex b/Rebuilding.tex index 208493717548df1980c776b7bf14707210192e9d..276418533962d20415fc86865e2c4bc658a06baa 100644 --- a/Rebuilding.tex +++ b/Rebuilding.tex @@ -5,20 +5,20 @@ Quick modifications will need to be done on the \verb|uosdocs.cls| file in the \ \section{The Build Process} To change the templates you should understand how the templates are made. The templates are built using the docstrip package. -"The packÂage preÂpares a \LaTeX kerÂnel or packÂage source file for acÂtual use, by reÂmovÂing the docÂuÂmenÂtaÂtion and meta-data" \citep{Docstrip} +``The packÂage preÂpares a \LaTeX kerÂnel or packÂage source file for acÂtual use, by reÂmovÂing the docÂuÂmenÂtaÂtion and meta-data'' \citep{Docstrip} It also creates a document containing some documentation for the created files. The docstrip utility comes as a latex package so when the main file (.dtx) is run with the command \verb|$(LATEX) uosdocs.ins| it creates all the class files plus the example templates. When this tool is run it creates lots of auxiliary files. -To help with managing these auxiliary files GNU Make is used. "GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files."\citep{GNUdesc}. +To help with managing these auxiliary files GNU Make is used. ``GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files.''\citep{GNUdesc}. The make command can be run in several different configurations. \verb|make all| creates all of the class, template, bibliography and figure files from the source files. \verb|make install| moves all of the created files into the users texmf directory ready for use. \section{The Source File} The source file \verb|uosdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files. -"The installer is the \verb|uosdocs.ins| file. An installer file +``The installer is the \verb|uosdocs.ins| file. An installer file extracts the code from a \verb|.dtx| file, uses \verb|DocStrip| to -strip off the comments and documentation, and outputs the \verb|.cls| files."\citep{} +strip off the comments and documentation, and outputs the \verb|.cls| files.''\citep{pack_write} It also creates the figure files and the chapter files. Whilst this creates a mess of files all in one folder the \verb|make install| command is designed to clean them up into a folder structure described in Listing~\ref{folder_struct}. The dtx file is designed to ensure continuity across different classes: names, font, department page styling and other formats. diff --git a/UOS.bib b/UOS.bib index 267eef968ce149d522fc209be5701bceaa217248..4a7cd60d3e0237dcab7e2ab78be58f2d88bab6f8 100644 --- a/UOS.bib +++ b/UOS.bib @@ -25,7 +25,7 @@ } @electronic{pack_write, author = {Scott Pakin}, - title = {Anintroduction to writing .ins and .dtx files}, + title = {An introduction to writing .ins and .dtx files}, year = {2008}, url = {https://www.tug.org/TUGboat/tb29-2/tb92pakin.pdf} }