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