DOCSEARCHbyAlgolia
Submit Docs

abnTeX2 Documentation

repository·master·Indexed 22 days ago

https://github.com/abntex/abntex2

A LaTeX suite designed to automate the formatting of scientific and technical documents according to Brazilian ABNT standards. It includes a LaTeX class for document structure, citation and bibliographic style formatting packages, and templates for academic works, research projects, technical reports, and scientific articles. Compatible with major LaTeX distributions (MiKTeX, TeX Live, MacTeX) and LyX.

Tokens
1.4K
Snippets
3
Records
12
Agent score
28%

What's inside abnTeX2

  1. Overview of abnTeX2

    master

    abnTeX2 is a LaTeX suite designed to meet the requirements of the Brazilian Association of Technical Standards (ABNT) for creating technical and scientific documents. It is an evolution of the original abnTeX project.

    The suite includes:

    • A LaTeX class for document structure.
    • Citation and bibliographic style formatting packages.
    • Document templates and examples.
    • Extensive documentation.

  2. Install abnTeX2

    master

    abnTeX2 is available via CTAN and is integrated into major LaTeX distributions. If you use one of the following, no additional installation is required:

    • Windows: MiKTeX or proTeXt
    • Linux: TeX Live
    • Mac: MacTeX

    If your distribution does not include it by default, you can install it using your LaTeX distribution's Package Manager. Specific installation guides are available for Windows, Linux, and Mac.

  3. Download abnTeX2 document templates

    master

    You can download canonical document templates built with abnTeX2 from CTAN. These templates include compiled examples for:

    1. Scientific articles
    2. Academic works (theses, dissertations, TCCs, etc.)
    3. Research projects
    4. Technical/scientific reports
    5. Books and pamphlets
    6. Documents with Glossaries
    7. Slide presentations

  6. Customizing abnTeX2

    master
    Users and institutions are encouraged to customize front pages and other elements. Instead of modifying the source files directly, it is recommended to use \renewcommand or commands from the memoir class to customize abnTeX2 commands. This ensures better compatibility and easier updates.

  7. Install abnTeX2 on TeXLive (Unix-like systems)

    master
    If you are using a TeXLive system on Linux, Mac, or BSD, you can perform an "automagic" installation by uncompressing the TDS file (e.g., abntex2-tds-VERSION.zip or abntex2-tds-VERSION.tar.gz) and running the make install command in your terminal.
    make install

  8. Compile abnTeX2 documentation

    master

    The documentation consists of several .tex files (e.g., abntex2.tex, abntex2cite.tex). To compile them into PDF, follow this sequence of commands (replacing FILE with the specific filename):

    pdflatex FILE.tex
bibtex FILE.aux
makeindex FILE
latex2pdf FILE.tex
latex2pdf FILE.tex

  9. Manually install abnTeX2 class and package

    master

    To manually install abnTeX2 in any LaTeX system (TeXLive, MiKTeX, etc.) on Windows, Linux, Mac, or BSD, place the following files in a directory that is within your LaTeX search path:

    • abntex2.cls: The abntex2 class file.
    • abntex2cite.sty: The abntex2cite citation package file.
    • abntex2abrev.sty: Extension of abntex2cite containing abbreviation helpers.
    • abntex2-alf.bst: Numeric citation style file.
    • abntex2-num.bst: Alphanumeric (author-date) citation style file.
    • abntex2-options.bib: Default citation options configurations.

  11. Reference: Supported ABNT Standards

    master

    abnTeX2 is compatible with the following ABNT standards:

    • ABNT NBR 6022:2018: Information and documentation - Article in periodic scientific publication - Presentation
    • ABNT NBR 6023:2002: Information and documentation - Reference - Preparation
    • ABNT NBR 6024:2012: Information and documentation - Progressive numbering of sections of a document - Presentation
    • ABNT NBR 6027:2012: Information and documentation - Summary - Presentation
    • ABNT NBR 6028:2003: Information and documentation - Abstract - Presentation
    • ABNT NBR 6029:2006: Information and documentation - Books and pamphlets - Presentation
    • ABNT NBR 6034:2004: Information and documentation - Index - Presentation
    • ABNT NBR 10520:2002: Information and documentation - Citations
    • ABNT NBR 10719:2015: Information and documentation - Technical and/or scientific report - Presentation
    • ABNT NBR 14724:2011: Information and documentation - Academic works - Presentation
    • ABNT NBR 15287:2011: Information and documentation - Research project - Presentation

  12. Available abnTeX2 usage examples

    master

    The repository provides several .tex models to demonstrate different document types and features:

    • abntex2-modelo-trabalho-academico.tex: Thesis/Academic work.
    • abntex2-modelo-relatorio-tecnico.tex: Technical report.
    • abntex2-modelo-projeto-pesquisa.tex: Research project.
    • abntex2-modelo-artigo.tex: Scientific article.
    • abntex2-modelo-glossarios.tex: Document with a glossary.
    • abntex2-modelo-slides.tex: Beamer presentation.
    • abntex2-modelo-livro.tex: Book.