Estrutura de arquivos

O modelo de projeto do limarka possui os seguintes arquivos:

A seguir é explicado como cada arquivo desse é utilizado.

trabalho-academico.md

O arquivo trabalho-academico.md é o principal arquivo do projeto, onde você irá digitar seu trabalho utilizando a sitaxe do Markdown. Seu conteúdo original pode ser consultado on-line, clicando no seu link.

Recomendamos a utilização de um editor de texto com suporte a destaque da sintaxe de Markdown para edição de todos os arquivos .md, consulte página de instalação.

apendices.md e anexos.md

O propósito dos arquivos apendices.md e anexos.md é bastante intuitivo, o primeiro serve para a escrita dos apêndices e o segundo para a escrita dos anexos. Ambos os arquivos devem ser escritos utilizando a sintaxe de Markdown.

errata.md

Provavelmente você não irá precisar, mas caso seja necessário a escrita da errata deve ser realizada no arquivo errata.md.

configuracao.pdf

A configuração do limarka é realizada através da edição do arquivo configuracao.pdf. Você o utilizá para fornecer o título do trabalho, nomes do autor e orientador, datas, etc. Inclusive as configurações para utilização dos apêndices, anexos e errata são realizadas nesse arquivo.

referencias.bib

O arquivo referencias.bib é o banco de referências do trabalho. Todas as referências que poderão ser utilizadas no seu trabalho deverão ser cadastradas nesse arquivo.

Embora o arquivo possa ser editado manualmente, recomendamos a utilização de um editor bibtex especializado, consulte página de instalação.

imagens/ficha-catalografica.pdf e imagens/folha-de-aprovacao-escaneada.pdf

O arquivo imagens/ficha-catalografica.pdf deve ser substituído pelo arquivo fornecido pela equipe especializada de sua instituição. Caso eles forneçam um arquivo no Word, exporte-o para PDF sobrescrevendo esse arquivo.

O arquivo imagens/folha-de-aprovacao-escaneada.pdf também deve ser substituído pela folha fornecida pelo seu curso.

Esses arquivos poderão ser utilizados na versão final do seu trabalho. Suas utilizações são configuradas no arquivo configuracao.pdf.

PDF do trabalho gerado

O nome do arquivo de saída, o PDF gerado, depende do tipo de trabalho configurado em configuracao.pdf, o nome pode ser um dos seguintes:

• xxx-Monografia-projeto.pdf
• xxx-Monografia.pdf
• xxx-TCC-projeto.pdf
• xxx-TCC.pdf
• xxx-Dissertacao-projeto.pdf
• xxx-Dissertacao.pdf
• xxx-Tese-projeto.pdf
• xxx-Tese.pdf

xxx-*

Os arquivos xxx-* são arquivos temporário que são gerados durante a execução do limarka.