Новая справка по QSP.
Сейчас пишется новая справка по платформе QSP. Цели, как обычно:
- Всеохватность
- Удобство
- Понятность
Ну и как обычно - эта тема для ваших пожеланий и т.п. :)
Ссылка на справку: http://wiki.qsp.su/
А пока - с радостью прочитаю ваши пожелания.
напиши в ней как делать менюшки из ссылок) замаялся пока нашел как их делать)
Qarp:
напиши в ней как делать менюшки из ссылок) замаялся пока нашел как их делать)
Можешь воспользоваться моим модулем работы с меню — он изрядно помогает работать с менюшками: https://qsp.org/forum/121-modul-dla-raboty-s-menu-rassirenie-funkcionala-operatora-menu
Может ну её - справку? Выбери другой жанр. Книгу напиши “QSP для чайников”. Больше простора, можно пользоваться простым языком и размытыми аналогиями.
Будут и примеры, и модули. Хотя я думаю заставить авторов модулей самих писать описание своих модулей, если описаний нет нормальных. :) Но до модулей очередь не скоро дойдёт :(
Qarp:
менюшки из ссылок
Ссылка, по нажатию которой меню открывается, или что-то другое?
newsash:
Ссылка, по нажатию которой меню открывается, или что-то другое?
https://dl.dropboxusercontent.com/u/57835358/%D0%94%D1%83%D0%B1%D0%B8%D0%BD%D0%BA%D0%B0.qsp
Написал пример по которому легко можно разобратся
Aleks Versus:
Может ну её - справку? Выбери другой жанр. Книгу напиши “QSP для чайников”. Больше простора, можно пользоваться простым языком и размытыми аналогиями.
А что мешает в справке пользоваться достаточно простым языком и размытыми аналогиями? Главная цель справки - описывать все возможности движка и всё равно как, нет?
Qarp:
Написал пример по которому легко можно разобратся
Я так понял речь идёт про ‘<a href=“EXEC: menu ‘‘$menu’’”>’? Будет.
В куспе нормальный синтаксис, примерно везде одинаковый. Поэтому и текущей справкой довольно легко пользоваться.
Ajenta:
В куспе нормальный синтаксис, примерно везде одинаковый. Поэтому и текущей справкой довольно легко пользоваться.
Текущая справка, к сожалению, не охватывает часть функционала. Например, ты знала, что в новых версиях библиотеки (на одной из которых собран, например, Квест Навигатор) есть такие вещи, как циклы и локальные переменные? (если я не ошибаюсь, конечно). Не говоря о фигурных скобках, использовании индекса при добавлении элемента и т.п., что есть даже в 5.7.0, а в справке нет.
К тому же даже Байт где-то писал, что справку нужно серьёзно переработать.
Итак, упорным трудом newsash была подготовлена новая версия справки!
Лицезреем в нашей вики: http://wiki.qsp.su/
По содержанию и структуре всё ещё будет немного меняться, но основной вид сформирован. В будущем прошерстим тексты статей, вычистим все огрехи, справка немного устаканится. Тогда по содержимому вики будет сформирована новая офлайновая справка. Онлайновой версией будет как раз вики.
Любые вопросы, замечания, предложения можете задавать мне и newsash. Если заметите в вики ошибку - исправляйте, редактирование открыто для всех. Ну или захотите чего-то дополнить.
немного вычитки:
Spoiler
в статье о переменных:
variables:
32 кибибайт или 2 гибибайт
там же
variables:
Название переменной может быть практически любым, но
слово “практически” - практически не нужно.
И, думаю, вот это
variables:
При попытке использования несуществующей переменной в выражении будет использовано значение по умолчанию
должно выглядеть иначе: “При попытке использования ранее не использовавшейся переменной в выражении будет использовано значение по умолчанию”.
variables:
Далее в справке будет использован последний способ, как самый нормальный.
“как наиболее удобный”.
expressions:
NO [#выр] - побитовая инверсия 1). В основном используется как логическая инверсия.
[#выр1] OR [#выр2] - операция побитового “или”. Во всём выражении будут равны единице те биты, которые равны единице хотя бы в одном из двух выражений.
[#выр1] AND [#выр2] - операция побитового “и”. Во всём выражении будут равны единице те биты, которые равны единице в каждом из двух выражений.
Это может создать сложности в понимании для непрограммистов. Даже не знаю, как тут быть. Сделать два варианта друг за другом: из старой справки и новый, и дать подробные пояснения с примерами?
ещё немного вычитки:
Spoiler
опечатка на странице “массивы”
arrays:
Соответственно для текстового массива нужно незабивать использовать символ ‘$’ в имени.
далее
arrays:
Если индекс элемента не указан, то очищается весь массив
возможно, всего лишь вопрос терминологии, но мне кажется “очищение массива” и “уничтожение массива” - разные понятия.
arrays:
ARRCOMP([#начало],[$имя_массива],[$шаблон]) - функция полностью аналогична ARRPOS, но вместо конкретного значения для поиска используется регулярное выражение. Поиск работает только по текстовым массивам (символ ‘$’ в названии можно опустить)
Для справки такое объяснение некорректно. Всё равно что рыться в словаре в поисках определения слова, и натыкаться на надпись “то же самое, что …” и потом приходится вновь рыться в словаре, чтобы найти уже новое определение. Это уместно было бы для экономии места на бумажном носителе, но в электронном виде лучше вновь объяснить подробно.
Править сам не возьмусь, ибо обязательно что-нибудь накосячу.
В целом, получилось неплохо. Поражает охват и лаконичность. Действительно требует серьёзного испытания до утверждения в конечном варианте. Справочник ближе к учебному пособию, так бы я охарактеризовал результат.
Aleks Versus,
исправь то, что можешь сам исправить. Оставь только те вопросы, где сам не знаешь как лучше. Накосячить особо бояться не стоит, все ревизии у нас сохраняются, можно всегда будет откатить.
Кстати, могу поставить плагин, который позволит вести обсуждения по вики-статьям, в виде ветки комментариев. То есть под любой статьёй можно будет оставить замечания и пообсуждать. Незалогиненным на вики (там отдельная авторизация) комментарии показываться не будут, так что читать никому не помешает.
Делать? Есть желающие пользоваться?
Nex:
Делать? Есть желающие пользоваться?
Я за, но нас с тобой мало - нужен ещё хотя бы один желающий.
Aleks Versus:
ранее не использовавшейся
Переменная создаётся в момент записи. Так, конечно, было бы понятнее, но здесь всё таки правду лучше оставить.
Aleks Versus:
Это может создать сложности в понимании для непрограммистов. Даже не знаю, как тут быть. Сделать два варианта друг за другом: из старой справки и новый, и дать подробные пояснения с примерами?
Старый вариант некорректен. А вот как объяснить проще - нужно подумать.
Aleks Versus:
32 кибибайт или 2 гибибайт
Википедия: двоичные приставки пора нести свет в массы :)
С остальным согласен - исправлю. Спасибо :)
newsash:
Википедия: двоичные приставки пора нести свет в массы
ух ты. не знал.
Nex:
Делать? Есть желающие пользоваться?
делай. Зарегистрируюсь, буду править/комментировать по-ходу.
Aleks Versus,
поставил плагин, можешь проверить в песочнице.