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

> Fügen Sie Ihrer Website einen Link hinzu, der eine LaTeX-Datei oder ein ganzes Projekt in Ihrer Instanz öffnet.

Setzen Sie einen Link auf Ihre Website, Ihren Blog oder Ihre Kursseite. Jeder, der darauf klickt, erhält ein eigenes neues Projekt mit Ihren Dateien. Sie müssen nichts einrichten.

Besucher benötigen ein Konto auf Ihrer Instanz. Ein nicht angemeldeter Besucher gelangt zuerst zur Anmeldeseite, und das Projekt öffnet sich nach der Anmeldung.

Die Seiten dieser Funktion verwenden den Namen Overleaf. Ihr eigener Link oder Ihre Schaltfläche kann beliebigen Text tragen, etwa **Open in Ayakaleaf**.

## Beispiele ansehen

Öffnen Sie `/devs` auf Ihrer Website, zum Beispiel `https://ayakaleaf.example.com/devs`. Kein Menü verlinkt auf diese Seite, geben Sie die Adresse also selbst ein. Standardmäßig müssen Sie angemeldet sein, um sie zu sehen.

![Die Seite Overleaf API mit den Schaltflächen A LaTeX code snippet und 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)

Die Seite Overleaf API

Klicken Sie auf **A LaTeX code snippet** oder **A zipped project**. Ein neues Projekt mit dem Beispiel öffnet sich.

![Das Projekt I am a Zip file mit main.tex, main2.tex und sample.bib sowie sein 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)

Das Projekt aus dem ZIP-Beispiel

## Auf eine Datei auf Ihrer Website verlinken

**1. Link erstellen**

Setzen Sie die URL-codierte Adresse der Datei hinter `/docs?snip_uri=`:

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

Für ein gezipptes Projekt verwenden Sie `zip_uri`:

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

Ihre Instanz lädt die Datei herunter, daher muss sie über HTTP oder HTTPS erreichbar sein. Adressen in einem privaten Netzwerk werden abgelehnt, siehe [External URL](https://ayakaleaf-pro.mintlify.site/de/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. Zur Seite hinzufügen**

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

**3. Darauf klicken**

Das neue Projekt öffnet sich im Editor, mit einer einzigen Datei, gespeichert als `main.tex`.

![Das Projekt Hello from a link im Editor, mit main.tex und seinem 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)

Ein über einen Link geöffnetes Projekt

Jeder Klick erstellt ein weiteres Projekt. Das Projekt ist eine Kopie, spätere Änderungen an Ihrer Datei erreichen es also nicht.

## Die Datei in den Link packen

Für eine kleine Datei müssen Sie nichts hosten: Packen Sie ihren Inhalt als Base64-Data-URL in den Link. In 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` akzeptiert nur Latin-1-Zeichen, codieren Sie anderen Text also zuerst als UTF-8. Für ein gezipptes Projekt verwenden Sie `zip_uri` und `data:application/zip;base64,`.

Ein Link, der länger als etwa 8 KB ist, wird mit dem Fehler **414 Request-URI Too Large** abgelehnt. Für alles Größere hosten Sie die Datei oder verwenden Sie ein [Formular](#use-a-button-instead-of-a-link).

## Optionen wählen

Fügen Sie diese dem Link hinzu oder dem Formular als versteckte Felder:

| Parameter | Was er bewirkt | Beispiel |
| - | - | - |
| `name` | Benennt das Projekt. Ohne ihn übernimmt ein gezipptes Projekt den Namen aus seinem `\title`, alles andere heißt `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Legt den Compiler fest: `latex_dvipdf`, `pdflatex`, `xelatex` oder `lualatex`. | `engine=xelatex` |
| `main_document` | Legt die Haupt-`.tex`-Datei fest, die zuerst geöffnet wird. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Importiert mehrere Dateien, jede mit eigenem Namen, in derselben Reihenfolge. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

Eine `.tex`-Datei ohne `\documentclass` wird in ein Standarddokument eingebettet, sodass sie sofort kompiliert:

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

## Eine Schaltfläche statt eines Links verwenden

Ein Formular sendet dieselben Parameter wie ein Link:

```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>
```

Um das LaTeX selbst zu senden, verwenden Sie `snip` für reinen Text oder `encoded_snip` für Text, der durch `encodeURIComponent` gelaufen ist.

Ein Formular funktioniert nicht immer, deshalb ist ein Link die bessere Wahl, es sei denn, Ihre Datei ist zu lang dafür:

| Wo sich das Formular befindet | Besucher ist angemeldet | Besucher ist nicht angemeldet |
| - | - | - |
| Auf derselben Domain wie Ihre Instanz oder einer Subdomain | Das Projekt öffnet sich | Anmeldeseite, kein Projekt |
| Auf einer anderen Domain | Anmeldeseite, kein Projekt | Anmeldeseite, kein Projekt |

Wenn Ihr Administrator `OVERLEAF_ALLOW_PUBLIC_ACCESS=true` setzt, öffnet sich das Projekt in all diesen Fällen, bei Bedarf nach der Anmeldung. Diese Einstellung öffnet auch andere Seiten für abgemeldete Besucher, siehe [Page Access](https://ayakaleaf-pro.mintlify.site/de/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Was Administratoren sonst noch einstellen können, finden Sie unter [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/de/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). Die Seite `/devs` enthält weitere Beispiele.

## Wenn sich das Projekt nicht öffnet

Die Seite sagt, was schiefgelaufen ist. **View the Overleaf API docs** führt Sie zu `/devs`.

![Die Seite Open in Overleaf mit der Meldung invalid url und der Schaltfläche 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)

Ein Link, den die Instanz nicht verwenden kann

| Meldung | Warum | Was zu tun ist |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | Der Link enthält keinen dieser Parameter | Parameternamen prüfen |
| `invalid url: ...` | Die Adresse beginnt nicht mit HTTP oder HTTPS | Eine HTTP- oder HTTPS-Adresse oder eine Data-URL verwenden |
| `could not download ... (HTTP 404)` | Unter dieser Adresse liegt die Datei nicht | Adresse prüfen |
| `could not download ... (HTTP 403)` | Die Adresse liegt in einem privaten Netzwerk | Die Datei dort hosten, wo Ihre Instanz sie erreichen darf |
| `zip_uri did not resolve to a zip archive` | Die Datei hinter `zip_uri` ist keine ZIP-Datei | Datei prüfen |
| `invalid base64 data url` | Die Data-URL ist beschädigt | Datei neu codieren und den Link URL-codieren |


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