refactor(docs): Исправление синтаксиса

modx-pro · Dec 12, 2024 · 2eb8b59 · 2eb8b59
1 parent 65b4ed0
commit 2eb8b59
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 53 deletions.
diff --git a/docs/components/crontabmanager/command.md b/docs/components/crontabmanager/command.md
@@ -83,7 +83,7 @@ php artisan mysupertask --arg_name=water
 class CrontabControllerMySuperTask extends modCrontabController
 {
     protected $signature = 'mysupertask {--arg_name}'; // необязательные аргументы
-    
+
     public function process()
     {
         $name = $this->getArgument('arg_name', 'world');
@@ -115,11 +115,11 @@ php artisan crontab:add --command=mysupertask
 ```shell
 php artisan schedule:list
 
-# ------ -------- ------------- --------------------- ----------------- --------------------------- 
-#  Path   Active   Crontab       Next run              Diff              Comment                    
-# ------ -------- ------------- --------------------- ----------------- --------------------------- 
+# ------ -------- ------------- --------------------- ----------------- ---------------------------
+#  Path   Active   Crontab       Next run              Diff              Comment
+# ------ -------- ------------- --------------------- ----------------- ---------------------------
 #  demo   Yes      */1 * * * *   2024-11-30 05:48:00   через 6 секунд    Тестовое задание для демонстрации
-# ------ -------- ------------- --------------------- ----------------- --------------------------- 
+# ------ -------- ------------- --------------------- ----------------- ---------------------------
 ```
 
 #### Запуск текущих заданий Cron
@@ -129,12 +129,11 @@ php artisan schedule:list
 ```shell
 php artisan schedule:run
 # // Тестовое задание для демонстрации работы контроллера...
-# 
-# [INFO] [1 1 * * *] mysupertask.php run 
+#
+# [INFO] [1 1 * * *] mysupertask.php run
 ```
 
 ### Настройка времени для crontab
 
 В административной части сайта можно настроить время для крон
 [manager](http://127.0.0.1:9001/manager/?a=home&namespace=crontabmanager)
-
diff --git a/docs/components/crontabmanager/interface.md b/docs/components/crontabmanager/interface.md
@@ -6,15 +6,13 @@
 
 [![](https://file.modx.pro/files/5/a/6/5a63ac91b0aec4774b2e863e175ba999s.jpg)](https://file.modx.pro/files/5/a/6/5a63ac91b0aec4774b2e863e175ba999.png)
 
-
-
 ## Добавить задание - сниппет
 
 Создайте сниппет который будет запускать автоматически и привяжите его крон заданию
 
 [![](https://file.modx.pro/files/d/5/e/d5ecfe8fbc76872995c252d40ee6940fs.jpg)](https://file.modx.pro/files/d/5/e/d5ecfe8fbc76872995c252d40ee6940f.png)
 
-#### Содержание сниппета
+### Содержание сниппета
 
 ```php
 <?php

diff --git a/docs/components/crontabmanager/setting.md b/docs/components/crontabmanager/setting.md
@@ -8,46 +8,46 @@
 
 Добавление крон задания в linux crontab
 
-Войдите на сервер по ssh:
+1. Войдите на сервер по ssh:
 
-```bash
-ssh www-data@127.0.0.1
-```
+    ```bash
+    ssh www-data@127.0.0.1
+    ```
 
-> **Примечание**: Замените `user` и `ip адрес 127.0.0.1` на имя пользователя, под которым работает сайт, и IP адрес для подключения.
+    > **Примечание**: Замените `user` и `ip адрес 127.0.0.1` на имя пользователя, под которым работает сайт, и IP адрес для подключения.
 
-Выполните команду от вашего пользователя:
+2. Выполните команду от вашего пользователя:
 
-```bash
-crontab -e
-```
+    ```bash
+    crontab -e
 
-> **Примечание**: Для выполнения от имени ROOT-пользователя:
+    ```
 
-```bash
-crontab -u www-data -e
-```
+    > **Примечание**: Для выполнения от имени ROOT-пользователя:
 
-> **Внимание!!** Не выполняйте команду `crontab -e` под ROOT пользователем без явного указания USER, иначе после исполнения команды у сайта пропадут доступы к
-> созданным файлам.
+    ```bash
+    crontab -u www-data -e
+    ```
 
-3. Откроется редактор [nano](https://www.digitalocean.com/community/tutorials/how-to-use-cron-to-automate-tasks-ubuntu-1804), при первом запуске может спросить,
-   какой редактор использовать по умолчанию.
+    > **Внимание!!** Не выполняйте команду `crontab -e` под ROOT пользователем без явного указания USER, иначе после исполнения команды у сайта пропадут доступы к
+    > созданным файлам.
+
+3. Откроется редактор [nano](https://www.digitalocean.com/community/tutorials/how-to-use-cron-to-automate-tasks-ubuntu-1804), при первом запуске может спросить, какой редактор использовать по умолчанию.
 
 4. Добавьте строку в конец файла:
 
-```bash
-*/1    *       *       *       *       /usr/local/bin/php /var/www/html/core/scheduler/artisan schedule:run 2>&1
-```
+    ```bash
+    */1    *       *       *       *       /usr/local/bin/php /var/www/html/core/scheduler/artisan schedule:run 2>&1
+    ```
 
 5. Сохраните изменения и выполните выход из файла: **CTRL+x && Yes Enter**
 
 Пример как будет выглядеть crontab:
 
-```bash
-# modX component CronTabManager
-*/1    *       *       *       *       /usr/local/bin/php /var/www/html/core/scheduler/artisan schedule:run 2>&1
-```
+    ```bash
+    # modX component CronTabManager
+    */1    *       *       *       *       /usr/local/bin/php /var/www/html/core/scheduler/artisan schedule:run 2>&1
+    ```
 
 **CronTab** запускается каждую минуту и выполняет команду от имени вашего пользователя `www-data`.
 
@@ -74,7 +74,7 @@ su - www-data
 
 ## Schedule Work console
 
-Для подключения через supervesor (php artisan schedule:work):
+Для подключения через supervisor (php artisan schedule:work):
 
 ```ini
 [program:crontab]

diff --git a/docs/components/crontabmanager/сrontab.md b/docs/components/crontabmanager/сrontab.md
@@ -13,11 +13,11 @@ php artisan crontab:add --command=mysupertask
 ```shell
 php artisan schedule:list
 
-# ------ -------- ------------- --------------------- ----------------- --------------------------- 
-#  Path   Active   Crontab       Next run              Diff              Comment                    
-# ------ -------- ------------- --------------------- ----------------- --------------------------- 
+# ------ -------- ------------- --------------------- ----------------- ---------------------------
+#  Path   Active   Crontab       Next run              Diff              Comment
+# ------ -------- ------------- --------------------- ----------------- ---------------------------
 #  demo   Yes      */1 * * * *   2024-11-30 05:48:00   через 6 секунд    Тестовое задание для демонстрации
-# ------ -------- ------------- --------------------- ----------------- --------------------------- 
+# ------ -------- ------------- --------------------- ----------------- ---------------------------
 ```
 
 #### Запуск текущих заданий Cron
@@ -27,8 +27,8 @@ php artisan schedule:list
 ```shell
 php artisan schedule:run
 # // Тестовое задание для демонстрации работы контроллера...
-# 
-# [INFO] [1 1 * * *] mysupertask.php run 
+#
+# [INFO] [1 1 * * *] mysupertask.php run
 ```
 
 ### Настройка времени для crontab

diff --git a/docs/components/fileman/index.md b/docs/components/fileman/index.md
@@ -16,4 +16,3 @@ items: [
 # FileMan
 
 FileMan – компонент для MODX Revolution 3, дающий возможность прикреплять к ресурсам файлы через административную панель.
-
diff --git a/docs/components/fileman/interface.md b/docs/components/fileman/interface.md
@@ -8,8 +8,8 @@
 
 Компонент предоставляет два способа для прикрепления файлов:
 
- - с компьютера пользователя, посредством стандартного окна загрузки файлов в MODX;
- - по ссылке, исключая необходимость предварительного сохранения на компьютер. 
+- с компьютера пользователя, посредством стандартного окна загрузки файлов в MODX;
+- по ссылке, исключая необходимость предварительного сохранения на компьютер.
 
  [![](https://file.modx.pro/files/b/d/8/bd82ccc44d5cda78e5e3eae2a42f3ed8s.jpg)](https://file.modx.pro/files/b/d/8/bd82ccc44d5cda78e5e3eae2a42f3ed8.png)
 
@@ -21,20 +21,20 @@
 
 После того, как файл будет загружен, информацию о нем можно будет изменить.
 
-Компонент позволяет для каждой записи указать следующую информацию (в скобках указано имя поля в БД): 
- - Заголовок (title) – удобно читаемый заголовок для файла;
- - Описание (description) – подробное описание файла;
- - Группа (group) – группируйте файлы по подразделам при необходимости (например Документация, Сертификаты, Каталоги и т.д.);
- - Название файла (name) – имя файла, с которым будет сохранен при скачивании;
- - Закрыть доступ (private) – указывает, что файл не доступен по прямой ссылке, а будет скачиваться через коннектор, позволяет организовать учет количества скачиваний.
+Компонент позволяет для каждой записи указать следующую информацию (в скобках указано имя поля в БД):
+
+- Заголовок (title) – удобно читаемый заголовок для файла;
+- Описание (description) – подробное описание файла;
+- Группа (group) – группируйте файлы по подразделам при необходимости (например Документация, Сертификаты, Каталоги и т.д.);
+- Название файла (name) – имя файла, с которым будет сохранен при скачивании;
+- Закрыть доступ (private) – указывает, что файл не доступен по прямой ссылке, а будет скачиваться через коннектор, позволяет организовать учет количества скачиваний.
 
 [![](https://file.modx.pro/files/f/9/6/f9643d1ecbede409ec92783e455e9fa5s.jpg)](https://file.modx.pro/files/f/9/6/f9643d1ecbede409ec92783e455e9fa5.png)
 
 Еще в базе сохраняются некоторые поля, недоступные для изменения: path, size, extension, internal_name, hash, но вы можете использовать их в своих сниппетах.
 
 [![](https://file.modx.pro/files/8/2/3/8237cf70f2a6e95774f7114e5725b1d9s.jpg)](https://file.modx.pro/files/8/2/3/8237cf70f2a6e95774f7114e5725b1d9.png)
 
-
 ## Управление всеми прикрепленными файлами
 
 Помимо управления файлами на странице ресурса реализован отдельный раздел, доступный в меню "Пакеты / FileMan", где можно увидеть общий список всех прикрепленных файлов.

diff --git a/docs/components/fileman/settings.md b/docs/components/fileman/settings.md
@@ -11,4 +11,4 @@
 | fileman_path        | files/{resource}/                                       | Путь внутри файлового источника. Должно завершаться на "/". Поддерживает переменные {year},{month},{day},{user},{resource}. Напр. files/{resource}/{year}/.    |
 | fileman_pdotools    | Нет                                                     | Использовать парсер pdoTools и шаблонизатор Fenom. Подробно описано в разделе Сниппеты / fmFiles.                                                              |
 | fileman_private     | Нет                                                     | Сохранять файлы по умолчанию со случайным именем чтобы нельзя было получить доступ к файлу по названию. Подсчет скачиваний ведется только для закрытых файлов. |
-| fileman_templates   | пусто                                                   | Список id шаблонов, у ресурсов с которыми будет доступна вкладка "Файлы".                                                                                      |
+| fileman_templates   | пусто                                                   | Список id шаблонов, у ресурсов с которыми будет доступна вкладка "Файлы".                                                                                      |
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,3 @@ items: [
		# FileMan

		FileMan – компонент для MODX Revolution 3, дающий возможность прикреплять к ресурсам файлы через административную панель.