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

> Lägg till en länk på din webbplats som öppnar en LaTeX-fil eller ett helt projekt i din instans.

Lägg en länk på din webbplats, blogg eller kurssida. Alla som klickar på den får ett eget nytt projekt med dina filer. Inget behöver konfigureras.

Besökare behöver ett konto på din instans. En besökare som inte är inloggad kommer först till inloggningssidan, och projektet öppnas efter inloggningen.

Den här funktionens sidor använder namnet Overleaf. Din egen länk eller knapp kan ha vilken text som helst, till exempel **Open in Ayakaleaf**.

## Se exemplen

Öppna `/devs` på din webbplats, till exempel `https://ayakaleaf.example.com/devs`. Ingen meny länkar till den här sidan, så skriv adressen själv. Som standard måste du vara inloggad för att se den.

![Sidan Overleaf API med knapparna A LaTeX code snippet och 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)

Sidan Overleaf API

Klicka på **A LaTeX code snippet** eller **A zipped project**. Ett nytt projekt med exemplet öppnas.

![Projektet I am a Zip file med main.tex, main2.tex och sample.bib, och dess 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)

Projektet från zip-exemplet

## Länka till en fil på din webbplats

**1. Bygg länken**

Lägg filens URL-kodade adress efter `/docs?snip_uri=`:

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

För ett zippat projekt använder du `zip_uri`:

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

Din instans laddar ned filen, så den måste vara nåbar via HTTP eller HTTPS. Adresser i ett privat nätverk nekas, se [External URL](https://ayakaleaf-pro.mintlify.site/sv/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. Lägg till den på din sida**

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

**3. Klicka på den**

Det nya projektet öppnas i redigeraren, med en enda fil sparad som `main.tex`.

![Projektet Hello from a link i redigeraren, med main.tex och dess 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)

Ett projekt som öppnats från en länk

Varje klick skapar ett nytt projekt. Projektet är en kopia, så senare ändringar i din fil når det inte.

## Lägg filen i länken

För en liten fil behöver du inte vara värd för något: lägg dess innehåll i länken som en Base64-data-URL. I 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` tar bara emot Latin-1-tecken, så koda annan text som UTF-8 först. För ett zippat projekt använder du `zip_uri` och `data:application/zip;base64,`.

En länk som är längre än ungefär 8 KB nekas med felet **414 Request-URI Too Large**. För något större är du värd för filen eller använder ett [formulär](#use-a-button-instead-of-a-link).

## Välj alternativen

Lägg till dessa i länken, eller i formuläret som dolda fält:

| Parameter | Vad den gör | Exempel |
| - | - | - |
| `name` | Namnger projektet. Utan den får ett zippat projekt namnet från sin `\title`, och allt annat heter `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Anger kompilatorn: `latex_dvipdf`, `pdflatex`, `xelatex` eller `lualatex`. | `engine=xelatex` |
| `main_document` | Anger huvudfilen `.tex`, som öppnas först. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Importerar flera filer, var och en med sitt eget namn, i samma ordning. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

En `.tex`-fil utan `\documentclass` packas in i ett standarddokument, så den kompileras direkt:

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

## Använd en knapp i stället för en länk

Ett formulär skickar samma parametrar som en länk:

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

För att skicka själva LaTeX-koden använder du `snip` för vanlig text eller `encoded_snip` för text som gått genom `encodeURIComponent`.

Ett formulär fungerar inte alltid, och därför är en länk det bättre valet om inte din fil är för lång för en:

| Var formuläret finns | Besökaren är inloggad | Besökaren är inte inloggad |
| - | - | - |
| På samma domän som din instans, eller en underdomän | Projektet öppnas | Inloggningssida, inget projekt |
| På en annan domän | Inloggningssida, inget projekt | Inloggningssida, inget projekt |

Om administratören anger `OVERLEAF_ALLOW_PUBLIC_ACCESS=true` öppnas projektet i alla dessa fall, efter inloggning vid behov. Den inställningen öppnar också andra sidor för utloggade besökare, se [Page Access](https://ayakaleaf-pro.mintlify.site/sv/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Det övriga som administratörer kan ställa in finns i [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/sv/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). Sidan `/devs` har fler exempel.

## Om projektet inte öppnas

Sidan talar om vad som gick fel. **View the Overleaf API docs** tar dig till `/devs`.

![Sidan Open in Overleaf med meddelandet invalid url och knappen 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)

En länk som instansen inte kan använda

| Meddelande | Varför | Vad du gör |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | Länken har ingen av dessa | Kontrollera parameternamnen |
| `invalid url: ...` | Adressen börjar inte med HTTP eller HTTPS | Använd en HTTP- eller HTTPS-adress, eller en data-URL |
| `could not download ... (HTTP 404)` | Filen finns inte på den adressen | Kontrollera adressen |
| `could not download ... (HTTP 403)` | Adressen finns i ett privat nätverk | Lägg filen där din instans får nå den |
| `zip_uri did not resolve to a zip archive` | Filen bakom `zip_uri` är inte en zip-fil | Kontrollera filen |
| `invalid base64 data url` | Data-URL:en är skadad | Koda filen igen och URL-koda länken |


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