Полиси по материалам, включаемых в состав модулей.

Требования, предъявляемые к материалам

Технология оформления материала

Всё начинается с создания паспорта материала. По принятому соглашению, паспорты материалов являются подстраницами страницы PspoMaterials. Вообще, никто не мешает создать паспорт вручную. Но для облегчения жизни существует две вещи:

Суммируя вышесказанное, рекомендуемый метод создания страницы паспорта таков: вы заходите на страницу, где размещён макрос CreateMaterialPassport (таких уже сейчас есть несколько, например PSPO и PspoMaterials; кроме того, данный макрос вполне себе настраивается, см. документацию, так что вы вполне себе можете положить макрос с заданными параметрами куда-нибудь на свою страницу, например), заполняете форму и нажимаете кнопку "Создать паспорт материала", после чего оказываетесь на созданной странице с заполненными полями.

Среди полей, которые стоит заполнить, имеются два особенных: Format и License. Эти поля являются собенными потому, что фактически указанные в них значения будут являться параметрами для соответственно макросов FormatInfo и LicenseInfo на новосозданной странице материала. Суть этих макросов в том, что они вставляют текст со страниц PspoMaterials/FormatInfo/PspoMaterials/LicenseInfo под заголовками, перечисленными в параметрах. Таким образом, <<LicenseInfo(GFDL,CC-BY-SA)>> преобразуется в

GFDL: http://www.gnu.org/copyleft/fdl.html
CC-BY-SA: http://creativecommons.org/licenses/by-sa/2.0/

и так далее.

Далее. Внизу сгенерированной страницы имеется макрос <<MaterialFiles()>>. Это способ управления файлами материала. Он умеет достаточно мало: upload, move, delete, pack/unpack, mkdir. (Рас)паковка работает пока только для архивов bzip2. Соответственно, если нужно загрузить дерево файлов, то сначала вы их архивируете (tar cjf), потом закачиваете средствами MaterialFiles, потом распаковываете.

В случае, если создаётся паспорт для страниц вики, просто замените макрос MaterialFiles на ссылку на эти страницы (ничего специального я по этому поводу не хакал, просто таково соглашение). Также, вероятнее всего, будет логичным размещать их как подстраницы страницы паспорта в некоторых случаях.

Для создания ссылки на паспорт материала используйте макрос PassportLink, например, так: <<PassportLink(MaterialName)>>.

Документация:


CategoryPolicy

PSPO/Policy/Materials (last edited 2009-10-26 11:36:13 by eSyr)