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

> Adicione ao seu site um link que abre um arquivo LaTeX ou um projeto inteiro na sua instância.

Coloque um link no seu site, blog ou página de curso. Qualquer pessoa que clicar nele recebe um novo projeto próprio com os seus arquivos. Não é preciso configurar nada.

Os visitantes precisam de uma conta na sua instância. Um visitante que não está conectado vai primeiro para a página de login, e o projeto abre depois do login.

As páginas deste recurso usam o nome Overleaf. Seu próprio link ou botão pode dizer o que você quiser, como **Open in Ayakaleaf**.

## Ver os exemplos

Abra `/devs` no seu site, por exemplo `https://ayakaleaf.example.com/devs`. Nenhum menu leva a esta página, então digite o endereço. Por padrão, você precisa estar conectado para vê-la.

![A página Overleaf API com os botões A LaTeX code snippet e 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)

A página Overleaf API

Clique em **A LaTeX code snippet** ou **A zipped project**. Um novo projeto abre com o exemplo.

![O projeto I am a Zip file com main.tex, main2.tex e sample.bib, e seu 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)

O projeto do exemplo compactado

## Criar um link para um arquivo no seu site

**1. Montar o link**

Coloque o endereço do arquivo, codificado como URL, depois de `/docs?snip_uri=`:

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

Para um projeto compactado, use `zip_uri`:

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

Sua instância baixa o arquivo, então ele precisa estar acessível por HTTP ou HTTPS. Endereços em uma rede privada são recusados; veja [External URL](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. Adicionar à sua página**

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

**3. Clicar**

O novo projeto abre no editor, com um único arquivo salvo como `main.tex`.

![O projeto Hello from a link no editor, com main.tex e seu 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)

Um projeto aberto a partir de um link

Cada clique cria outro projeto. O projeto é uma cópia, então mudanças posteriores no seu arquivo não chegam a ele.

## Colocar o arquivo no link

Para um arquivo pequeno, você não precisa hospedar nada: coloque o conteúdo dele no link como uma URL de dados Base64. Em 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` só aceita caracteres Latin-1, então codifique antes qualquer outro texto como UTF-8. Para um projeto compactado, use `zip_uri` e `data:application/zip;base64,`.

Um link com mais de cerca de 8 KB é recusado com o erro **414 Request-URI Too Large**. Para algo maior, hospede o arquivo ou use um [formulário](#use-a-button-instead-of-a-link).

## Escolher as opções

Adicione estes parâmetros ao link, ou ao formulário como campos ocultos:

| Parâmetro | O que faz | Exemplo |
| - | - | - |
| `name` | Dá nome ao projeto. Sem ele, um projeto compactado usa o nome do seu `\title`, e qualquer outro se chama `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Define o compilador: `latex_dvipdf`, `pdflatex`, `xelatex` ou `lualatex`. | `engine=xelatex` |
| `main_document` | Define o arquivo `.tex` principal, que abre primeiro. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Importa vários arquivos, cada um com seu próprio nome, na mesma ordem. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

Um arquivo `.tex` sem `\documentclass` é envolvido em um documento padrão, então compila na hora:

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

## Usar um botão em vez de um link

Um formulário envia os mesmos parâmetros que um 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>
```

Para enviar o próprio LaTeX, use `snip` para texto simples ou `encoded_snip` para texto passado por `encodeURIComponent`.

Um formulário nem sempre funciona, por isso um link é a melhor escolha, a menos que seu arquivo seja longo demais para caber em um:

| Onde está o formulário | Visitante conectado | Visitante não conectado |
| - | - | - |
| No mesmo domínio da sua instância, ou em um subdomínio | O projeto abre | Página de login, sem projeto |
| Em outro domínio | Página de login, sem projeto | Página de login, sem projeto |

Se o seu administrador definir `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`, o projeto abre em todos esses casos, após o login se necessário. Essa configuração também abre outras páginas para visitantes desconectados; veja [Page Access](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Para o restante do que os administradores podem configurar, veja [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). A página `/devs` tem mais exemplos.

## Se o projeto não abrir

A página diz o que deu errado. **View the Overleaf API docs** leva você a `/devs`.

![A página Open in Overleaf com a mensagem invalid url e o botão 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)

Um link que a instância não pode usar

| Mensagem | Por quê | O que fazer |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | O link não tem nenhum desses parâmetros | Verifique os nomes dos parâmetros |
| `invalid url: ...` | O endereço não começa com HTTP ou HTTPS | Use um endereço HTTP ou HTTPS, ou uma URL de dados |
| `could not download ... (HTTP 404)` | O arquivo não está nesse endereço | Verifique o endereço |
| `could not download ... (HTTP 403)` | O endereço está em uma rede privada | Hospede o arquivo onde sua instância possa acessá-lo |
| `zip_uri did not resolve to a zip archive` | O arquivo em `zip_uri` não é um arquivo zip | Verifique o arquivo |
| `invalid base64 data url` | A URL de dados está corrompida | Codifique o arquivo novamente e codifique o link como URL |


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