uowthesistitlepage (12jul13)

git-svn-id: svn://tug.org/texlive/trunk@31182 c570f23f-e606-0410-a88d-b1316a301751

3 files changed, 42 insertions, 31 deletions

diff --git a/Master/texmf-dist/doc/latex/uowthesistitlepage/README b/Master/texmf-dist/doc/latex/uowthesistitlepage/README
index 67ae0932d58..aed0ce747b1 100644
--- a/Master/texmf-dist/doc/latex/uowthesistitlepage/README
+++ b/Master/texmf-dist/doc/latex/uowthesistitlepage/README
@@ -1,16 +1,12 @@
-This is the README for uowthesistitlepage.sty Version 1.1, 2013-07-01
+This is the README for uowthesistitlepage.sty Version 1.2, 2013-07-12
 
 ABOUT
-
-This Package redefines the \maketitle command for LaTeX documents and generates a title page for a UOW thesis in accordance with the uow branding guidelines. Use this package with the book class to typeset your thesis. Implimented in version 1.1 is the \declaration command. This typesets the declaration (below) that this thesis is your own work, required in the front of each PhD Thesis.
-
+This Package redefines the \maketitle command for LaTeX documents and generates a title page for a UOW thesis in accordance with the uow branding guidelines. Use this package with the book class to typeset your thesis (it will work with report though if you do so desire). The package also provides the \declaration command. This typesets the declaration (below) that this thesis is your own work, required in the front of each PhD Thesis.
 
 LEGAL
-
 Copyright (CC BY-NC-SA 3.0 AU) 2013 by T. M. Griffiths under the creative commons licence(attribution, non-comercial, share alike): http://creativecommons.org/licenses/by-nc-sa/3.0/au/. This work may be distributed and/or modified under the conditions of the LaTeX Project Public License version 1.3c: http://www.latex-project.org/lppl/lppl-1-3c.txt
 
 REQUIREMENTS
-
 - lmodern 
 - setspace
 - etoolbox
@@ -18,7 +14,6 @@ REQUIREMENTS
 
 
 BASIC USAGE
-
 \usepackage[]{uowthesistitlepage}
 
 \begin{document}
@@ -52,7 +47,7 @@ or acknowledged. The document has not been submitted for qualifications at any o
 
 %--------------%
 
-The UOW default dimensions can be implimented with:
+The UOW default dimensions can be implemented with:
 \usepackage{geometry}
     \geometry{a4paper,inner=4.0cm, outer=2cm, top=3cm, bottom=2cm}               
                    
diff --git a/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.pdf b/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.pdf
index 1a649597dc6..ae860d94c34 100644
--- a/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.pdf
+++ b/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.pdf
diff --git a/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.tex b/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.tex
index a21ee1f813a..f94f2569a32 100644
--- a/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.tex
+++ b/Master/texmf-dist/doc/latex/uowthesistitlepage/uowthesistitlepage.tex
@@ -8,8 +8,17 @@
 \usepackage[usenames, dvipsnames]{color}
 \usepackage{titlesec}
     \titleformat{\section}
-        {\color{RoyalBlue}\normalfont\Large\bfseries}
+        {\color{RoyalBlue}\normalfont\Large\sffamily}
         {\color{RoyalBlue}\thesection}{1em}{}
+    \titleformat{\subsection}
+        {\normalfont\large\sffamily}
+        {\thesection}{1em}{}
+
+\usepackage{fontspec,xltxtra,xunicode} 
+\defaultfontfeatures{Mapping=tex-text}
+%\setromanfont[Mapping=tex-text]{EB Garamond}
+\setsansfont[Scale=MatchLowercase,Mapping=tex-text]{Roboto}
+%\setmonofont[Scale=MatchLowercase]{Menlo}
 
 \usepackage{pdfpages}
 \usepackage{hyperref}
@@ -24,7 +33,7 @@
 
 \begin{document}
     
-\title{\textbf{The \texttt{uowthesistitlepage} Package\\
+\title{\textsf{The \texttt{uowthesistitlepage} Package\\
 Redefinition of \texttt{\textbackslash{}maketitle} to Create a Title Page for a Thesis at the University of Wollongong}}
 \author{Thomas M. Griffiths}
 \date{Released \today, Version 1.1}
@@ -45,7 +54,7 @@ The crest of the University of Wollongong is copyright and the property of the U
 
 \section{Usage}
 \subsection*{\oporcom{\textbackslash{}maketitle}}
-If you are familiar with LaTeX using this package is very simple, place the \texttt{uowthesistitlepage} package in your document's preamble:
+If you are familiar with LaTeX using this package is very simple, place the package in your document's preamble:
 \begin{verbatim}
 \usepackage[]{uowthesistitlepage} 
 \end{verbatim}
@@ -62,7 +71,7 @@ The new fields from the uowthesistitlepage package are\oporcom{\textbackslash{}d
 \school{Your School} 
 \supervisor[x]{Supervisor 1, Supervisor 2 \& Supervisor 3 etc.}
 \end{verbatim}
-You need to ensure a copy of the logo named \texttt{uow\textunderscore{}logo} is in the working directory where you're compiling your thesis, if you downloaded this style from the UOW website there will be one in the zipped package. When you want to typeset the title page simply use \oporcom{\textbackslash{}maketitle} after all the defined fields as you usually would.
+You need to ensure a copy of the logo named \texttt{uow\textunderscore{}logo} is in the working directory where you're compiling your thesis (unless you're using the \oporcom{fullsubject} or \oporcom{partialsubject} options, their title pages have have no logo), if you downloaded this style from the UOW website there will be one in the zipped package. When you want to typeset the title page simply use \oporcom{\textbackslash{}maketitle} after all the defined fields as you usually would.
 
 \subsection*{\oporcom{\textbackslash{}declaration}}
 Using the \oporcom{\textbackslash{}declaration} command is simple just place it in your document where you want it typeset. It uses the same macros (\oporcom{\textbackslash{}author}, \oporcom{\textbackslash{}degree} and \oporcom{\textbackslash{}school}) that we defined for the redefinition of \oporcom{\textbackslash{}maketitle}. 
@@ -74,8 +83,9 @@ Using the \oporcom{\textbackslash{}declaration} command is simple just place it
     \item[\oporcom{\textbackslash{}author}\comoptions{\{Your Name\}}]
     The author of the work, in this case you. For the your thesis you should use your full name and any previous degrees, for example: Average Joe Blogs BSc Hon.
     
-    \item[\oporcom{\textbackslash{}date}\comoptions{\{Month Year\}}]
-    The date of your submission, usually `Month Year'. Alternatively, you can use the \oporcom{\textbackslash{}today} macro, and it will print the date in the format month dd, yyyy.
+    \item[\oporcom{\textbackslash{}class}\comoptions{\{Your Class\}}] If this is a dissertation submitted for an individual subject instead of a whole degree like honours, masters by coursework, or a PhD, this is where you tell us what it is. You can write the subject code, e.g. CHEM364, or the full subject name: `Molecular Structure and Spectroscopy'. If you're using this command you need to have the \oporcom{fullsubject} or \oporcom{partialsubject} option loaded in the preamble. If you don't load one of these two options this macro will do a disappointing nothing.
+    
+    \item[\oporcom{\textbackslash{}date}\comoptions{\{Month Year\}}] The date of your submission, usually `Month Year'. Alternatively, you can use the \oporcom{\textbackslash{}today} macro, and it will print the date in the format month dd, yyyy.
     
     \item[\oporcom{\textbackslash{}declaration}] This typesets the declaration that is required in the frontmatter of a PhD thesis. It's used in the exact same way as \oporcom{\textbackslash{}maketitle}, place it in the document where you want it typeset, and it will typeset the following:
 \begin{quote}
@@ -88,36 +98,36 @@ Using the \oporcom{\textbackslash{}declaration} command is simple just place it
     \textbf{\textless{}Student's Full Name\textgreater}, \today\\
 \end{quote}
     
-    \item[\oporcom{\textbackslash{}degree}\comoptions{\{Your Degree\}}]
-    The degree for which you are submitting this work. Write the degree out in full; Doctor of Philosophy, Master of Science, Bachelor of Arts Honours etc.
+    \item[\oporcom{\textbackslash{}degree}\comoptions{\{Your Degree\}}] The degree for which you are submitting this work. Write the degree out in full; Doctor of Philosophy, Master of Science, Bachelor of Arts Honours etc.
     
-    \item[\oporcom{\textbackslash{}graphic}]
-    This macro is used internally to load the UOW Graphic. It has no immediate use in the body of your document and can be ignored unless you feel like cracking open the style file and tinkering. For the graphic to load properly in the title page there must be an image file in the working directory named \texttt{uow\textunderscore{}logo}. It can be used in the body of the document to load an alternative graphic if that is desired, be warned that determining the size in this case is up to you.
+    \item[\oporcom{\textbackslash{}graphic}] This macro is used internally to load the UOW Graphic. It has no immediate use in the body of your document and can be ignored unless you feel like cracking open the style file and tinkering. For the graphic to load properly in the title page there must be an image file in the working directory named \texttt{uow\textunderscore{}logo}. It can be used in the body of the document to load an alternative graphic if that is desired, be warned that determining the size in this case is up to you.
     The usage is a bit odd note the nested \oporcom{\textbackslash{}includegraphics} command:
     
     \oporcom{\textbackslash{}graphic}\comoptions{\{\textbackslash{}includegraphics\{yourgraphic\}\}}
     
-    \item[\oporcom{\textbackslash{}requirement}]
-    Similar to the \oporcom{\textbackslash{}graphic} macro, this macro is for internal use. It is manipulated by the degree options (\oporcom{phd}, \oporcom{honours} etc.) in the preamble, and determines what is printed in the requirement section of the title page. The default is the \oporcom{honours} option.
+    \item[\oporcom{\textbackslash{}requirement}] Similar to the \oporcom{\textbackslash{}graphic} macro, this macro is for internal use. It is manipulated by the degree options (\oporcom{phd}, \oporcom{honours} etc.) in the preamble, and determines what is printed in the requirement section of the title page. The default is the \oporcom{honours} option.
     
-    \item[\oporcom{\textbackslash{}school}\comoptions{\{Your School\}}]
-    The school within the university with which you are associated. If you are not associated with a school you can use the \oporcom{noschool} option in the preamble to disable the school under the UOW logo. The \oporcom{\textbackslash{}school} command will still work with the \oporcom{noschool} option, so you can specify another affiliation, for example The Australian Institute for Innovative Materials (AIIM).
+    \item[\oporcom{\textbackslash{}school}\comoptions{\{Your School\}}] The school within the university with which you are associated. If you are not associated with a school you can use the \oporcom{noschool} option in the preamble to disable the school under the UOW logo. The \oporcom{\textbackslash{}school} command will still work with the \oporcom{noschool} option, so you can specify another affiliation, for example The Australian Institute for Innovative Materials (AIIM).
     
-    \item[\oporcom{\textbackslash{}supervisor}\comoptions{[number of supervisors (integer)]\{Your Supervisors\}}]
-    Prints your supervisor(s) to the title page. List all your supervisors and their titles in the one set of enclosing braces (\texttt{\{ \}}), separated by commas with an ampersand (\&) before the final supervisor if you have multiple supervisors. Use the optional argument `\texttt{[x]}' to specify how many supervisors you have. The default number of supervisors is one.
+    \item[\oporcom{\textbackslash{}supervisor}\comoptions{[number of supervisors (integer)]\{Your Supervisors\}}] Prints your supervisor(s) to the title page. List all your supervisors and their titles in the one set of enclosing braces (\texttt{\{ \}}), separated by commas with an ampersand (\&) before the final supervisor if you have multiple supervisors. Use the optional argument `\texttt{[x]}' to specify how many supervisors you have. The default number of supervisors is one.
     
-    \item[\oporcom{\textbackslash{}title}\comoptions{\{Your Thesis Title\}}]
-    Self explanatory, it's the title of your thesis
+    \item[\oporcom{\textbackslash{}title}\comoptions{\{Your Thesis Title\}}] Self explanatory, it's the title of your thesis
 \end{description}
 
 \subsection*{Options}
 \begin{description}
+    \item[\oporcom{fullsubject}]
+    This option typesets the title page of the document in a manner appropriate for a single subject based report, where the report is worth 100\% of the total mark of the subject. There is corresponding option \oporcom{partialsubject} for a report that is only a part of the assessable content of the subject. The name of the subject is loaded with the \oporcom{\textbackslash{}class} macro in the document body. By default this option also loads the \oporcom{nosupervisor} option, if you have any supervisors you'll need to add the correct supervisor option in the preamble. This option and its corresponding partial option do not typeset the logo on the title page.
+    
     \item[\oporcom{honours}]
-    One of the degree options and the default. This option modifies the wording of the thesis requirement so that it is reflective of an honours degree: `This thesis is presented as part of the requirement for the'.
+    One of the degree options, and the default. This option modifies the wording of the thesis requirement so that it is reflective of an honours degree: `This thesis is presented as part of the requirement for the'.
     
     \item[\oporcom{honors}]
     Identical to \oporcom{honours}, just the alternative u-less spelling. See above.
     
+    \item[\oporcom{partialsubject}]
+    This option typesets the title page of the document in a manner appropriate for a subject based report, where the report is worth part of the total mark of the subject. This  command has an option friend, \oporcom{fullsubject}, for a report that is 100\% assessable content of the subject. The name of the subject is loaded with the \oporcom{\textbackslash{}class} macro in the document body. By default this option also loads the \oporcom{nosupervisor} option, if you have any supervisors you'll need to add the correct supervisor option in the preamble. This option and its corresponding full option do not typeset the logo on the title page.
+    
     \item[\oporcom{phd}]
     One of the degree options. This option modifies the wording of the thesis requirement so that it is reflective of a Doctoral degree: `This thesis is presented as required for the'.
     
@@ -128,7 +138,7 @@ Using the \oporcom{\textbackslash{}declaration} command is simple just place it
     One of the degree options, the same as \oporcom{mastersbyresearch} except that the thesis is only a partial requirement for the award of the degree. This option modifies the wording of the thesis requirement so that it is reflective of a Masters by Coursework: `This thesis is presented as part of the requirement for the'.
     
     \item[\oporcom{multiplesupervisors}]
-    Makes the supervisor field plural, printing `Supervisors'. Still implemented but unnecessary, use the optional argument to the \oporcom{\textbackslash{}supervisor} command.
+    Makes the supervisor field plural, printing `Supervisors'. Still implemented but only necessary if you have supervisors and the \oporcom{partialsubject} or \oporcom{fullsubject} option is loaded. Use the optional argument to the \oporcom{\textbackslash{}supervisor} command.
     
     \item[\oporcom{noschool}]
     Removes the text underneath the UOW stating your school affiliation. While it removes the `School of' text it doesn't deactivate the \oporcom{\textbackslash{}school} command completely it prints an empty space instead. The \oporcom{\textbackslash{}school} command will still works with the \oporcom{noschool} option, so that you can specify another affiliation.
@@ -137,19 +147,25 @@ Using the \oporcom{\textbackslash{}declaration} command is simple just place it
     Removes the supervisor field from the title page completely. Incorporated mainly to match the Word template, which, oddly is missing a supervisor field. Still implemented but unnecessary, use the optional argument to the \oporcom{\textbackslash{}supervisor} command
     
     \item[\oporcom{onesupervisor}]
-    Makes the supervisor field singular, printing `Supervisor' This option is the default. Still implemented but unnecessary, use the optional argument to the \oporcom{\textbackslash{}supervisor} command
+    Makes the supervisor field singular, printing `Supervisor' This option is the default. Still implemented but only necessary ifs you have supervisors and the \oporcom{partialsubject} or \oporcom{fullsubject} option is loaded. Use the optional argument to the \oporcom{\textbackslash{}supervisor} command.
+    
 \end{description}
 
 \section{Change Log}
 If you spot any errors or bugs, or alternately you have any requests for an addition let me know.
-\subsubsection*{Version 1.1, 2013-07-01, tmgriffiths}
+\subsection*{Version 1.2, 2013-07-12, tmgriffiths}
+\begin{itemize}
+    \item Added the \oporcom{fullsubject} and \oporcom{partialsubject} options. These are for individual subject based documents e.g. a report.
+    \item Fixed spacing in the School \textless{}Your School\textgreater field. Previously there was no whitespace between School and the name of your school
+\end{itemize}    
+\subsection*{Version 1.1, 2013-07-01, tmgriffiths}
 \begin{itemize}
     \item Rewrote the \oporcom{\textbackslash{}supervisor} command to have an optional argument giving the number of supervisors. I used the \texttt{etoolbox} package and its \texttt{\textbackslash{}ifnumcom} macros to do so. The old options \oporcom{nosupervisor}, \oporcom{onesupervisor} and \oporcom{multiplesupervisors} still exist but mainly for legacy reasons. It is not necessary to specify them in the preamble anymore. The only thing of note is that \oporcom{nosupervisor} is achieved by either \oporcom{nosupervisor} in the preamble or \oporcom{\textbackslash{}supervisor}\texttt{[0]\{\}} in the document Simply leaving out supervisor will not remove the field.
     \item Rewrote the way each degree type specified partial or complete requirement in the \oporcom{\textbackslash{}@requirement} macro. I'm now using \texttt{\textbackslash{}if} statements to set the field.
     \item Implemented the \oporcom{\textbackslash{}declaration} command (see examples). It typesets declaration page that PhD students are required to have in the frontmatter of their thesis.
 \end{itemize}
 
-\subsubsection*{Version 1.0, 2013-23-06, tmgriffiths}
+\subsection*{Version 1.0, 2013-23-06, tmgriffiths}
 \begin{enumerate}
     \item Implimented \oporcom{phd}, \oporcom{mastersbyresearch}, the various \oporcom{supervisor} based, and \oporcom{noschool} options.
     \item Annotated code in sty file.