Skip to content
Snippets Groups Projects
Commit d852561a authored by Edward Longman's avatar Edward Longman
Browse files

Fix quotation marks and missing citation

parent e5f6be90
No related branches found
No related tags found
No related merge requests found
No preview for this file type
......@@ -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.
......
......@@ -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}
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment