Документация QSP
Сайт Форум

Эта страница только для чтения. Вы можете посмотреть исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
=====To do=====

__**Это служебная страница, вас здесь не ждали =)**__

  * Доделать статьи в help.
    * Описание классика
    * Описание для остальных плееров
  * Сделать неймспэйс examples
  * Сделать неймспэйс modules

====Общие принципы====

===Как можно читать справку===

  * **Последовательно** читать __ВСЕ__ статьи подряд, пропуская неинтересные.
    * __Ссылки сверху и снизу статей__
    * Возможно стоит реализовать другой вариант, но нет идей.
    * __Последовательное изложение__ информации
      * Т.е. минимальное количество отсылок "вперёд"
      * Если не ошибаюсь, то у меня это нарушается только с регэкспами, но так лучше.
      * Возможно __стоит перенести вывод на экран, предметы и действия до программирования__ в структуре
  * **Искать необходимое**
    * __Оглавление__
      * Удобная структура
      * //Ссылки на оглавление//
        * //В каждой статье//
        * //Или в меню слева//
      * Говорящие названия статей
    * __Список ключевых слов__ со ссылками на статьи
    * __Перекрёстные ссылки__ между статьями
    * __Словарь терминов__

===Удобочитаемость===
  * __Разбиение материала__ по статьям должно быть __удобным и логичным__.
    * Пока существует несколько актуальных плееров, приходится на это оглядываться.
      * Должно легко сводиться к одному плееру в будущем.
  * **Выделение** новых ключевых слов, чтобы взгляд мог зацепиться.
    * Реализовано **жирным**
  * Выделение __ключевых__ моментов
    * В каждой статье //индивидуально//
    * Но так, чтобы __не__ пестрило
  * __Характерные примеры__
    * Нужно будет многие переделать
      * Пока на это нет сил, времени и воображения


====Структуры статей====

[[help:contents|Оглавление]]
  * **[[help:introduction]]**
  * [[help:qsp|Что такое QSP?]] - статья со скрином QSP (классики) и описанием что есть что. Возможно несколько скринов в разных конфигурациях окна. 
  * [[help:glossary|Словарь]]
  * [[help:keywords|Список ключевых слов]]
  * **[[help:locations]]**
  * Программирование (подумать над названием ещё раз, когда будут написаны статьи)
    * **[[help:variables]]**
    * **[[help:expressions]]**
    * **[[help:coding]]** - возможно перенести CURLOC.
    * **[[help:arrays]]**
    * **[[help:strings]]**
      * [[help:regexp|Регулярные выражения]]
    * **[[help:conditional]]**
    * **[[help:organizing]]**
    * **[[help:jump]]**
    * [[help:principle]]
    * [[help:sluzhebnye_lokacii|Служебные локации]] ((и переменные, задающие обработчики))
      * На каждый аспект отдельная статья, кроссылки с соответствующими аспектам ((инвентарь, переходы и т.п.))
    * [[help:dynamical|Динамический код]]
  * Вывод текста
    * [[help:osnovnoe_okno|Основное окно описания]]
    * [[help:dopolnitelnoe_okno|Дополнительное окно описания]]
    * [[help:dialog_window|Диалоговое окно]]
  * [[help:dejstvija|Действия]]
  * [[help:predmety_inventar|Предметы (инвентарь)]]
  * [[help:menju|Меню]]
  * Оформление
    * [[help:sound|Звук]]
    * [[help:graphics|Графика]]
    * [[help:fonts|Шрифты]]
    * [[help:html|HTML]]
  * Расширенные возможности
    * [[help:inputs|Ввод текста игроком]]
    * [[help:files_modules|Работа с файлами, использование модулей]]
    * //Готовые модули//
    * [[help:realtime|Реальное время]]
    * //Нюансы написания игр под разные плееры//
      * //Quest Soft Player//
        * [[help:qsp_license|Лицензия]]
      * //AeroQSP//
        * //Справка по AeroQSP// ((Придется собирать по всему сайту и форумам информацию. Хотя можно тупо ссылки, всё равно плеер устарел))
      * //Quest Navigator//
        * //Список файлов игры//
        * //Файл настроек игры//
        * //Файл шаблона и файл стилей// ((Похоже будет лучше объединить эти две статьи, не могу придумать, как будет  хорошо в разделенном виде)) ((Список id, классов и кусочков body. Разные варианты для разных целей. Возможно ссылки на самоучители))
          * //Шрифты//
        * //Файл JS// ((Список колбэков и переменных. Возможно ссылки на самоучители типа https://learn.javascript.ru/ . Возможно примеры кода для разных целей.))
        * //Нюансы переноса с предыдущих плееров, отличия.//
        * //Гайд по кроссплатформенности// ((я не возмусь писать, но статья нужная для тех, кто будет шаблоны править))
    * //Утилиты или средства разработки// - позже выберу название, которое будет лучше содержанию подходить
      * //[[help:txt2gam|TXT2GAM]]//
      * //[[help:qgen|QGen]] - пока оставлю тут, потом подумаю, нужна ли статья//
  * [[help:dummy|Фишки]] ((Фигурные скобки, двумерные массивы и прочие фишки, которые я сейчас не помню или не знаю ака тёмная сторона силы))
  * //Игровые задачи (как сделать)//
  * //Само
    * Структуру самоучителя буду прорабатывать после всего остального. Сначала нормальная документация, потом обучение.учитель - пошаговое написание первой игры.//


====Всякие нюансы, которые должны быть упомянуты, и памятка для себя====
  * Отдельно упомянуть отличие операторов и системных переменных (("SHOWACTS 1", но "USEHTML **=** 1"))
  * Дополнительное окно описания и окно пользователя - одно и то же, нечеткость терминологии.
  * Проверить IIF на запись выражений через &.
  * Фигурные скобки = третий вид кавычек?
  * Возможно статью "Известные баги"
  * Упомянуть, что if ($строка) не работает, ошибка типов данных
  * ADDQST не работает в Aero, в Aero работает ADDLIB
  * Модули olegus'a:
    * https://forum.ifiction.ru/viewtopic.php?id=1613 - экран
    * https://forum.ifiction.ru/viewtopic.php?id=1522 - таблицы данных
    * https://forum.ifiction.ru/viewtopic.php?id=1527 - меню
    * https://forum.ifiction.ru/viewtopic.php?id=1540 - форматирование текста
    * https://forum.ifiction.ru/viewtopic.php?id=1873 - таймер
  * Из справки по QSP 5.6.4 не использованы (не распиханы по статьям) благодарности, минимальные требования, FAQ

----

Благодарности:
  * Nex
  * Ajenta
  * MasterSet
  * olegus
Документация QSPСайтФорум

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

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

Инструменты страницы

Документация QSP
Сайт Форум
