summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/ryethesis
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-06-18 00:06:30 +0000
committerKarl Berry <karl@freefriends.org>2010-06-18 00:06:30 +0000
commit1cd867ef11ec5a4a1a5e94fefa0d17de9b630e65 (patch)
tree4e172150908a03d500ff09770a022cbd142a10df /Master/texmf-dist/doc/latex/ryethesis
parent1ce3ee2ff28a4ec21ca5ac6e1bafaa73930f5265 (diff)
ryethesis 1.1 (17jun10)
git-svn-id: svn://tug.org/texlive/trunk@19022 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/ryethesis')
-rw-r--r--Master/texmf-dist/doc/latex/ryethesis/Makefile49
-rw-r--r--Master/texmf-dist/doc/latex/ryethesis/README28
-rw-r--r--Master/texmf-dist/doc/latex/ryethesis/ryesample.pdfbin78337 -> 224700 bytes
-rw-r--r--Master/texmf-dist/doc/latex/ryethesis/ryesample.tex63
-rw-r--r--Master/texmf-dist/doc/latex/ryethesis/ryethesis.pdfbin75181 -> 238181 bytes
5 files changed, 118 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/ryethesis/Makefile b/Master/texmf-dist/doc/latex/ryethesis/Makefile
new file mode 100644
index 00000000000..2f7255912d3
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/ryethesis/Makefile
@@ -0,0 +1,49 @@
+FILEROOT=
+SHELL=/bin/sh
+
+VERSION=1.1
+
+LATEX=pdflatex
+
+TEXFILES=ryesample.tex
+BIBFILES=ryesample.bib
+FIGS=figure1.pdf
+FILES=README ryethesis.ins ryethesis.dtx ryethesis.pdf ryesample.pdf Makefile
+
+TEXMFFLAGS=-file-line-error -halt-on-error -interaction=batchmode
+
+TARGETS=ryethesis.cls ryethesis.pdf ryesample.pdf ryethesis-$(VERSION).zip
+all: $(TARGETS)
+
+.PHONY: again.and.again
+
+again.and.again:
+ @if [ $(MAKELEVEL) = 4 ]; then \
+ echo "Too many nesting levels of make!"; exit 1; \
+ fi
+ @$(LATEX) $(TEXMFFLAGS) $(FILEROOT) || ( rm -f $(FILEROOT).pdf && exit 2)
+ @bibtex -terse $(FILEROOT)
+ @if [ -f $(FILEROOT).ist ]; then makeglossaries -q $(FILEROOT) ; fi
+ @if [ -f $(FILEROOT).idx ]; then makeindex -q $(FILEROOT) ; fi
+ @if [ -f $(FILEROOT).glo ]; then makeindex -q $(FILEROOT).nlo -s nomencl.ist -o $(FILEROOT).nls; fi
+ @$(LATEX) $(TEXMFFLAGS) $(FILEROOT) || ( rm -f $(FILEROOT).pdf && exit 2)
+ @if `grep -q -e "There were undefined references" -e "There were multiply-defined labels" -e "Label(s) may have changed. Rerun to get cross-references right" $(FILEROOT).log`; \
+ then $(MAKE) FILEROOT=$(FILEROOT) again.and.again; \
+ fi
+
+clean:
+ @rm -rf $(TARGETS) *.aux *.lof *.lot *.loa *.log *.bbl *.blg *.ind *.ilg *.toc *.idx *.gls *.glo *.out *~ *.nls *.nlo *.ist *.toa *.glg auto
+
+ryesample.pdf: Makefile ${TEXFILES} ${BIBFILES} ${FIGS}
+ $(MAKE) FILEROOT=ryesample again.and.again
+
+ryethesis.pdf: Makefile ryethesis.dtx
+ $(LATEX) $(TEXMFFLAGS) ryethesis.dtx
+ $(LATEX) $(TEXMFFLAGS) ryethesis.dtx
+
+ryethesis.cls: Makefile ryethesis.ins
+ $(LATEX) $(TEXMFFLAGS) ryethesis.ins
+
+ryethesis-$(VERSION).zip: ${FILES} ${TEXFILES} ${BIBFILES} ${FIGS}
+ zip $@ $^
+
diff --git a/Master/texmf-dist/doc/latex/ryethesis/README b/Master/texmf-dist/doc/latex/ryethesis/README
index b07ee75034b..8ca78266f7c 100644
--- a/Master/texmf-dist/doc/latex/ryethesis/README
+++ b/Master/texmf-dist/doc/latex/ryethesis/README
@@ -13,30 +13,40 @@
and version 1.3c or later is part of all distributions of LaTeX
version 2008/05/04 or later.
-This is a class definition for formatting a thesis, dissertation or project subject to
-Ryerson University School of Graduate Studies policy. The following files are provided:
+This is a class definition for formatting a thesis, dissertation or
+project subject to Ryerson University School of Graduate Studies
+policy. The following files are provided:
README
ryethesis.ins
ryethesis.dtx
- ryethesis.cls
ryethesis.pdf
ryesample.tex
ryesample.bib
ryesample.pdf
figure1.pdf
-To re-create the class file 'ryethesis.cls',
+To create the class file 'ryethesis.cls',
run LaTeX on the install file 'ryethesis.ins'.
To re-create the class and usage documentation 'ryethesis.pdf',
run LaTeX on the file 'ryethesis.dtx'.
-For a sample thesis using most of the available options, see 'ryesample.tex'.
-This LaTeX file will include a figure 'figure1.pdf', which requires that you use
-pdflatex, xelatex, or similar. Run BiBTeX to process the cited references from
-the file 'ryesample.bib'. You will also need to recreate the nomenclature, glossary,
-and index. See 'ryesample.tex' for details or examine the output log messages.
+For a sample thesis using most of the available options, see
+'ryesample.tex'. This LaTeX file will include a figure 'figure1.pdf',
+which requires that you use pdflatex, xelatex, or similar. Run BiBTeX
+to process the cited references from the file 'ryesample.bib'. You
+will also need to recreate the nomenclature, glossary, and index. See
+'ryesample.tex' for details or examine the output log messages. Using
+pdflatex, the sequence of commands is:
+
+pdflatex ryesample
+bibtex ryesample
+makeindex -s nomencl.ist -o ryesample.nls ryesample.nlo
+makeindex ryesample
+makeglossaries ryesample
+pdflatex ryesample
+pdflatex ryesample
Feel free to send bug reports to the author above.
diff --git a/Master/texmf-dist/doc/latex/ryethesis/ryesample.pdf b/Master/texmf-dist/doc/latex/ryethesis/ryesample.pdf
index 44392928f8f..0b6627a44bb 100644
--- a/Master/texmf-dist/doc/latex/ryethesis/ryesample.pdf
+++ b/Master/texmf-dist/doc/latex/ryethesis/ryesample.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/ryethesis/ryesample.tex b/Master/texmf-dist/doc/latex/ryethesis/ryesample.tex
index 9ba8c84ac6f..d4ecf3c1b18 100644
--- a/Master/texmf-dist/doc/latex/ryethesis/ryesample.tex
+++ b/Master/texmf-dist/doc/latex/ryethesis/ryesample.tex
@@ -1,4 +1,7 @@
-\documentclass[final,los,index,glossary]{ryethesis}
+\documentclass[final,los,index,glossary,loa]{ryethesis}
+%
+% Note that this usage example is not an introduction to using LaTeX. You are highly recommended to check out Leslie Lamport's "LaTeX: A Document Preparation System". Please read through this file to get started using the ryethesis document class, including all comments!
+
% Available options to ryethesis class:
% draft - Produce a one-sided, double-spaced draft.
% final (default) - Produce a two-sided, 1.5-spaced final version
@@ -10,15 +13,18 @@
% los | nolos (default) - Enable | disable a list of symbols (nomenclature)
% glossary | noglossary (default) - Enable | disable a glossary of terms
% index | noindex (default) - Enable | disable an index
+%
-% Note that currently, SGS policy does not specify a requirement for a nomenclature list
-% The List of Symbols currently appears as the last item in the front matter.
-% The nomenclature must be processed using the 'makeindex' command, similar to the creation
-% of an index. E.g.
-% makeindex ryesample.nlo -s nomencl.ist -o ryesample.nls }
+% List of Symbols / Nomenclature
+%=====================
+% Note that current SGS policy does not specify a requirement for a nomenclature list. In keeping with the "List of ..." model, the nomenclature is presented as a "List of Symbols". The List of Symbols currently appears as the last item in the front matter.
+%
+% The nomenclature must be processed using the 'makeindex' command, similar to the creation of an index. For example:
+% makeindex ryesample.nlo -s nomencl.ist -o ryesample.nls
+%
+% Symbols can be defined with the \nomenclature command in the body of the text (see below for examples).
-% Some of the above options can be toggled in the preamble. The following commands are
-% available (function should be obvious by name):
+% Some of the class options can be toggled in the preamble. The following commands are available (function should be obvious by name):
% \includelistoftables
% \nolistoftables
% \includelistoffigures
@@ -37,10 +43,12 @@
% \noindex
% If you wish to include pictures, I recommend the graphics package. This is not
-% loaded by the ryethesis class. Add any other packages you wish to load here in the
-% preamble.
+% loaded by the ryethesis class.
\usepackage{graphicx}
+% Add any other packages you wish to load here in the preamble.
+% \usepackage{somecoolpackage}
+
% In the pre-amble, define some of necessary information for the document frontmatter.
% Specify the author (required):
@@ -114,7 +122,8 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer pulvinar cursus
% Specify your desired BibTeX bibliographic style.
\bibliographystyle{plain}
%
-% The \bibliography command is inserted automatically in the correct place (ahead of any glossary but after the appendix). Use the \addtoreferences command to add BibTeX .bib files to the input list.
+% The \bibliography command is inserted automatically in the correct place (ahead of any glossary but after the appendix). Use the \addtoreferences command to add BibTeX .bib files to the input list. Note that this is not the usual way of doing this in LaTeX but works to fit the bibliography in the correct place.
+%
% \addtoreferences{bibfilename}
\addtoreferences{ryesample}
%
@@ -122,7 +131,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer pulvinar cursus
% \usebibliography
% or to use "End Notes" use the \useendnotes command.
% \useendnotes
-
+%
% Glossaries are implemented using the `glossaries' package.
\newglossaryentry{Lorem}{name={Lorem},description={lorem ipsem dolor sit amet}}
@@ -133,7 +142,12 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer pulvinar cursus
%
\begin{document}
\chapter{Introduction}
+\textit{Please note that this sample is not a beginner's introduction on using \LaTeX{}. While it's not difficult to get started with \LaTeX{}, especially if using the TexLive distribution, please see Leslie Lamport's ``LaTeX: A Document Preparation System'' as a starting point for learning \LaTeX{}.}
+
\textit{For the main matter of your thesis use the following sectional hierarchy: (part), chapter, section, subsection, paragraph, subparagraph. Each of these divisions can be indicated using the respective \LaTeX{} commands (e.g.\ \texttt{\textbackslash{chapter}} for a new chapter). Chapters will start on the right-hand page in two-sided mode with clear empty pages inserted as needed. In draft mode, no empty pages will be inserted.}
+
+\textit{This \LaTeX{} sample document includes additional comments regarding usage in the source.}
+
\section{Background}
\gls{Lorem} ipsum dolor sit amet, consectetur adipiscing elit. Praesent eu mauris tortor. Aliquam erat volutpat. Morbi gravida varius ornare. Duis vitae erat a odio pretium pharetra ornare sit amet urna. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla tempor lacinia augue, nec blandit lacus placerat nec. Phasellus non blandit dui. Donec lobortis eros id dolor semper consectetur. Mauris laoreet metus ut elit fringilla adipiscing posuere neque mattis. Aliquam turpis nibh, porta tristique elementum pellentesque, pharetra non neque. Cras dapibus ullamcorper dolor, ac tincidunt erat fermentum adipiscing. Fusce molestie, velit lobortis sollicitudin consectetur, ante metus tempus tortor, quis cursus lacus augue sit amet sem. Maecenas nibh urna, ullamcorper eget suscipit ac, fermentum ut ante.\footnote{Footnotes will be included on the same page whenever possible. Cras congue consectetur elit, ac lobortis tortor laoreet sit amet. Cras mauris est, feugiat vitae elementum eget, aliquam consequat urna. Aliquam ac vestibulum enim. Suspendisse.} Sed non lectus sapien. Suspendisse commodo sagittis massa, eget consectetur ipsum hendrerit sed. Sed condimentum tortor quis tortor facilisis aliquam. Ut tristique diam sit amet eros convallis ac eleifend felis imperdiet. Nam eros nunc, condimentum in blandit et, consectetur ac velit. Etiam sem purus, hendrerit id adipiscing et, viverra nec mi. Proin auctor, dolor at pretium facilisis, massa mauris blandit felis, ut vestibulum nibh purus non lectus.\footnote{Integer ornare vestibulum magna, in vestibulum lacus dapibus ac. Maecenas et enim et metus malesuada.}
@@ -169,7 +183,7 @@ Nam vestibulum (Fig.~\ref{fig::1}), libero et molestie mollis, urna est posuere
\begin{figure}
\begin{center}
\includegraphics[width=\textwidth,keepaspectratio=true]{figure1.pdf}
-\caption[Lorem ipsum dolor sit amet, consectetur adipiscing elit.]{Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis nibh.}\label{fig::1}
+\caption[Lorem ipsum dolor sit amet, consectetur adipiscing elit.]{\textit{Figures should be included using the \texttt{figure} float environment.} Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis nibh.}\label{fig::1}
\end{center}
\end{figure}
\clearemptydoublepage
@@ -211,4 +225,27 @@ Phasellus et imperdiet justo. Pellentesque nec suscipit tortor. Aliquam ut nibh
Vivamus dictum ligula vitae ante ornare hendrerit. Quisque ac dolor nibh, eu ornare sem. Cras sit amet neque odio. Nulla bibendum bibendum turpis at congue. Nunc ultricies scelerisque sem, ut dapibus tellus dignissim sollicitudin. Curabitur sed sapien nibh, nec consectetur ante. Aliquam erat volutpat. Fusce tempor orci in ante venenatis nec pharetra diam aliquet. Nullam pretium elementum mauris, non commodo metus eleifend vel. Cras vel ante dolor. Suspendisse potenti. Quisque vel odio eget lorem posuere ultrices. Duis et volutpat diam. In sit amet pulvinar lacus. Vestibulum lacinia, turpis ut interdum venenatis, lorem sem eleifend diam, in hendrerit nisi tellus in lorem.
}
+\typeout{**************************************************************************}
+\typeout{}
+\typeout{This sample file includes nomenclature (a List of Symbols). Please run:}
+\typeout{ makeindex ryesample.nlo -s nomencl.ist -o ryesample.nls}
+\typeout{}
+\typeout{}
+\typeout{This sample file includes a glossary. Please run:}
+\typeout{ makeglossaries ryesample}
+\typeout{}
+\typeout{}
+\typeout{This sample file includes an index. Please run:}
+\typeout{ makeindex ryesample}
+\typeout{}
+\typeout{}
+\typeout{This sample file includes a bibliography. Please run:}
+\typeout{ bibtex ryesample}
+\typeout{}
+\typeout{Reprocess the document using LaTeX again, two more times to include the}
+\typeout{above sections.}
+\typeout{}
+\typeout{**************************************************************************}
+
+
\end{document}
diff --git a/Master/texmf-dist/doc/latex/ryethesis/ryethesis.pdf b/Master/texmf-dist/doc/latex/ryethesis/ryethesis.pdf
index bd5dd8208aa..49d74a677f7 100644
--- a/Master/texmf-dist/doc/latex/ryethesis/ryethesis.pdf
+++ b/Master/texmf-dist/doc/latex/ryethesis/ryethesis.pdf
Binary files differ