SW JProjects - Документация
Категория: Компоненты

Создание проекта

Как заполнять данные проекта для Joomla-расширения в компоненте SW JProjects, параметры платного скачивания, настройки для встроенного сервера обновлений для Joomla расширений.

Что такое проект в SW JProjects?

Проект - это любой скачиваемый цифровой продукт, к которому применимо (но необязательно) версионирование, а также возможно бесплатное или платное скачивание с помощью лицензионного ключа. Таким цифровым продуктом может стать всё, что угодно, но компонент исторически развивается как основа для каталога программного обеспечения, в том числе расширений для CMS Joomla, поэтому для проекта есть возможность создавать его версии, а также вести документацию. Скорее всего для скачивания фотографий, аудио или видео файлов лучше использовать другие решения.

Создание проекта

Чтобы создать проект, пройдите в меню в панели администратора - Компоненты - SW JProjects - Проекты. Нажмите кнопку создать.

Создание проекта для Joomla расширения в компоненте SW JProjects

Настройки проекта SW JProjects

Скриншот настроек страницы создания проекта в компоненте  SW JProjects для joomla

Titile
Заголовок проекта, виден пользователям сайта. Название Вашего цифрового продукта.
Элемент
Системное имя проекта в компоненте SW JProejcts, некий аналог алиаса в Joomla. Должен быть уникальным для каждого проекта. 
Алиас
Обычный алиас в Joomla, который используется для построения SEF URL веб-страницы.
Контент, Оплата, Joomla и т.д.
Табы настроек компонента.
Id
После сохранения здесь будет виден Id проекта.
Категория
Основная категория, в которой будет находиться проект. Алиас этой категории может быть в SEF URL проекта.
Дополнительные категории
Вы можете назначить проекту неограниченное количество дополнительных категорий, создавая тематические подборки из проектов или объединяя их по любой другой логике. Например, Ваш проект - плагин для Joomla и находится  в основной категории "плагины". А дополнительной категорией может быть "Для Joomla 5" или "CRM" и т.д.
Опубликовано
Состояние проекта: опубликовано, не опубликовано, в корзине. Не опубликованный проект не виден пользователям сайта, не попадает в XML-карту сайта, для него отключены сервер обновлений и Changelog URL..Любое обращение к проекту будет вызывать ошибку 404.
Видимость проекта
Параметр позволяет установить видимость проекта для фронтенда. Создание приватного проекта. Аналогично состоянию публикации. Необходимо в тех случаях, когда Вы хотите использовать для проекта сервера обновлений и Сhangelog URL, но при этом не хотите, чтобы пользователи могли скачать это расширение самостоятельно. Например, это сопутствующее расширение, которое устанавливается как зависимость для основного, но имеющее собственный сервер обновлений.
Макет
Вы можете создавать собственные HTML-макеты для страниц проектов и указывать для каждого проекта свои индивидуальные настройки. Настройки конкретного проекта переопределяют общие настройки.

Таб "Контент"

В табе "Контент" находятся краткое и полное описание цифрового продукта. В кратком описании нельзя использовать HTML, также это поле не обрабатывают плагины контента Joomla.

В поле редактора находится полное описание, в нём можно использовать контент плагины. Если для цифрового продукта документация небольшая, то имеет смысл поместить её всю на одной странице в полном описании проекта. 

Таб "Оплата"

В этом табе указывается платный цифровой продукт или бесплатный. 

Настройки оплаты для проекта  SW JProjects компонента для Joomla

Тип скачивания
Возможные значения: платно, бесплатно. Если продукт платный, то скачать его можно будет только с использованием действующего лицензионного ключа. Ключ создается для клиента в разделе "Ключи".
Ссылка на покупку
Укажите абсолютную или относительную ссылку, где можно произвести оплату Вашего цифрового продукта. Это может быть как ссылка на интернет-магазин на Вашем же сайте, так и ссылка на сторонние сервисы. Ссылка будет показана вместо кнопки "скачать". Ссылка будет показана только если выбран "тип скачивания - платный".
Цена
Укажите стоимость Вашего цифрового продукта. Здесь же можно указать валюту. Это значение отображается одинаково для всех языков сайта, если у Вас мультиязычный сайт.

Таб "Joomla"

Настройки сервера обновлений для Joomla расширения

Если Ваш проект - расширение для Joomla - используйте этот раздел. Если нет - оставьте не заполненным. 

Настройка проекта для Joomla расширения в компоненте SW JProjects

Здесь Вы можете выбрать тип Вашего расширения для Joomla:

  • компонент
  • файл
  • язык
  • библиотека
  • пакет
  • плагин
  • шаблон

05 ru

Для некоторых типов расширений Joomla будут доступны дополнительные необходимые параметры. Так для модулей, шаблонов нужно указать область системы - Сайт или Панель управления. А для плагинов нужно указать каталог: system, content, editors-xtd, console и т.д. Эта информация отображается на странице проекта.

В Joomla есть система получения обновлений расширений от их разработчиков. Для этого разработчик должен на своём сайте сформировать XML-файл сервера обновлений согласно официальной документации Joomla

С компонентом SW JProjects это делается в несколько кликов. Укажите тип расширения и включите сервер обновлений. Как только для проекта будет создана хотя бы одна версия - сервер обновлений начнёт формировать XML файл нужной структуры.

Скопируйте код из поля в XML манифест Вашего расширения. При его установке на сайтах клиентов Joomla добавит Ваш сервер в список серверов обновлений и периодически будет его опрашивать на предмет получения новых версий.

Вставка кода сервера обновлений в манифест расширения Joomla.

Тогда на сайтах Ваших клиентов Вы сможете обновлять версии расширений естественным для Joomla образом.

07 ru

Перейдите в левом меню Система - Обновление - Расширения.

Расширение в списке обновлений расширений Joomla

Changelog URL

Начиная с Joomla 4 в CMS есть возможность просмотреть список изменений в расширении перед обновлением. Для этого разработчик должен реализовать на своём сервере для каждого расширения XML файл с описаниями изменений для каждого расширения согласно официальной документации Joomla: Adding changelog to your manifest file

Компонент SW JProjects создаёт для каждого расширения Joomla Changelog URL автоматически. На предыдущем скриншоте обратите внимание на кнопку Изменения в списке обновлений расширения. При нажатии откроется модальное окно со списком изменений в новой версии. Таким образом Вы сможете проинформировать своего клиента о новых функциях и потенциальных проблемах обратной совместимости перед тем, как он обновит расширение. 

Это же окно с информацией об изменениях в релизе открывается в списке расширений Joomla. Пройдите в левом меню Система - Расширения - Управление. Найдите в списке нужное расширение.

Ссылка на changelog Joomla расширения в списке расширений Joomla 5

Если для него есть Changelog URL (он был добавлен в XML-манифест расширения), то номер версии будет ссылкой, по которой откроется окно с информацией.

Список изменений для расширения можно посмотреть прямо в админке Joomla

Таб "Ссылки"

В этом табе можно указать все внешние ссылки для проекта:

  • ссылка на страницу с демонстрацией работы расширения
  • условия поддержки расширения
  • ссылку на репозиторий GitHub. Можно указать любую ссылку, не обязательно GitHub, но в таком случае сделайте переопределение макета в шаблоне или свой шаблон, чтоб указать своё название для кнопки.
  • ссылка на страницу расширения в JED - официальный маркетплейс расширений Joomla - Joomla Extensions Directory
  • Поддержать - это ссылка на страницу для пожертвований
  • документация - ссылка на документацию, если не используется встроенная документация SW JProjects

Внешние ссылки для проекта в SW JProjects для Joomla

Таб "Связи"

В этом табе для проекта можно указать связь с внешним проектом или внутренним. Это может быть ссылка на библиотеку, от которой зависит работа Вашего расширения Joomla, ссылка на фреймворк, сервис и так далее. Например, Вы можете указать здесь ссылку на репозиторий GitHub стороннего разработчика или сайт, где можно скачать / купить расширение, компонент и т.д. Если проект "внутренний" - находится в Вашем SW JProjects, то выберите его в выпадающем списке.

Связи между проектами в SW JProjects Joomla

Таб "Изображения"

Таб изображения для проекта sw jprojects joomla

Здесь можно указать изображения для проекта.

Иконка
Небольшая картинка, отображаемая в списке проектов и на странице проекта
Обложка
В шаблоне по умолчанию эта картинка используется только для тегов Open Graph, мета-тега image. Однако, в своём шаблоне Вы можете также использовать её в дизайне.
Галерея
Сюда загружаются все необходимые для проекта скриншоты: интерфейс, экраны установки, результат работы и т.д.
Таб изображения для проекта sw jprojects joomla с картинкой
Указываем картинки в проекте
Скриншот проекта SW JProjects на шаблоне Cassiopeia Joomla 5
Скриншот проекта SW JProjects на шаблоне Cassiopeia Joomla 5

Таб "Метаданые"

В этом табе находятся параметры, необходимые для СЕО (оптимизации под поисковые системы) Вашего проекта. 

Заголовок
Это тег <title> страницы. Если поле не заполнено в тег <title> страницы проекта попадает название проекта. Но Вы можете сделать заголовок более информативным, например: "Скачать плагин НАЗВАНИЕ ПЛАГИНА для Joomla 5 бесплатно". 
Описание
Это тег meta-description страницы проекта. Здесь должно быть краткое описание проекта для поисковых систем. Данные из meta-description участвуют в создании сниппета поисковой выдачи.
Ключевые слова
Это тег meta-keywords. Некоторые поисковые системы ещё учитывают этот тег, хотя, например, Google объявил о том, что не использует данный тег ещё в 2009 году.
Индексирование
Параметр управляет индексацией страницы, добавляя теги noindex и nofollow в тело страницы. 
Изображение
Изображение для мета-тега image.

 Таб метаданные проекта SW JProjects для Joomla

 

Расширения Joomla WebTolk

90 Всего расширений
11 Категорий
401 Выпущено версий
397191 Всего скачиваний
Корзина
Корзина пуста