summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/stellenbosch/README.txt
blob: e3f71a0b0d8d55332a0eeec4a8f2319685d80fa6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
                     The Stellenbosch bundle
     for typesetting dissertations, theses and reports of the
              University of Stellenbosch, South Africa.

Author:    Danie Els
Copyright (c) 2001-2006 Danie Els
Licence:  LaTeX Project Public License

DESCRIPTION
===========

The Stellenbosch bundle consists of the following:

 usthesis.cls/usthesis.sty:

     The usthesis class/style files are provided to typeset reports,
     theses and dissertations that conform to the requirements of
     the Engineering Faculty of the University of Stellenbosch.
         The class file usthesis.cls is based on the standard LaTeX
     book class, while usthesis.sty is a style file to be loaded on
     top of the very powerful memoir class. Both options give
     identical output, but the benefit of the using memoir is that
     it has many additional command and environments for formatting
     and processing of a document.
         Usthesis is primarily concerned with the formatting of the
     front matter such as the title page, abstract, etc. It also
     works together with the babel package to provide language
     language options to typeset documents in Afrikaans or in
     English.

 usbib.sty (usmeg-a.bst, usmeg-n.bst, ussagus.bst)

     USbib is a LaTeX and BibTeX package for the formatting of
     bibliographic references of theses and dissertations of the
     Department of Mechanical Engineering at the University of
     Stellenbosch. This package is tailored towards citations and
     bibliographical formatting for the natural sciences and
     engineering.

 ustitle.sty

     The ustitle package redefine the standard title page of the
     LaTeX classes to add a logo at the top and an address line
     below the author. It is intended for use when writing general
     notes and articles.

 usnomencl.sty

     A very simple utility to set a nomenclature or list of symbols
     for US theses and reports.

 ussummary.sty

     Summary page required for the final year projects of the
     Department of Mechanical Engineering.

 masters-sample.zip, report-sample.zip

    Templates for dissertations, theses and final year projects.

 uslogos

    Collection of graphics file for crest and logos.



BASIC INSTALLATION
====================

 For a basic installation on a TDS compliant system, move the
 following files to the following directories:

     <texmf>/tex/latex/stellenb/
        usthesis.sty
        usthesis.cls
        usbib.sty
        usbib.afr
        usbib.eng
        ustitle.sty
        usnomencl.sty
        ussummary.sty

     <texmf>/tex/latex/stellenb/logos
        (all the logo graphics)

     <texmf>/bibtex/bst/stellenb
         usmeg-a.bst
         usmeg-n.bst
         ussagus.bst

 A full installation with source code and documentation can be
 obtained by unzipping stellenbosch-3.0.zip in your <(local) texmf>
 directory.