Форум » » Доработка справки » Ответить

Доработка справки

Nex: В этой теме пишем, что следует добавить или изменить в справке QSP. Для затравки: оператор присваивания SET - необязательный, в справке это не объясняется.

Ответов - 30, стр: 1 2 All

Byte: Nex, из справки: SET [название переменной]=[выражение], LET [название переменной]=[выражение] или [название переменной]=[выражение] - установка значения переменной. Если нужно установить текстовое значение переменной, то перед её названием ставится "$". то есть перечислен список альтернатив записи SET.. Но, наверное, действительно лучше внести какое-то примечание.

Nex: Просто примеры присваивания, сразу за этим предложением. Пример: SET a=5 LET b=10 c=15

Byte: Nex, OK.

elmortem: Текстовые варианты присваивания так же не забудьте в примерах. Некоторые могут сильно тупить в подобных местах. Если есть возможность делать раскрываемые области (а-ля справка Виндовс), то было бы неплохо в такие области вносить расширенные примеры, где можно было бы найти ВСЕ варианты синтаксиса.

Byte: Обновил справку в каталоге (примеры присваивания).

Nex: Byte по каждой мелочи обновлять будешь? Зачем? Набрали бы изменений, а к следующей версии QSP и обновили бы.

Byte: Nex, пока есть время - обновил :) Это для тех, кто будет писать игры к конкурсу.

Nex: В справке в разделах "Использование регулярных выражений" и "Введение в регулярные выражения" стоит проставить ссылки на "Функции, работающие с регулярными выражениями". Сегодня еле нашёл.

noname: только что читал свежескачанную с сайта справку. хотел сделать в квесте ввод с соответствующей строки в любой удобный для игрока момент. нашёл функцию INPUT - не то. того что надо в функциях и операторах не нашёл. не каждый чел полез бы искать в системных переменных, но я полез: $USER_TEXT и $USRTXT - содержат текст, находящийся в строке ввода. ОК! - то, что надо, но как отследить момент ВВОДА? т е игрок нажал <ENTER>- и что? или мож игрок должен нажать мышкой на соотв кнопочку? приведите плизз простенький пример ввода с командной строки а так же хочу ссылку на Великую Пустоту и на любой квест с открытым кодом, в котором задействован воод с этой строки.

noname: а в справку после описания перемнных $USER_TEXT и $USRTXT надо добавить что-либо о том, как отследить момент ввода- я этой инфы в хелпе не нашёл.

noname: о! вроде бы нашёл более подробную инфу, но всё равно кой-чего приходится самому додумывать... работа с текстовым вводом в справке описана так, что народ может не разобраться...

Byte: Системная переменная $USERCOM.

Nex: Кстати говоря, было бы логично служебные локации вынести в отдельный раздел в справке - чтобы лежало "в одном месте", сейчас в "словаре терминов" находятся определения для служебных локаций, а переменные - в разделе "Системные переменные/Переменные, задающие обработчики событий". Стоит сделать раздел "Служебные локации", с общим определением, подробным описанием каждой служебной локации и со ссылкой на соотв. переменные.

Nex: Не описано, какие символы нельзя употреблять в названиях переменных.

elmortem: Нужно изменить логику построения справки. Сейчас там программерская структура и многие новички просто не могут найти то, что им нужно. Логическое объединение было бы более полезно обществу. Всё про поле вывода, всё про настройку интерфейса, всё про события и т.д...

Nex: Можно сделать и то, и другое одновременно.

elmortem: Не нужно. Программер и поиском сможет воспользоваться...

Nex: elmortem зачем усложнять? Надо упрощать.

elmortem: Я ж и говорю, не нужно 10 разных каталогизаторов инфы, достаточно одного, простого для понимаю целевой аудиторией. (:

Nex: elmortem достаточно двух параллельных.

elmortem: Достаточно одной логичной.

Nex: Так предлагай. Распиши подробно.

luciofulci: По-моему, речь идет о разнице между руководством и справкой. Руководство - это обычно связный текст, в котором должны быть объяснены основы, принципы работы с движком, пошагово разобраны несколько простых примеров и т.д. А справка - это просто каталог операторов, функций, встроенных переменных языка. По идее, в руководстве должен быть небольшой гайд о том, как пользоваться справкой.

Ziohekx: А есть подробный Учебник с примерами как пользоватся QSP. Разобраться с ходу очень тяжело. Справки явно не хватает. Нужен учебник.

WladySpb: Было несколько попыток, но никто так и не закончил процесс.... Есть статьи на ifwiki по куспу, там разобраны азы для работы в txt2gam, тоесть без редактора. Можно попробовать ориентироваться на них в начале. Ещё можно посмотреть примеры, архивы с примерами кода лежат на сайте. Ну, и самый простой способ - онлайн справка на irc-канале)

Yashko: Мне, кстати очень удобно было читать учебник на if вики. Лично мне было все понятно. Впринципе, могу написать (дописать) уроки по QSP. Именно через редактор и с скринами.

Byte: Уроки по QSP, о которых идет речь - http://ifwiki.ru/QSP_%D0%A3%D1%80%D0%BE%D0%BA%D0%B8

MasterSet: Это очень важный момент кстати - уроки рулят. Реально могут стать решающим фактором того появится или не появится новый автор. Жаль что не доделаны. Но я, в отличие от Яшко, пока не чувствую себя достаточно опытным чтобы писать учебник )

Ziohekx: Справка слишком сухая. Она на писано на через чур техническом языке. Для обывателя это может оказаться слишком сложным к пониманию. Вот простой пример Переменная - именованная "ячейка памяти". И как прикажете это понимать? Слишком сухо товарищи. Что такое Ячейка памяти, да ещё и именная? Прежде чем понять это я убил пару дней. И это обстоятельство не радует. Нужно повысить понимание справки. До такой степени, чтоб человек прочел и понял о чем идет речь. Локация - одно из базовых понятий текстовых адвентюр. Локация - элементарная единица игрового мира. Это может быть комната, пещера, её часть, дом... Как правило, игрок исследует игровой мир посредством перемещений между локациями. Вот тут сразу получаешь представление о том, что такое Локация. Потому, что после определения " Элементарная единица игрового мира" идет пояснения о чем именно идет речь " Это может быть комната, пещера, её часть, дом..." и для чего это используется " Как правило, игрок исследует игровой мир посредством перемещений между локациями". Таким образом человек читая справку получат представления о чем идет речь. Справка в данный момент приводит список базовых элементов их работы. То есть Это Справочник. Но нужно еще и добавить в него "Толковый словарь". Человек прочитав справку должен не только иметь перечень базовых элементов, но и понять их, получив возможность сними работать с пониманием, а не на у гад.

Nex: Ziohekx справка написана с упором на тех, кто имеет базовые навыки программирования. Для тех кто программировать совсем не умеет, будет учебник. Там будут разъясняться базовые понятия программирования - переменные, условия, порядок выполнения операторов и т.д. Урока по переменным пока еще нет, но он запланирован.



полная версия страницы