This version (2013/05/22 05:16) is a draft.This is an old revision of the document!
Создать dev crash course (DCC), который будет содержаться в себе вводные инструкции по работе с кодом Oxwall, сопровождаемые последовательно расставлеными (закоменченными) примерами в плагине-скелетоне. Которые юзер может раскомменчивать по ходу чтения DCC.
Выглядеть это будет так:
чтобы добавить новую странице в главное меню, расскоменьте:
File: /ow_plugins/skeleton/routing.php Line: 83
Some PHP here
При этом, в коде, через комментарии указать всю необходимую техническую инфу: какие параметры принимаются, какие отдаются. У человека, читающего код, не должно возникать вопросов какие данные передаются и отдаются.
Это должен быть самодостаточнй плагин, который устанавлиается/активируется/деактивируется и работает на сайте без дополнительных телодвижений. Он должен содержать весб набор дефолтных папок и файлов для работы плагина в Oxwall
- схема папок и файлов, с описанием где что лежит и за что отвечает. Положить read.info в каждую подпапку, в котором добавить краткое описание предназначения этой подпапки
Указать инструменты в софте для debug и dev.
Расписать каждую константу:
- name: text("Text") / type: text-input / description: text("additional field's description")
- name: text("Extended text") / type: textarea
- name: text("Single Choice(dropdown)") / type: selectbox / values: invitation=text("Select any"), val1=text("Red"), val2=text("Blue")
- name: text("Multiple Choice") / type: multicheckbox / values: val1=New York, val2=Boston, val3=Chicago
- name: text("Upload files") / type: file
- name: text("Hidden") / type: hidden
- name: text("Submit ME") / type: submit
* для каждого элемента добавить PHP/JS проверки валидации
** указать ссылку на form_element.php и validator.php и сказать что там лежит полный список возможных типов и их валидаторов
- указать все возможные опции у формы
- дать инструкции, как вывести на той же странице введенные данные в табличном виде. Для файла вывести только название подгруженного файла