summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/unbtex/README.md
blob: f723051c4a64c86996419e8cd82f696eabe144d1 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# UnBTeX: A class for bachelor, master, and doctoral thesis at the
# University of Brasilia (UnB), Brazil.
# Version 1.5.3 2024/10/07

Copyright (C) 2021-2024 by Henrique C. Ferreira <hcferreira@unb.br>

The package provides a class based on abnTeX and compatible with pdflatex 
and bibtex to prepare theses for the University of Brasilia (UnB), Brazil. 
The class also comes with a template for the various types of theses for 
ungraduated and graduated programs at UnB.

Please note that the documentation for the class and the comments in the 
templates are all written in Portuguese, the language of the target 
audience.

This package consists of the file unbtex.cls and the bibliographic style
files located in the unbtexcite directory.
Template files: unbtex-example.pdf, unbtex-example.tex, and files within 
unbtex-example directory.
To compile the unbtex-example.tex file you should call pdflatex, bibtex, 
pdflatex.

Here is a history of changes:
  1.0 (2021-12-15): Initial release
  1.1 (2022-05-23): 
    . Changed \codigocutter to \numerocutter 
    . The argument of \preambulo command now admits a more general text
  1.1.1 (2022-05-30):
    . Changed abntex2 commands \orientador and \coorientador to do the 
      same as \orient and \coorient
    . Changed hyphenation for \preambulo text in portuguese when english 
      language is selected
  1.1.2 (2022-07-29):
    . Page break on the copyright page has been corrected
    . Documentation and comments improvements
  1.1.3 (2022-09-04):
    . Improved compilation time
  1.2 (2022-10-05):
    . The styles of Table of Contents (Sumário), List of Sybols (Lista de
      símbolos), and List of Acronyms (Lista de abreviaturas) have been
      modified
    . A compilation problem with Tex Live 2022 that arises when microtype
      package is used has been solved
  1.2.1 (2023-06-15):
    . Braces around equation numbering and language option for \autoref 
      command has been corrected
    . The code comments have been improved
  1.3 (2023-10-17):
    . To avoid the compilation time limit in Overleaf, the biblatex 
      bibliography package has been replaced by the bibtex package, 
      and the TikZ package for drawings no more has not been used.
    . The indentation of lists of figures and tables have been corrected
    . The cleveref package is now being used for cross-references instead 
      of the autoref command
  1.3.1 (2023-10-18):
    . The abtex2eng-alf.bst file was included to format bibliographic 
      references in ABNT style for documents written in English.
  1.3.2 (2023-10-20):
    . Documentation and comments improvements
  1.3.3 (2023-11-02):
    . The abtex2eng-alf.bst file has been replaced by the unbtexcite-en.bst
      and unbtexcite-pt.bst files. These style files generate citations and
      bibliographic references in accordance with updates to ABNT's NBR
      6023:2018 and NBR 10520:2023 standards 
    . Example and code comments improvements
  1.4 (2023-11-15):
    . Text main font based on stix2 package has been replace by stickstoo
      package to improve math subscript spacing
    . Sans serif font scale has been adjusted (helvet package)
    . Typewriter font and scale have been changed (inconsolata package)
    . Font size and line spread of verbatim environment have been modified
    . Cross-references names for listing, algorithm, and theorem
      environments have been corrected
    . Indentation and line spacing of references list have been adjusted
    . Figure and table numbering by chapter have been corrected
  1.4.1 (2023-11-27):
    . Figure captions have been moved to the top to comply with the ABNT
      standard
    . Spacing between figures/tables and captions/legends has been 
      adjusted
    . Spacing between figures/tables and text has been adjusted
    . Spacing in list environments has been adjusted
  1.4.2 (2023-12-15):
    . Cross-references to the appendix and annex using the cref command
      have been corrected
    . The lists of abbreviations and acronyms, as well as the list of 
      symbols, have been enhanced, and page numbering has been removed
    . The chapters of the example document have been reorganized
  1.4.3 (2023-12-22):
    . Keywords in English have been included on the copyright page if 
      the document is written in this language
    . Examples of long tables and rotated tables have been included
  1.4.4 (2024-01-05):
    . The pdfpages package has been used to include pages from PDF 
      documents
    . The sans-serif font Helvetica (helvet package) has been replaced 
      by the TeX Gyre Heros font (tgheros package)
  1.5 (2024-02-02):
    . ABNT style with a numeric citation scheme for bibliographic 
      references has been included
    . Added an option to the UnBTeX class for selecting the citation 
      style (author-year or numeric)
    . Added an option to the UnBTeX class for selecting the main language
      of the text (Brazilian Portuguese or English)
    . The font size of the title is automatically adjusted according to 
      its length (and number of lines)
    . Reorganization of the class source code and improvements in the 
      comments
    . The template text has been revised and improved
  1.5.1 (2024-03-02):
    . The approval sheet (folha de aprovação) has been changed
    . The bottom margin size has been corrected to be consistently 
      adhered to
  1.5.2 (2024-07-04):
    . The length of the footnote separator line has been corrected 
      according to ABNT standards
    . The left margin indentation of the citacao environment has been 
      corrected according to ABNT standards
    . The left margin indentation of the references can be adjusted by 
      the user
  1.5.3 (2024-10-07):
    . A back cover has been added to the template
    . Language options for the Babel package are now declared directly 
      in the UnBTeX class file
    . Included the DOI (Digital Object Identifier) field in bibliography
      entries
    . An environment for including charts (quadros) has been created, 
      and the list of charts has been added.
    . Included list of algorithms and list of codes
    . The packages algpseudocode and algorithm have been replaced by 
      the algorithm2e package for including pseudocode
    . The internal cross-referencing for tables created with the longtable 
      package has been corrected
    . An option has been added to the UnBTeX class to select the numbering 
      style for figures, tables, etc., either by chapter or for the entire 
      document.
    . The options article and twocolumn of the Memoir class have been
      configured for use.
    . The example document has been updated and reorganized

## Overleaf

The template is available on [Overleaf]
(https://www.overleaf.com/latex/templates/unbtex-a-class-for-bachelor-master-and-doctoral-thesis-at-university-of-brasilia-unb/rfsxjkzprztc).

## Licence

This class file may be distributed and/or modified under the conditions
of the LaTeX Project Public License, either version 1.3 of this license
or (at your option) any later version. The latest version of this
license is in:

https://www.latex-project.org/lppl.txt

and version 1.3 or later is part of all distributions of LaTeX version
2005/12/01 or later.