Названия и идентификаторы расширений Joomla
Согласуйте имена до сборки первого выпуска. Понадобятся установочный манифест расширения и доступ к платформе элемента в SovMart. Для уже выпущенного расширения исходите из идентификаторов установленной версии: новое рекламное название не повод менять их.
Какое имя где используется
| Значение | Пример | Назначение |
|---|---|---|
| Название продукта | Example Pro | Объясняет покупателю, какую редакцию он получает |
| Название элемента | Example — системный плагин | Помогает узнать техническую часть в составе продукта |
«Алиас» продукта — alias | example-pro | Участвует в адресе страницы продукта; пустое поле можно оставить для автоматического заполнения |
| ID и UUID элемента SovMart | Значения из записи элемента | Идентифицируют запись площадки; UUID создаётся автоматически и показывается только для чтения |
«Тип расширения Joomla» — type | plugin | Определяет вид устанавливаемого расширения |
«Системное имя расширения» — element | example | Идентифицирует расширение в Joomla |
«Группа плагина» — folder | system | Вместе с именем различает плагины разных групп |
«Область Joomla» — client | site, administrator | Уточняет область модуля или шаблона |
| Имя ZIP | plg_system_example_1_2_3.zip | Обозначает файл конкретного выпуска |
В форме элемента SovMart нет отдельного редактируемого алиаса, аналогичного алиасу продукта. Не подставляйте название карточки, её алиас или UUID в поле element.
Выберите читаемое название
Для нового продукта используйте узнаваемое название и понятное обозначение редакции: например, Example Basic и Example Pro. В описании поясните различия состава. Обозначение «для Joomla» помогает указать платформу, но не должно создавать впечатление, что продукт выпущен самой командой Joomla.
Для нового системного имени рекомендуем короткое устойчивое обозначение строчными латинскими буквами без пробелов. При необходимости добавьте обозначение автора, чтобы уменьшить вероятность совпадений. Это рекомендация по оформлению; окончательную структуру имени определяет ваше расширение и его манифест. Номер очередного выпуска храните в версии и имени ZIP.
Согласуйте технические значения
Ниже приведены примеры, которые нужно заменить именами своего расширения.
| Расширение | type | element в SovMart | Дополнительные значения | Пример манифеста внутри ZIP |
|---|---|---|---|---|
| Компонент Example | component | com_example | — | example.xml или com_example.xml |
| Модуль Example для сайта | module | mod_example | client=site | mod_example.xml |
| Системный плагин Example | plugin | example | folder=system | example.xml |
| Пакет Example | package | pkg_example | <packagename>example</packagename> в манифесте | pkg_example.xml |
Для компонента, модуля и плагина правила имени манифеста и внутреннего имени описаны в документации Joomla. Связь имени пакета с его манифестом разобрана в инструкции по пакету Joomla.
Для плагина plg_system_example согласуйте следующие значения:
SovMart: type=plugin, element=example, folder=system
Манифест example.xml: <extension type="plugin" group="system" method="upgrade">
Запись services: <folder plugin="example">services</folder>
Имя файла выпуска: plg_system_example_1_2_3.zip
Номер версии: 1.2.3Это фрагменты для проверки соответствия, а не полный установочный манифест. Генератор XML SovMart умеет удалять plg_ и префикс группы из имени плагина. Всё равно сразу сохраняйте element=example, а группу — отдельно: так техническая идентичность останется одинаковой в SovMart, манифесте и XML обновлений.
Публичное название продукта и технические идентификаторы его расширения Joomla.
Сохраните идентичность между выпусками
- Зафиксируйте
type,element, группу плагина и область установки первого поддерживаемого выпуска. - Для обычного обновления сохраняйте эти значения. Меняйте номер версии и нужные файлы расширения.
- При изменении отображаемого названия проверьте подписи карточки и документацию. При изменении алиаса продукта отдельно проверьте ссылки на его страницу.
- Если действительно меняете системное имя, группу или тип, подготовьте и испытайте отдельный переход со старой установки. Простое редактирование поля SovMart не переименовывает расширение на сайтах покупателей.
- После сборки проверьте ZIP и соответствие значений опубликованному XML сервера обновления, затем проверьте обновление с предыдущего выпуска на отдельном сайте Joomla.
Если выпускаете самостоятельный форк, опишите его происхождение и отличия. Для параллельной установки исходного расширения и форка отдельно проверьте отсутствие конфликтов имён, файлов и данных. Решение о переходе с исходного продукта должно сопровождаться инструкцией; совпадение названий само по себе не обеспечивает совместимость.
Если имена не совпали
| Симптом | Что проверить |
|---|---|
| Опубликованный плагин не совпадает с установленным | Сохранённые type, element, folder и манифест; для примера выше нужно example, а не plg_system_example |
| Joomla не предлагает ожидаемое обновление | Идентичность установленного расширения и XML, номер версии, совместимость и доступность файла |
| Новый ZIP устанавливает вторую запись вместо обновления | Не изменилось ли системное имя, группа или область установки |
| Ошибка установки либо удаления пакета | Имя пакета и id, type, group вложенных расширений в его манифесте |
| SovMart отклоняет имя ZIP | Допустимы и _1_2_3.zip, и 1.2.3.zip; проверьте ведущую, завершающую или соседние точки и внутреннее PHP-расширение вроде package.php.zip |
Результат: названия понятны покупателю, а значения SovMart согласованы с установленным расширением и его обновлениями. Продолжите подготовкой ZIP и проверкой публикации.