Templates

Este recurso foi desenvolvido inicialmente por yu-i-i/overleaf-cep e modificado e otimizado por ayaka-notes/overleaf-pro.

Por padrão, apenas usuários logados podem navegar pela galeria e abrir links de templates. Para compartilhar templates com visitantes não autenticados, defina também OVERLEAF_ALLOW_PUBLIC_ACCESS=true; consulte Acesso a páginas. Criar um projeto a partir de um template sempre exige login.

​

Configuração

A partir da versão 6.3.0, a galeria realiza paginação, busca e ordenação no servidor. Nenhuma migração é necessária. Para galerias grandes, consulte os índices opcionais do MongoDB nas notas de versão.

O recurso de Galeria de Templates é controlado pelas seguintes variáveis de ambiente:

• OVERLEAF_TEMPLATE_GALLERY: defina como true para habilitar a Galeria de Templates.

• OVERLEAF_TEMPLATE_CATEGORIES: uma lista opcional, separada por espaços em branco, de zero ou mais chaves de categoria de templates. As chaves válidas incluem:

  • academic-journal
  • book
  • presentation
  • poster
  • cv
  • homework
  • bibliography
  • calendar
  • formal-letter
  • report
  • thesis
  • newsletter

  A chave especial all é adicionada automaticamente. Essa chave representa uma categoria que inclui todos os templates.

  Para cada chave de categoria, as seguintes variáveis de ambiente opcionais podem ser definidas:

  • TEMPLATE_<KEY>_NAME: o nome de exibição da categoria de templates.
  • TEMPLATE_<KEY>_DESCRIPTION: uma breve descrição da categoria.

  Se uma chave de categoria contiver um hífen (-), substitua-o por um sublinhado (_) nos nomes das variáveis de ambiente.

• ENABLE_CONVERSIONS: deve ser definida como true para habilitar a geração de miniaturas e pré-visualizações dos templates.

​

Permissões para publicação

Administradores podem publicar templates. Você também pode designar um usuário não administrador para gerenciar os templates selecionados exibidos na sua galeria local em /templates.

Para isso, você precisará definir a variável de ambiente OVERLEAF_TEMPLATES_USER_ID em toolkit/config/variables.env com o ID do usuário que será responsável pelo gerenciamento de templates na sua instância, por exemplo:

OVERLEAF_TEMPLATES_USER_ID=56a8865231faeb5f07d69959

​

Publicando templates

Para cada template que você deseja enviar:

1. Crie um projeto contendo o código-fonte do template e certifique-se de que ele compila.
2. No editor, escolha File > Manage Template.
3. No formulário que aparecer, insira os detalhes do template:
   • O Title deve ser único.
   • O campo Description suporta formatação Markdown.
   • O campo Author aceita links formatados em Markdown.

Após o envio, os detalhes do template podem ser editados, ou o template pode ser excluído pela página da Galeria de Templates. Administradores e o usuário de templates (OVERLEAF_TEMPLATES_USER_ID) podem gerenciar qualquer template.

Aqui está um exemplo:

#################
#   TEMPLATES   #
#################

ENABLE_CONVERSIONS=true

OVERLEAF_TEMPLATE_GALLERY=true
OVERLEAF_TEMPLATE_CATEGORIES=academic-journal book presentation poster cv homework bibliography calendar formal-letter report thesis newsletter

TEMPLATE_ACADEMIC_JOURNAL_NAME=Journal articles
TEMPLATE_ACADEMIC_JOURNAL_DESCRIPTION=Templates for academic journal submissions, including formats for major publishers and preprint servers.

TEMPLATE_BIBLIOGRAPHY_NAME=Bibliographies
TEMPLATE_BIBLIOGRAPHY_DESCRIPTION=Styles for creating and managing bibliographies with BibTeX or BibLaTeX. Suitable for use in academic papers, theses, and reports.

TEMPLATE_BOOK_NAME=Books
TEMPLATE_BOOK_DESCRIPTION=Templates for writing books or long-form documents, including chapter structuring, front matter, and indexing.

TEMPLATE_CALENDAR_NAME=Calendars
TEMPLATE_CALENDAR_DESCRIPTION=Templates to create yearly, monthly, or weekly calendars. Useful for personal planners or event scheduling.

TEMPLATE_CV_NAME=CVs and résumés
TEMPLATE_CV_DESCRIPTION=Templates for CVs and résumés with various formats for academic, industry, and creative positions.

TEMPLATE_FORMAL_LETTER_NAME=Formal letters
TEMPLATE_FORMAL_LETTER_DESCRIPTION=Templates for professional letters, such as cover letters, recommendation letters, and official correspondence.

TEMPLATE_HOMEWORK_NAME=Assignments
TEMPLATE_HOMEWORK_DESCRIPTION=Templates for homework, coursework, and problem sets. Designed to be clean and well-structured for students and educators.

TEMPLATE_NEWSLETTER_NAME=Newsletters
TEMPLATE_NEWSLETTER_DESCRIPTION=Templates for creating newsletters with formats for academic, corporate, or community communications.

TEMPLATE_POSTER_NAME=Posters
TEMPLATE_POSTER_DESCRIPTION=Templates for scientific and academic posters, typically used in conferences and research presentations.

TEMPLATE_PRESENTATION_NAME=Presentations
TEMPLATE_PRESENTATION_DESCRIPTION=Templates for Beamer and other presentation formats, tailored for academic talks and lectures.

TEMPLATE_REPORT_NAME=Reports
TEMPLATE_REPORT_DESCRIPTION=Templates for technical, lab, or project reports. Includes sections for figures, tables, and references.

TEMPLATE_THESIS_NAME=Theses
TEMPLATE_THESIS_DESCRIPTION=Templates for writing theses and dissertations, following institutional formatting and citation guidelines.

TEMPLATE_ALL_NAME=All templates
TEMPLATE_ALL_DESCRIPTION=Browse a collection of all available LaTeX templates, categorized by document type, style, and purpose.

​

Transferindo templates do overleaf.com

Como o Overleaf Pro foi arquitetado para funcionar offline, não existe uma forma automatizada de integrar os templates da galeria do overleaf.com à sua instalação on-premises; no entanto, é possível fazer isso manualmente, template por template.

Por padrão, o Overleaf Pro é configurado para usar uma versão com esquema básico do TeXLive para compilações. Essa versão básica é leve e contém apenas um subconjunto bem limitado de pacotes LaTeX, o que provavelmente resultará em erros de pacotes ausentes para seus usuários ao tentarem usar templates do overleaf.com na sua instância on-premises local.

Infelizmente, embora não exista uma forma automática de instalar pacotes ausentes, temos uma configuração no Server Pro que permite aos seus usuários compilar projetos com acesso a mais pacotes, e de forma mais segura. Esse recurso se chama Sandbox Compiles (também conhecido como Sibling Containers).

Para garantir que os templates baixados sejam compatíveis com sua instância on-premises do Server Pro, recomendamos fortemente que você habilite o Sandbox Compiles, pois esse recurso dará aos seus usuários acesso ao mesmo ambiente TeX Live do overleaf.com. Essas imagens contêm os pacotes e fontes mais populares e já foram testadas com os templates da nossa galeria.

Você encontra informações adicionais sobre como configurar quais versões do TeX Live os usuários podem escolher em seus projetos, bem como sobre como definir a versão padrão da imagem do TeX Live para novos projetos, na seção Changing the TeX Live Image da nossa documentação.

1. Acesse a Galeria de Templates no overleaf.com e localize o template desejado, por exemplo IEEE Photonics Journal Paper Template - Example Submission
2. Clique no botão Open as Template
3. Clique no menu do projeto e escolha Download Source
4. Em seguida, faça login na conta do Server Pro on-premises
5. Clique no botão New Project no painel de projetos e escolha Upload Project
6. Clique no botão Select a .zip file e escolha o arquivo zip do template baixado

O usuário poderá então usar esse template recém-enviado em sua própria conta ou, como usuário de templates, você poderá publicá-lo para que outros usuários o utilizem.

​

Perguntas e respostas

Posso excluir o projeto depois de publicar o template correspondente?

Resposta: Sim, mas não recomendamos fazer isso. Quando você publica um template, tiramos um snapshot do projeto e o salvamos como um arquivo zip no momento da publicação. Isso garante que, mesmo que você exclua o projeto correspondente ao template, o template não será afetado.

No entanto, também registramos o ProjectID associado a esse template, o que facilita atualizá-lo no futuro.

Se você excluir o projeto correspondente, não verá o botão “Admin: Source Project” na página de detalhes do template (veja a imagem abaixo).

Por que, em alguns projetos, a publicação de um template demora tanto?

Resposta: Quando você publica o template, salvamos o projeto como um arquivo zip e um arquivo pdf, o que normalmente é rápido. No entanto, também precisamos gerar miniaturas do PDF para que possam ser exibidas nos detalhes do template.

O tempo de geração das miniaturas normalmente depende do conteúdo da primeira página do seu PDF. Para equilibrar a qualidade de exibição e o tempo de conversão, escolhemos uma largura intermediária.

No entanto, se a primeira página do PDF contiver muito texto, a conversão das miniaturas pode levar 40 segundos ou até mais; tenha paciência. Aqui está um exemplo de um pôster grande, que levará mais tempo.

Um pôster grande