From 3f6b7cf1baa37bae742f2500874cd4b338dc9995 Mon Sep 17 00:00:00 2001 From: Alexey Date: Fri, 22 Mar 2024 12:31:51 +0300 Subject: [PATCH] =?UTF-8?q?FileMan,=20=D0=B8=D1=81=D0=BF=D1=80=D0=B0=D0=B2?= =?UTF-8?q?=D0=BB=D0=B5=D0=BD=D0=B8=D1=8F=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC?= =?UTF-8?q?=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/components/fileman/settings.md | 20 ++++++++++---------- docs/components/fileman/snippets.md | 20 +++++++++----------- 2 files changed, 19 insertions(+), 21 deletions(-) diff --git a/docs/components/fileman/settings.md b/docs/components/fileman/settings.md index 4c2402c1..4685cbd1 100644 --- a/docs/components/fileman/settings.md +++ b/docs/components/fileman/settings.md @@ -2,13 +2,13 @@ В таблице приведены настройки компонента, доступные в меню "Системные настройки", пространство имен "fileman". -| Настройка | По умолчанию | Описание | -|---------------------|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| fileman_auto_title | Да | Автоматически формировать заголовок из имени файла (без расширения) при загрузке | -| fileman_calchash | Нет | Вычислять SHA1 хэш файла при загрузке | -| fileman_grid_fields | id, name, title, description, group, private, download | Поля, через запятую, которые будут выводится в списке файлов | -| fileman_mediasource | 1 | Источник файлов, с которым работает компонент | -| fileman_path | files/{resource}/ | Путь внутри файлового источника. Должно завершаться на "/". Поддерживает переменные {year},{month},{day},{user},{resource}. Напр. files/{resource}/{year}/ | -| fileman_pdotools | Нет | Использовать парсер pdoTools и шаблонизатор Fenom | -| fileman_private | Нет | Сохранять файлы по умолчанию со случайным именем чтобы нельзя было получить доступ к файлу по названию. Подсчет скачиваний ведется только для закрытых файлов | -| fileman_templates | пусто | Список id шаблонов, у ресурсов с которыми будет доступна вкладка "Файлы" | \ No newline at end of file +| Настройка | По умолчанию | Описание | +|---------------------|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fileman_auto_title | Да | Автоматически формировать заголовок из имени файла (без расширения) при загрузке. | +| fileman_calchash | Нет | Вычислять SHA1 хэш файла при загрузке. | +| fileman_grid_fields | id, name, title, description, group, private, download | Поля, через запятую, которые будут выводится в списке файлов. | +| fileman_mediasource | 1 | Источник файлов, с которым работает компонент. | +| fileman_path | files/{resource}/ | Путь внутри файлового источника. Должно завершаться на "/". Поддерживает переменные {year},{month},{day},{user},{resource}. Напр. files/{resource}/{year}/. | +| fileman_pdotools | Нет | Использовать парсер pdoTools и шаблонизатор Fenom. Подробно описано в разделе Сниппеты / fmFiles. | +| fileman_private | Нет | Сохранять файлы по умолчанию со случайным именем чтобы нельзя было получить доступ к файлу по названию. Подсчет скачиваний ведется только для закрытых файлов. | +| fileman_templates | пусто | Список id шаблонов, у ресурсов с которыми будет доступна вкладка "Файлы". | \ No newline at end of file diff --git a/docs/components/fileman/snippets.md b/docs/components/fileman/snippets.md index ef4d0027..104e19e6 100644 --- a/docs/components/fileman/snippets.md +++ b/docs/components/fileman/snippets.md @@ -6,15 +6,13 @@ Сниппет предназначен для вывода списка файлов, прикрепленных к ресурсу. -# Поддержка pdoTools и шаблонизатора Fenom +### Поддержка pdoTools и шаблонизатора Fenom -::: warning До версии 3.1.5-pl включительно компонент в своей работе использовал библиотеку [pdoTools](/components/pdotools/), а единственный чанк был написан с использованием шаблонизатора Fenom. -::: Начиная с версия 3.2.0-pl компонент может работать как с использованием pdoTools (и шаблонизатора Fenom), так и с использованием стандартного парсера MODx. -Управление производится системной настройкой ```fileman_pdotools```: +Управление производится системной настройкой `fileman_pdotools`: * **Настройка включена и pdoTools установлен:**\ Сниппет fmFiles использует в своей работе только параметр `tpl` и единственный чанк, указанный в нем. В чанке можно (и нужно) использовать шаблонизатор Fenom. @@ -25,18 +23,18 @@ | | Параметр | По умолчанию | Описание | |---|------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| | tpl | `tpl.FileMan.Files` | Единый чанк оформления результата работы, написан на шаблонизаторе Fenom. Этот параметр работает только при установленном pdoTools и включенной настройке "fileman_pdotools" | -| | tplRow | `tpl.FileMan.Row` | Чанк для оформления строки с одним файлом (если настройка "fileman_pdotools" выключена). В качестве плейсхолдеров доступны все поля объекта fmFile. | -| | tplGroup | `tpl.FileMan.Group` | Чанк для оформления группы (если настройка "fileman_pdotools" выключена). Доступны плейсхолдеры [[+group]] и [[+output]]. | -| | tplWrapper | | Чанк-обертка результата (если настройка "fileman_pdotools" выключена). Доступен плейсхолдер [[+output]]. | -| | wrapIfEmpty | `0` | Оборачивать ли пустой результат работы в tplWrapper (если файлов нет). | +| | tpl | `tpl.FileMan.Files` | Единый чанк оформления результата работы, написан на шаблонизаторе Fenom. Этот параметр работает только при установленном pdoTools и включенной настройке `fileman_pdotools` | +| | tplRow | `tpl.FileMan.Row` | Чанк для оформления строки с одним файлом (если настройка `fileman_pdotools` выключена). В качестве плейсхолдеров доступны все поля объекта fmFile. | +| | tplGroup | `tpl.FileMan.Group` | Чанк для оформления группы (если настройка `fileman_pdotools` выключена). Доступны плейсхолдеры `[[+group]]` и `[[+output]]`. | +| | tplWrapper | | Чанк-обертка результата (если настройка `fileman_pdotools` выключена). Доступен плейсхолдер `[[+output]]`. | +| | wrapIfEmpty | `0` | Оборачивать ли пустой результат работы в `tplWrapper` (если файлов нет). | | | sortBy | `sort_order` | Поле, по которому будут отсортированы файлы. | | | sortDir | `ASC` | Направление сортировки, ASC или DESC. | | | limit | `0` | Ограничить кол-во результатов, по умолчанию 0 - выводить все. | | | offset | `0` | С какого элемента выводить файлы, используется при постраничном выводе результатов сниппетом pdoPage. | | | totalVar | `total` | В плейсхолдер с таким названием будет установлено общее кол-во файлов при постраничном выводе. | -| | toPlaceholder | | Результат работы будет сохранен в плейсхолдер, вместо вывода на страницу. | -| | ids | | Позволяет указать список id файлов (через запятую) которые нужно вывести. | +| | toPlaceholder | | Результат работы будет сохранен в указанный здесь плейсхолдер, вместо вывода на страницу. | +| | ids | | Позволяет указать список id конкретных файлов (через запятую), которые нужно вывести. | | | resource | | Id ресурса, с которым работаем, по умолчанию - текущий. | | | showGroups | `1` | Показывать группы файлов. | | | makeUrl | `1` | Если файлы нужно скачивать, то следует сформировать ссылки на них. |