Различия

Показаны различия между двумя версиями страницы.

--- software:development:demo:cms:ucms:help [2025/05/08 17:02] – VladPolskiy
+++ software:development:demo:cms:ucms:help [2026/05/02 09:34] (текущий) – [Файл help.txt] VladPolskiy
@@ Строка 1: / Строка 1: @@
-====== 6. Файл help.txt ======
+<note page>
+{{:icons:16:arrow-transition-180.png?|}}
+**[[software:development:demo:cms:ucms:ucms_table_of_contents | Краткое содержание]]**
+</note>
+====== 6.1. Файл help.txt ======
-Этот файл не будет участвовать в работе приложения, это - вспомогательный файл для упрощения написания кода. Да, мы будем много писать, и в основном это будут комментарии. Создадим в корне нашего приложения файл с именем help.txt
+===== Введение =====
-{{:software:development:demo:cms:ucms_creat_2.png?|}}
+Файл **help.txt** — это обычный текстовый документ, содержащий справочную информацию, инструкции, описание команд или руководства пользователя для программ или скриптов. Обычно он открывается в «Блокноте» и содержит неформатированный текст (инструкцию: «как пользоваться», «ошибки» или «команды»).
+\\
+Основные характеристики **help.txt**:
+  * Формат: Обычный текст (TXT), открывается на любых устройствах.
+  * Назначение: Предоставление быстрой помощи, документации, списка горячих клавиш или параметров запуска.
+  * Местоположение: Часто находится в папке с установленной программой.
+  * Способ создания: Может быть создан разработчиком для пользователя или сгенерирован автоматически через командную строку.
+Его можно безопасно открывать, читать, редактировать или удалять, если программа уже не используется.
+===== Файл help.txt =====
+Этот файл не будет участвовать в работе приложения, это - вспомогательный файл для упрощения написания кода.
+Да, мы будем много писать, и в основном это будут комментарии.
+Создадим в корне нашего приложения файл с именем **help.txt**
+<note shadow>
+{{:software:development:demo:cms:ucms:ucms_kernel_demo_book_2.png?|}}
+</note>
 По мере запоминания кода при частом использовании, мы будем удалять записи из этого файла и в
-конце нашей работы мы его удалим вообще. А в начале нашего пути в нем будут записываться используемые части кода, чтобы мы всегда могли посмотреть как и что пишется, чтобы не тратить время на перелистывание страниц в интернете.  Так-же там будут наши заметки, т.к. за один день мы не успеем охватить весь процесс.
+конце нашей работы мы его удалим. А в начале нашего пути в нем будут записываться используемые части кода, чтобы мы всегда могли посмотреть как и что пишется, чтобы не тратить время на перелистывание страниц в интернете.  Так-же там будут наши заметки, т.к. за один день мы не успеем охватить весь процесс.
-Пример файла help.txt
+=== Пример файла help.txt ===
 <code php help.txt>
 !Это файл - подсказка по написанию кода в руководстве по написанию UCMS
@@ Строка 33: / Строка 53: @@
 </code>
 Казалось бы, этого можно не делать, но поверьте, когда у нас будет много директорий и много файлов, мы начнем путаться, а если нас еще и отвлекут от процесса на недельку, то мы вообще все забудим, а так у нас будет все записано, то нам не прийдется начинать все с начала.
+===== Дополнения и Файлы =====
+см. также:
+  * [[https://github.com/ArtUshak/BookingBot/blob/master/help.txt|пример на GitHub.]]
 <note blue>
 <wrap left>← [[software:development:demo:cms:ucms:directory_structure|5. Структура директорий]]</wrap>
-<wrap right>[[software:development:demo:cms:ucms:readme|6.1. Файл readme.txt]] →</wrap>
+<wrap right>[[software:development:demo:cms:ucms:readme|6.2. Файл readme.txt]] →</wrap>
 </note>