Commit ee2a11a0 authored by MikeyMJCO's avatar MikeyMJCO
Browse files

Fix docs links and images.

parent 82c1d21d
......@@ -16,12 +16,12 @@ In this chapter we will briefly discuss the forms and screens you need to go thr
Once you installed the **Form Processor** extension you will have an additional option in the **Administer>Automation>Form processors** option which will lead you the the first view of all the form processors in your installation.
This will be empty if you just installed the extension.
![Form Processors Page](/images/init-form.png)
![Form Processors Page](./img/init-form.png)
## New Form Processor - define form processor
On this page you can click on the **New Form Processor** button to create a new form processor. If you do this you will see a form like the one below:
![New Form Processor](/images/new-processor.png)
![New Form Processor](./img/new-processor.png)
On the top of the form you can see that there are **two** tabs:
......@@ -47,7 +47,7 @@ In the top part of the form you can enter the general form processor information
It will look something like this:
![Top part of the form](/images/new_first.png)
![Top part of the form](./img/new_first.png)
### Input fields on your form processor
......@@ -57,11 +57,11 @@ For each field you can select the type of field (short text, numeric no decimal,
Adding the input field for the *email* will probably have to look like this:
![Input field for email](/images/new-input-email.png)
![Input field for email](/./img/new-input-email.png)
Once I have added all the fields (and as you can see I have added the validation that first and last name should at least have 3 characters) the list will look like this:
![List of input fields](/images/new-list-input-fields.png)
![List of input fields](./img/new-list-input-fields.png)
What I have done now is specify that I expect my form to show 3 fields for the website visitor to enter: First Name, Last Name and Email.
......@@ -73,7 +73,7 @@ We do that by adding *actions* to the form processor.
So in our example, we should find a contact by the email. Next the contact found should be added to the newsletter group.
Initially the part of the form where we can specify actions will look like this:
![Action part of the form](/images/new-action-part.png)
![Action part of the form](./img/new-action-part.png)
If you click on the action select box you will get a list of actions that are already available because some of the funding organizations needed that action.
As time goes by and more people start using and enhancing the [**Action Provider** extension][actionproviderrepo], the list will grow.
......@@ -83,12 +83,12 @@ As time goes by and more people start using and enhancing the [**Action Provider
In this example we have a first step: find the contact with the data from the form.
![Find contact action](/images/action-find-contact.png)
![Find contact action](./img/action-find-contact.png)
Once I have found the contact it should be added to the newsletter group.
If I select the *add to group* action I can select the group and specify that I want to use the contact ID found in the previous action:
![Add to newsletter group action](/images/action-add-to-group.png)
![Add to newsletter group action](./img/action-add-to-group.png)
## New Form Processor - retrieval of defaults
......@@ -97,14 +97,14 @@ We could pass a parameter (a checksum for example) in the URL of the form and ba
This can be specified in the *Retrieval of defaults* tab. Once I have ticked the *Enable default data retrieval?* option I will see a form like this:
![New retrieval of defaults](/images/new-retrieval.png)
![New retrieval of defaults](./img/new-retrieval.png)
As you can see the input fields from my form processor have already been loaded.
I can specify here what criteria I want to use, in this example I have specified a short text named *checksum*.
At the *retrieval methods* part I can select how I want to retrieve my data.
Here I would like an action called *Find contact with checksum*. Unfortunately that is not available yet because it has not been developed yet, but you get the gist.
And it will be developed in the section [Email Preferences](email-preferences.md).
And it will be developed in the section [Email Preferences](./email-preferences.md).
For each of my input fields I can finally specify what data should be loaded here, which should come from the result of my action.
......@@ -115,7 +115,7 @@ For each of my input fields I can finally specify what data should be loaded her
At the bottom of the form where you edit or create your form processor there is also a bit about an *output handler*:
![Output Handler](/images/output-handler.png)
![Output Handler](./img/output-handler.png)
This gives you the option to manipulate the output that is sent back to the public website once all the actions have been executed.
If you do not specify anything, the default value of *send everything* then all the data involved is sent back (inputs, output from actions etc.).
......@@ -127,9 +127,9 @@ If you click on the *Retrieval of defaults* tab in the **New Form Processor** fo
And that is all! A form to be used without coding. Once I saved the form processor I can see at the top of the form what API action I can use:
![API to be used](/images/api-to-be-used.png)
![API to be used](./img/api-to-be-used.png)
So far the basic concept. Obviously the public website part needs to be done too, check the [Example Sign Up Newsletter](sign-up-newsletter.md) section for that part, this section just covers the basis principles.
So far the basic concept. Obviously the public website part needs to be done too, check the [Example Sign Up Newsletter](./sign-up-newsletter.md) section for that part, this section just covers the basis principles.
[actionproviderrepo]:https://lab.civicrm.org/extensions/action-provider
......
......@@ -22,7 +22,7 @@ I would like to have a form on my website where a contact can specify his or her
The idea is that we include a link in each mailing or mail we send out with a checksum (see the wonderful [AGH Strategies Email Link Guide][aghchecksum]).
This link should lead to the form (prefilled if we know the person) which should look like this:
![Mockup Form](/images/emailprefs-mockup.png)
![Mockup Form](./img/emailprefs-mockup.png)
Once the person has ticked all their boxes the result should be processed into CiviCRM.
......@@ -32,7 +32,7 @@ In CiviCRM I will have a few groups:
* a group called Monthy Actions
* a group called Yearly Summary
![Groups in CiviCRM](/images/emailprefs-groups.png)
![Groups in CiviCRM](./img/emailprefs-groups.png)
The email preferences should reflect this group membership:
......@@ -65,7 +65,7 @@ This is not required, but it reflects the structure of CiviCRM and the structure
In the *Action* folder I can add my actions if I only expect to have a couple, or add a folder for each entity and then add my actions in there.
Because this extension for now will only hold 2 actions I will put them in the *Action* folder.
![Extension folders](/images/emailprefs-folders.png)
![Extension folders](./img/emailprefs-folders.png)
Next I have updated my info.xml, most of the information is not too important for this example but the <**classloader**> tag is!
This is required for an extension that creates *actions* for the **Action Provider**.
......@@ -331,7 +331,7 @@ function myemailprefs_civicrm_container(ContainerBuilder $container) {
I have completed the code for my actions, tested them with the API Explorer with entities *FormProcessor* and *FormProcesserDefaults*.
Now I could set up a form on my website to work with the actions. This is outside the scope of this section, the ambition here was to explain how to create your own actions.
If you want to see an example of how to set up a form check [Newsletter Drupal7 Example](sign-up-newsletter.md) or [Newsletter Wordpress Example](sign-up-newsletter-wordpress.md).
If you want to see an example of how to set up a form check [Newsletter Drupal7 Example](./sign-up-newsletter.md) or [Newsletter Wordpress Example](./sign-up-newsletter-wordpress.md).
[dataprocessor]:https://civicrm.org/extensions/data-processor
[aghchecksum]:https://aghstrategies.com/content/how-create-one-click-personalized-links-civicrm-emails
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment