Шаблоны

Изначально эта функция была разработана в yu-i-i/overleaf-cep, а затем доработана и оптимизирована в ayaka-notes/overleaf-pro.

По умолчанию просматривать галерею и открывать ссылки на шаблоны могут только пользователи, вошедшие в систему. Чтобы сделать шаблоны доступными для неавторизованных посетителей, также задайте OVERLEAF_ALLOW_PUBLIC_ACCESS=true, см. Доступ к страницам. Создание проекта из шаблона всегда требует входа в систему.

​

Настройка

Начиная с версии 6.3.0 галерея выполняет постраничный вывод, поиск и сортировку на сервере. Миграция не требуется. Для больших галерей см. необязательные индексы MongoDB в примечаниях к выпуску.

Функция галереи шаблонов управляется следующими переменными окружения:

• OVERLEAF_TEMPLATE_GALLERY: установите значение true, чтобы включить галерею шаблонов.

• OVERLEAF_TEMPLATE_CATEGORIES: необязательный список из нуля или более ключей категорий шаблонов, разделённых пробелами. Допустимые ключи:

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

  Специальный ключ all добавляется автоматически. Он обозначает категорию, включающую все шаблоны.

  Для каждого ключа категории можно задать следующие необязательные переменные окружения:

  • TEMPLATE_<KEY>_NAME: отображаемое название категории шаблонов.
  • TEMPLATE_<KEY>_DESCRIPTION: краткое описание категории.

  Если ключ категории содержит дефис (-), замените его на подчёркивание (_) в именах переменных окружения.

• ENABLE_CONVERSIONS: должна быть установлена в true, чтобы включить генерацию миниатюр и предпросмотра для шаблонов.

​

Права на публикацию

Публиковать шаблоны могут администраторы. Вы также можете назначить пользователя без прав администратора для управления подборкой шаблонов, отображаемой в вашей локальной галерее по адресу /templates.

Для этого задайте в toolkit/config/variables.env переменную окружения OVERLEAF_TEMPLATES_USER_ID, указав ID пользователя, который будет отвечать за управление шаблонами в вашем экземпляре, например:

OVERLEAF_TEMPLATES_USER_ID=56a8865231faeb5f07d69959

​

Публикация шаблонов

Для каждого шаблона, который вы хотите загрузить:

1. Создайте проект, содержащий исходный код шаблона, и убедитесь, что он компилируется.
2. В редакторе выберите File > Manage Template.
3. В появившейся форме введите сведения о шаблоне:
   • Поле Title должно быть уникальным.
   • Поле Description поддерживает форматирование Markdown.
   • Поле Author принимает ссылки в формате Markdown.

После отправки сведения о шаблоне можно изменить, а сам шаблон — удалить на странице галереи шаблонов. Администраторы и пользователь шаблонов (OVERLEAF_TEMPLATES_USER_ID) могут управлять любым шаблоном.

Пример:

#################
#   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.

​

Перенос шаблонов с overleaf.com

Поскольку архитектура Overleaf Pro рассчитана на работу в автономном режиме, автоматического способа интегрировать шаблоны из галереи overleaf.com в вашу локальную установку нет, однако это можно сделать вручную для каждого шаблона по отдельности.

По умолчанию Overleaf Pro настроен на использование для компиляции базовой схемы TeXLive. Эта базовая версия легковесна и содержит лишь очень ограниченный набор пакетов LaTeX, что, скорее всего, приведёт к ошибкам об отсутствующих пакетах, когда ваши пользователи попытаются использовать шаблоны с overleaf.com в вашем локальном экземпляре.

К сожалению, хотя автоматического способа установить недостающие пакеты нет, в Server Pro есть настраиваемый параметр, который позволяет вашим пользователям компилировать проекты с доступом к большему числу пакетов и более безопасным образом. Эта функция называется Sandbox Compiles (также известна как Sibling Containers).

Чтобы загруженные шаблоны были совместимы с вашим локальным экземпляром Server Pro, настоятельно рекомендуем включить Sandbox Compiles: эта функция предоставит вашим пользователям ту же среду TeX Live, что и на overleaf.com. Эти образы содержат самые популярные пакеты и шрифты и уже протестированы на шаблонах из нашей галереи.

Дополнительную информацию о том, как настроить версии TeX Live, доступные пользователям для выбора в проекте, а также как задать версию образа TeX Live по умолчанию для новых проектов, можно найти в разделе документации Changing the TeX Live Image.

1. Перейдите в галерею шаблонов на overleaf.com и найдите нужный шаблон, например IEEE Photonics Journal Paper Template - Example Submission
2. Нажмите кнопку Open as Template
3. Откройте меню проекта и выберите Download Source
4. Затем войдите в учётную запись на локальном экземпляре Server Pro
5. На панели проектов нажмите кнопку New Project и выберите Upload Project
6. Нажмите кнопку Select a .zip file и выберите загруженный zip-файл шаблона

После этого пользователь может использовать только что загруженный шаблон в своей учётной записи, либо вы, как пользователь шаблонов, можете опубликовать его для других пользователей.

​

Вопросы и ответы

Можно ли удалить проект после публикации соответствующего шаблона?

Ответ: Да, но мы не рекомендуем этого делать. При публикации шаблона мы делаем снимок проекта и сохраняем его в виде zip-файла на момент публикации. Благодаря этому шаблон не пострадает, даже если вы удалите соответствующий ему проект.

Однако мы также сохраняем ProjectID, связанный с этим шаблоном, что упрощает его обновление в будущем.

Если вы удалите соответствующий проект, на странице сведений о шаблоне не будет отображаться кнопка “Admin: Source Project” (см. изображение ниже).

Почему для некоторых проектов публикация шаблона занимает так много времени?

Ответ: При публикации шаблона мы сохраняем проект в виде zip- и pdf-файла, что обычно происходит быстро. Однако нам также нужно сгенерировать миниатюры для PDF, чтобы отображать их в сведениях о шаблоне.

Время генерации миниатюр обычно зависит от содержимого первой страницы PDF. Чтобы сбалансировать качество отображения и время конвертации, мы выбираем промежуточное значение ширины.

Тем не менее, если первая страница PDF содержит много текста, конвертация миниатюр может занять 40 секунд и даже больше — пожалуйста, наберитесь терпения. Ниже пример большого постера: для него это займёт больше времени.

Большой постер