Документация QSP

СайтФорум

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

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

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

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

Оглавление

• introduction
• Что такое QSP? - статья со скрином QSP (классики) и описанием что есть что. Возможно несколько скринов в разных конфигурациях окна.
• Словарь
• Список ключевых слов
• Локации
• Программирование (подумать над названием ещё раз, когда будут написаны статьи)
  • Переменные
  • Выражения
  • Программный код - возможно перенести CURLOC.
  • Массивы
  • Строки
    • Регулярные выражения
  • Условия
  • Пользовательские функции и процедуры
  • Переходы внутри локации
  • Порядок работы интерпретатора
  • Служебные локации ¹⁾
    • На каждый аспект отдельная статья, кроссылки с соответствующими аспектам ²⁾
  • Динамический код
• Вывод текста
  • Основное окно описания
  • Дополнительное окно описания
  • Диалоговое окно
• Действия
• Предметы (инвентарь)
• Меню
• Оформление
  • Звук
  • Графика
  • Шрифты
  • HTML
• Расширенные возможности
  • Ввод текста игроком
  • Работа с файлами, использование модулей
  • Готовые модули
  • Реальное время
  • Нюансы написания игр под разные плееры
    • Quest Soft Player
      • Лицензия
    • AeroQSP
      • Справка по AeroQSP ³⁾
    • Quest Navigator
      • Список файлов игры
      • Файл настроек игры
      • Файл шаблона и файл стилей ^{4) 5)}
        • Шрифты
      • Файл JS ⁶⁾
      • Нюансы переноса с предыдущих плееров, отличия.
      • Гайд по кроссплатформенности ⁷⁾
  • Утилиты или средства разработки - позже выберу название, которое будет лучше содержанию подходить
    • TXT2GAM
    • QGen - пока оставлю тут, потом подумаю, нужна ли статья
• Фишки ⁸⁾
• Игровые задачи (как сделать)
• Само * Структуру самоучителя буду прорабатывать после всего остального. Сначала нормальная документация, потом обучение.учитель - пошаговое написание первой игры.

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

Благодарности:

• Nex
• Ajenta
• MasterSet
• olegus