テンプレート

この機能は当初 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：0 個以上のテンプレートカテゴリキーを空白区切りで並べたリスト（任意）。有効なキーは次のとおりです。

  • 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 はコンパイルに TeX Live の basic スキーム版を使用するよう設定されています。この basic 版は軽量で、LaTeX パッケージのごく一部しか含まれていないため、ユーザーが overleaf.com のテンプレートをローカルのオンプレミスインスタンスで使おうとすると、パッケージ不足のエラーが発生する可能性が高くなります。

残念ながら、不足しているパッケージを自動でインストールする方法はありませんが、Server Pro には、ユーザーがより多くのパッケージを利用して、より安全な方法でプロジェクトをコンパイルできるようにする設定があります。この機能は Sandbox Compiles（Sibling Containers とも呼ばれます）といいます。

ダウンロードしたテンプレートがオンプレミスの Server Pro インスタンスと互換性を持つように、Sandbox Compiles を有効にすることを強くおすすめします。この機能により、ユーザーは overleaf.com と同じ TeX Live 環境を利用できるようになります。これらのイメージには人気のあるパッケージやフォントが含まれており、ギャラリーのテンプレートですでにテスト済みです。

ユーザーがプロジェクト内で選択できる 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 ファイルを選択します

ユーザーは、アップロードしたこのテンプレートを自分のアカウント内で使用できます。また、テンプレートユーザーであれば、他のユーザーが使えるように公開することもできます。

​

Q&A

テンプレートを公開した後、対応するプロジェクトを削除してもよいですか？

回答： はい、可能ですが、おすすめはしません。テンプレートを公開すると、公開時点のプロジェクトのスナップショットを取得し、zip ファイルとして保存します。そのため、テンプレートに対応するプロジェクトを削除しても、テンプレートには影響しません。

ただし、このテンプレートに関連付けられた ProjectID も記録しているため、将来テンプレートを簡単に更新できます。

対応するプロジェクトを削除すると、テンプレート詳細ページに「Admin: Source Project」ボタンが表示されなくなります（下の画像を参照）。

一部のプロジェクトで、テンプレートの公開に時間がかかるのはなぜですか？

回答： テンプレートを公開すると、プロジェクトを zip ファイルと PDF ファイルとして保存します。これは通常すぐに完了します。しかし、テンプレートの詳細に表示するために、PDF のサムネイルも生成する必要があります。

サムネイルの生成時間は、通常 PDF の 1 ページ目の内容によって決まります。表示品質と変換時間のバランスを取るため、幅には中程度の値を採用しています。

ただし、PDF の 1 ページ目に大量のテキストが含まれている場合、サムネイルの変換に 40 秒以上かかることがありますので、しばらくお待ちください。以下は大きなポスターの例で、より長い時間がかかります。

大きなポスター