diff --git a/README.md b/README.md index 98fa866..a24d097 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,42 @@ -# CiviCRM extension Twingle API[¶](https://docs.civicrm.org/twingle/en/latest/#twingle-api "Permanent link") +# Twingle API -Twingle is a payment service provider that makes it possible to create donation forms with various payment options and embed them on websites or integrate them into your homepage. Interested parties can donate via known payment options (e.g. credit card, PayPal). The procedure is also set up and optimised for mobile devices. If you want to use the Twingle fundraising service, you have to set up a corresponding online account. +Twingle is a payment service provider that makes it possible to create donation +forms with various payment options and embed them on websites or integrate them +into your homepage. Interested parties can donate via known payment options ( +e.g. credit card, PayPal). The procedure is also set up and optimised for mobile +devices. If you want to use the Twingle fundraising service, you have to set up +a corresponding online account. -For further information about Twingle fundraising follow [this link](https://www.twingle.de/). +For further information about Twingle fundraising +see the [Twingle website](https://www.twingle.de/). -Twingle as fundraising service can be connected to CiviCRM via its API with the extension **Twingle API**. +Twingle as fundraising service can be connected to CiviCRM via its API with the +extension **Twingle API**. -## What advantages does the Twingle API extension offer? +## Features -- Donations from Twingle can be automatically created in CiviCRM and assigned to existing or new contacts and administered yourself in CiviCRM. +* Donations from Twingle can be automatically created as contributions in + CiviCRM and assigned to existing or new contacts and administered in CiviCRM. +* Supporters and contacts of donations can be managed in CiviCRM. +* Donations can be submitted with different payment statuses depending on the + payment type +* SEPA mandates can be created for one-off and recurring payments. +* Donors can be added into groups for receiving newsletters, mailings and + donation receipts. +* A memberships can be set up for a donor. +* Data can be entered in user-defined fields -- Supporters and contacts of donations can be managed yourself in CiviCRM and contacts yourself. +## Configuration -- Donations can be declared as closed or open depending on the payment type - -- SEPA mandates can be created for one-off and recurring payments. - -- Donors can be entered into groups for newsletters, mailings and donation receipts. - -- A memberships can be set up for a donor. - -- Data can be entered in user-defined fields - -## How to set up the Twingle API extension - -Following the successful installation of the Twingle API extension, there is some configuration work to do in order to set up the smooth connection between CiviCRM and Twingle fundraising service. +Following the successful installation of the Twingle API extension, there is +some configuration work to do in order to set up the smooth connection between +CiviCRM and Twingle fundraising service. You have to carry out the following configuration steps: -- Creating a Twingle user and a user role in your CMS-System (Drupal, Wordpress ...) - -- Configuring the Extended Contact Matcher (XCM) in CiviCRM - -- Creating a Twingle User and an API key in CiviCRM - -- Activating the SEPA connection in CiviCRM - -- Configuring the Twingle profile in CiviCRM - -- Configuring your Twingle Account on the Twingle website - - - -The Twingle API extension is licensed under [AGPL-3.0](https://github.com/systopia/de.systopia.twingle/blob/master/LICENSE.txt). \ No newline at end of file +* Creating a Twingle user and a user role in your CMS (Drupal, Wordpress, etc.) +* Configuring the *Extended Contact Matcher (XCM)* in CiviCRM +* Creating a Twingle User and an API key in CiviCRM +* Activating the SEPA connection in CiviCRM (optional) +* Configuring the Twingle profile in CiviCRM +* Configuring your Twingle Account on the Twingle website diff --git a/docs/api_tw.md b/docs/api.md similarity index 99% rename from docs/api_tw.md rename to docs/api.md index d19af35..4165d29 100644 --- a/docs/api_tw.md +++ b/docs/api.md @@ -1,6 +1,6 @@ # API documentation -The extension provides a new CiviCRM API entity `TwingleDonation` with API +The extension provides a new CiviCRM API 3 entity `TwingleDonation` with API actions to record a new donation, end a previously submitted recurring donation and cancel previously submitted donation. @@ -84,4 +84,4 @@ The action accepts the following parameters: You may also refer to [the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Cancel.php) -for more insight into this API action. \ No newline at end of file +for more insight into this API action. diff --git a/docs/con_civi.md b/docs/con_civi.md deleted file mode 100644 index e1289a9..0000000 --- a/docs/con_civi.md +++ /dev/null @@ -1,39 +0,0 @@ -# Twingle API: Creating a Twingle User in CiviCRM - -After the installation of the Twingle API extension, various configuration steps must be carried out so that the connection functions smoothly. Among other things, certain configurations must be made regarding the general CiviCRM administration. Among other things, there must be in either case a Twingle user in the CiviCRM contacts. - -## Take over user - -The Twingle API only works correctly if a user with the name **Twingle API** exists in CiviCRM. Make sure that you have previously created the corresponding user your CMS user administration (Drupal, Wordpress ...). - -Here, the corresponding steps are described by way of example when using Drupal. - -1. In CiviCRM, go to **Administer**. - -2. In the **Users and Permissions** section, choose **Synchronize Users to Contacts**. - -![](Img/Kon_syn.jpg) - -This function checks each user record in Drupal for a contact record in CiviCRM. If there is no corresponding contact record for a user, a new one will be generated. Check this in your CiviCRM contact management. - -![](Img/civiuser_tw.jpg) - -## Assign API key for the Twingle API user - -The Twingle API user in CiviCRM needs his own API key. The API key is assigned with the help of the API Explorer in CiviCRM. - -1. Select the Twingle API user in CiviCRM. - -2. Look for the corresponding **CiviCRM ID** and remember the ID. - -3. Go to **Support/Developper/API Explorer v4**. - -4. Enter **Contact** in the entity field, **create** in action field and the **ID** of the Twingle User in the **index** field. - -5. In the values field, select **api_key**. - -6. Enter the API key for the Twingle API user in the **add value** field. - -7. Click on **Execute**. - -![](Img/apikey.jpg) diff --git a/docs/con_drup.md b/docs/con_drup.md deleted file mode 100644 index 37a4312..0000000 --- a/docs/con_drup.md +++ /dev/null @@ -1,41 +0,0 @@ -# Twingle API: Creating a Twingle user and a user roll in your CMS system - -After the installation of the Twingle API extension, various configuration steps must be carried out so that the connection functions smoothly. Among other things, certain configurations must be made on the CMS platform CiviCRM is implemented on. - -In an CMS system, administration of permissions is made easier by creating roles and assigning permissions to them rather than assigning permissions to each user. - -The Twingle API requires a user with the name Twingle API and a user role with the name Twingle API in your CMS-system. - -Here, the corresponding steps are described by way of example when using Drupal. - -## New User Role in Drupal - -1. In Drupal, go to **Administration/People/Permissions/Roles**. - -2. Type Twingle API in the text box and select **Add role**. To the right of your role there will be a *edit role* function and an *edit permissions* button. The *edit permissions* selection will show only the permission selections for the individual role. - -3. As Permission you only have to select the following entry: **Twingle API: Access Twingle API**. - -## New User Role in Wordpress - -1. In CiviCRM, go to **Administer/User and Permissions (Access Control)**. - -2. Then select the **WordPress Access Control** link. - Here you can adjust the CiviCRM settings for each of the predefined User Roles from WordPress. - -3. Scroll down. As Permission you only have to select the following entry: **Twingle API: Access Twingle API**. - - -![](Img/Twin_per.png) - -## New User in Drupal - -1. In Drupal, go to **Administration/People**. - -2. Then select **Add user**. - -3. In user name field enter **Twingle API** - -4. In the e-mail field enter either **info@example.de** or **mailtest@example.de**. - -5. In Roles select **Twingle API**. diff --git a/docs/con_man.md b/docs/con_man.md deleted file mode 100644 index d943158..0000000 --- a/docs/con_man.md +++ /dev/null @@ -1,22 +0,0 @@ -# Twingle API: Configuring the Twingle account on the Twingle website - -The use of the Twingle API extension requires that you already have a Twingle account and that you make some settings in this account for the connection. - -You will have to make the following settings: - -1. API key from your Twingle user - -2. Site key - -3. URL - -Important: The URL must always be the complete URL to the interface. -Examples: - -- Drupal: https://meine-domain.de/sites/all/modules/civicrm/extern/rest.php -- Wordpress (with CiviCRM <5.25): https://meine-domain.de/wp-content/plugins/civicrm/civicrm/extern/rest.php -- Wordpress (with CiviCRM 5.25+): https://meine-domain.de/wp-json/civicrm/v3/rest - - - -[For detailled information please follow this link](https://support.twingle.de/faq/de-de/9-anbindung-externer-systeme/46-wie-kann-ich-civicrm-mit-twingle-nutzen) (in German language only). diff --git a/docs/con_tw.md b/docs/con_tw.md deleted file mode 100644 index 470b36c..0000000 --- a/docs/con_tw.md +++ /dev/null @@ -1,31 +0,0 @@ -# Configuring the Twingle Profile in CiviCRM - -After the installation of the Twingle API extension, various configuration steps must be carried out so that the connection functions smoothly. Among other things, you have to make some settings in the Twingle Profile in CiviCRM. - -1. In CiviCRM, go to **Administer**. - -2. Choose **Twingle API configuration**. - - ![](Img/Konso.jpg) - -3. Then click on **Configure profiles**. - - ![](Img/SepaKon.jpg) - -4. The Twingle configuration is always done with the help of a profile. Please use the Twingle default profile and click on **Edit**. - - ![](Img/Prof.jpg) - -5. Then you will identify the Twingle API profile window. Start by entering the corresponding information in the **General settings** section. - - ![](Img/GenSet.jpg) - -6. Define the different payment methods in the Payments section. - - ![](Img/twpay.jpg) - -7. Make the settings for the groups. - - ![](Img/Twgrou.jpg) - -8. When you have made all the settings, please press the **Save** button. diff --git a/docs/con_twse.md b/docs/con_twse.md deleted file mode 100644 index aaf7f4c..0000000 --- a/docs/con_twse.md +++ /dev/null @@ -1,25 +0,0 @@ -# Activating SEPA for the Twingle API extension in CiviCRM - -After the installation of the extension, various configuration steps must be carried out so that the connection functions smoothly. If you would like to create and manage the SEPA mandates yourself for the one-off and recurring payments with CiviCRM, you have to make some settings regarding the SEPA connection. - -1. In CiviCRM, go to **Administer**. - -2. Choose **Twingle API configuration**. - - ![](Img/Konso.jpg) - -3. Then click on **Configure extension settings**. - - ![](Img/SepaKon.jpg) - -4. Tick the boxes **Use CiviSEPA** and **Use CiviSEPA generated reference**. - These options can only be activated if CiviSEPA is installed and used. If it is not activated, the administration of SEPA mandates takes place in Twingle. - -5. Write **TW-** in the **Twingle ID Prefix** field. - To avoid overlaps when assigning CiviCRM IDs and Twingle transaction IDs, a prefix should be assigned here, e.g. "TWNGL" or "Twingle" or similar. - Attention: The prefix should not be changed later, otherwise problems may occur. - -6. In the **Protect Recurring Contributions** field select **No**. - If you choose Yes, all recurring donations created by Twingle can no longer be changed in CiviCRM, but must then be changed accordingly in Twingle. If no recurring payments are processed via Twingle, but only one-off donations, then this does not need to be activated. Otherwise, we strongly recommend setting the button here to **Yes** so that there are no discrepancies between CiviCRM and Twingle. - - ![](Img/Sepa.jpg) diff --git a/docs/con_xcm.md b/docs/con_xcm.md deleted file mode 100644 index 0087ca1..0000000 --- a/docs/con_xcm.md +++ /dev/null @@ -1,59 +0,0 @@ -# Twingle API: Configuring the Extended Contact Manager extension (XCM) - -After the installation of the Twingle API extension, various configuration steps must be carried out so that the connection functions smoothly. Twingle API works only correctly when you have previously installed the Extended Contact Manager extension (XCM). - -Taking over contact data using the Twingle API means that they may produce duplicates in your CiviCRM contact management. Before contacts are added or updated in CiviCRM a data check should take place to avoid this problem. This data check is handled by the Extended Contact Manager extension (XCM). This extension must be configured accordingly for use with Twingle by defining a corresponding profile. - -## Creating a Twingle Profile - -Your first task regarding the Extended Contact Manager extension (XCM) configuration will be to create a corresponding Twinge profile. This works best if you copy the Default profile. - -1. In CiviCRM, go to **Administer**. - -2. Select **Xtended Contact Matcher (XCM) Configuration** in the **System Settings** section. - -![](Img/XCMAdmin.jpg) - -3. Click on **Copy** in the **Default** profile. - -4. Rename the new profile with **Twingle** in the **Profile name** field. - -![](Img/ProNam.jpg) - -5. Click **Save** at the bottom of this window. In the Profiles overview you can find your new Twingle profile. - -![](Img/XCM_Profile.jpg) - -## Set up the Extended Contact Manager extension (XCM) - -After you have created the Twingle profile, you must enter the configuration settings for the Twingle connection to CiviCRM in this profile. Generally, you will find a description of all the settings in the [Extended Contact Manager (XCM) documentation](https://docs.civicrm.org/xcm/en/latest/configuration/). - -Here you will find as support screenshots of the various sections of the Extended Contact Manager extension (XCM). The settings are only an example. Please adapt the settings to your individual requirements or environnement. - -#### General section - -![](Img/XCMGen.jpg) - -#### Update section - -![](Img/XCMUpda.jpg) - -#### Assignment rules section - -![](Img/XCMReg.jpg) - -#### Identified contacts section - -![](Img/XCMIde.jpg) - -#### New contact section - -![](Img/XCMNeu.jpg) - -#### Duplicate section - -![](Img/XCMDup.jpg) - -#### Difference Handling section - -![](Img/xcmdif.jpg) diff --git a/docs/configuration/account.md b/docs/configuration/account.md new file mode 100644 index 0000000..c141036 --- /dev/null +++ b/docs/configuration/account.md @@ -0,0 +1,27 @@ +# Twingle account settings on the Twingle website + +The use of the Twingle API extension requires that you already have a Twingle +account and that you make some settings in this account for the connection. + +You will have to provide the following settings in your Twingle account settings +in order to send donations to CiviCRM: + +1. API key from your Twingle user +2. Site key +3. URL + +Important: The URL must always be the complete URL to the CiviCRM REST API +endpoint. +Examples: + +- Drupal (with the *AuthX* extension): https://example.org/civicrm/ajax/rest +- Drupal (legacy + method): https://example.org/sites/all/modules/civicrm/extern/rest.php +- Wordpress (with CiviCRM < + 5.25): https://example.org/wp-content/plugins/civicrm/civicrm/extern/rest.php +- Wordpress (with CiviCRM + 5.25+): https://example.org/wp-json/civicrm/v3/rest + +For detailled information, please see +the [Twingle documentation](https://support.twingle.de/faq/de-de/9-anbindung-externer-systeme/46-wie-kann-ich-civicrm-mit-twingle-nutzen) ( +in German language only). diff --git a/docs/configuration/civisepa.md b/docs/configuration/civisepa.md new file mode 100644 index 0000000..28dbef2 --- /dev/null +++ b/docs/configuration/civisepa.md @@ -0,0 +1,32 @@ +# Activating CiviSEPA integration + +The Twingle API extension provides integration with the [ +*CiviSEPA*](https://civicrm.org/extensions/civisepa-sepa-direct-debit-extension) +extension. This allows for managing SEPA mandates and collections with +*CiviSEPA* for donations being initiated via a *Twingle* form. + +1. In CiviCRM, go to **Administer**. +2. Choose **Twingle API configuration**. + ![](../img/Konso.jpg) + +3. Then click on **Configure extension settings**. + ![](../img/SepaKon.jpg) + +4. Tick the boxes **Use CiviSEPA** and **Use CiviSEPA generated reference**. + These options can only be activated if CiviSEPA is installed and used. If it + is not activated, the administration of SEPA mandates will have to take place + in Twingle, which is subject to configuration of your available payment + methods. +5. Write **TW-** in the **Twingle ID Prefix** field. + To avoid overlaps when assigning CiviCRM IDs and Twingle transaction IDs, a + prefix should be assigned here, e.g. "TWNGL" or "Twingle" or similar. + Attention: The prefix should not be changed later, otherwise problems may + occur. +6. In the **Protect Recurring Contributions** field select **No**. + If you choose Yes, all recurring donations created by Twingle can no longer + be changed in CiviCRM, but must then be changed accordingly in Twingle. If no + recurring payments are processed via Twingle, but only one-off donations, + then this does not need to be activated. Otherwise, we strongly recommend + setting the button here to **Yes** so that there are no discrepancies between + CiviCRM and Twingle. + ![](../img/Sepa.jpg) diff --git a/docs/configuration/profiles.md b/docs/configuration/profiles.md new file mode 100644 index 0000000..34612c1 --- /dev/null +++ b/docs/configuration/profiles.md @@ -0,0 +1,30 @@ +# Configuring the Twingle Profile in CiviCRM + +The Twingle API extension is being configured through configuration profiles. +This allows you to have different sets of configuration, as you might want to +handle donation submissions differently, depending on which form was used. +Each profile can react to one ore more form IDs being submitted along with +donation data. + +1. In CiviCRM, go to **Administer**. +2. Choose **Twingle API configuration**. + ![](../img/Konso.jpg) + +3. Then click on **Configure profiles**. + ![](../img/SepaKon.jpg) + +4. The Twingle configuration is always done with the help of a profile. Please + use the Twingle default profile and click on **Edit**. + ![](../img/Prof.jpg) + +5. Then you will identify the Twingle API profile window. Start by entering the + corresponding information in the **General settings** section. + ![](../img/GenSet.jpg) + +6. Define the different payment methods in the Payments section. + ![](../img/twpay.jpg) + +7. Make the settings for the groups. + ![](../img/Twgrou.jpg) + +8. When you have made all the settings, please press the **Save** button. diff --git a/docs/configuration/user_permissions.md b/docs/configuration/user_permissions.md new file mode 100644 index 0000000..68e81ef --- /dev/null +++ b/docs/configuration/user_permissions.md @@ -0,0 +1,82 @@ +# User, permissions, and API authentication + +After the installation of the Twingle API extension, various configuration steps +must be carried out so that the connection functions smoothly. Among other +things, certain configurations must be made on the CMS platform CiviCRM is +implemented on. + +Connecting to the Twingle API via CiviCRM's REST interface requires a user with +appropriate permissions in your CMS-system. + +You might want to create a specific user role to assign permissions necessary +for calling the Twingle API only. This section describes how to accomplish this +in *Drupal* and *Wordpress*: + +## New User Role in Drupal + +1. In Drupal, go to **Administration/People/Permissions/Roles**. +2. Type Twingle API in the text box and select **Add role**. To the right of + your role there will be a *edit role* function and an *edit permissions* + button. The *edit permissions* selection will show only the permission + selections for the individual role. +3. As Permission you only have to select the following entry: **Twingle API: + Access Twingle API**. + +## New User Role in Wordpress + +1. In CiviCRM, go to **Administer/User and Permissions (Access Control)**. +2. Then select the **WordPress Access Control** link. + Here you can adjust the CiviCRM settings for each of the predefined User + Roles from WordPress. +3. Scroll down. As Permission you only have to select the following entry: * + *Twingle API: Access Twingle API**. + +![](../img/Twin_per.png) + +## New User in Drupal + +1. In Drupal, go to **Administration/People**. +2. Then select **Add user**. +3. In user name field enter something like **Twingle API** +5. In Roles select **Twingle API**. + +## Take over user + +The Twingle API only works correctly if a contact connected to the permissioned +user exists in CiviCRM. + +Here, the corresponding steps are described by way of example when using Drupal. + +1. In CiviCRM, go to **Administer**. +2. In the **Users and Permissions** section, choose **Synchronize Users to + Contacts**. + +![](../img/Kon_syn.jpg) + +This function checks each user record in Drupal for a contact record in CiviCRM. +If there is no corresponding contact record for a user, a new one will be +generated. Check this in your CiviCRM contact management. + +![](../img/civiuser_tw.jpg) + +## Assign API key for the Twingle API user + +The Twingle API contact in CiviCRM needs their own API key for authenticating +against CiviCRM's REST API endpoint. The API key is assigned with the help of +the API Explorer in CiviCRM. + +1. Select the Twingle API contact in CiviCRM. +2. Look for the corresponding **CiviCRM ID** and remember the ID. +3. Go to **Support/Developper/API Explorer v4**. +4. Enter **Contact** in the entity field, **create** in action field and the + **ID** of the Twingle User in the **index** field. +5. In the values field, select **api_key**. +6. Enter the API key for the Twingle API user in the **add value** field. +7. Click on **Execute**. + +![](../img/apikey.jpg) + +!!!note + You can also create API keys for contacts by using the [*API + Key*](https://civicrm.org/extensions/api-key) extension or with administrator + tools like *cv* or *drush*. diff --git a/docs/configuration/xcm.md b/docs/configuration/xcm.md new file mode 100644 index 0000000..87d36e5 --- /dev/null +++ b/docs/configuration/xcm.md @@ -0,0 +1,75 @@ +# Configuring the Extended Contact Manager extension (XCM) + +After the installation of the Twingle API extension, various configuration steps +must be carried out so that the connection functions smoothly. Twingle API +depends on the *Extended Contact Manager (XCM)* extension. + +Taking over contact data using the Twingle API means that they may produce +duplicates in your CiviCRM contact management. Before contacts are added or +updated in CiviCRM a data check should take place to avoid this problem. This +data check is handled by the *Extended Contact Manager (XCM)* extension. This +extension must be configured accordingly for use with Twingle by defining a +corresponding profile. + +## Creating an XCM Profile + +Your first task regarding the Extended Contact Manager extension (XCM) +configuration will be to create an XCM profile to be used for the Twingle API. +This works best if you copy the *Default* profile. + +1. In CiviCRM, go to **Administer**. + +2. Select **Xtended Contact Matcher (XCM) Configuration** in the **System + Settings** section. + +![](../img/XCMAdmin.jpg) + +3. Click on **Copy** in the **Default** profile. + +4. Rename the new profile with **Twingle** in the **Profile name** field. + +![](../img/ProNam.jpg) + +5. Click **Save** at the bottom of this window. In the Profiles overview you can + find your new Twingle profile. + +![](../img/XCM_Profile.jpg) + +## Set up the Extended Contact Manager extension + +After you have created the XCM profile, you must enter the configuration +settings for the Twingle connection to CiviCRM in this profile. Generally, you +will find a description of all the settings in +the [Extended Contact Manager (XCM) documentation](https://docs.civicrm.org/xcm/en/latest/configuration/). + +Here you will find as support screenshots of the various sections of the +Extended Contact Manager extension (XCM). The settings are only an example. +Please adapt the settings to your individual requirements or environnement. + +#### General section + +![](../img/XCMGen.jpg) + +#### Update section + +![](../img/XCMUpda.jpg) + +#### Assignment rules section + +![](../img/XCMReg.jpg) + +#### Identified contacts section + +![](../img/XCMIde.jpg) + +#### New contact section + +![](../img/XCMNeu.jpg) + +#### Duplicate section + +![](../img/XCMDup.jpg) + +#### Difference Handling section + +![](../img/xcmdif.jpg) diff --git a/docs/Img/GenSet.jpg b/docs/img/GenSet.jpg similarity index 100% rename from docs/Img/GenSet.jpg rename to docs/img/GenSet.jpg diff --git a/docs/Img/Kon_syn.jpg b/docs/img/Kon_syn.jpg similarity index 100% rename from docs/Img/Kon_syn.jpg rename to docs/img/Kon_syn.jpg diff --git a/docs/Img/Konso.jpg b/docs/img/Konso.jpg similarity index 100% rename from docs/Img/Konso.jpg rename to docs/img/Konso.jpg diff --git a/docs/Img/NewUser_Tw.jpg b/docs/img/NewUser_Tw.jpg similarity index 100% rename from docs/Img/NewUser_Tw.jpg rename to docs/img/NewUser_Tw.jpg diff --git a/docs/Img/ProNam.jpg b/docs/img/ProNam.jpg similarity index 100% rename from docs/Img/ProNam.jpg rename to docs/img/ProNam.jpg diff --git a/docs/Img/Prof.jpg b/docs/img/Prof.jpg similarity index 100% rename from docs/Img/Prof.jpg rename to docs/img/Prof.jpg diff --git a/docs/Img/Role_Twingle.jpg b/docs/img/Role_Twingle.jpg similarity index 100% rename from docs/Img/Role_Twingle.jpg rename to docs/img/Role_Twingle.jpg diff --git a/docs/Img/Sepa.jpg b/docs/img/Sepa.jpg similarity index 100% rename from docs/Img/Sepa.jpg rename to docs/img/Sepa.jpg diff --git a/docs/Img/SepaKon.jpg b/docs/img/SepaKon.jpg similarity index 100% rename from docs/Img/SepaKon.jpg rename to docs/img/SepaKon.jpg diff --git a/docs/Img/Twgrou.jpg b/docs/img/Twgrou.jpg similarity index 100% rename from docs/Img/Twgrou.jpg rename to docs/img/Twgrou.jpg diff --git a/docs/Img/Twin_per.png b/docs/img/Twin_per.png similarity index 100% rename from docs/Img/Twin_per.png rename to docs/img/Twin_per.png diff --git a/docs/Img/XCMAdmin.jpg b/docs/img/XCMAdmin.jpg similarity index 100% rename from docs/Img/XCMAdmin.jpg rename to docs/img/XCMAdmin.jpg diff --git a/docs/Img/XCMAkt.jpg b/docs/img/XCMAkt.jpg similarity index 100% rename from docs/Img/XCMAkt.jpg rename to docs/img/XCMAkt.jpg diff --git a/docs/Img/XCMDup.jpg b/docs/img/XCMDup.jpg similarity index 100% rename from docs/Img/XCMDup.jpg rename to docs/img/XCMDup.jpg diff --git a/docs/Img/XCMGen.jpg b/docs/img/XCMGen.jpg similarity index 100% rename from docs/Img/XCMGen.jpg rename to docs/img/XCMGen.jpg diff --git a/docs/Img/XCMIde.jpg b/docs/img/XCMIde.jpg similarity index 100% rename from docs/Img/XCMIde.jpg rename to docs/img/XCMIde.jpg diff --git a/docs/Img/XCMNeu.jpg b/docs/img/XCMNeu.jpg similarity index 100% rename from docs/Img/XCMNeu.jpg rename to docs/img/XCMNeu.jpg diff --git a/docs/Img/XCMPro.jpg b/docs/img/XCMPro.jpg similarity index 100% rename from docs/Img/XCMPro.jpg rename to docs/img/XCMPro.jpg diff --git a/docs/Img/XCMReg.jpg b/docs/img/XCMReg.jpg similarity index 100% rename from docs/Img/XCMReg.jpg rename to docs/img/XCMReg.jpg diff --git a/docs/Img/XCMUpda.jpg b/docs/img/XCMUpda.jpg similarity index 100% rename from docs/Img/XCMUpda.jpg rename to docs/img/XCMUpda.jpg diff --git a/docs/Img/XCM_Profile.jpg b/docs/img/XCM_Profile.jpg similarity index 100% rename from docs/Img/XCM_Profile.jpg rename to docs/img/XCM_Profile.jpg diff --git a/docs/Img/apikey.jpg b/docs/img/apikey.jpg similarity index 100% rename from docs/Img/apikey.jpg rename to docs/img/apikey.jpg diff --git a/docs/Img/civiuser_tw.jpg b/docs/img/civiuser_tw.jpg similarity index 100% rename from docs/Img/civiuser_tw.jpg rename to docs/img/civiuser_tw.jpg diff --git a/docs/Img/twpay.jpg b/docs/img/twpay.jpg similarity index 100% rename from docs/Img/twpay.jpg rename to docs/img/twpay.jpg diff --git a/docs/Img/xcmdif.jpg b/docs/img/xcmdif.jpg similarity index 100% rename from docs/Img/xcmdif.jpg rename to docs/img/xcmdif.jpg diff --git a/docs/install_tw.md b/docs/install_tw.md deleted file mode 100644 index 9f90aec..0000000 --- a/docs/install_tw.md +++ /dev/null @@ -1,12 +0,0 @@ -# Installation Twingle API - -You can find an official release archive from the [release page](https://github.com/systopia/de.systopia.twingle). - -1. First, download and then unpack the archive and move the directory into your CiviCRM extensions folder (e.g., `.../civicrm/ext/`. - If you don't know where your extensions folder is, just have a look in your CiviCRM settings ( **Administer**/**System Settings**/**Directories**)). -2. Next, open the extensions page in the CiviCRM settings (**Administer**/**System Settings**/**Extensions**). -3. Find the extension Twingle API in the *Extensions* tab and click on **Install**. The extension will be set up. - -## Extended Contact Matcher (XCM) - -Please note that for the correct working of Twingle API you still need to install the extension Extended Contact Matcher (XCM). You can find the corresponding information therefore [here](https://docs.civicrm.org/xcm/en/latest/). diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..352a50f --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,19 @@ +# Installation + +You can find an official release archive from +the [release page](https://github.com/systopia/de.systopia.twingle). + +1. First, download and then unpack the archive and move the directory into your + CiviCRM extensions folder (e.g.,`.../civicrm/ext/`. + If you don't know where your extensions folder is, just have a look in your + CiviCRM settings ( **Administer**/**System Settings**/**Directories**)). +2. Next, open the extensions page in the CiviCRM settings (**Administer**/* + *System Settings**/**Extensions**). +3. Find the extension Twingle API in the*Extensions*tab and click on**Install**. + The extension will be set up. + +## Extended Contact Matcher (XCM) + +Please note that for the correct working of Twingle API you still need to +install the extension Extended Contact Matcher (XCM), see +the [documentation](https://docs.civicrm.org/xcm). diff --git a/mkdocs.yml b/mkdocs.yml index d6d4222..6fe26ca 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,28 +1,32 @@ site_name: Twingle API -theme: +theme: name: material nav: -- Home: index.md -- Installation: install_tw.md -- Configuration: - - Creating a Twingle user in the CMS system: con_drup.md - - Configuring the Extended Contact Manager extension: con_xcm.md - - Creating a Twingle user in CiviCRM: con_civi.md - - Activating SEPA for the Twingle API extension in CiviCRM: con_twse.md - - Configuring the Twingle Profile in CiviCRM: con_tw.md - - Configuring the Twingle Account on the Twingle website: con_man.md - - API documentation: api_tw.md + - Introduction: index.md + - Installation: installation.md + - Configuration: + - User, permissions and API authentication: configuration/user_permissions.md + - Extended Contact Manager (XCM) extension: configuration/xcm.md + - CiviSEPA integration: configuration/civisepa.md + - Twingle Profiles: configuration/profiles.md + - Configuring the Twingle Account on the Twingle website: configuration/account.md + - API documentation: api.md markdown_extensions: -- attr_list -- admonition -- def_list -- codehilite -- toc: - permalink: true -- pymdownx.superfences -- pymdownx.inlinehilite -- pymdownx.tilde -- pymdownx.betterem -- pymdownx.mark + - attr_list + - admonition + - def_list + - pymdownx.highlight: + guess_lang: false + - toc: + permalink: true + - pymdownx.superfences + - pymdownx.inlinehilite + - pymdownx.tilde + - pymdownx.betterem + - pymdownx.mark + +plugins: + - search: + lang: en \ No newline at end of file