Modèles

Cette fonctionnalité a été initialement développée par yu-i-i/overleaf-cep, puis modifiée et optimisée par ayaka-notes/ayakaleaf-pro.

Par défaut, seuls les utilisateurs connectés peuvent parcourir la galerie et ouvrir les liens de modèles. Pour partager des modèles avec des visiteurs non connectés, définissez également OVERLEAF_ALLOW_PUBLIC_ACCESS=true ; voir Accès aux pages. La création d’un projet à partir d’un modèle nécessite toujours une connexion.

​

Configuration

À partir de la version 6.3.0, la galerie effectue la pagination, la recherche et le tri côté serveur. Aucune migration n’est nécessaire. Pour les galeries volumineuses, consultez les index MongoDB facultatifs dans les notes de version.

La galerie de modèles est contrôlée par les variables d’environnement suivantes :

• OVERLEAF_TEMPLATE_GALLERY : définissez-la à true pour activer la galerie de modèles.

• OVERLEAF_TEMPLATE_CATEGORIES : une liste facultative, séparée par des espaces, de zéro ou plusieurs clés de catégories de modèles. Les clés valides sont :

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

  La clé spéciale all est ajoutée automatiquement. Elle représente une catégorie regroupant tous les modèles.

  Pour chaque clé de catégorie, les variables d’environnement facultatives suivantes peuvent être définies :

  • TEMPLATE_<KEY>_NAME : le nom affiché de la catégorie de modèles.
  • TEMPLATE_<KEY>_DESCRIPTION : une courte description de la catégorie.

  Si une clé de catégorie contient un tiret (-), remplacez-le par un trait de soulignement (_) dans les noms des variables d’environnement.

• ENABLE_CONVERSIONS : doit être définie à true pour activer la génération des miniatures et des aperçus des modèles.

​

Permissions de publication

Les administrateurs peuvent publier des modèles. Vous pouvez également désigner un utilisateur non administrateur pour gérer les modèles sélectionnés affichés dans votre galerie locale sur /templates.

Pour cela, définissez la variable d’environnement OVERLEAF_TEMPLATES_USER_ID dans toolkit/config/variables.env sur l’ID de l’utilisateur chargé de la gestion des modèles dans votre instance, par exemple :

OVERLEAF_TEMPLATES_USER_ID=56a8865231faeb5f07d69959

​

Publier des modèles

Pour chaque modèle que vous souhaitez téléverser :

1. Créez un projet contenant le code source du modèle et assurez-vous qu’il compile.
2. Dans l’éditeur, choisissez File > Manage Template.
3. Dans le formulaire qui apparaît, saisissez les détails du modèle :
   • Le Titre doit être unique.
   • Le champ Description prend en charge la mise en forme Markdown.
   • Le champ Auteur accepte les liens au format Markdown.

Après l’envoi, les détails du modèle peuvent être modifiés, ou le modèle supprimé, depuis la page de la galerie de modèles. Les administrateurs et l’utilisateur des modèles (OVERLEAF_TEMPLATES_USER_ID) peuvent gérer n’importe quel modèle.

Voici un exemple :

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

​

Transférer des modèles depuis overleaf.com

Overleaf Pro ayant été conçu pour fonctionner hors ligne, il n’existe pas de moyen automatisé d’intégrer les modèles de la galerie d’overleaf.com à votre installation on-premises ; il est toutefois possible de le faire manuellement, modèle par modèle.

Par défaut, Overleaf Pro est configuré pour utiliser une version au schéma basique de TeX Live pour les compilations. Cette version basique est légère et ne contient qu’un sous-ensemble très limité de paquets LaTeX, ce qui entraînera très probablement des erreurs de paquets manquants pour vos utilisateurs lorsqu’ils tenteront d’utiliser des modèles d’overleaf.com sur votre instance on-premises locale.

Malheureusement, s’il n’existe pas de moyen automatique d’installer les paquets manquants, Server Pro propose un paramètre configurable permettant à vos utilisateurs de compiler leurs projets avec accès à davantage de paquets, et de manière plus sécurisée. Cette fonctionnalité s’appelle Sandbox Compiles (également appelée Sibling Containers).

Pour garantir la compatibilité des modèles téléchargés avec votre instance Server Pro on-premises, nous vous recommandons vivement d’activer Sandbox Compiles, car cette fonctionnalité donnera à vos utilisateurs accès au même environnement TeX Live que celui d’overleaf.com. Ces images contiennent les paquets et polices les plus courants et ont déjà été testées avec les modèles de notre galerie.

Vous trouverez des informations complémentaires sur la configuration des versions de TeX Live que les utilisateurs peuvent choisir dans leur projet, ainsi que sur la définition de la version d’image TeX Live par défaut pour les nouveaux projets, dans la section Changing the TeX Live Image de notre documentation.

1. Rendez-vous dans la galerie de modèles sur overleaf.com et trouvez le modèle souhaité, par exemple IEEE Photonics Journal Paper Template - Example Submission
2. Cliquez sur le bouton Open as Template
3. Cliquez sur le menu du projet et choisissez Download Source
4. Connectez-vous ensuite au compte Server Pro on-premises
5. Cliquez sur le bouton New Project depuis le tableau de bord des projets et choisissez Upload Project
6. Cliquez sur le bouton Select a .zip file et choisissez le fichier zip du modèle téléchargé

L’utilisateur peut alors utiliser ce modèle nouvellement téléversé dans son propre compte ou, en tant qu’utilisateur des modèles, vous pouvez le publier pour que d’autres utilisateurs puissent s’en servir.

​

Questions-réponses

Puis-je supprimer le projet après avoir publié le modèle correspondant ?

Réponse : Oui, mais nous ne le recommandons pas. Lorsque vous publiez un modèle, nous prenons un instantané du projet et l’enregistrons sous forme de fichier zip au moment de la publication. Ainsi, même si vous supprimez le projet correspondant au modèle, celui-ci ne sera pas affecté.

Cependant, nous enregistrons également le ProjectID associé à ce modèle, ce qui vous permet de mettre facilement à jour le modèle par la suite.

Si vous supprimez le projet correspondant, vous ne verrez plus le bouton « Admin: Source Project » sur la page de détails du modèle (voir l’image ci-dessous).

Pourquoi la publication d'un modèle prend-elle autant de temps pour certains projets ?

Réponse : Lorsque vous publiez le modèle, nous enregistrons le projet sous forme de fichier zip et de fichier PDF, ce qui est généralement rapide. Cependant, nous devons aussi générer des miniatures du PDF afin de les afficher dans les détails du modèle.

Le temps de génération des miniatures dépend généralement du contenu de la première page de votre PDF. Pour trouver un équilibre entre qualité d’affichage et temps de conversion, nous choisissons une largeur intermédiaire.

Toutefois, si la première page du PDF contient beaucoup de texte, la conversion des miniatures peut prendre 40 secondes, voire plus ; merci de patienter. Voici l’exemple d’un grand poster, dont le traitement prendra plus de temps.

Un grand poster