O Projeto Jacurutu tem como principal objetivo disponibilizar um modelo guiado para trabalhos acadêmicos da UFRJ, aderente ao padrão estabelecido no manual de trabalhos acadêmicos da UFRJ estabalecido pelo SIBI (https://www.sibi.ufrj.br/index.php/inicio/700-atualizacao-do-manual-de-trabalhos-academicos-da-ufrj) , e o manual está disponível em: Manual da padronização.
A ideia desse projeto é de criar um modelo LaTeX para o utilização nos trabalhos acadêmicos da UFRJ, mas seguindo algumas premissas:
A principal ponto do projeto é a de tentar fazer um modelo que seja fácil de usar e de manter. Para isso o princípio do KISS (Keep It Simple Stupid) é muito bem vindo.
Seguem algumas sugestões podem ajudar a alcançar esse objetivo de simplicidade:
- Utilizando preferencialmente os recursos básicos e existentes do LaTeX.
- É importante tentar minimizar o uso de macros e comandos mirabolantes. Esse tipo de comando muitas vezes dificulta o entendimento e ajustes no trabalho dos usuários.
- Utilizar pacotes de latex já existentes para conseguir que as formatações desejadas. Por exemplo, para escrever uma epígrafe no formato estabelecido no manual, bastou utilizar o pacote "epigraph" já existente.
É desejado que o esqueleto do modelo, possa ir além da formatação apenas do texto. É possível indicar boas práticas na semântica esperadas em um texto acadêmico, como: as principais seções e subseções esperadas bem como as indicações sobre qual seria o conteúdo esperado para cada uma delas.
Uma documentação detalhada do projeto pode ser encontrada na wiki do projeto.
A documentação do projeto também possui uma seção para listar os problemas conhecidos.
Dentre as maneiras possíveis para colaborar com o projeto, podemos destacar:
O tópico Como citar da wiki do projeto, apresenta de forma mais detalhada, como citar esse modelo. A seção de 2-textos/metodologia.tex também apresenta um exemplo de citação.
- Avaliar o formato atual do texto gerado pelo projeto (pode ser olhando o arquivo
documento.pdf, na raiz do repositório); - Verificar se ja existe uma issue aberta ou em execução para solucionar o problema;
- Verificar a seção de problemas conhecidos para entender se o que está ocorrendo é de fato um problema, ou se é algo que já esta resolvido;
- Caso não encontr o problema específico, abrir uma nova issue/ticket para que o problema possa ser endereçado.
A melhor forma de colaborar é assumindo algum dos issues do projeto, e para isso basta:
- Submeter através de um push, um novo pull request com a solução implementada. O nome da branch do pull request deve referenciar o número da issue que está sendo tratada. Ex: 1-Ajustes_titulo_sumario
- Wikibook do LaTeX Possui bastante informação sobre funcionamento básico e o que já é disponível por padrão no LaTeX.
- Repositório de pacotes LaTeX Repositório oficial de pacotes LaTeX
- Fontes disponíveis no CTAN Lista com fontes disponíveis em pacotes para o LaTeX