Português · English

Typst template for academic works (final course works, dissertations and theses) that follow the standards of the Brazilian Association of Technical Standards (ABNT), especially ABNT NBR 14724:2024.

Template do Typst para trabalhos acadêmicos (trabalhos de conclusão de curso, dissertações e teses) condizentes com as normas da Associação Brasileira de Normas Técnicas (ABNT), especialmente a ABNT NBR 14724:2024.

O que é o pacote

O abntly formata um trabalho acadêmico escrito em Typst de acordo com as normas da ABNT. A função principal, trabalho-academico, é chamada uma vez no início do arquivo e aplica a formatação a todo o documento. Cada elemento da estrutura do trabalho tem a sua função.

• Regras gerais: página A4 e margens, fonte, espaçamento, paginação, numeração das seções, alíneas e notas de rodapé.
• Estrutura: capa, folha de rosto, ficha catalográfica, errata, folha de aprovação, dedicatória, agradecimentos, epígrafe, resumos, listas, sumário, glossário, apêndices, anexos e índice.
• Elementos do texto: ilustrações com fonte, legenda e notas, quadros, tabelas no padrão do IBGE, equações e remissões.
• Citações e referências: sistemas autor-data e numérico, citação de citação e lista de referências, a partir de um arquivo .bib.
• Dois idiomas: todas as funções têm um nome em português e um em inglês (capa e cover), e o trabalho pode ser escrito em português ou em inglês.

O pacote trata apenas de trabalhos acadêmicos. Artigos, relatórios técnicos e projetos de pesquisa ficam fora do escopo (veja ABNTyp).

Uso

Para criar um trabalho novo a partir do modelo, em que cada elemento está comentado como obrigatório ou opcional:

typst init @preview/abntly:0.1.0 meu-trabalho

Para usar o pacote em um arquivo que já existe, importe-o no início:

#import "@preview/abntly:0.1.0": *

As fontes New Computer Modern Sans, Mono e 08 precisam estar instaladas (veja Dependências).

Exemplo básico

O exemplo a seguir tem só os elementos obrigatórios da NBR 14724:2024, na ordem da norma. O arquivo refs.bib contém as obras citadas no texto.

// Trabalho acadêmico mínimo: só os elementos obrigatórios da ABNT NBR 14724:2024, na ordem da norma.
#import "@preview/abntly:0.1.0": *

#show: trabalho-academico.with(
  dados: config-dados(
    titulo: [Título do trabalho],
    autor: "Nome do Autor",
    orientador: "Prof. Dr. Nome do Orientador",
    instituicao: [Universidade do Brasil],
    local: [Rio Branco],
    ano: 2026,
  ),
)

// Elementos pré-textuais
#capa()
#folha-de-rosto[
  Dissertação apresentada à Universidade do Brasil, como requisito parcial para a obtenção do título de Mestre.
]
#ficha-catalografica()
#folha-de-aprovacao(
  (titulacao: [Prof. Dr.], nome: [Nome do Orientador], instituicao: [Universidade do Brasil]),
  (titulacao: [Profa. Dra.], nome: [Nome da Convidada], instituicao: [Outra Universidade]),
)
#resumo[
  Texto do resumo, em um único parágrafo.

  #palavras-chave[primeira][segunda][terceira]
]
#resumo(idioma: "en")[
  Abstract text, in a single paragraph.

  #palavras-chave[first][second][third]
]
#outline()

// Elementos textuais
= Introdução

Texto da introdução, com uma citação @luck2010.

= Desenvolvimento

Texto do desenvolvimento.

= Conclusão

Texto da conclusão.

// Elementos pós-textuais
#bibliography("refs.bib")

Exemplo completo

• examples/pt/main.typ (PDF): um trabalho com todos os elementos da estrutura e os capítulos em arquivos separados, escrito com os nomes em português.
• examples/en/main.typ (PDF): o mesmo trabalho em inglês, com os nomes em inglês.

Documentação

O manual descreve cada função junto com o que a norma pede de cada elemento, com o código e o resultado. Ele serve como guia do pacote e como referência rápida das normas.

• Manual em português (PDF), com os nomes em português.
• Manual em inglês (PDF), com os nomes em inglês.

Normas atendidas

Dependências

O Typst baixa os pacotes automaticamente. As fontes não: a New Computer Modern e a New Computer Modern Math acompanham o Typst, mas a Sans (títulos), a Mono (código) e a 08 (sobrescritos) precisam ser instaladas. Elas fazem parte da família New Computer Modern: baixe o arquivo do CTAN e instale, da pasta otf, os arquivos NewCM10-*, NewCM08-*, NewCMSans10-*, NewCMSans08-*, NewCMMono10-* e NewCMMath-* (os que têm Book no nome não são usados). No typst.app, envie esses arquivos para o projeto.

Veja também

O abntly se inspirou nestes projetos:

• ABNTyp: pacote do Typst para documentos nas normas da ABNT. Além de trabalhos acadêmicos, tem modelos para artigos, relatórios técnicos, projetos de pesquisa, livros, pôsteres e slides.
• abnTeX2: classes e pacotes do LaTeX para documentos nas normas da ABNT. O abntly segue o modelo de trabalho acadêmico do abnTeX2 nos pontos que as normas deixam em aberto.
• csl-abnt: estilo CSL nas normas ABNT NBR 6023 e NBR 10520 para o Zotero, de @virgilinojuca e @AAguiarCAM, em domínio público (CC0). O src/csl/abnt-6023.csl do abntly foi adaptado dele.

Licença

O pacote é distribuído sob a licença MIT.