> ## 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/ru/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/ru/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Остальные настройки, доступные администраторам, описаны в [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/ru/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.