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

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


Боковая панель

dev:main

Это старая версия документа.


Служебная страница

Сделать

Подумать/обсудить

  • Регулярные выражения - выглядит не очень
    • Нужен самоучитель
  • HTML - выглядит не очень
    • Можно отложить до релиза Навигатора.
  • Самоучители - отдельный неймспейс, отдельные неймспейсы или howto?
  • Как хранить файлы с примерами кода, там же или перезалить в wiki (все яйца в одну корзину)?
  • Возможно статью "Известные баги"
  • Возможно перенести подвыражения:
    • Разбить строковые константы и строковые функции на две статьи
    • Строки сразу после переменных
    • Подвыражения в выражениях
  • Возможно отдельные статьи по концепциям "блоков кода" и "переменных с двумя значениями"
  • Возможно вынести базовые функции из программного кода
  • В какой момент обрабатываются подвыражения?
  • Распределить локации-обработчики по соответствующим статьям (ONNEWLOC - в локации и т.д.)?

Статьи вне меню

Общие принципы для статей

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

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

Удобочитаемость

  • Разбиение материала по статьям должно быть удобным и логичным.
    • Пока существует несколько актуальных плееров, приходится на это оглядываться.
      • Должно легко сводиться к одному плееру в будущем.
  • Выделение новых ключевых слов, чтобы взгляд мог зацепиться.
    • Реализовано жирным
  • Выделение ключевых моментов
    • В каждой статье индивидуально
    • Но так, чтобы не пестрило
  • Характерные примеры
    • Нужно будет многие переделать
      • Пока на это нет сил, времени и воображения
1) Похоже будет лучше объединить эти две статьи, не могу придумать, как будет хорошо в разделенном виде
2) Список id, классов и кусочков body. Разные варианты для разных целей. Возможно ссылки на самоучители
3) Список колбэков и переменных. Возможно ссылки на самоучители типа https://learn.javascript.ru/ . Возможно примеры кода для разных целей.
4) я не возмусь писать, но статья нужная для тех, кто будет шаблоны править
dev/main.1384419603.txt.gz · Последние изменения: 2013/11/14 13:00 (внешнее изменение)