Требования к названию проекта
1. Названия расширений
Название расширения очень важно. Имена расширений влияют на структуру расширения и URL-адреса, которые будут отображаться после установки расширения, поэтому планируйте их заранее! В этой статье приведены несколько рекомендаций по наименованию расширений, основанных на лучших практиках сообщества Joomla.
2. Подбор названия
2.1. Использование названия, схожего с названием другого расширения
-
Пользователи могут перепутать два расширения и сообщить о вашем расширении или написать плохой отзыв о вашем расширении, хотя оно предназначалось для другого;
-
Отчеты о безопасности для расширений с похожими названиями могут сбить пользователей с толку;
-
Простое добавление названия компании может быть недостаточным изменением, чтобы пользователи поняли различия;
-
Старайтесь избегать споров о бренде с другими разработчиками.
2.2. Создание оригинального названия расширения
Проявите творческий подход и подумайте о брендинге и маркетинге вашего расширения.
-
Придумайте оригинальное название торговой марки;
-
Выберите имя, которое легко произносится;
-
Имя должно быть коротким, поскольку ваши XML- и PHP-файлы будут называться по имени расширения. Имена расширений также влияют на URL-адреса сайтов Joomla;
-
Избегайте чрезмерно описательных имен;
-
Обеспечьте удобный поиск расширения по функциональности, а не по названию.
3. Названия расширений в SovMart
Каждый проект в SovMart получает свой уникальный ID (номер в конце URL на странице редактирования).
-
Этот ID используется в качестве основного идентификатора для страниц проекта;
-
Каждая запись получает псевдоним, также называемый «Название», для удобства запоминания.
3.1. В порядке поступления
Название проекта SovMart утверждается редакторами SovMart в порядке поступления.
-
Название вашего расширения должно отличаться от названия любого расширения, уже представленного в SovMart (названия компаний не учитываются);
-
Название расширения должно быть указано в теге NAME XML-файла;
-
Такое же название должно быть использовано на вашем сайте и на странице загрузки.
3.2. Конфликты названий расширений
По усмотрению редакторов SovMart название расширения будет считаться конфликтным, если оно слишком похоже на название другого расширения.
-
При обнаружении конфликта названий расширений SovMart будет рассматривать первый представленный проект, даже если он не был опубликован;
-
Более поздние проекты должны изменить название расширения;
-
Конфликты рассматриваются в каждом конкретном случае.
4. Алиасы названий расширений
Название алиаса создается редактором SovMart с использованием следующей информации:
-
Предложение разработчика в поле «название» (предложение должно совпадать с тегом XML-файла "NAME" и MENU");
-
Некоторые слова не допускаются;
-
Некоторые слова могут быть добавлены редакторами SovMart, выступая в качестве тегов.
4.1. Отказ от использования алиасов
Названия алиасов могут быть отредактированы редакторами SovMart в любое время, если это будет сочтено необходимым для поддержания работоспособности каталога.
-
Алиасы, используемые в SovMart, не являются одобрением торговых марок, используемых продуктом SovMart.ru, RadicalMart.ru, Joomla.org или OSM;
-
SovMart не будет участвовать в спорах о торговых марках, поскольку они должны решаться самими пользователями.
4.2. Зарегистрированные имена
SovMart ищет названия расширений в XML-тегах и именах файлов с кодом. Некоторые специальные теги должны быть одинаковыми (пробелы не учитываются).
4.3. Пример XML
<name>jedilightsaber</name>
<menu>Jedi Lightsaber</menu>
4.4. Примеры названий файлов
mod_jedilightsaber.xml
mod_jedilightsaber.php
4.5. Light и Pro версии
Слова «Light» и «Pro» могут быть добавлены для различения двух расширений одного разработчика, но при этом расширения должны иметь разные возможности и планы распространения (например, бесплатная Lite-версия и платная Pro-версия). Слово «Free» считается рекламным текстом и не может быть использовано.
При добавлении тегов «Light» и «Pro»:
5. Использование слов «Joomla» и «RadicalMart»
-
Название расширения не может начинаться со слова «Joomla», «RadicalMart»;
-
Расширения, использующие в названии «Joomla» или производное от Joomla, должны быть лицензированы OpenSourceMatters (OSM);
-
Расширения, использующие "Joomla" или производное от Joomla в имени домена, должны быть лицензированы OSM;
-
Лучше всего полностью отказаться от использования слова Joomla.
Обратите внимание, что расширения не должны называться "Joomla! x". Вместо этого они должны называться "x for Joomla!" или как-то иначе, чтобы их не путали с Joomla. Более подробную информацию можно получить в
справочнике по товарным знакам (JED).
6. Особые случаи
6.1. Специфические расширения
Специфические расширения - это расширения, для работы которых необходимо установить другое расширение. Такие расширения должны иметь в конце имени "for MAIN-EXTENSION-NAME", даже если его нет в XML-файле.
6.2. Ребрендинг
Если вам нужно переименовать старое расширение, но вы хотите избежать конфликтов с сайтами, на которых уже установлено старое расширение, пожалуйста, сначала обсудите это с командой SovMart. После выбора нового имени:
-
Обновите теги NAME и MENU вашего XML-файла;
-
Переименуйте файлы в соответствии с новым названием расширения;
-
Перепакуйте и прикрепите файл к проекту в SovMart;
-
Пересмотрите упоминания о расширении на своем сайте.
Примечание: Если №1 или №2 невозможны из-за проблем совместимости с установленными сайтами, укажите новое имя в теге description или в строке комментариев к XML-файлу.
6.3. Форки
6.4. Скрипты или библиотеки
Название должно быть включено в основной файл.
- В заголовки скрипта необходимо включить комментарии с названием скрипта, копирайтом и лицензией;
- В TXT-файл необходимо включить название, копирайт, лицензию и URL для скачивания.
7. Названия расширений. Что можно, а что нельзя
Что можно:
-
Именовать XML-файл тегом NAME так же, как и имя расширения;
-
Назовите меню администратора компонента (тег MENU в XML) так же, как и имя расширения.
Что нельзя:
-
Использовать оскорбительные слова, политические или религиозные высказывания;
-
Использовать типы расширений как часть имени расширения (используется только для версий модуля и плагина одного и того же расширения от одного разработчика). Такие ключевые слова, как module, plugin или template, считаются зарезервированными и не могут быть использованы в названиях расширений;
-
Использовать в названии номер версии (для этого есть соответствующее поле);
-
Использовать в названии ценники, коммерческие акции или URL-домены;
-
Использовать в названии расширения имя автора или название компании (для этого есть соответствующее поле).
8. Установочное название и название расширения (Install name and Entry Name)
Пожалуйста, не забывайте определять имя установки в файле манифеста так же, как и имя записи.
9. Название установочных плагинов (Plugins install name)
Что касается плагинов, то в Joomla! существует общая конвенция добавления группы плагинов в имя расширения.
Имя вашего плагина должно соответствовать соглашению об именовании JED - плагины в виде "{Тип} - {Имя расширения}".
Например: Authentication - Joomla
