Различия между версиями 6 и 7
Версия 6 от 2008-08-05 14:37:44
Размер: 1325
Редактор: eSyr
Комментарий:
Версия 7 от 2008-08-05 16:08:13
Размер: 5193
Редактор: eSyr
Комментарий:
Удаления помечены так. Добавления помечены так.
Строка 8: Строка 8:
=== Создание паспорта материала ===
Паспорт материала является подстраницей страницы PspoMaterials. Сами файлы материалов находятся в директории [[http://uneex.mithril.cs.msu.su/static/]], в поддиректориях с именем страницы паспорта материала. Для создания паспорта материала рекомендуется использовать шаблон MaterialPassportTemplate или макрос !CreateMaterialPassport:
##<<CreateMaterialPassport>>
=== Технология оформления материала ===
Всё начинается с создания паспорта материала. По принятому соглашению,
паспорты материалов являются подстраницами страницы
[[PspoMaterials]]. Вообще, никто не мешает создать паспорт
вручную. Но для облегчения жизни существует две вещи:
 * Шаблон http://uneex.ru/MaterialPassportTemplate , в котором имеется заготовка для страницы материала
 * Макрос и действие CreateMaterialPassport, которые позволяют создавать страницы паспорта, используя формочку (по аналогии с макросом/действием NewPage)
Суммируя вышесказанное, рекомендуемый метод создания страницы паспорта
таков: вы заходите на страницу, где размещён макрос
CreateMaterialPassport (таких уже сейчас есть несколько, например
[[PSPO]] и [[PspoMaterials]]; кроме
того, данный макрос вполне себе настраивается, см. [[eSyr/WikiHack/Macros/CreateMaterialPassport|документацию]], так
что вы вполне себе можете положить макрос с заданными параметрами
куда-нибудь на свою страницу, например), заполняете форму и нажимаете
кнопку "Создать паспорт материала", после чего оказываетесь на
созданной странице с заполненными полями.
Строка 12: Строка 25:
После создания паспорта можно загружать файлы материала, используя интерфейс, предоставляемый макросом !MaterialFiles. Среди полей, которые стоит заполнить, имеются два особенных: Format и
License. Эти поля являются собенными потому, что фактически указанные
в них значения будут являться параметрами для соответственно макросов
[[eSyr/WikiHack/Macros/FormatInfo|FormatInfo]] и [[eSyr/WikiHack/Macros/LicenseInfo|LicenseInfo]] на новосозданной странице материала. Суть
этих макросов в том, что они вставляют текст со страниц
[[PspoMaterials/FormatInfo]]/[[PspoMaterials/LicenseInfo]] под заголовками,
перечисленными в параметрах. Таким образом,
`<<LicenseInfo(GFDL,CC-BY-SA)>>` преобразуется в
|| GFDL: http://www.gnu.org/copyleft/fdl.html <<BR>> CC-BY-SA: http://creativecommons.org/licenses/by-sa/2.0/ ||
и так далее.

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

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

Для создания ссылки на паспорт материала используйте макрос
[[eSyr/WikiHack/Macros/PassportLink|PassportLink]], например, так: `<<PassportLink(MaterialName)>>`.

Документация:
 * [[eSyr/WikiHack/Macros/CreateMaterialPassport]]
 * [[eSyr/WikiHack/Actions/CreateMaterialPassport]]
 * [[eSyr/WikiHack/Macros/FormatInfo]]
 * [[eSyr/WikiHack/Macros/LicenseInfo]]
 * [[eSyr/WikiHack/Macros/MaterialFiles]]
 * [[eSyr/WikiHack/Actions/MaterialFiles]]
 * [[eSyr/WikiHack/Macros/PassportLink]]

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

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

  • Материалы должны быть вычитаны на предмет пригодности ПСПО
  • Материалы должны быть проверены на лицензионную чистоту
  • Материалы должны иметь паспорт

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

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

  • Шаблон http://uneex.ru/MaterialPassportTemplate , в котором имеется заготовка для страницы материала

  • Макрос и действие CreateMaterialPassport, которые позволяют создавать страницы паспорта, используя формочку (по аналогии с макросом/действием NewPage)

Суммируя вышесказанное, рекомендуемый метод создания страницы паспорта таков: вы заходите на страницу, где размещён макрос 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 (последним исправлял пользователь eSyr 2009-10-26 14:36:13)