> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Open in Overleaf

> Ajoutez à votre site web un lien qui ouvre un fichier LaTeX ou un projet entier dans votre instance.

Placez un lien sur votre site web, votre blog ou votre page de cours. Toute personne qui clique dessus obtient son propre nouveau projet avec vos fichiers. Aucune configuration n'est nécessaire.

Les visiteurs ont besoin d'un compte sur votre instance. Un visiteur non connecté passe d'abord par la page de connexion, et le projet s'ouvre après la connexion.

Les pages de cette fonctionnalité utilisent le nom Overleaf. Votre propre lien ou bouton peut afficher n'importe quel texte, par exemple **Open in Ayakaleaf**.

## Voir les exemples

Ouvrez `/devs` sur votre site, par exemple `https://ayakaleaf.example.com/devs`. Aucun menu ne renvoie vers cette page, saisissez donc l'adresse. Par défaut, vous devez être connecté pour la voir.

![La page Overleaf API avec les boutons A LaTeX code snippet et A zipped project](https://mintcdn.com/ayakaleaf-pro/PeD9iteXIf8j4GXw/images/on-premises/open-in-overleaf-devs.png?fit=max\&auto=format\&n=PeD9iteXIf8j4GXw\&q=85\&s=e0769b26bc5206799501cf44c0cf2c46)

La page Overleaf API

Cliquez sur **A LaTeX code snippet** ou **A zipped project**. Un nouveau projet s'ouvre avec l'exemple.

![Le projet I am a Zip file avec main.tex, main2.tex et sample.bib, et son PDF](https://mintcdn.com/ayakaleaf-pro/PeD9iteXIf8j4GXw/images/on-premises/open-in-overleaf-zip-project.png?fit=max\&auto=format\&n=PeD9iteXIf8j4GXw\&q=85\&s=0070a05e99c93a4e1ff11962d36a8d83)

Le projet issu de l'exemple zippé

## Lier un fichier de votre site web

**1. Construire le lien**

Placez l'adresse du fichier, encodée pour URL, après `/docs?snip_uri=` :

```text theme={null}
https://ayakaleaf.example.com/docs?snip_uri=https%3A%2F%2Fexample.com%2Fmain.tex
```

Pour un projet zippé, utilisez `zip_uri` :

```text theme={null}
https://ayakaleaf.example.com/docs?zip_uri=https%3A%2F%2Fexample.com%2Fproject.zip
```

Votre instance télécharge le fichier, il doit donc être accessible en HTTP ou HTTPS. Les adresses d'un réseau privé sont refusées, voir [External URL](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. L'ajouter à votre page**

```html theme={null}
<a href="https://ayakaleaf.example.com/docs?snip_uri=https%3A%2F%2Fexample.com%2Fmain.tex">Open in Ayakaleaf</a>
```

**3. Cliquer dessus**

Le nouveau projet s'ouvre dans l'éditeur, avec un seul fichier enregistré sous le nom `main.tex`.

![Le projet Hello from a link dans l'éditeur, avec main.tex et son PDF](https://mintcdn.com/ayakaleaf-pro/PeD9iteXIf8j4GXw/images/on-premises/open-in-overleaf-project.png?fit=max\&auto=format\&n=PeD9iteXIf8j4GXw\&q=85\&s=870760e85a1053dc1730663a74c48744)

Un projet ouvert depuis un lien

Chaque clic crée un autre projet. Le projet est une copie, les modifications ultérieures de votre fichier ne l'atteignent donc pas.

## Mettre le fichier dans le lien

Pour un petit fichier, vous n'avez rien à héberger : mettez son contenu dans le lien sous forme d'URL de données Base64. En JavaScript :

```javascript theme={null}
const tex = '\\documentclass{article}\n\\begin{document}\nHello from a link.\n\\end{document}\n'
const link = 'https://ayakaleaf.example.com/docs?' + new URLSearchParams({
  snip_uri: 'data:application/x-tex;base64,' + btoa(tex),
  name: 'Hello from a link',
})
```

`btoa` n'accepte que les caractères Latin-1, encodez donc d'abord tout autre texte en UTF-8. Pour un projet zippé, utilisez `zip_uri` et `data:application/zip;base64,`.

Un lien de plus de 8 Ko environ est refusé avec l'erreur **414 Request-URI Too Large**. Pour un contenu plus volumineux, hébergez le fichier ou utilisez un [formulaire](#use-a-button-instead-of-a-link).

## Choisir les options

Ajoutez ces paramètres au lien, ou au formulaire sous forme de champs masqués :

| Paramètre | Effet | Exemple |
| - | - | - |
| `name` | Nomme le projet. Sans lui, un projet zippé prend le nom de son `\title`, tout le reste s'appelle `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Définit le compilateur : `latex_dvipdf`, `pdflatex`, `xelatex` ou `lualatex`. | `engine=xelatex` |
| `main_document` | Définit le fichier `.tex` principal, qui s'ouvre en premier. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Importe plusieurs fichiers, chacun avec son propre nom, dans le même ordre. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

Un fichier `.tex` sans `\documentclass` est enveloppé dans un document standard, il compile donc immédiatement :

```latex theme={null}
\documentclass[12pt]{article}
\usepackage[english]{babel}
\usepackage{amsmath}
\usepackage{tikz}
\begin{document}
Your file
\end{document}
```

## Utiliser un bouton au lieu d'un lien

Un formulaire envoie les mêmes paramètres qu'un lien :

```html theme={null}
<form action="https://ayakaleaf.example.com/docs" method="post" target="_blank">
  <input type="hidden" name="snip_uri" value="https://example.com/main.tex">
  <input type="hidden" name="engine" value="xelatex">
  <button type="submit">Open in Ayakaleaf</button>
</form>
```

Pour envoyer le LaTeX lui-même, utilisez `snip` pour du texte brut ou `encoded_snip` pour du texte passé par `encodeURIComponent`.

Un formulaire ne fonctionne pas toujours, c'est pourquoi un lien est le meilleur choix, sauf si votre fichier est trop long pour tenir dans un lien :

| Emplacement du formulaire | Visiteur connecté | Visiteur non connecté |
| - | - | - |
| Sur le même domaine que votre instance, ou un sous-domaine | Le projet s'ouvre | Page de connexion, pas de projet |
| Sur un autre domaine | Page de connexion, pas de projet | Page de connexion, pas de projet |

Si votre administrateur définit `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`, le projet s'ouvre dans tous ces cas, après connexion si nécessaire. Ce paramètre ouvre aussi d'autres pages aux visiteurs déconnectés, voir [Page Access](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Pour les autres réglages accessibles aux administrateurs, voir [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). La page `/devs` contient d'autres exemples.

## Si le projet ne s'ouvre pas

La page indique ce qui n'a pas fonctionné. **View the Overleaf API docs** vous mène à `/devs`.

![La page Open in Overleaf avec le message invalid url et le bouton View the Overleaf API docs](https://mintcdn.com/ayakaleaf-pro/PeD9iteXIf8j4GXw/images/on-premises/open-in-overleaf-error.png?fit=max\&auto=format\&n=PeD9iteXIf8j4GXw\&q=85\&s=0fdd1309fab22f5aa1c80925377627c7)

Un lien que l'instance ne peut pas utiliser

| Message | Pourquoi | Que faire |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | Le lien ne contient aucun de ces paramètres | Vérifier les noms des paramètres |
| `invalid url: ...` | L'adresse ne commence pas par HTTP ou HTTPS | Utiliser une adresse HTTP ou HTTPS, ou une URL de données |
| `could not download ... (HTTP 404)` | Le fichier ne se trouve pas à cette adresse | Vérifier l'adresse |
| `could not download ... (HTTP 403)` | L'adresse se trouve sur un réseau privé | Héberger le fichier là où votre instance peut l'atteindre |
| `zip_uri did not resolve to a zip archive` | Le fichier derrière `zip_uri` n'est pas un fichier zip | Vérifier le fichier |
| `invalid base64 data url` | L'URL de données est endommagée | Réencoder le fichier et encoder le lien pour URL |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.