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

> Dodaj do swojej witryny link, który otwiera plik LaTeX lub cały projekt w Twojej instancji.

Umieść link na swojej stronie, blogu lub stronie kursu. Każdy, kto go kliknie, dostaje własny nowy projekt z Twoimi plikami. Nie trzeba niczego konfigurować.

Odwiedzający potrzebują konta w Twojej instancji. Niezalogowany odwiedzający trafia najpierw na stronę logowania, a projekt otwiera się po zalogowaniu.

Strony tej funkcji używają nazwy Overleaf. Twój link lub przycisk może mieć dowolny tekst, na przykład **Open in Ayakaleaf**.

## Zobacz przykłady

Otwórz `/devs` w swojej witrynie, na przykład `https://ayakaleaf.example.com/devs`. Żadne menu nie prowadzi do tej strony, więc wpisz adres ręcznie. Domyślnie musisz być zalogowany, aby ją zobaczyć.

![Strona Overleaf API z przyciskami A LaTeX code snippet i 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)

Strona Overleaf API

Kliknij **A LaTeX code snippet** lub **A zipped project**. Otworzy się nowy projekt z przykładem.

![Projekt I am a Zip file z main.tex, main2.tex i sample.bib oraz jego 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)

Projekt z przykładu zip

## Link do pliku w Twojej witrynie

**1. Zbuduj link**

Umieść zakodowany w URL adres pliku po `/docs?snip_uri=`:

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

Dla spakowanego projektu użyj `zip_uri`:

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

Twoja instancja pobiera plik, więc musi on być dostępny przez HTTP lub HTTPS. Adresy w sieci prywatnej są odrzucane, zobacz [External URL](https://ayakaleaf-pro.mintlify.site/pl/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. Dodaj go do strony**

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

**3. Kliknij go**

Nowy projekt otwiera się w edytorze z jednym plikiem zapisanym jako `main.tex`.

![Projekt Hello from a link w edytorze z main.tex i jego 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)

Projekt otwarty z linku

Każde kliknięcie tworzy kolejny projekt. Projekt jest kopią, więc późniejsze zmiany w Twoim pliku do niego nie trafiają.

## Umieść plik w linku

Dla małego pliku nie musisz niczego hostować: umieść jego treść w linku jako adres URL danych Base64. W 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` przyjmuje tylko znaki Latin-1, więc inny tekst najpierw zakoduj jako UTF-8. Dla spakowanego projektu użyj `zip_uri` i `data:application/zip;base64,`.

Link dłuższy niż około 8 KB jest odrzucany z błędem **414 Request-URI Too Large**. Dla większych treści hostuj plik lub użyj [formularza](#use-a-button-instead-of-a-link).

## Wybierz opcje

Dodaj je do linku albo do formularza jako ukryte pola:

| Parametr | Co robi | Przykład |
| - | - | - |
| `name` | Nadaje projektowi nazwę. Bez niego spakowany projekt bierze nazwę ze swojego `\title`, a każdy inny nazywa się `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Ustawia kompilator: `latex_dvipdf`, `pdflatex`, `xelatex` lub `lualatex`. | `engine=xelatex` |
| `main_document` | Ustawia główny plik `.tex`, który otwiera się jako pierwszy. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Importuje kilka plików, każdy z własną nazwą, w tej samej kolejności. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

Plik `.tex` bez `\documentclass` jest opakowywany w standardowy dokument, więc od razu się kompiluje:

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

## Użyj przycisku zamiast linku

Formularz wysyła te same parametry co 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>
```

Aby wysłać sam kod LaTeX, użyj `snip` dla zwykłego tekstu lub `encoded_snip` dla tekstu przepuszczonego przez `encodeURIComponent`.

Formularz nie zawsze działa, dlatego link jest lepszym wyborem, chyba że Twój plik jest na niego za długi:

| Gdzie jest formularz | Odwiedzający jest zalogowany | Odwiedzający nie jest zalogowany |
| - | - | - |
| W tej samej domenie co Twoja instancja lub w subdomenie | Projekt się otwiera | Strona logowania, brak projektu |
| W innej domenie | Strona logowania, brak projektu | Strona logowania, brak projektu |

Jeśli administrator ustawi `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`, projekt otwiera się we wszystkich tych przypadkach, w razie potrzeby po zalogowaniu. To ustawienie udostępnia też inne strony niezalogowanym odwiedzającym, zobacz [Page Access](https://ayakaleaf-pro.mintlify.site/pl/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Pozostałe ustawienia dostępne dla administratorów opisuje [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/pl/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). Strona `/devs` zawiera więcej przykładów.

## Jeśli projekt się nie otwiera

Strona informuje, co poszło nie tak. **View the Overleaf API docs** prowadzi do `/devs`.

![Strona Open in Overleaf z komunikatem invalid url i przyciskiem 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)

Link, którego instancja nie może użyć

| Komunikat | Dlaczego | Co zrobić |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | Link nie zawiera żadnego z tych parametrów | Sprawdź nazwy parametrów |
| `invalid url: ...` | Adres nie zaczyna się od HTTP ani HTTPS | Użyj adresu HTTP lub HTTPS albo adresu URL danych |
| `could not download ... (HTTP 404)` | Pod tym adresem nie ma pliku | Sprawdź adres |
| `could not download ... (HTTP 403)` | Adres znajduje się w sieci prywatnej | Hostuj plik tam, gdzie Twoja instancja ma do niego dostęp |
| `zip_uri did not resolve to a zip archive` | Plik pod `zip_uri` nie jest plikiem zip | Sprawdź plik |
| `invalid base64 data url` | Adres URL danych jest uszkodzony | Zakoduj plik ponownie i zakoduj link jako URL |


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