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

المشروع الناتج عن المثال المضغوط

## الربط بملف على موقعك

**1. أنشئ الرابط**

ضع عنوان الملف بعد ترميزه لعنوان URL بعد `/docs?snip_uri=`:

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

للمشروع المضغوط استخدم `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/ar/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)

مشروع فُتح من رابط

كل نقرة تنشئ مشروعًا آخر. المشروع نسخة، لذا لا تصل إليه التغييرات اللاحقة على ملفك.

## وضع الملف داخل الرابط

بالنسبة إلى ملف صغير، لا تحتاج إلى استضافة أي شيء: ضع محتواه في الرابط بصيغة data URL بترميز Base64. في 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_uri` و`data:application/zip;base64,`.

يُرفض الرابط الأطول من 8 KB تقريبًا مع الخطأ **414 Request-URI Too Large**. لأي محتوى أكبر، استضف الملف أو استخدم [نموذجًا](#use-a-button-instead-of-a-link).

## اختيار الخيارات

أضف هذه المعلمات إلى الرابط، أو إلى النموذج كحقول مخفية:

| المعلمة | وظيفتها | مثال |
| - | - | - |
| `name` | تسمّي المشروع. بدونها يأخذ المشروع المضغوط الاسم الموجود في `\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/ar/on-premises/configuration/overleaf-toolkit/authentication/public-access.md#page-access).

لبقية ما يمكن للمسؤولين ضبطه، راجع [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/ar/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.