Szablony

Ta funkcja została pierwotnie opracowana przez yu-i-i/overleaf-cep, a następnie zmodyfikowana i zoptymalizowana przez ayaka-notes/overleaf-pro.

Domyślnie tylko zalogowani użytkownicy mogą przeglądać galerię i otwierać linki do szablonów. Aby udostępniać szablony niezalogowanym odwiedzającym, ustaw również OVERLEAF_ALLOW_PUBLIC_ACCESS=true, zobacz Dostęp do stron. Tworzenie projektu z szablonu zawsze wymaga zalogowania.

​

Konfiguracja

Począwszy od wersji 6.3.0 galeria wykonuje paginację, wyszukiwanie i sortowanie po stronie serwera. Migracja nie jest wymagana. W przypadku dużych galerii zapoznaj się z opcjonalnymi indeksami MongoDB w informacjach o wydaniu.

Funkcją Galerii szablonów steruje się za pomocą następujących zmiennych środowiskowych:

• OVERLEAF_TEMPLATE_GALLERY: ustaw na true, aby włączyć Galerię szablonów.

• OVERLEAF_TEMPLATE_CATEGORIES: opcjonalna lista zera lub więcej kluczy kategorii szablonów, rozdzielonych białymi znakami. Prawidłowe klucze to:

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

  Specjalny klucz all jest dodawany automatycznie. Reprezentuje on kategorię obejmującą wszystkie szablony.

  Dla każdego klucza kategorii można ustawić następujące opcjonalne zmienne środowiskowe:

  • TEMPLATE_<KEY>_NAME: wyświetlana nazwa kategorii szablonów.
  • TEMPLATE_<KEY>_DESCRIPTION: krótki opis kategorii.

  Jeśli klucz kategorii zawiera łącznik (-), w nazwach zmiennych środowiskowych zastąp go podkreślnikiem (_).

• ENABLE_CONVERSIONS: musi być ustawione na true, aby włączyć generowanie miniatur i podglądów szablonów.

​

Uprawnienia do publikowania

Administratorzy mogą publikować szablony. Możesz także wyznaczyć użytkownika niebędącego administratorem do zarządzania wybranymi szablonami wyświetlanymi w lokalnej galerii pod adresem /templates.

W tym celu ustaw zmienną środowiskową OVERLEAF_TEMPLATES_USER_ID w pliku toolkit/config/variables.env na ID użytkownika, który będzie odpowiedzialny za zarządzanie szablonami w Twojej instancji, na przykład:

OVERLEAF_TEMPLATES_USER_ID=56a8865231faeb5f07d69959

​

Publikowanie szablonów

Dla każdego szablonu, który chcesz przesłać:

1. Utwórz projekt zawierający kod źródłowy szablonu i upewnij się, że się kompiluje.
2. W edytorze wybierz File > Manage Template.
3. W wyświetlonym formularzu wprowadź szczegóły szablonu:
   • Tytuł musi być unikalny.
   • Pole Opis obsługuje formatowanie Markdown.
   • Pole Autor akceptuje linki sformatowane w Markdown.

Po przesłaniu szczegóły szablonu można edytować, a sam szablon można usunąć na stronie Galerii szablonów. Administratorzy i użytkownik szablonów (OVERLEAF_TEMPLATES_USER_ID) mogą zarządzać dowolnym szablonem.

Oto przykład:

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

​

Przenoszenie szablonów z overleaf.com

Ponieważ Overleaf Pro został zaprojektowany do pracy offline, nie istnieje zautomatyzowany sposób integracji szablonów z galerii overleaf.com z instalacją lokalną (on-premise). Można to jednak zrobić ręcznie, szablon po szablonie.

Domyślnie Overleaf Pro jest skonfigurowany do używania podstawowego schematu (basic scheme) TeXLive do kompilacji. Ta podstawowa wersja jest lekka i zawiera jedynie bardzo ograniczony podzbiór pakietów LaTeX, co najprawdopodobniej spowoduje u użytkowników błędy brakujących pakietów przy próbie użycia szablonów z overleaf.com w lokalnej instancji.

Niestety, choć nie ma automatycznego sposobu instalowania brakujących pakietów, Server Pro oferuje konfigurowalne ustawienie, które pozwala użytkownikom kompilować projekty z dostępem do większej liczby pakietów i w bezpieczniejszy sposób. Funkcja ta nazywa się Sandbox Compiles (znana również jako Sibling Containers).

Aby zapewnić zgodność pobranych szablonów z lokalną instancją Server Pro, zdecydowanie zalecamy włączenie Sandbox Compiles, ponieważ funkcja ta zapewni użytkownikom dostęp do tego samego środowiska TeX Live co na overleaf.com. Obrazy te zawierają najpopularniejsze pakiety i czcionki i zostały już przetestowane z szablonami z naszej galerii.

Dodatkowe informacje o konfigurowaniu wersji TeX Live, spośród których użytkownicy mogą wybierać w swoich projektach, a także o ustawianiu domyślnej wersji obrazu TeX Live dla nowych projektów, znajdziesz w sekcji Changing the TeX Live Image naszej dokumentacji.

1. Przejdź do Galerii szablonów na overleaf.com i znajdź wymagany szablon, na przykład IEEE Photonics Journal Paper Template - Example Submission
2. Kliknij przycisk Open as Template
3. Kliknij menu projektu i wybierz Download Source
4. Następnie zaloguj się na konto w lokalnej instancji Server Pro
5. Na pulpicie projektów kliknij przycisk New Project i wybierz Upload Project
6. Kliknij przycisk Select a .zip file i wybierz pobrany plik zip z szablonem

Użytkownik może następnie korzystać z nowo przesłanego szablonu na własnym koncie, a Ty — jako użytkownik szablonów — możesz go opublikować, aby inni użytkownicy również mogli z niego korzystać.

​

Pytania i odpowiedzi

Czy mogę usunąć projekt po opublikowaniu odpowiadającego mu szablonu?

Odpowiedź: Tak, ale nie zalecamy tego. Podczas publikowania szablonu tworzymy migawkę projektu i zapisujemy go jako plik zip w stanie z chwili publikacji. Dzięki temu nawet jeśli usuniesz projekt odpowiadający szablonowi, nie wpłynie to na szablon.

Zapisujemy jednak również ProjectID powiązany z tym szablonem, co ułatwia jego późniejszą aktualizację.

Jeśli usuniesz odpowiedni projekt, na stronie szczegółów szablonu nie zobaczysz przycisku “Admin: Source Project” (patrz obraz poniżej).

Dlaczego w przypadku niektórych projektów publikowanie szablonu trwa tak długo?

Odpowiedź: Podczas publikowania szablonu zapisujemy projekt jako plik zip oraz plik pdf, co zwykle przebiega szybko. Musimy jednak również wygenerować miniatury PDF, aby można je było wyświetlić w szczegółach szablonu.

Czas generowania miniatur zależy zazwyczaj od zawartości pierwszej strony pliku PDF. Aby zachować równowagę między jakością wyświetlania a czasem konwersji, wybieramy pośrednią szerokość.

Jeśli jednak pierwsza strona pliku PDF zawiera dużo tekstu, konwersja miniatur może zająć 40 sekund lub nawet więcej — prosimy o cierpliwość. Oto przykład dużego plakatu, którego przetwarzanie potrwa dłużej.

Duży plakat