more updates

Author: Andy McCormick

docs/_images/prolet_example.png

@@ -12,9 +12,9 @@
 [TOC]
 
 ## Overview
-Actions in ExpressionEngine are URL endpoints which are typically reached with the `ACT` query parameter. An example of this might be `http://myamazingsite.com/?ACT=43` where 43 is the ID given to an action registered in the `exp_actions` database table. These actions are tied to methods in an add-on which can be used to accept input from forms or run some sort of other functionality defined in the add-on. 
+Actions in ExpressionEngine are URL endpoints that are reached with the `ACT` query parameter. An example of this might be `http://myamazingsite.com/?ACT=43` where 43 is the ID given to an action registered in the `exp_actions` database table. These actions are tied to methods in an add-on which can be used to accept input from forms or run some sort of other functionality defined in the add-on. 
 
-## How To Build An Amazing Add-on?
+## How To Build An Amazing Action?
 To generate an action we use the CLI to add the action to our existing add-on named "Amazing Add-on".
 
 ```
@@ -79,18 +79,18 @@ Actions are not available for use until they have been added to the `exp_actions
 
 If you want your action to be accessible immediately, you can either run the migration that was created by the CLI or set a flag in the CLI when creating the add-on.
 
-### Run Migration
+### Run Migration To Activate
 After creating your action using the CLI run `$ php system/ee/eecli.php migrate`. When asked for the location, type in the name of your add-on. This will run all migrations that have not been ran for your add-on including entering the action into `exp_actions`.
 
 
-### Setting Flag
+### Setting Flag To Activate On Creation
 On creation of an action, you can also specify to add it to the database after the CLI creates it. You can do this with the `--install` or `-i` flag by running your `make:action` command like so: `$ php system/ee/eecli.php make:action --install`.
 
 
 
 ## AddonName/Module/Actions
 
-Once we've added an action to our add-on, an `Actions` folder is created inside our add-on's `Module` folder. The CLI will generate a class and respective file for us based on the method name we passed to the CLI when creating our action. In this case we added an action with a method named  "ExampleAction" to Amazing Add-on.
+Once we've added an action to our add-on, an `Actions` folder is created inside our add-on's `Module` folder. The CLI will generate a class and respective file for us based on the action name we passed to the CLI when creating our action. In this case we added an action named  "ExampleAction" to Amazing Add-on.
 
 ```
 php system/ee/eecli.php make:action
@@ -108,7 +108,7 @@ amazing_add_on
 ```
 
 
-### class [MethodName]
+### class [ActionName]
 
 Inside `Module/Actions/ExampleAction.php` we see the following code generated for us:
 
@@ -127,7 +127,7 @@ class ExampleAction extends AbstractRoute
 }
 ```
 
-As we can see, the CLI has correctly created a new class using our method's name in PascalCase as the class name.
+As we can see, the CLI has correctly created a new class using our action's name in PascalCase as the class name.
 
 Inside of our class is the `process()` method. Anything we want to happen when a user reaches our action should be placed inside this `process()` function.
 
@@ -179,7 +179,7 @@ Let's do something with our action to demonstrate how this would work.
 ### Form Data
 In this example we want to insert a row into our database when a user submits a form. 
 
-For this example we'll use a really basic form that would be found in our template which uses our action's endpoint as the action for the form. We know our action's ID from the `exp_actions` table and we're just going to collect the user's first name and last name. We'll then take that information and store it in our database. For the purpose of this example, we'll insert this into a custom table we've added to ExpressionEngien which just has columns `ID`, `first_name`, `last_name`.
+For this example we'll use a really basic form that would be found in our template which uses our action's endpoint as the action for the form. We know our action's ID from the `exp_actions` table and we're just going to collect the user's first name and last name. We'll then take that information and store it in our database. For the purpose of this example, we'll insert this into a custom table we've added to ExpressionEngine which just has columns `ID`, `first_name`, `last_name`.
 
 
 Create our action:
@@ -189,9 +189,11 @@ What is the action name? ExampleAction
 What add-on is the action being added to? [amazing_add_on,...]: amazing_add_on
 ```
 
-This creates our required files. Now we had some functionality to our action which will add the first and last name submitted from a form to our custom database table.
+This creates our required files.   
 
-Our action code:
+Now we had some functionality to our action which will add the first and last name submitted from a form to our custom database table.
+
+Our action's code (`Module/Actions/ExampleAction.php`):
 
 ```
 <?php
@@ -221,7 +223,7 @@ class ExampleAction extends AbstractRoute
 }
 ```
 
-In our template:
+Our template code:
 
 ```
 <form method="post" action="/?ACT=41">
@@ -237,9 +239,9 @@ In our template:
 ```
 
 
-**A note about action IDs.** For the example above, we looked up the action ID in the database. However, the action ID of your method may be different in your database than someone else as the IDs are auto-incremented by the database on insertion. Therefore, it's always best practice to fetch your action ID for use in a template by using the [`fetch_action_id()`](/development/legacy/libraries/cp.md#fetch_action_idclass-method) method from the `CP Class` library.
+**A note about action IDs.** For the example above, we looked up the action ID in the database. However, the action ID of your method may be different in your database than someone else as the IDs are auto-incremented by the database on insertion. Therefore, when dynamically creating the form with a custom template tag, it's always best practice to fetch your action ID for use in a template by using the [`fetch_action_id()`](/development/legacy/libraries/cp.md#fetch_action_idclass-method) method from the `CP Class` library.
 
-We would do this in our add-on with something like this:
+We would do this in our add-on's template tag with something like this:
 
 ```
 $aid = ee()->cp->fetch_action_id(`Amazing_add_on`, `ExampleAction`);
@@ -248,7 +250,7 @@ $aid = ee()->cp->fetch_action_id(`Amazing_add_on`, `ExampleAction`);
 
 ### Return Data
 
-In this next example we are just creating an endpoint which will be reachable from servers outside of our domain. We are going to expect the application to use cURL or similar libray to post an ID to our endpoint. Upon receiving the request our action will return the name of the entry matching the ID if it exists.
+In this next example we are just creating an endpoint which will be reachable from servers outside of our domain. We are going to expect the application to use cURL or similar library to post an ID to our endpoint. Upon receiving the request our action will return the name of the entry matching the ID if it exists.
 
 Create our action:
 ```
@@ -317,6 +319,13 @@ The response:
 ```
 This is because of the [`csrf_exempt` value](#cross-site-request-forgerycsrf-exemption) mentioned above. To fix this we can go into the `exp_actions` table of our database and update the `csrf_exempt` column to `1`. 
 
-Now when I send that same request, I simply get the entry title I requested.
+Now when I send that same request, I simply get the entry title I requested:
 
+The response after disabling CSRF protection:
+
+```
+...
+The Entry You Requested
+...
+```
 

docs/development/actions.md

@@ -17,7 +17,9 @@ lang: php
 
 ## Overview
 
-An add-on's template tags can be used anywhere in templates to help edit content.
+TIP:If you are unfamiliar with Template Tags be sure to read the docs on [ExpressionEngine's template language](/templates/language.md) first. 
+
+Creating your own custom template tags allows you to display dynamic data from your add-on anywhere you want, in any template.
 
 ## Creating Template Tags
 Tags are created via the CLI by using the `make:template-tag` command. 
@@ -28,10 +30,6 @@ php system/ee/eecli.php make:template-tag
 
 Follow the prompts to add a tag file to your add-on. 
 
-Now, let's update the class to read the timezone that is passed in:
-
-
-
 This will create an `Models/Tags` folder in your add-on.
 
 ```
@@ -62,11 +60,12 @@ class ExampleTag extends AbstractRoute
 }
 ```
 
-As we can see, the CLI has correctly created a new class using our tag's name in PascalCase as the class name.
 
 Inside of our class is the `process()` method. Anything we want to happen when our template tag is used should be placed inside this `process()` function.
 
-After your tag is created, you can use your tag by just using `{exp:[addon_name][tag_name]}`. In the example above, we created a tag named "Example Tag". We can now use the tag `{exp:amazing_add_on:example_tag}` and the text "My Tag" will be outputted to my template.
+After your tag is created, you can use your tag by just using `{exp:[addon_name][tag_name]}`.    
+
+In the example above, we created a tag named "Example Tag". We can now use the tag `{exp:amazing_add_on:example_tag}` and the text "My Tag" will be outputted to my template.
 
 
 ## Tag Construction
@@ -96,7 +95,7 @@ Single tags are designed to return a single value.  Tag pairs look like this:
 
 Tag pairs allow you to process the information contained between the tags. In the above example, the text between the pairs would be encoded with XML entities.
 
-## Creating Single Tags
+## Creating Single Template Tags
 Single Tags are the easiest template tags to create and process. Here we'll add a single tag to our add-on using the CLI. We'll name the tag Amazing Text.
 
 ```
@@ -138,7 +137,7 @@ This would render in the browser as:
 Here is some amazing text: ExpressionEngine is the best CMS in the world!
 ```
 
-## Creating Tag Pairs
+## Creating Tag Pair Template Tags
 
 Often you will want to process content contained between a pair of tags. Let's create a simple tag that makes text bold to illustrate how this is done. Our example plugin will have this syntax:
 
@@ -292,6 +291,8 @@ This typically looks something like this:
 
 In the snippet above, we're passing in the `channel` and `limit` as parameters. We're then expecting the Channel Entries tag to replace the `{title}` and `{body}` **variables** when the tag is parsed. Now, let's do something similar to our add-on.
 
+
+## Create A Tag With Variables
 Let's add a tag to our add-on that will render the current date and time. The user can pass in their timezone and the tag will return the current Date and time.
 
 First, generate the tag (we're calling our tag "date and time" and adding it to our Amazing Add-On):

docs/development/custom-template-tags.md

@@ -15,12 +15,24 @@ lang: php
 
 [TOC]
 
+TIP: For an overview of what a Fieldtype is, read the [Fieldtype Overview docs](/fieldtypes/overview.md).
+
+
+## Generating A Custom Fieldtype
+
+Adding a custom fieldtype to your add-on is easy with the `make:fieldtype` command. 
+
+```
+$ php system/ee/eecli.php make:fieldtype
+compatiblity
+```
+
+Follow the prompts to complete the setup of your custom fieldtype.
 
-NOTE: Fieldtypes can also be **generated quickly by the Command Line Interface (CLI)**. Refer to the [make:addon command](cli/built-in-commands/make-addon.md) for more information.
 
 ## Basic File Structure
 
-All fieldtypes should be placed into the `system/user/addons` folder in a package and be named after that package name. So in a packaged named google_maps the fieldtype file will be `ft.google_maps.php`. All fieldtypes must inherit from the `EE_Fieldtype` base class and they must provide an \$info array with a name and version number.
+Once generated via the CLI a file named `ft.[addon_name].php` will created in your add-on's folder. All fieldtypes must inherit from the `EE_Fieldtype`.
 
     <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');