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

> Lisää verkkosivustollesi linkki, joka avaa LaTeX-tiedoston tai kokonaisen projektin instanssissasi.

Lisää linkki verkkosivustollesi, blogiisi tai kurssisivullesi. Jokainen, joka napsauttaa sitä, saa oman uuden projektin, jossa ovat tiedostosi. Mitään ei tarvitse määrittää.

Vierailijat tarvitsevat tilin instanssissasi. Kirjautumaton vierailija ohjataan ensin kirjautumissivulle, ja projekti avautuu kirjautumisen jälkeen.

Tämän ominaisuuden sivuilla käytetään nimeä Overleaf. Oma linkkisi tai painikkeesi voi sanoa mitä tahansa, esimerkiksi **Open in Ayakaleaf**.

## Katso esimerkit

Avaa sivustollasi `/devs`, esimerkiksi `https://ayakaleaf.example.com/devs`. Mikään valikko ei linkitä tälle sivulle, joten kirjoita osoite itse. Oletuksena sinun on oltava kirjautuneena nähdäksesi sen.

![Overleaf API -sivu, jossa painikkeet A LaTeX code snippet ja 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 -sivu

Napsauta **A LaTeX code snippet** tai **A zipped project**. Uusi projekti avautuu esimerkin kanssa.

![Projekti I am a Zip file, jossa main.tex, main2.tex ja sample.bib, sekä sen 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-esimerkistä luotu projekti

## Linkki verkkosivustosi tiedostoon

**1. Muodosta linkki**

Lisää tiedoston URL-koodattu osoite `/docs?snip_uri=`-osan perään:

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

Pakatulle projektille käytä `zip_uri`:

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

Instanssisi lataa tiedoston, joten sen on oltava saatavilla HTTP:n tai HTTPS:n kautta. Yksityisverkon osoitteet hylätään, katso [External URL](https://ayakaleaf-pro.mintlify.site/fi/on-premises/configuration/overleaf-toolkit/external-url.md).

**2. Lisää se sivullesi**

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

**3. Napsauta sitä**

Uusi projekti avautuu editorissa, ja siinä on yksi tiedosto tallennettuna nimellä `main.tex`.

![Projekti Hello from a link editorissa, jossa main.tex ja sen 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)

Linkistä avattu projekti

Jokainen napsautus luo uuden projektin. Projekti on kopio, joten tiedostoosi myöhemmin tehdyt muutokset eivät päädy siihen.

## Tiedoston lisääminen linkkiin

Pientä tiedostoa varten sinun ei tarvitse isännöidä mitään: lisää sen sisältö linkkiin Base64-data-URL:nä. JavaScriptissä:

```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` hyväksyy vain Latin-1-merkit, joten koodaa muu teksti ensin UTF-8:ksi. Pakatulle projektille käytä `zip_uri` ja `data:application/zip;base64,`.

Noin 8 kt:tä pidempi linkki hylätään virheellä **414 Request-URI Too Large**. Suuremmille sisällöille isännöi tiedosto tai käytä [lomaketta](#use-a-button-instead-of-a-link).

## Asetusten valitseminen

Lisää nämä linkkiin tai lomakkeeseen piilokenttinä:

| Parametri | Mitä se tekee | Esimerkki |
| - | - | - |
| `name` | Nimeää projektin. Ilman sitä pakattu projekti saa nimensä `\title`-kentästään, ja kaikki muu on nimeltään `Open in Overleaf project`. | `name=My%20notes` |
| `engine` | Asettaa kääntäjän: `latex_dvipdf`, `pdflatex`, `xelatex` tai `lualatex`. | `engine=xelatex` |
| `main_document` | Asettaa päätiedoston `.tex`, joka avautuu ensimmäisenä. | `main_document=thesis.tex` |
| `snip_uri[]`, `snip_name[]` | Tuo useita tiedostoja, kukin omalla nimellään, samassa järjestyksessä. | `snip_uri[]=.../a.tex&snip_name[]=a.tex` |

`.tex`-tiedosto ilman `\documentclass`-määritystä kääritään vakiodokumenttiin, joten se kääntyy heti:

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

## Painikkeen käyttäminen linkin sijaan

Lomake lähettää samat parametrit kuin linkki:

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

Jos haluat lähettää itse LaTeX-koodin, käytä `snip` tavalliselle tekstille tai `encoded_snip` tekstille, joka on käsitelty `encodeURIComponent`-funktiolla.

Lomake ei aina toimi, joten linkki on parempi valinta, ellei tiedostosi ole liian pitkä siihen:

| Missä lomake on | Vierailija on kirjautunut | Vierailija ei ole kirjautunut |
| - | - | - |
| Samassa verkkotunnuksessa kuin instanssisi tai sen aliverkkotunnuksessa | Projekti avautuu | Kirjautumissivu, ei projektia |
| Toisessa verkkotunnuksessa | Kirjautumissivu, ei projektia | Kirjautumissivu, ei projektia |

Jos ylläpitäjä asettaa `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`, projekti avautuu kaikissa näissä tapauksissa, tarvittaessa kirjautumisen jälkeen. Asetus avaa myös muita sivuja kirjautumattomille vierailijoille, katso [Page Access](https://ayakaleaf-pro.mintlify.site/fi/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

Muut ylläpitäjien määritettävissä olevat asiat löydät sivulta [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/fi/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md). Sivulla `/devs` on lisää esimerkkejä.

## Jos projekti ei avaudu

Sivu kertoo, mikä meni vikaan. **View the Overleaf API docs** vie sivulle `/devs`.

![Open in Overleaf -sivu, jossa viesti invalid url ja View the Overleaf API docs -painike](https://mintcdn.com/ayakaleaf-pro/PeD9iteXIf8j4GXw/images/on-premises/open-in-overleaf-error.png?fit=max\&auto=format\&n=PeD9iteXIf8j4GXw\&q=85\&s=0fdd1309fab22f5aa1c80925377627c7)

Linkki, jota instanssi ei voi käyttää

| Viesti | Miksi | Mitä tehdä |
| - | - | - |
| `no snippet, snip_uri or zip_uri provided` | Linkissä ei ole mitään näistä | Tarkista parametrien nimet |
| `invalid url: ...` | Osoite ei ala HTTP:llä tai HTTPS:llä | Käytä HTTP- tai HTTPS-osoitetta tai data-URL:ää |
| `could not download ... (HTTP 404)` | Tiedosto ei ole kyseisessä osoitteessa | Tarkista osoite |
| `could not download ... (HTTP 403)` | Osoite on yksityisverkossa | Isännöi tiedosto paikassa, johon instanssisi saa yhteyden |
| `zip_uri did not resolve to a zip archive` | `zip_uri`-osoitteen takana oleva tiedosto ei ole zip-tiedosto | Tarkista tiedosto |
| `invalid base64 data url` | Data-URL on vioittunut | Koodaa tiedosto uudelleen ja URL-koodaa linkki |


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