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

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

  * [[dev:stats]]
  * Navigator: свёрстанный шаблон экрана называется "сценой". Изменение оформление удобнее всего сделать переключением сцен.

====Сделать====

  * Доработки навигации
    * Ссылки вперед/назад и сверху и снизу
      * Как первую половину строки прижать влево, а вторую - вправо?
    * **К Nex'у**: выделение текущей страницы в левом меню.
      * Жирностью, выключением ссылки, цветом?
    * **К Nex'у**: баг - в левом меню выделяется жирным последняя отредактированная страница
    * **К Nex'у**: нужна более заметная ссылка на вики в разделе сайта "Разработчикам".
  * Сделать выделение символов **~&!%*^|-+=,./?<>;:()[]{}** в sxh.
  * Дописать [[help:qsp]] и картинки туда.
  * Общие слова к статьям:
    * [[help:conditional]]
    * [[help:organizing]]
    * //[[help:jump]]//??
    * [[help:dynamical]]
    * //[[help:msgbox]]//??
    * //[[help:sound]]//??
    * //[[help:fonts]]//??
    * [[help:modules]]
    * [[help:realtime]]
  * Переделать [[help:menu]]
  * Переделать [[help:principle]]
  * Переделать [[help:regexp]]
  * Впихнуть куда-нибудь статью "Как писать игры" - в каком порядке удобнее обдумывать и писать, что изначально лучше локации прописать на листочке и т.п.
  * Самоучители
    * regexp
  * Недописанный кусок структуры:
    * //Quest Navigator//
      * //Список файлов игры//
      * //Файл настроек игры//
      * //Файл шаблона и файл стилей// ((Похоже будет лучше объединить эти две статьи, не могу придумать, как будет  хорошо в разделенном виде)) ((Список id, классов и кусочков body. Разные варианты для разных целей. Возможно ссылки на самоучители))
        * //Шрифты//
      * //Файл JS// ((Список колбэков и переменных. Возможно ссылки на самоучители типа https://learn.javascript.ru/ . Возможно примеры кода для разных целей.))
      * //Нюансы переноса с предыдущих плееров, отличия.//
      * //Гайд по кроссплатформенности// ((я не возмусь писать, но статья нужная для тех, кто будет шаблоны править))
    * //Утилиты или средства разработки//
      * //[[help:txt2gam|TXT2GAM]]//
      * //[[help:qgen|QGen]] - пока оставлю тут, потом подумаю, нужна ли статья//
  * Добавить куда-нибудь все способы экранирования в одном месте:<sxh qsp>
'<a href="exec:GOTO ''верстак''">версак</a>' 
"<a href=""exec:GOTO 'верстак'"">версак</a>" 
{<a href="exec:GOTO 'верстак'">версак</a>} 
'<a href="exec:GOTO \"верстак\"">версак</a>' 
'<a href="exec:GOTO &quot;верстак&quot;">версак</a>'

!Ещё способ, который может пригодиться с глубокими уровнями вложенности:
'<a href="exec:GOTO '+"'верстак'"+'">версак</a>' 
</sxh>

====Подумать/обсудить====
  * [[help:regexp]] - выглядит не очень
    * Нужен самоучитель
  * [[help:html]] - выглядит не очень
    * Можно отложить до релиза Навигатора.
  * Самоучители - отдельный неймспейс, отдельные неймспейсы или howto?
  * Как хранить файлы с примерами кода, там же или перезалить в wiki (все яйца в одну корзину)?
  * Возможно статью "Известные баги"
  * Возможно перенести подвыражения:
    * Разбить строковые константы и строковые функции на две статьи
    * Строки сразу после переменных
    * Подвыражения в выражениях
  * Возможно отдельные статьи по концепциям "блоков кода" и "переменных с двумя значениями"
  * Возможно вынести базовые функции из [[help:coding|программного кода]]
  * В какой момент обрабатываются подвыражения?
  * Распределить локации-обработчики по соответствующим статьям (ONNEWLOC - в локации и т.д.)?
  * На странице циклов сделать примеры циклов do-while и while-do.

====Статьи вне меню====
  * [[help:dummy]]
  * [[help:qsp_license]]
    * [[help:gnu_gpl_eng]]
    * [[help:gnu_gpl_rus]]
  * [[help:qgen]]
  * [[help:txt2gam]]
  * [[:razbor_izmenenij_dvizhka]]
  * [[:sidebar]]

====Список плагинов====

  * [[doku>plugin:statdisplay|statdisplay]]
  * Здесь должно быть продолжение
====Общие принципы для статей====

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

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

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

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

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

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

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