Next: GNU Free Documentation License, Previous: Using ThesisPUC, Up: Top [Contents][Index]

## 3 Commands List

This chapter describes all user available commands provided by the ThesisPUC latex document class. Unless otherwise grouped to for subject purposes, entries are listed in alphabetical order.

Optional: \abreviationstitle {title}
Optional: \abreviationstitleuk {title}

  Sets the title of the abreviations section. The default values are

      List of Abreviations (en_US)
      Lista de Abreviaturas (pt_BR)

Mandatory: \abstract {text}
Mandatory: \abstractuk {text}

  The former should be used to set the text of the abstract in the language of the thesis. The latter to set the text of the abstract in english.

Mandatory: \acknowledgment {text}

  Sets the text of the acknowledgment section of the thesis.

Mandatory: \advisor {name} {title}
Mandatory: \advisorR {reversed name}
Mandatory: \advisorInst {institution name}

  The first command should be used to set the full name of the advisor of the thesis, following a firstname(s) lastname order and without any comma. The second command should be used to set the full name as well, but using a reverse order: lastname, firstname(s) using a comma to separate the lastname from the firstname(s). For example:

      \advisor{Sidnei Paciornik}{Prof.}
      \advisorR{Paciornik, Sidnei}

  The last command is used to set the advisor’s institution name. For example:

      \advisorInst{Pontifícia Universidade Católica do Rio de Janeiro}

Optional: \coadvisor {name} {title}
Optional: \coadvisorR {reversed name}
Optional: \coadvisorInst {institution name}
Optional: \coadvisorII {name} {title}
Optional: \coadvisorIIR {reversed name}
Optional: \coadvisorIIInst {institution name}
Optional: \coadvisorIII {name} {title}
Optional: \coadvisorIIIR {reversed name}
Optional: \coadvisorIIIInst {institution name}

  All the above commands follow the exact same definition schema then respectively `\advisor`, `\advisorR` and `\advisorInst`.

Mandatory: \author {name}
Mandatory: \authorR {reversed name}

  The first command should be used to set the full name of the author of the thesis, following a firstname(s) lastname order and without any comma. The second command should be used to set the full name as well, but using a reverse order: lastname, firstname(s) using a comma to separate the lastname from the firstname(s). For example:

      \author{Julio César Álvarez Iglesias}
      \authorR{Álvarez Iglesias, Julio César}

Mandatory: \CDD {CDD number}

  Sets the CDD number of the thesis.

Mandatory: \city {name}

Mandatory: \day {day number}
Mandatory: \month {month name}
Mandatory: \year {year number}

Optional: \dedication {text}

  Sets the text of the dedication section of the thesis.

Mandatory: \department {name}

Optional: \epigraph {text}
Optional: \epigraphauthor {name}
Optional: \epigraphbook {title}

  Respectively set the epigraph text, author and book title of an epigraph. For example:

      \epigraph{%
        My beautifull epigraph
      }
      \epigraphauthor{Wassily Kandinsky}
      \epigraphbook{Regards sur le passé}

Mandatory: \jury
Mandatory: \jurymember {name} {title} {instution} {inst. acronym}
Mandatory: \schoolhead {name} {title}

  The `\jury` command is used as a block delimiter of the jury members. Each jury member must be defined using four parameters. The schoolhead must be defined using two parameters and must be the last entry of the jury block. Here is an example:

      \jury{%
        \jurymember{Paulo Roberto Gomes Brandão}{Prof.}
          {Universidade Federal de Minas Gerais}{UFMG}
        ...
        \jurymember{Reiner Neumann}{Dr.}
          {Centro de Tecnologia Mineral}{CETEM/MCTI}
        \schoolhead{José Eugenio Leal}{Prof.}
      }

  Note: the mandatory `\school` command, also known as `center`, must be defined outside the `\jury block`.

Mandatory: \catalogprekeywords
Mandatory: \catalogprekey {text}

  The `\catalogprekeywords` command is used as a block delimiter for all `\catalogprekey` entries:

      \catalogprekeywords{%
        \catalogprekey{Engenharia Química}%
        \catalogprekey{Engenharia de Materiais}%
      }

  Catalog prekey(s) is(are) mandatory: you must have at least one catalog prekey. They preceed the list of keywords in the catalog entry of your thesis (ficha catalográfica), and list its domains of application, such as in the example above.

Mandatory: \keywords
Mandatory: \keywordsuk
Mandatory: \key {text}

  The `\keywords` and \keywordsuk commands are used as a block delimiter for all `\key` entries, respectively in the language of the thesis and in english. Here is an example:

      \keywords{%
        \key{Microscopia Digital;}
        ...
        \key{Classificação.}
      }
      \keywordsuk{%
        \key{Digital Microscopy;}%
        ...
        \key{Classification.}
      }

Mandatory: \program {text}

  Set the post graduation program to which the thesis pertains. For example:

      \department{Engenharia Química e de Materiais}
      \program{Engenharia de Materiais e de Processos Químicos e Metalúrgicos}

Mandatory: \resume {text}

  Sets the curriculum vitae summary of the candidate. For example:

      \resume{%
        Graduou-se em Física pela Universidade da Havana (Havana,
        Cuba). Fez mestrado ...}

Mandatory: \school {name}

  Set the school name, also known as the center name. For example:

      \school{Centro Técnico Científico}

Optional: \tablesmode {mode}

  This command is used to define whether the thesis preamble will include a list of figures, a list of tables, both or none. The default is both.

  The accepted values for the `mode` are: `empty`, `fig`, `tab` and `figtab`. Note that empty means no text, such as `\tablemodes{}`.

Optional: \title {title}
Optional: \titleuk {title}

  The first command is used to set the title in the language of the thesis. The second command is used to set the title in english. For example:

      \title{Desenvolvimento de um sistema de microscopia digital para
        classificação automática de tipos de hematita em minério de ferro}

      \titleuk{Development of a digital microscopy system for automatic
        classification of hematite types in iron ore}

Optional: \subtitle {subtitle}

  This command is optional and may be used if the thesis also has a subtitle.

Mandatory: \university {name}
Mandatory: \uni {acronym}

  Respectively set the name and shortname of the university. For example:

      \university{Pontifícia Universidade Católica do Rio de Janeiro}
      \uni{PUC-Rio}

Optional: \usecolour {boolean}

  You must use this command and set it to `true` if your thesis makes use of colours. The default value is false.

  Note that this command influences the output of the catalog entry on the third page, labeled ’Ficha catalográfica’, see `tiny.tex` and `tiny.pdf` for an example of usage and corresponding output.

#### Counters

Optional: \setcounter {name} {value}

  The name must be one of the following values: `tocdepth`, `lofdepth`, `lotdepth` or `secnumdepth`. All these counters are set to `3` per default in the ThesisPUC document class. Here is example to change these default values to `2`:

      \setcounter{tocdepth}{2}
      \setcounter{lofdepth}{2}
      \setcounter{lotdepth}{2}
      \setcounter{secnumdepth}{2}

Next: GNU Free Documentation License, Previous: Using ThesisPUC, Up: Top [Contents][Index]