Next: Commands List, Previous: Introduction, Up: Top [Contents][Index]

## 2 Using ThesisPUC

> Notes:

> - At this moment, the documentation is available in english only: translations are on their way though, stay tuned;
> - The pdf documentation you are now reading is also distributed with the ThesisPUC.zip, here: `doc/en_US/ThesisPUC.pdf`;
> - If that feels more conformtable for you, the documentation is also available in html format, fire your browser and open this file: `doc/en_US/ThesisPUC/index.html`;

ThesisPUC comes with two examples: (a) `julio`, based on a real phd thesis and (b) `tiny`, which you can use to start your own master or phd thesis document. The `tiny` example directory has the following files:

> `ThesisPUC.bst -> ../../ThesisPUC.bst`
> `ThesisPUC.cls -> ../../ThesisPUC.cls`
> `atbeginend.sty -> ../../atbeginend.sty`
> `puc.png -> ../../puc.png`

>   These files are mandatory to compile any master or phd thesis. You should not edit them. Note that in this `examples/tiny` case, they are symbolic links to the same and ’real’ files two directories above.

>   Notes for Windows users: the above symbolic links won’t exist on Windows. Windows users must copy and paste these four files from the directory where they unzip the ThesisPUC.zip archive.

> `defs.tex`

>   In this file comes your new and redefined latex commands.

> `images/`
> `tables/`

>   These directories are just a suggestion, to better organize things.

> `abrevs.tex`

>   This file defines the mandatory ’thenotations’ chapter, where you list the abreviations used in your thesis.

> `chapter-1.tex`
> `chapter-2.tex`
> `...`
> `conclusions.tex`

>   The chapters and conclusions of your thesis.

> `appendix.tex`

>   This file is optional. It is used when part of the work done on the master or phd thesis has been published. If used, it comes after the bibliography.

> `tiny.bib`

>   This file is where you keep all your bibliographic references. You can empty it and fill it with your own bibliographic references as your write your thesis. In its distributed version, it is a copy of `examples/julio/julio.bib`, where you can always look for and copy biblography entry models as needed.

> `tiny.tex`
> `tiny.pdf`

>   These are the main document and the resulting pdf version after compilation.

>   English thesis must declare their doccument class as this:

>       \documentclass[
>         phd,
>         american
>       ]{ThesisPUC}

>   In the above:

>       master replaces phd for master thesis;
>       brazilian replaces american for Portuguese thesis.

>   For English thesis, the \title command must still hold the portuguese version of the title: it is used for the page ’Resumo’.

>   The tiny.tex example has been declared as a phd american english written thesis (although we did not translate its chapters and conclusion content): all front pages, their order when applicable, as well as any automatically generated text are in English.

As you may have understood from the explanations besides the aforementioned file list, the master document, `tiny.tex` in our case, imports the other `.tex` files: `defs`, `abrevs`, `chapter-1`, `chapter-2`, `conclusions` and `appendix`.

Now, time to fire-up your prefered editor, open the document `example/tiny/tiny.tex`, make a few changes and save the file. Aside, open a terminal, make sure you are in the `example/tiny` directory, then execute these commands:

    pdflatex tiny.tex
    bibtex tiny.aux
    pdflatex tiny.tex
    pdflatex tiny.tex

The first command compiles all intermediary files, and produces a first but incomplete version of `tiny.pdf`.

The second command is used to generate the bibliography `tiny.bbl` file, looking for occurrences of `\cite{}` in your `.tex` files and checking for their corresponding entry in `tiny.bib`.

The last two commands are necessary to produce a fully cross referenced `tiny.pdf` file, which you can visualize: it is ready for proof reading and printing.

Next: Commands List, Previous: Introduction, Up: Top [Contents][Index]