Инструменты пользователя

Инструменты сайта


software:development:demo:cms:ucms:help

6.1. Файл help.txt

Введение

Файл help.txt — это обычный текстовый документ, содержащий справочную информацию, инструкции, описание команд или руководства пользователя для программ или скриптов. Обычно он открывается в «Блокноте» и содержит неформатированный текст (инструкцию: «как пользоваться», «ошибки» или «команды»).
Основные характеристики help.txt:

  • Формат: Обычный текст (TXT), открывается на любых устройствах.
  • Назначение: Предоставление быстрой помощи, документации, списка горячих клавиш или параметров запуска.
  • Местоположение: Часто находится в папке с установленной программой.
  • Способ создания: Может быть создан разработчиком для пользователя или сгенерирован автоматически через командную строку.

Его можно безопасно открывать, читать, редактировать или удалять, если программа уже не используется.

Файл help.txt

Этот файл не будет участвовать в работе приложения, это - вспомогательный файл для упрощения написания кода. Да, мы будем много писать, и в основном это будут комментарии. Создадим в корне нашего приложения файл с именем help.txt

По мере запоминания кода при частом использовании, мы будем удалять записи из этого файла и в конце нашей работы мы его удалим. А в начале нашего пути в нем будут записываться используемые части кода, чтобы мы всегда могли посмотреть как и что пишется, чтобы не тратить время на перелистывание страниц в интернете. Так-же там будут наши заметки, т.к. за один день мы не успеем охватить весь процесс.

Пример файла help.txt

help.txt
!Это файл - подсказка по написанию кода в руководстве по написанию UCMS
-----------------------------------------------------------------------
<!--  Комментарии html -->
// Комментарии в PHP или /* ... */
/* Комментарии CSS */
// Комментарии в JavaScript или /* ... */
/* Комментарии MySQL */
-----------------------------------------------------------------------
<?php
	// Вставка кода PHP в HTML-файл
?>
-----------------------------------------------------------------------
Подключение файлов JavaScript к HTML
<script src="js/main.js"></script>
-----------------------------------------------------------------------
Подключение файлов CSS к HTML
<link rel="stylesheet" href="/style.css">
/////////////////////////Важно!////////////////////////////////////////
в файле login.php переменную password заменили на login_pass
не забыть !!! произвести замену в reg.php
////////////////////////26.04.2025/////////////////////////////////////
закончили на подключении файла стилей CSS в index.php в директории ./ucms/bin/user в Главе 14 руководства UCMS
и т.д.

Казалось бы, этого можно не делать, но поверьте, когда у нас будет много директорий и много файлов, мы начнем путаться, а если нас еще и отвлекут от процесса на недельку, то мы вообще все забудим, а так у нас будет все записано, то нам не прийдется начинать все с начала.

Только авторизованные участники могут оставлять комментарии.
software/development/demo/cms/ucms/help.txt · Последнее изменение: VladPolskiy

Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki