From c088ea9698f5164542761078b501a6b426262bf7 Mon Sep 17 00:00:00 2001 From: Sean Madsen <sean@seanmadsen.com> Date: Fri, 11 Aug 2017 22:32:02 -0600 Subject: [PATCH] Document more tags in info.xml - `<classloader>` - `<psr4>` - `<requires>` - `<ext>` I don't know what these do, so I just added them with "not yet documented" --- docs/extensions/info-xml.md | 47 +++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/docs/extensions/info-xml.md b/docs/extensions/info-xml.md index 3d930e4b..5478d3c8 100644 --- a/docs/extensions/info-xml.md +++ b/docs/extensions/info-xml.md @@ -78,6 +78,18 @@ Elements acceptable within `<civix>` | -- | -- | | [`<namespace>`](#namespace) | 1 | +### `<classloader>` {:#classloader} + +* Containing element: [`<extension>`](#extension) +* Description: *not yet documented* +* Contains: elements + +Elements acceptable within `<classloader>` + +| Element | Acceptable instances | +| -- | -- | +| [`<psr4>`](#psr4) | ? | + ### `<comments>` {:#comments} * Containing element: [`<extension>`](#extension) @@ -127,6 +139,13 @@ Elements acceptable within `<compatibility>` * Description: The maintainer's email address * Contains: text +### `<ext>` {:#ext} + +* Containing element: [`<requires>`](#requires) +* Description: Specifies the unique name of one extension on which this extension is dependent. +* Contains: text +* Example: `org.civicrm.shoreditch` + ### `<extension>` {:#extension} * Containing element: None. This is the root element of `info.xml`. @@ -145,6 +164,7 @@ Elements acceptable within `<extension>` | Element | Acceptable instances | Acceptable<br>when | | -- | -- | -- | | [`<civix>`](#civix) | 0 or 1 | | +| [`<classloader>`](#classloader) | 0 or 1 | | | [`<compatibility>`](#compatibility) | 1 | | | [`<comments>`](#comments) | 0 or 1 | | | [`<description>`](#description) | 1 | | @@ -156,6 +176,7 @@ Elements acceptable within `<extension>` | [`<maintainer>`](#maintainer) | 1 | | | [`<name>`](#name)| 1 | | | [`<releaseDate>`](#releaseDate) | 1 | | +| [`<requires>`](#requires) | 0 or 1 | | | [`<typeInfo>`](#typeInfo) | 0 or 1 | | | [`<urls>`](#urls) | 1 | | | [`<version>`](#version) | 1 | | @@ -226,6 +247,20 @@ Elements acceptable within `<maintainer>` * Description: *not yet documented* * Contains: text +### `<psr4>` {:#psr4} + +* Containing element: [`<classloader>`](#classloader) +* Description: *not yet documented* +* Contains: nothing — should be empty + +Attributes acceptable for `<psr4>` + +| Attribute | Contains | Purpose | +| -- | -- | -- | +| `prefix` | text | *Not yet documented* | +| `path` | text | *Not yet documented* | + + ### `<releaseDate>` {:#releaseDate} * Containing element: [`<extension>`](#extension) @@ -238,6 +273,18 @@ Elements acceptable within `<maintainer>` * Description: *not yet documented* * Contains: text +### `<requires>` {:#requires} + +* Containing element: [`<extension>`](#extension) +* Description: Used to to specify other extension on which this extension is dependent +* Contains: elements + +Elements acceptable within `<requires>` + +| Element | Acceptable instances | +| -- | -- | +| [`<ext>`](#ext) | 1+ | + ### `<signatureLabel>` {:#signatureLabel} * Containing element: [`<typeInfo>`](#typeInfo) -- GitLab