CB Авторизация

Ваш логин в:

Меню пользователя
Скачать
Статьи на сайте
 
XML файл (часть 1)
Написал Kotofeich   
11.08.2007

Файл XML - первый и самый важный файл плагина CommunityBuilder. Он содержит все инструкции CommunityBuilder и предназначен для проведения правильной установки плагина, настройки и удаления. Для описания установки, используется удобный язык XML (упрощенный XML, используемый Joomla!, не будет сообщать, какая ошибка произошла при установке). 
XML-файл разделен на следующие части (причем не все части являются обязательными) :

  • Заголовкок
  • Файлы
  • Параметры плагина
  • Вкладки, каждая из которых содержит: описание вкладки, параметры и поля
  • SQL-запрос установки
  • SQL-запрос удаления
  • Php Файл установки
  • Php файл удаления

Заголовок

Заголовок xml-файла выглядит следующим образом:

<?xml version="1.0" encoding="windows-1251"?>
<cbinstall version="4.5.3" type="plugin" group="user">
<name>pms.MyPMSPro</name>
<author>Kotofeich</author>
<creationDate>11/10/2007</creationDate>
<copyright>(C) 2007 CommunityBuilder.ru</copyright>
<license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license>
<authorEmail> Этот адрес e-mail защищен от спам-ботов. Чтобы увидеть его, у Вас должен быть включен Java-Script </authorEmail>
<authorUrl>www.skydisign.com</authorUrl>
<version>1.0 RC 2</version>
<description>Служит для интеграции компонента личных сообщений в CB.</description>

Поскольку плагины, скорее всего, вы  будете создавать на русском языке, то выберите кодировку win1251. Это делается в первой строчке, и там же - для совместимости, - указывается версия xml языка.

<?xml version="1.0" encoding="windows-1251"?>

Файл установки включает следующую обязательную строку:

<cbinstall version="4.5.3" type="plugin" group="user">

Версия необходима для совместимости плагина.
В параметре тип, обязательно должно стоять значение "plugin".
Третий параметр показывает, к какому виду будет относиться ваш плагин: пользовательский (user), шаблон (template) или перевод (language).

<name>pms.MyPMSPro</name>

Имя используется для двух целей:
1) Создание специальных видов плагинов (причем первая часть названия отделяется точкой).
  • "cb."  - указывает основные программные расширения
  • "pms."  - указывает на то, что плагин совместим с системой личных сообщений

2) Создание названия папки плагина при установке. Причем, плагину типа "user" будет добавлен префикс "plug_", а все пробелы будут заменены на знаки "_".

<author>Kotofeich</author>
<creationDate>11/10/2007</creationDate>
<copyright>(C) 2007 CommunityBuilder.ru</copyright>
<license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license>
<authorEmail> Этот адрес e-mail защищен от спам-ботов. Чтобы увидеть его, у Вас должен быть включен Java-Script </authorEmail>
<authorUrl>www.skydisign.com</authorUrl>

Эти поля необязательны, но они дают информацию пользователю о вас. Используются, в основном, для тех.поддержки.

<version>1.0 RC 2</version>

Обратите внимание! Версия плагина должна строго соответствовать версии CommunityBuilder!

<description>Служит для интеграции компонента личных сообщений в CB.</description>
Это сообщение будет показано пользователю после успешной установки плагина. Оно может содержать инструкции для администратора по установке.

Файлы
Следующая секция, содержит информацию об установке файлов :
<files>
<filename plugin="pms.mypmspro">pms.mypmspro.php</filename>
<filename>index.html</filename>
</files>

В этой секции не должен содержаться сам файл xml, потому что установщик CB скопирует его автоматически после установки, если не встретит никаких ошибок.
Главный файл, содержащий все классы, должен иметь аргумент тега "plugin=" с названием плагина, указанным выше. Не забывайте включать пустой html файл, для правильной настройки каталогов.
Вот пример, как плагин включает дополнительные файлы :

<files>
<filename plugin="english">default_language.php</filename>
<filename>index.html</filename>
<filename>calendar-locals.js</filename>
<filename>images/index.html</filename>
<filename>images/nophoto.jpg</filename>
<filename>images/pendphoto.jpg</filename>
<filename>images/tnnophoto.jpg</filename>
<filename>images/tnpendphoto.jpg</filename>
</files>

Мы видим, что в вашей установке должен быть создан каталог images . Если вы не вложите файл index.html в плагин (в каталог images), то при установке, каталог не будет создан!
 
< Пред.   След. >

 

© 2011 Русский сайт поддержки Community Builder
Все права принадлежат Sunshine studio, LLC
Партнерки
Модуль SunBlog
CB поиск пользователя

CB Online

Посетителей нет.
CB статистика
5039 зарегестрировано
0 сегодня
0 за неделю
0 за месяц
Последние: Denis85

Дружина
хостится тут

и отзывы о хостинге для Joomla от дружинников