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

# Колекція Templates

`templates` містить один документ на кожен шаблон у галереї шаблонів. Файлів шаблону (zip проєкту та PDF) тут немає: вони зберігаються у filestore в `template/<_id>/v/<version>/`. Колекція належить web-модулю `template-gallery` (`services/web/modules/template-gallery`). Схему задає модель Mongoose `Template` у `services/web/modules/template-gallery/app/src/models/Template.mjs`; логіка міститься в `services/web/modules/template-gallery/app/src/TemplateGalleryManager.mjs` і в сусідньому `TemplateGalleryHelper.mjs`.

#### Поля

| Поле | Тип | Значення | Джерело |
| - | - | - | - |
| `_id` | ObjectId | Задається Mongoose. Це також тека файлів шаблону у filestore. | `TemplateGalleryHelper.mjs:148-150` |
| `name` | String | Назва. Обов'язкове, не більше 150 символів. Під час публікації шаблон шукають за назвою, а під час редагування відхиляється назва, яку вже має інший шаблон, тому назви лишаються унікальними без індексу. | `Template.mjs:7`, `TemplateGalleryHelper.mjs:50-52`, `TemplateGalleryManager.mjs:30-38,55` |
| `category` | String | Посилання на категорію `/templates/<key>`, де `<key>` є одним зі значень `OVERLEAF_TEMPLATE_CATEGORIES` або `all`. Обов'язкове. | `Template.mjs:8`, `services/web/modules/template-gallery/index.mjs:17-31`, `TemplateGalleryManager.mjs:206` |
| `descriptionMD` | String | Опис у тому вигляді, як його ввели, у Markdown. Не більше 4096 символів. Використовується під час пошуку в галереї. | `Template.mjs:10`, `TemplateGalleryHelper.mjs:53-55`, `TemplateGalleryManager.mjs:207-212` |
| `description` | String | HTML, відрендерений з `descriptionMD` і очищений. Встановлюється щоразу, коли встановлюється `descriptionMD`. | `Template.mjs:9`, `TemplateGalleryHelper.mjs:224-228` |
| `authorMD` | String | Автор у тому вигляді, як його ввели, у Markdown. Не більше 512 символів. Використовується під час пошуку в галереї. | `Template.mjs:12`, `TemplateGalleryHelper.mjs:56-58` |
| `author` | String | HTML, відрендерений з `authorMD`, лише посилання. Встановлюється щоразу, коли встановлюється `authorMD`. | `Template.mjs:11`, `TemplateGalleryHelper.mjs:229-232` |
| `license` | String | Текст ліцензії, вибраний у формі. Обов'язкове, не більше 512 символів. | `Template.mjs:13`, `TemplateGalleryHelper.mjs:59-61` |
| `mainFile` | String | Шлях до кореневого doc вихідного проєкту без початкової скісної риски. Обов'язкове: проєкт без кореневого doc опублікувати не можна. | `Template.mjs:14`, `TemplateGalleryHelper.mjs:112-114` |
| `compiler` | String | Компілятор вихідного проєкту. Обов'язкове. | `Template.mjs:15`, `TemplateGalleryHelper.mjs:122` |
| `imageName` | String | Образ TeX Live вихідного проєкту. На сторінці шаблону показано лише його останню частину. | `Template.mjs:16`, `TemplateGalleryHelper.mjs:123`, `TemplateGalleryManager.mjs:249-253` |
| `language` | String | Мова перевірки правопису вихідного проєкту. Можна змінити у формі редагування. | `Template.mjs:17`, `TemplateGalleryHelper.mjs:124` |
| `version` | Number | Починається з 1 і збільшується на одиницю щоразу, коли шаблон повторно публікують під тією самою назвою. Файли кожної версії лежать у `v/<version>/`. Обов'язкове. | `Template.mjs:18`, `TemplateGalleryManager.mjs:74-79` |
| `owner` | ObjectId | Користувач, який першим опублікував шаблон. Повторна публікація поверх зберігає власника. | `Template.mjs:19`, `TemplateGalleryManager.mjs:70-79` |
| `project_id` | ObjectId | Проєкт, з якого шаблон востаннє опублікували. Оновлюється під час кожної публікації. | `Template.mjs:20`, `TemplateGalleryManager.mjs:81-84` |
| `lastUpdated` | Date | Коли шаблон востаннє опублікували або змінили. Обов'язкове, типово поточний час. | `Template.mjs:21-27`, `TemplateGalleryHelper.mjs:125`, `TemplateGalleryManager.mjs:41` |
| `__v` | Number | Ключ версії Mongoose. Схема його не вимикає. | Типово в Mongoose |

#### Хто записує

| Код | Що робить |
| - | - |
| `TemplateGalleryManager.mjs:53-97` (`createTemplateFromProject`) | `POST /template/new/:Project_id`. Копіює налаштування проєкту (`TemplateGalleryHelper.mjs:94-134`), завантажує zip і PDF у filestore та зберігає. Якщо назву зайнято, відповідає конфліктом, якщо тільки клієнт не попросив перезапис: тоді оновлює цей шаблон, збільшує його `version` і видаляє файли попередньої версії. |
| `TemplateGalleryManager.mjs:21-47` (`editTemplate`) | `POST /template/:template_id/edit`. Присвоює документу надіслані поля, заново рендерить `description` і `author` та встановлює `lastUpdated`. Форма редагування надсилає змінені поля з `name`, `license`, `category`, `language`, `authorMD` і `descriptionMD` (`services/web/modules/template-gallery/frontend/js/pages/template/util/api.ts:22-29`). |
| `TemplateGalleryHelper.mjs:186-222` (`deleteTemplateAssets`) | `DELETE /template/:template_id/delete` видаляє документ і файли вказаної версії (`TemplateGalleryManager.mjs:49-51`). |

Викликати ці три маршрути можуть лише адміністратори сайту й користувач з `OVERLEAF_TEMPLATES_USER_ID` (`services/web/modules/template-gallery/app/src/Router.mjs:55-62,70-84`, `PermissionsMiddleware.mjs:8-19`).

#### Хто читає

| Код | Що робить |
| - | - |
| `TemplateGalleryManager.mjs:158-183` (`getTemplate`) | Знаходить один шаблон за `_id` або `name` для сторінки шаблону й для `GET /api/template` (`services/web/modules/template-gallery/app/src/TemplateGalleryController.mjs:210-232`). Якщо `project_id` вказує на проєкт, якого вже немає, відповідь його пропускає; документ не змінюється. |
| `TemplateGalleryManager.mjs:190-236` (`getCategoryTemplates`) | `GET /api/templates`: одна сторінка категорії з пошуком у `name`, `authorMD` і `descriptionMD`, відсортована за `lastUpdated` або за `name` (без урахування регістру). |
| `TemplateGalleryHelper.mjs:64-80` (`canUserOverrideTemplate`) | Читає `owner`, щоб назвати власника в повідомленні про конфлікт. |

#### Індекси

| Назва | Ключі | Параметри | Міграція |
| - | - | - | - |
| `_id_` | `_id: 1` | | типовий |

`autoIndex` у Mongoose вимкнено (`services/web/app/src/infrastructure/Mongoose.mjs:7`). `tools/migrations/20190912145030_create_templates_indexes.mjs` (унікальні `project_id`, `user_id`, `name`) позначена тегами `server-pro` і `saas`, тому не виконується в CE, де виконуються лише міграції `server-ce` (`server-ce/init_scripts/900_run_web_migrations.sh`).

#### Примітки

* Upstream вважає `templates` застарілою колекцією й видаляє її на своєму сайті (`tools/migrations/20241002180623_drop_unused_collections.mjs`, тег `saas`). В Ayakaleaf Pro її використовує модуль галереї шаблонів.
* Сортування за назвою використовує порівняння без урахування регістру, і коментар у `TemplateGalleryManager.mjs:186-188` зазначає, що індексу `name` знадобилося б таке саме. У CE індексу `name` немає, тому Mongo сортує в пам'яті.
* Видалення вихідного проєкту або власника не видаляє шаблон.


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