Skip to content
Snippets Groups Projects
Commit 62de230a authored by eileen's avatar eileen :8ball: Committed by GitHub
Browse files

Remove references to legacy extension types

Originally there were different types of extensions - payment processors, reports & modules. For a long time only modules have been recommended and I feel documenting the others only adds confusion.
parent a15afc0e
No related branches found
No related tags found
No related merge requests found
......@@ -60,14 +60,6 @@ Here we describe all the elements acceptable within the XML file. They are prese
* Description: Name of the person and/or organisation maintaining the extension
* Contains: text
### `<billingMode>` {:#billingMode}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: Specifies the billing mode (aka "type") for a payment processing extension
* Contains: text
* Acceptable values: See [payment processor types](/extensions/payment-processors/create.md#type)
* Example: `button`
### `<civix>` {:#civix}
* Containing element: [`<extension>`](#extension)
......@@ -192,12 +184,6 @@ Elements acceptable within `<extension>`
* Description: The name of the file to invoke when the extension is executed (not including `.php` file extension) This file must be present in the root of the extension `.zip` file / in base directory of the extension
* Contains: text
### `<isRecur>` {:#isRecur}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<label>` {:#label}
* Containing element: [`<extension>`](#extension)
......@@ -240,18 +226,6 @@ Elements acceptable within `<maintainer>`
* Contains: text
* Example: `CRM/Volunteer`
### `<passwordLabel>` {:#passwordLabel}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: Label to use for the password field
* Contains: text
### `<paymentType>` {:#paymentType}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<psr4>` {:#psr4}
* Containing element: [`<classloader>`](#classloader)
......@@ -272,12 +246,6 @@ Attributes acceptable for `<psr4>`
* Description: The release date of the current version (use `YYYY-MM-DD` format)
* Contains: text
### `<reportUrl>` {:#reportUrl}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<requires>` {:#requires}
!!! warning "Experimental"
......@@ -305,32 +273,6 @@ Elements acceptable within `<requires>`
* Description: Label to use for the subject field
* Contains: text
### `<typeInfo>` {:#typeInfo}
* Containing element: [`<extension>`](#extension)
* Description: This is a container tag for other tags which store information that is only relevant to extensions of particular types (e.g. payment processor extensions)
* Contains: elements
Elements acceptable within `<typeInfo>`
| Element | Acceptable instances | Acceptable<br>when |
| -- | -- | -- |
| [`<billingMode>`](#billingMode) | 0 or 1 | `<extension type="payment">` |
| [`<isRecur>`](#isRecur) | 0 or 1 | `<extension type="payment">` |
| [`<passwordLabel>`](#passwordLabel) | 0 or 1 | `<extension type="payment">` |
| [`<paymentType>`](#paymentType) | 0 or 1 | `<extension type="payment">` |
| [`<reportUrl>`](#reportUrl) | 0 or 1 | `<extension type="report">` |
| [`<signatureLabel>`](#signatureLabel) | 0 or 1 | `<extension type="payment">` |
| [`<subjectLabel>`](#subjectLabel) | 0 or 1 | `<extension type="payment">` |
| [`<urlApiDefault>`](#urlApiDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlApiTestDefault>`](#urlApiTestDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlButtonDefault>`](#urlButtonDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlButtonTestDefault>`](#urlButtonTestDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlRecurDefault>`](#urlRecurDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlRecurTestDefault>`](#urlRecurTestDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlSiteDefault>`](#urlSiteDefault) | 0 or 1 | `<extension type="payment">` |
| [`<urlSiteTestDefault>`](#urlSiteTestDefault) | 0 or 1 | `<extension type="payment">` |
| [`<userNameLabel>`](#userNameLabel) | 0 or 1 | `<extension type="payment">` |
### `<url>` {:#url}
......@@ -356,61 +298,6 @@ Elements acceptable within `<urls>`
| -- | -- |
| [`<url>`](#url) | 1+ |
### `<urlSiteDefault>` {:#urlSiteDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<urlApiDefault>` {:#urlApiDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<urlRecurDefault>` {:#urlRecurDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<urlSiteDefault>` {:#urlSiteTestDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: The url to use to process live site transactions
* Contains: text
### `<urlSiteTestDefault>` {:#urlSiteTestDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: The url to use to process test site transactions
* Contains: text
### `<urlApiTestDefault>` {:#urlApiTestDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<urlRecurTestDefault>` {:#urlRecurTestDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<urlButtonDefault>` {:#urlButtonDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<urlButtonTestDefault>` {:#urlButtonTestDefault}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: *not yet documented*
* Contains: text
### `<ver>` {:#ver}
* Containing element: [`<compatibility>`](#compatibility)
......@@ -420,12 +307,6 @@ Elements acceptable within `<urls>`
!!! note
It is not currently possible to specify compatibility with point releases. If your extension is compatible with CiviCRM 4.7.21 but *not* 4.7.20, then you will need to clearly specify this in the [comments](#comments).
### `<userNameLabel>` {:#userNameLabel}
* Containing element: [`<typeInfo>`](#typeInfo)
* Description: Label to use for the username field
* Contains: text
### `<version>` {:#version}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment