plugin:repository
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:repository [2013-04-08 20:44] – Klap-in | plugin:repository [2024-02-06 14:13] (current) – andi | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | The DokuWiki | + | This plugin is the counterpart of the [[extension|extension manager]]. It manages [[: |
+ | |||
+ | (A plugin similar to this one but with more flexibility, | ||
===== Plugins Entry ===== | ===== Plugins Entry ===== | ||
Line 18: | Line 20: | ||
conflicts | conflicts | ||
similar | similar | ||
- | screenshot_img : http://< | ||
tags : example, sample | tags : example, sample | ||
- | downloadurl: | + | downloadurl: |
- | bugtracker : http:// | + | bugtracker : https:// |
- | sourcerepo : http:// | + | sourcerepo : https:// |
donationurl: | donationurl: | ||
+ | |||
+ | screenshot_img : http://< | ||
---- | ---- | ||
</ | </ | ||
- | The info is stored in a database and used to build a dynamic repository browser (at [[plugins]]). | + | The info is stored in a database and used to build a dynamic repository browser (see the [[:plugins]] |
About the fields: | About the fields: | ||
Line 36: | Line 39: | ||
* **email** -- email address of the plugin' | * **email** -- email address of the plugin' | ||
* **type** -- one or more of the plugin types (syntax, action, admin, helper, render) | * **type** -- one or more of the plugin types (syntax, action, admin, helper, render) | ||
- | * **lastupdate** -- date when newest version of the plugin was provided, in YYYY-MM-DD format | + | * **lastupdate** -- date when newest version of the plugin was provided, in YYYY-MM-DD format, it is used for automated update checking by the [[plugin: |
- | * **compatible** -- give the DokuWiki version(s) your plugin is [[: | + | * **updatemessage** -- show message to inform users about update, visible in Extension Manager |
+ | * **compatible** -- give the DokuWiki version(s) your plugin is [[: | ||
+ | * Use a plus sign ''**+**'' if you think it's safe to assume that the plugin will be compatible with future releases of DokuWiki. | ||
+ | * Use an exclamation mark '' | ||
* **depends** -- comma separated list of plugin dependencies if any | * **depends** -- comma separated list of plugin dependencies if any | ||
* **conflicts** -- comma separated list of plugins/ | * **conflicts** -- comma separated list of plugins/ | ||
Line 43: | Line 49: | ||
* **tags** -- categorize your plugin here. If '' | * **tags** -- categorize your plugin here. If '' | ||
* **screenshot_img** -- image url to characteristic screenshot of plugin/ | * **screenshot_img** -- image url to characteristic screenshot of plugin/ | ||
- | * **securitywarning** -- use this field to warn about inherent security problems with the plugin. Ability to execute arbitrary script could be a reason | + | * **securitywarning** -- use this field to warn about inherent security problems with the plugin. Ability to execute arbitrary script could be a reason |
* **securityissue** -- only add this field when there is a [[devel: | * **securityissue** -- only add this field when there is a [[devel: | ||
* **downloadurl** -- this should be the direct URL to the download compatible with the most current release | * **downloadurl** -- this should be the direct URL to the download compatible with the most current release | ||
Line 64: | Line 70: | ||
conflicts | conflicts | ||
similar | similar | ||
- | screenshot_img: | ||
tags : example, sample | tags : example, sample | ||
- | downloadurl | + | downloadurl |
- | bugtracker | + | bugtracker |
- | sourcerepo | + | sourcerepo |
donationurl | donationurl | ||
+ | |||
+ | screenshot_img: | ||
---- | ---- | ||
</ | </ | ||
- | The info is stored in a database and used to build a dynamic repository browser (at [[plugins]]). | + | The info is stored in a database and used to build a dynamic repository browser (see the [[:template]] listing or the [[plugin: |
About the fields: | About the fields: | ||
Line 81: | Line 88: | ||
* **author** -- the template' | * **author** -- the template' | ||
* **email** -- email address of the template' | * **email** -- email address of the template' | ||
- | * **lastupdate** -- date when newest version of the template was provided, in YYYY-MM-DD format | + | * **lastupdate** -- date when newest version of the template was provided, in YYYY-MM-DD format, it is used for automated update checking by the [[plugin: |
+ | * **updatemessage** -- show message to inform users about update, visible in Extension Manager | ||
* **compatible** -- give the DokuWiki version(s) your template is compatible to. Multiple versions can be given and code names can be used. Eg: 2009-02-14, lemming, anteater | * **compatible** -- give the DokuWiki version(s) your template is compatible to. Multiple versions can be given and code names can be used. Eg: 2009-02-14, lemming, anteater | ||
* **depends** -- comma separated list of template dependencies if any | * **depends** -- comma separated list of template dependencies if any | ||
Line 95: | Line 103: | ||
* **donationurl** -- a link to paypal, an Amazon wishlist or similar thing where people can donate to you, leave empty if none available | * **donationurl** -- a link to paypal, an Amazon wishlist or similar thing where people can donate to you, leave empty if none available | ||
- | ===== Repository Plugin Manual | + | ===== Security warning: predefined shortcuts |
- | The [[: | + | The security warning field allows usage of some predefined shortcuts. The following table shows the actually defined shortcuts and their meaning: |
+ | |||
+ | ^ Shortcut | ||
+ | | **informationleak** | ||
+ | | **allowsscript** | ||
+ | | **requirespatch** | ||
+ | | **partlyhidden** | ||
+ | |||
+ | An example for the **partlyhidden** security warning can be viewed at the [[plugin: | ||
+ | |||
+ | ===== Repository Plugin Manual and API ===== | ||
+ | |||
+ | The [[: | ||
+ | |||
+ | The [[:plugin:repository:api|API doc]] describes how to query the plugin info from remote. | ||
Line 103: | Line 125: | ||
When a new release candidate is available please update the plugin homepage with appropriate compatibility, | When a new release candidate is available please update the plugin homepage with appropriate compatibility, | ||
+ | |||
+ | |||
+ |
plugin/repository.1365446692.txt.gz · Last modified: 2013-04-08 20:44 by Klap-in