По предложению на форуме созданы отдельные темы (по и по ), только в которых будут рассматриваться просьбы о дополнительных попытках по тестированию.
В этом месяце начаты большие работы по АПИ документации (сверх текущей): обработка комментариев к доке и простановка версий.
[spoiler]
Комментарии. Ранее опубликованные комментарии к доке будут либо переносится в саму доку (в основном, ибо это и есть основной целью работ), либо переноситься в учебные курсы, либо оставаться в виде комментариев, если содержание комментария не удастся ни как классифицировать.После выполнения этих работ бесценный опыт пользователей будет доступен и в файлах CHM, куда раньше комментарии не попадали.
Простановка версий. Достаточно большое число проектов не обновляются. Но работы по ним ведутся. Для облегчения программистского труда мы проставляем в доке с какой и по какую версию продукта класс, метод, параметр, событие существовали (существуют).
Версии проставляются в двух местах: в названии и в таблицах.
Если метод действующий, то в заголовке будет стоять только номер версии с которой он появился в продукте. Если метод устарел, то там же будет указан диапазон версий, где он был действующий.
В таблицах указывается версия, с которой сущность появилась в продукте только в том случае, если её появление не совпадает с моментом появления самого класса, метода и так далее.
На иллюстрации: параметр COURSE_ID появился вместе с методом (то есть с 5.1.0), а параметр CHAPTER_ID только с версии 9.5.4.
Если с развитием продукта параметр (обычно это относится к параметрам) изменялся, то будет соответствующее примечание в его описании. (Например: до версии х.х.х параметр назывался *****).
Примечание. В некоторых классах встречается срок создания в таком виде: ранее 8.6.0. Такие надписи будут заменены точным указанием версии. Это "наследие" предидущего варианта нашего внутреннего ПО для простановки версий.
Теперь о том, что сделано:
Пользовательская документация
Добавлено:
Добавлено:
АПИ документация:
Добавлено:
- класс
- - описание метода изменено в соответствии с новым поведением ()
- описаны (OnSetCouponList, OnClearCouponList, OnDeleteCouponList)
- Добавлены в (TAGGED_user_card_size, BX_NO_ACCELERATOR_RESET)
- В целом ряде функций торгового каталога убрано убрано упоминание про группирующие функции
Изменено:
Администратор. Модули
Создано:
- , на которой будут содержаться ссылки на примеры совместного использования БП и другого функционала системы.
Изменено:
- Пример платёжной системы Яндекс.Деньги под новый протокол Яндекса v.3.
Разработчик Bitrix Framework
Добавлено:
- Раздел и урок .
Добавлено:
Пользователь КП
Внесены обновления под 14-ю версию
Администратор КП
Добавлено:
- службы техподдержки
- Пример бизнес-процесса для подачи
Внесены обновления под 14-ю версию
- Пример бизнес-процесса для подачи
ФАйлы CHM курсов и документации обновлены.
Спасибо, подправил.
OS: Windows 8.1 rus x64.
В таблице по классу приводится дата , с какой версии он не актуален,, но на что заменен не понятно, хотелось бы видеть в данной таблице, на что заменять устаревшие конструкции.
например классы CChapter, CLesson модуля обучения.
уроки в поле COURSE_ID значений нет, в доках написано, что оно обязательное (возможно это глюк CLesson, который не актуален с 12.0 версии) или же в доках не отображены логическиие изменения модуля с версии 12.0
"...программистского труда в документации просталено с какой и по какую версию продукта класс, метод, параметр, событие существовали (существуют)."
К этому списку необходимо добавить сущности, призванные в некоторой, но вполне достаточной мере отобразить логику процесса т е там где опубликована структура модуля добавить версионизирование.
Например, в b_learning_lessons course_ id уже не обязателен (по смыслу), так как значения 0, у chapter_id значения "null" и все работает, так как поменяна логика.
также предлагаю в chm, внутри файла указывать дату его создания, для возможности быстро понять последняя версии или нет. //возможно я этого просто не заметил
Надеюсь, что мои дополнения помогут сделать продукт лучше!
В любом случае спасибо за Ваш труд и быструю реакцию!
По поводу файлов CHM. Указывать версию в самом файле программно пока не можем. Ориентируйтесь на дату создания.
но встречаются отсылы, ради которых и вставлены структуры таблиц
"...Идентификатор изменяемого курса.
arFields
Массив Array("поле"=>"значение", ...). Содержит значения всех полей курса. Обязательные поля должны быть заполнены. ..."
и главное, чтобы не создавалось коллизий, когда допустим старый и новый методы работы ссылаются на структуру, к-ая подходит под один из них. Пока я такого не находил,но если от версии к версии структуры будут меняться, то необходимость тут же возникнет.
по поводу вывода даты создания
в chm подразумевалось примерно следующие
$arCourse['NAME'].=<дата>
$this->courseName = $arCourse['NAME'];
см скрипт подготовки данных к импорту в chm
Не смог найти документацию по классу CLearnLesson? (возможно, не заметил)
Скажите, пожалуйста, есть ли таковая и если нет, то планируется ее добавление в будущем?