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

> Додайте на свій сайт посилання, яке відкриває файл LaTeX або цілий проєкт у вашому екземплярі.

Розмістіть посилання на своєму сайті, у блозі чи на сторінці курсу. Кожен, хто натисне на нього, отримає власний новий проєкт із вашими файлами. Нічого налаштовувати не потрібно.

Відвідувачам потрібен обліковий запис у вашому екземплярі. Відвідувач, який не ввійшов, спочатку потрапляє на сторінку входу, а проєкт відкривається після входу.

На сторінках цієї функції використовується назва Overleaf. Ваше посилання чи кнопка може містити будь-який текст, наприклад **Open in Ayakaleaf**.

## Перегляньте приклади

Відкрийте `/devs` на своєму сайті, наприклад `https://ayakaleaf.example.com/devs`. Жодне меню не веде на цю сторінку, тому введіть адресу вручну. За замовчуванням для її перегляду потрібно ввійти.

![Сторінка Overleaf API з кнопками A LaTeX code snippet і 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)

Сторінка Overleaf API

Натисніть **A LaTeX code snippet** або **A zipped project**. Відкриється новий проєкт із прикладом.

![Проєкт I am a Zip file з main.tex, main2.tex і sample.bib та його 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)

Проєкт із zip-прикладу

## Посилання на файл на вашому сайті

**1. Складіть посилання**

Поставте URL-закодовану адресу файлу після `/docs?snip_uri=`:

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

Для проєкту в zip-архіві використовуйте `zip_uri`:

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

Ваш екземпляр завантажує файл, тому він має бути доступний через HTTP або HTTPS. Адреси в приватній мережі відхиляються, див. [External URL](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. Додайте його на сторінку**

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

**3. Натисніть на нього**

Новий проєкт відкривається в редакторі з єдиним файлом, збереженим як `main.tex`.

![Проєкт Hello from a link у редакторі з main.tex та його 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)

Проєкт, відкритий за посиланням

Кожне натискання створює ще один проєкт. Проєкт є копією, тому подальші зміни вашого файлу до нього не потрапляють.

## Помістіть файл у посилання

Для невеликого файлу нічого розміщувати не потрібно: помістіть його вміст у посилання як Base64 data URL. У 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` приймає лише символи Latin-1, тому інший текст спочатку закодуйте в UTF-8. Для проєкту в zip-архіві використовуйте `zip_uri` і `data:application/zip;base64,`.

Посилання, довше приблизно 8 КБ, відхиляється з помилкою **414 Request-URI Too Large**. Для чогось більшого розмістіть файл або використайте [форму](#use-a-button-instead-of-a-link).

## Виберіть параметри

Додайте їх до посилання або до форми як приховані поля:

| Параметр | Що робить | Приклад |
| - | - | - |
| `name` | Задає назву проєкту. Без нього проєкт із zip-архіву отримує назву зі свого `\title`, а все інше називається `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Задає компілятор: `latex_dvipdf`, `pdflatex`, `xelatex` або `lualatex`. | `engine=xelatex` |
| `main_document` | Задає основний файл `.tex`, який відкривається першим. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Імпортує кілька файлів, кожен зі своєю назвою, у тому самому порядку. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

Файл `.tex` без `\documentclass` обгортається у стандартний документ, тому одразу компілюється:

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

## Кнопка замість посилання

Форма надсилає ті самі параметри, що й посилання:

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

Щоб надіслати сам LaTeX, використовуйте `snip` для звичайного тексту або `encoded_snip` для тексту, пропущеного через `encodeURIComponent`.

Форма працює не завжди, тому краще використовувати посилання, якщо тільки файл не задовгий для нього:

| Де розміщено форму | Відвідувач увійшов | Відвідувач не увійшов |
| - | - | - |
| На тому самому домені, що й ваш екземпляр, або на піддомені | Проєкт відкривається | Сторінка входу, проєкту немає |
| На іншому домені | Сторінка входу, проєкту немає | Сторінка входу, проєкту немає |

Якщо адміністратор задає `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`, проєкт відкривається в усіх цих випадках, за потреби після входу. Цей параметр також відкриває інші сторінки для відвідувачів, які не ввійшли, див. [Page Access](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Інші налаштування, доступні адміністраторам, описано в [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). На сторінці `/devs` є більше прикладів.

## Якщо проєкт не відкривається

Сторінка повідомляє, що пішло не так. **View the Overleaf API docs** веде на `/devs`.

![Сторінка Open in Overleaf з повідомленням invalid url і кнопкою 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)

Посилання, яке екземпляр не може використати

| Повідомлення | Причина | Що робити |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | У посиланні немає жодного з цих параметрів | Перевірте назви параметрів |
| `invalid url: ...` | Адреса не починається з HTTP або HTTPS | Використайте адресу HTTP чи HTTPS або data URL |
| `could not download ... (HTTP 404)` | За цією адресою файлу немає | Перевірте адресу |
| `could not download ... (HTTP 403)` | Адреса розташована в приватній мережі | Розмістіть файл там, де ваш екземпляр може його отримати |
| `zip_uri did not resolve to a zip archive` | Файл за `zip_uri` не є zip-архівом | Перевірте файл |
| `invalid base64 data url` | Data URL пошкоджено | Закодуйте файл заново та застосуйте URL-кодування до посилання |


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