Инструменты пользователя

Инструменты сайта


wiki:devel:plugin_info

Информация о плагине

Каждый плагин должен предоставить некоторую базовую информацию о себе. Это делается через файл с именем, plugin.info.txt расположенный в каталоге плагина .

Вот пример того, как должен выглядеть такой файл.

lib/plugins/example/plugin.info.txt
base   example
author My Full Name
email  me@example.com
date   2010-01-17
name   Example Plugin to do Stuff
desc   This is just an Example of how a plugin description looks like
url    https://www.dokuwiki.org/plugin:example
Параметр Описание
base Техническое имя плагина. Менеджер расширений установит его в этот каталог.
author Полное имя автора плагина
email Электронная почта для связи с автором плагина по поводу этого плагина
date Дата последнего обновления этого плагина в формате ГГГГ-ММ-ДД. Не забудьте обновить это, когда будете обновлять свой плагин! 1)
name Удобочитаемое имя плагина
desc Описание того, что делает плагин
url URL-адрес , по которому можно получить более подробную информацию о плагине
minphp Минимальная версия PHP, требуемая для этого плагина. Пусто для того же, что и DokuWiki. Только Major.Minor версия, например 8.2, не 8.2.3 может быть указана!
maxphp Максимальная версия PHP, поддерживаемая этим плагином. Пусто для того же, что и DokuWiki. Только Major.Minor версия, например 8.2, не 8.2.3может быть указана!

Примечание: plugin.info.txt заменяет старый вызов getInfo() в ваших компонентах плагина для DokuWiki 2009-12-25 «Lemming» и более поздних версий. getInfo() теперь реализован в базовом классе и будет считывать всю информацию из этого файла. Его больше не нужно реализовывать в ваших подклассах.

1)
Эта дата должна быть равна дате «Последнее обновление» на странице плагинов в репозитории. Это необходимо для автоматической маркировки обновлений, используемой Extension Manager, представленной в релизе Ponder Stibbons
Только авторизованные участники могут оставлять комментарии.
wiki/devel/plugin_info.txt · Последнее изменение: 2025/01/09 23:21 — vladpolskiy