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

> Web サイトにリンクを追加して、LaTeX ファイルやプロジェクト全体をインスタンスで開けるようにします。

Web サイト、ブログ、講義ページにリンクを置きます。クリックした人は誰でも、あなたのファイルが入った自分専用の新しいプロジェクトを得られます。設定は何も必要ありません。

訪問者にはインスタンスのアカウントが必要です。ログインしていない訪問者はまずログインページに移動し、ログイン後にプロジェクトが開きます。

この機能のページでは Overleaf という名前が使われています。自分のリンクやボタンには、**Open in Ayakaleaf** など任意の文言を使えます。

## 例を見る

サイトの `/devs` を開きます（例: `https://ayakaleaf.example.com/devs`）。このページへのメニューリンクはないため、アドレスを直接入力してください。デフォルトでは、表示するにはログインが必要です。

![A LaTeX code snippet と A zipped project のボタンがある Overleaf API ページ](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** をクリックします。例の入った新しいプロジェクトが開きます。

![main.tex、main2.tex、sample.bib を含むプロジェクト I am a Zip file とその 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 の例から作成されたプロジェクト

## Web サイト上のファイルにリンクする

**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/ja/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` として保存された 1 つのファイルが入っています。

![エディター内のプロジェクト 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 KB を超えるリンクは、エラー **414 Request-URI Too Large** で拒否されます。それより大きいものは、ファイルをホストするか[フォーム](#use-a-button-instead-of-a-link)を使ってください。

## オプションを選ぶ

次のパラメーターをリンクに、またはフォームの hidden フィールドとして追加します:

| パラメーター | 機能 | 例 |
| - | - | - |
| `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` |

`\documentclass` のない `.tex` ファイルは標準的なドキュメントで包まれるため、すぐにコンパイルできます:

```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`、`encodeURIComponent` を通したテキストなら `encoded_snip` を使います。

フォームは常に動作するとは限りません。そのため、ファイルが長すぎてリンクに収まらない場合を除き、リンクのほうが適しています:

| フォームの場所 | 訪問者がログイン済み | 訪問者が未ログイン |
| - | - | - |
| インスタンスと同じドメイン、またはそのサブドメイン | プロジェクトが開く | ログインページ、プロジェクトなし |
| 別のドメイン | ログインページ、プロジェクトなし | ログインページ、プロジェクトなし |

管理者が `OVERLEAF_ALLOW_PUBLIC_ACCESS=true` を設定している場合、これらすべてのケースで、必要ならログイン後にプロジェクトが開きます。この設定はほかのページもサインアウト中の訪問者に公開します。[Page Access](https://ayakaleaf-pro.mintlify.site/ja/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access) を参照してください。

管理者が設定できるその他の項目については、[Overleaf Import API](https://ayakaleaf-pro.mintlify.site/ja/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md) を参照してください。`/devs` ページにはさらに多くの例があります。

## プロジェクトが開かない場合

ページに問題の内容が表示されます。**View the Overleaf API docs** をクリックすると `/devs` に移動します。

![メッセージ invalid url と View the Overleaf API docs ボタンのある Open in Overleaf ページ](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.