worldwide open-source software - plugin:repository

api

anonymous@undisclosed.example.com (Anonymous) — Sun, 09 Feb 2025 12:27:17 +0000

API репозитория расширений

API позволяет запрашивать список доступных расширений DokuWiki. Он доступен по адресу https://www.dokuwiki.org/lib/plugins/pluginrepo/api.php

Этот API используется плагином Extension Manager Plugin.

/lib/plugins/pluginrepo/api.php?fmt=json&ext[]=plugin1&ext[]=plugin2

/lib/plugins/pluginrepo/api.php?fmt=json with &ext[]=plugin1, &tag[]=tag1, &mail[]=mail1, &type[]=4 and/or &q=text.

Команды

Использование cmd параметра определяет, что возвращается API.

ping – просто возвращает одну единицу, чтобы показать, что соединение работает
query – действие запроса по умолчанию, описанное ниже

Форматы

Определяет формат вывода и указывается параметром fmt Может быть:

debug – print_r для удобного просмотра
xml – XML не следует использовать, если этого можно избежать
yaml – Данные в кодировке YAML
php – PHP сериализованные данные
json – Данные в кодировке JSON (по умолчанию)
- укажите имя обратного вызова в качестве cb параметра и это JSONP. пример:
```
api.php?fmt=json&cb=my_callback
```

Фильтры

Все фильтры можно комбинировать и использовать функцию AND.

Имя расширения

Укажите одно или несколько имен в ext[] параметре. Префикс template: для шаблонов.

На данный момент только полные совпадения.

пример: api.php?ext[]=wrap&ext[]=template:ach

Полнотекстовый поиск

Параметр q позволяет задать полнотекстовый запрос (с расширением запроса). Если не limit указано, то ограничение устанавливается равным 50. Если не order указано, то результат сортируется по баллу результата.

Полнотекстовый индекс использует поля плагина, имени, описания, автора и тега.

пример: api.php?q=wrap

Тип

Для фильтрации по типу используйте type параметр, можно сложить несколько типов.

Поддерживается:

1 ⇒ 'Syntax',
2 ⇒ 'Admin',
4 ⇒ 'Action',
8 ⇒ 'Render',
16 ⇒ 'Helper',
32 ⇒ 'Template',
64 ⇒ 'Remote',
128 ⇒ 'Auth'

пример: api.php?type=5

Электронная почта

Мы не раскрываем адреса электронной почты, чтобы избежать спама. Вместо этого используется MD5 адреса электронной почты в нижнем регистре. Вы можете использовать его для запроса по адресу(ам) электронной почты с помощью mail параметра.

пример: api.php?mail[]=4933823dc5f71300a20a506869fcf4d9

Заказ

Вы можете влиять на порядок результатов с помощью order параметра.

Поддерживаемые поля:

последнееобновление
популярность
плагин ('по умолчанию')
все остальные непроизводные поля БД

пример: api.php?order=lastupdate

Предел

Вы можете ограничить количество результатов с помощью limit параметра.

пример: api.php?limit=5

Old Repository API

/lib/plugins/pluginrepo/repository.php возвращает данные плагина/шаблона в виде XML. Можно использовать тот же синтаксис, что и для сортировки/фильтрации таблицы репозитория, а также запросить массив именованных плагинов.

Все еще используется, например Translate Tool
(см. код по ссылке [wiki]/lib/plugins/pluginrepo/repository.php?includetemplates=yes)

Доступные фильтры:

плагины – [массив строк] возвращает только именованные плагины
тип_плагина – [целое число] 1, 2, 4, 8, 16, 32=шаблоны
plugintag – [string] фильтрует результат по плагинам с соответствующим тегом. Фильтровать по тегу и типу можно одновременно, хотя компонент синтаксиса таблицы обычно не использует эту функцию.
pluginsort – [author/lastupdate/type/popularity/compatibility] результат сортируется по именованному полю. Также доступны сочетания клавиш (author=a).
showall – [yes] возвращает плагины независимо от их безопасности или устаревшего статуса, обычно пропускается.
includetemplates – [yes] возвращает шаблоны И плагины, обычно возвращаются только плагины. Объедините с plugintype=32 для возврата только шаблонов.

Пример вызова для получения данных о плагинах синтаксиса:

http://www.dokuwiki.org/lib/plugins/pluginrepo/repository.php?plugintype=1&plugintag=list

Пример вывода:

<repository>
  <plugin>
    <id>captcha</id>
    <dokulink>plugin:captcha</dokulink>
    <popularity>5947</popularity>
    <name>CAPTCHA Plugin</name>
    <description>Use an image verification (CAPTCHA) to defeat spambots</description>
    <author>Andreas Gohr</author>
    <type>Action, Helper</type>
    <lastupdate>2016-01-24</lastupdate>
    <compatible>
      <release>2015-08-10</release>
      <release>2014-09-29</release>
      <release>2014-05-05</release>
      <release>2013-12-08</release>
    </compatible>
    <securityissue></securityissue>
    <securitywarning></securitywarning>
    <tags>
      <tag>captcha</tag>
      <tag>spam</tag>
    </tags>
    <screenshoturl></screenshoturl>
    <thumbnailurl></thumbnailurl>
    <downloadurl>https://github.com/splitbrain/dokuwiki-plugin-captcha/zipball/master</downloadurl>
    <sourcerepo>https://github.com/splitbrain/dokuwiki-plugin-captcha</sourcerepo>
    <bugtracker>https://github.com/splitbrain/dokuwiki-plugin-captcha/issues</bugtracker>
    <donationurl>http://donate.dokuwiki.org/CAPTCHA</donationurl>
    <relations>
      <similar></similar>
      <conflicts></conflicts>
      <depends></depends>
    </relations>
  </plugin>
  <plugin>
    ...
  </plugin>
  ...
</repository>

manual

anonymous@undisclosed.example.com (Anonymous) — Sat, 08 Feb 2025 14:11:10 +0000

⇐ Репозиторий расширений

Руководство по плагину репозитория

Репозиторий расширений используется www.dokuwiki.org для организации информации о плагинах и шаблонах.

Источник

Исходный код доступен по адресу https://github.com/dokuwiki/dokuwiki-plugin-pluginrepo

Разработка DokuWiki движется в сторону одинакового отношения к плагинам и шаблонам. В репозитории плагинов шаблоны — это просто плагин типа == 32. Это облегчает совместное использование тегов (пользователи, ищущие боковые панели, должны видеть и плагины, и шаблоны) и «Больше вкладов одного автора».

шаблоны идентифицируются по используемому пространству имен.

Функциональность

Плагин имеет несколько компонентов синтаксиса (см. раздел Syntax ниже):

Записи для ввода свойств
- плагин ---- plugin ----
- или шаблон ---- template ---- .
Таблица репозитория ---- pluginrepo ---- в которой перечислены сохраненные плагины или шаблоны.
Информационное поле с некоторыми (случайными) моментами ---- pluginnews -----
Список результатов заданного запроса, полезный для администраторов вики ---- pluginquery -----

Для использования информации о расширениях во внешних инструментах доступны некоторые API:

API позволяет запрашивать список доступных расширений DokuWiki. Доступно по адресу
Available at /lib/plugins/pluginrepo/api.php?[parameters] (см . также api)

Старая конечная точка /lib/plugins/pluginrepo/repository.php?[parameters]
(все еще используется, например, translate-tool) (см. также api)

Creates output in different formats of the usage statistics of DokuWiki
Available at /lib/plugins/pluginrepo/popularity.php?[parameters]
Examples at popularity
(see for parameters details: source)

And maintenance tasks are performed by:

/lib/plugins/pluginrepo/cron.php
- Calculate popularity
- Check for version and base discrepancies and update the badextensions page

Синтаксис

Entry Component

Besides the entry component details it's worth mentioning that the securitywarning field has some predefined values

informationleak – 'This plugin expose information that might be valuable to a hacker. It is not recommended in a public installation.'
allowsscript – 'This plugin will allow execution of scripts. It should only be used when you trust ALL editors, best suited in private personal wikis.'
requirespatch – 'The plugin requires patching the DokuWiki core. Manual patches may break compatibility with other plugins and make it harder to secure your installation by upgrading to latest version.'
partlyhidden – 'Hiding parts of a DokuWiki page is not supported by the core. Most attempts to introduce ACL control for parts of a page will leak information through RSS feed, search or other core functionality.'

Of course free text could be used as well.

Pluginrepo (Table) Component

The «table» component comes in two variants, classic and a new more compact version with download buttons etc. An additional navigation feature «Jump to plugins starting with A B C..» is present for both. The new table also shows «tags» for each plugin.

The pluginrepo syntax component accepts parameters if supplied, which overrides parameters in HTTP request.

Available:

plugintype – [integer] 1, 2, 4, 8, 16, 32=templates, or combination
plugintag – [string] filter by this tag
pluginsort – [string] sort by author(a), lastupdate(d), type (t), compatibility (v), popularity (c), plugin (p) otherwise sorted by most recent compatible release. Shortcuts can be used. If results are equal then further sorted by basename.
showall – [yes] returns plugins regardless of security or obsolete status, normally skipped.
includetemplates – [yes] returns templates AND plugins, normally only plugins returned. Combine with plugintype=32 to return templates only.
showscreenshot – [yes] shows screenshot thumbnail column
showcompatible – [yes] shows latest compatible DokuWiki version column
cloudmin – [integer] needed number of occurrences for a tag to be included in navigation cloud

Example:

---- pluginrepo ----
cloudmin: 2
----

News Component

Example News

Sqlite plugin

Вспомогательный плагин для легкого доступа к базе данных SQLite.

Author: Andreas Gohr

More plugins >>

Creates a right float box with one or more featured plugin/templates. Besides the repository API, additional parameters are:

Syntax definition:

---- pluginnews -----
headline:     <headline text>
style:        <sameauthor/DEFAULT>
showscreenshot:   <yes/NO>
random:       <YES/no>
entries:      <number of plugins displayed>
link:         <internallink id>
linktext:     <internallink text>
-----

Parameters

style – sameauthor will display a list of plugins/templates by same author. Only usable in plugin/template homepages.
headline – [string] headline of the news block
link – [string] add link at bottom of the news block
linktext – [string] if combined with link, it sets the link text
entries – [int] number of plugins displayed
random – [yes], set to no to disable random picked extensions
showscreenshot – [no], set to yes to show screenshot
onlyrecent – [yes], set to no to show bundled and older than 2 releases as well

Query Component

A tool tailored for Plugins & templates team to make wiki gardening easier. The query results are displayed as a configurable table looking something like this:

Plugin	Downloadurl	Plugins WHERE author = Håkan Sandell

∑ 0 plugins matching query

Syntax definition:

---- pluginquery -----
SELECT   : <list of field names (optional)>
WHERE    : <sql where clause>
VALUES   : <list of values matching ? in where clause (optional)>
HEADLINE : <heading used instead of raw query (optional)>
-----

Allowed fields: plugin, name, description, author, email, bestcompatible, compatible, lastupdate, type, securityissue, securitywarning, updatemessage, screenshot, downloadurl, bugtracker, sourcerepo, donationurl, tags, popularity

All fields are allowed in WHERE clause together with AND, OR, NOT, NULL, LIKE, %, <, >, =, (, ). All values in where clause should be replaced by ?.

For values of bestcompatible four placeholders can be used: @DATEMOSTRECENT@, @DATESECONDMOSTRECENT@, @DATETHIRDMOSTRECENT@ and @DATEFOURTHMOSTRECENT@.

Syntax examples:

---- pluginquery -----
WHERE  : downloadurl IS null AND popularity > ?
VALUES : 400
-----

---- pluginquery -----
SELECT : author type
WHERE  : (type & ?) AND (author LIKE ?)
VALUES : 3, %Andreas Gohr%
-----

---- pluginquery -----
SELECT   : compatible
WHERE    : ?
VALUES   : 1
HEADLINE : All plugins and templates
-----

Configuration

There are some config settings for the dokuwiki.org admin

db_name – contain the DataSourceName, which consists of the PDO driver name, followed by a colon, followed by the PDO driver-specific connection syntax. See also: http://se2.php.net/manual/en/pdo.construct.php
Example: 'mysql:dbname=testdb;host=127.0.0.1' or 'sqlite:C:\DokuWikiStickNew\dokuwiki\repo.sqlite'
SQLITE2 not supported
db_user – database login username (leave blank for sqlite).
db_pass – database login password (leave blank for sqlite).
bundled – comma separated list of plugins that are bundled.
releases – comma separated list of releases (YYYY-MM-DD «<name>») newest MUST be first.

Repository plugin honors allowdebug for SQL debugging.

Дополнения и Файлы

Ссылка на оригинальную статью

worldwide open-source software - plugin:repository

api

API репозитория расширений

Команды

Форматы

Фильтры

Имя расширения

Полнотекстовый поиск

Тип

Теги

Электронная почта

Заказ

Предел

Old Repository API

manual

Руководство по плагину репозитория

Источник

Функциональность

Синтаксис

Entry Component

Pluginrepo (Table) Component

News Component

Example News

Query Component

Configuration

Дополнения и Файлы