Šablony

Tuto funkci původně vyvinul projekt yu-i-i/overleaf-cep a upravil a optimalizoval ji projekt ayaka-notes/overleaf-pro.

Ve výchozím nastavení mohou galerii procházet a otevírat odkazy na šablony pouze přihlášení uživatelé. Chcete-li šablony sdílet s nepřihlášenými návštěvníky, nastavte také OVERLEAF_ALLOW_PUBLIC_ACCESS=true, viz Page Access. Vytvoření projektu ze šablony vždy vyžaduje přihlášení.

​

Konfigurace

Od verze 6.3.0 provádí galerie stránkování, vyhledávání a řazení na serveru. Žádná migrace není nutná. Pro rozsáhlé galerie viz volitelné indexy MongoDB v poznámkách k vydání.

Funkce Template Gallery se ovládá následujícími proměnnými prostředí:

• OVERLEAF_TEMPLATE_GALLERY: Nastavte na true pro povolení Template Gallery.

• OVERLEAF_TEMPLATE_CATEGORIES: Volitelný seznam nula či více klíčů kategorií šablon oddělených bílými znaky. Platné klíče jsou:

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

  Speciální klíč all se přidává automaticky. Představuje kategorii, která zahrnuje všechny šablony.

  Pro každý klíč kategorie lze nastavit následující volitelné proměnné prostředí:

  • TEMPLATE_<KEY>_NAME: Zobrazovaný název kategorie šablon.
  • TEMPLATE_<KEY>_DESCRIPTION: Krátký popis kategorie.

  Pokud klíč kategorie obsahuje pomlčku (-), nahraďte ji v názvech proměnných prostředí podtržítkem (_).

• ENABLE_CONVERSIONS: Musí být nastavena na true, aby se u šablon generovaly miniatury a náhledy.

​

Oprávnění k publikování

Šablony mohou publikovat administrátoři. Můžete také určit uživatele bez administrátorských práv, který bude spravovat vybrané šablony zobrazené v lokální galerii na /templates.

K tomu je nutné nastavit proměnnou prostředí OVERLEAF_TEMPLATES_USER_ID v toolkit/config/variables.env na ID uživatele, který bude ve vaší instanci odpovědný za správu šablon, například:

OVERLEAF_TEMPLATES_USER_ID=56a8865231faeb5f07d69959

​

Publikování šablon

Pro každou šablonu, kterou chcete nahrát:

1. Vytvořte projekt obsahující zdrojový kód šablony a ujistěte se, že se úspěšně zkompiluje.
2. V editoru zvolte File > Manage Template.
3. Do zobrazeného formuláře zadejte údaje o šabloně:
   • Title musí být jedinečný.
   • Pole Description podporuje formátování Markdown.
   • Pole Author přijímá odkazy ve formátu Markdown.

Po odeslání lze údaje o šabloně upravit nebo šablonu smazat na stránce Template Gallery. Administrátoři a uživatel pro šablony (OVERLEAF_TEMPLATES_USER_ID) mohou spravovat libovolnou šablonu.

Zde je příklad:

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

​

Přenos šablon z overleaf.com

Protože Overleaf Pro je navržen pro provoz offline, neexistuje automatický způsob, jak začlenit šablony z galerie overleaf.com do vaší on-premise instalace. Je to však možné provést ručně, šablonu po šabloně.

Ve výchozím nastavení je Overleaf Pro nakonfigurován tak, aby pro kompilace používal verzi TeXLive se schématem basic. Tato základní verze je odlehčená a obsahuje jen velmi omezenou podmnožinu balíčků LaTeXu, což u vašich uživatelů nejspíš povede k chybám chybějících balíčků, když se pokusí použít šablony z overleaf.com na vaší lokální on-premise instanci.

Ačkoli bohužel neexistuje automatický způsob instalace chybějících balíčků, Server Pro nabízí konfigurovatelné nastavení, které uživatelům umožní kompilovat projekty s přístupem k více balíčkům, a to bezpečnějším způsobem. Tato funkce se nazývá Sandbox Compiles (známá také jako Sibling Containers).

Abyste zajistili, že stažené šablony budou kompatibilní s vaší on-premise instancí Server Pro, důrazně doporučujeme povolit Sandbox Compiles, protože tato funkce poskytne vašim uživatelům přístup ke stejnému prostředí TeX Live jako na overleaf.com. Tyto image obsahují nejoblíbenější balíčky a fonty a již byly otestovány se šablonami z naší galerie.

Další informace o tom, jak nastavit, ze kterých verzí TeX Live si uživatelé mohou v projektu vybírat, a jak nastavit výchozí verzi image TeX Live pro nové projekty, najdete v části Changing the TeX Live Image naší dokumentace.

1. Přejděte do Template Gallery na overleaf.com a najděte požadovanou šablonu, například IEEE Photonics Journal Paper Template - Example Submission
2. Klikněte na tlačítko Open as Template
3. Klikněte na nabídku projektu a zvolte Download Source
4. Poté se přihlaste k účtu na on-premise Server Pro
5. Na přehledu projektů klikněte na tlačítko New Project a zvolte Upload Project
6. Klikněte na tlačítko Select a .zip file a vyberte stažený soubor zip se šablonou

Uživatel pak může tuto nově nahranou šablonu používat ve svém účtu, nebo ji jako uživatel pro šablony můžete publikovat, aby ji mohli používat i ostatní.

​

Otázky a odpovědi

Mohu po publikování šablony smazat odpovídající projekt?

Odpověď: Ano, ale nedoporučujeme to. Při publikování šablony pořídíme snímek projektu a uložíme projekt v jeho tehdejší podobě jako soubor zip. Tím je zajištěno, že šablona nebude ovlivněna, ani když projekt odpovídající šabloně smažete.

Zároveň si však zaznamenáme ProjectID přidružené k této šabloně, což vám v budoucnu usnadní aktualizaci šablony.

Pokud odpovídající projekt smažete, nebude se na stránce s podrobnostmi šablony zobrazovat tlačítko „Admin: Source Project“ (viz obrázek níže).

Proč u některých projektů trvá vydání šablony tak dlouho?

Odpověď: Při publikování šablony ukládáme projekt jako soubor zip a pdf, což je obvykle rychlé. Musíme však také vygenerovat miniatury PDF, aby je bylo možné zobrazit v podrobnostech šablony.

Doba generování miniatur obvykle závisí na obsahu první stránky PDF. Abychom vyvážili kvalitu zobrazení a dobu převodu, volíme střední šířku.

Pokud však první stránka PDF obsahuje hodně textu, může převod miniatur trvat 40 sekund i déle, buďte prosím trpěliví. Zde je příklad velkého plakátu, jehož zpracování bude trvat déle.

Velký plakát