completed overview

Author: Andy McCormick

docs/cli/creating-a-command.md

@@ -19,7 +19,7 @@ Follow the prompts to add a CLI command to your add-on.
 This will create a `Commands` folder in your add-on along with a class and file based on your command name.
 
 ```
-amazing_addon
+amazing_add_on
  ┣ Commands
  ┃ ┣ Command[CommandName].php
 ```
@@ -29,7 +29,7 @@ amazing_addon
 We see that the CLI has added our `Commands` folder and created our new class. However, the CLI has also modified our `addon.setup.php` file as well.
 
 ```
-amazing_addon
+amazing_add_on
  ┣ Commands
  ┃ ┣ CommandAnAmazingCommand.php
 ```
@@ -48,7 +48,7 @@ return [
     'namespace'         => 'ExpressionengineDeveloper\AmazingAddon',
     'settings_exist'    => true,
     'commands' => [
-        'amazing_addon:make:amazing-things' => ExpressionengineDeveloper\AmazingAddon\Commands\CommandAnAmazingCommand::class,
+        'amazing_add_on:make:amazing-things' => ExpressionengineDeveloper\AmazingAddon\Commands\CommandAnAmazingCommand::class,
     ],
 
     ],
@@ -83,7 +83,7 @@ class CommandAnAmazingCommand extends Cli
      * signature of command
      * @var string
      */
-    public $signature = 'amazing_addon:make:amazing-things';
+    public $signature = 'amazing_add_on:make:amazing-things';
 
     /**
      * Public description of command
@@ -101,7 +101,7 @@ class CommandAnAmazingCommand extends Cli
      * How to use command
      * @var string
      */
-    public $usage = 'php eecli.php amazing_addon:make:amazing-things';
+    public $usage = 'php eecli.php amazing_add_on:make:amazing-things';
 
     /**
      * options available for use in command

docs/development/actions.md

@@ -27,7 +27,7 @@ Follow the prompts to add an action file to your add-on.
 This will create an `Actions` folder inside our `Module` folder where will build out the code we want to run when a user hits our `ACT` URL. Inside our `Actions` folder the CLI will create a file with the same name as the method we defined when creating our action.
 
 ```
-amazing_addon
+amazing_add_on
  ┣ Module
  ┃ ┣ Actions
  ┃ ┃ ┗ [MethodName].php
@@ -164,7 +164,11 @@ public function up()
 }
 ...
 ```
-- To set an action as CSRF exempt on creation, use the `--csrf_exempt` or `-c` flag in the CLI: `$ php system/ee/eecli.php make:action --csrf_exempt`
+- To set an action as CSRF exempt on creation, use the `--csrf_exempt` or `-c` flag in the CLI: 
+
+```
+$ php system/ee/eecli.php make:action --csrf_exempt
+```
 
 
 
@@ -179,22 +183,14 @@ For this example we'll use a really basic form that would be found in our templa
 
 
 Create our action:
-
-In our template:
-
 ```
-<form method="post" action="/?ACT=41">
-
-    <label for="fname">First name:</label><br>
-    <input type="text" id="fname" name="fname" value="John"><br>
-    <label for="lname">Last name:</label><br>
-    <input type="text" id="lname" name="lname" value="Doe"><br><br>
-    <input type="submit" value="Submit">
-
-</form>
-
+$ php system/ee/eecli.php make:action --install
+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.
+
 Our action code:
 
 ```
@@ -225,6 +221,22 @@ class ExampleAction extends AbstractRoute
 }
 ```
 
+In our template:
+
+```
+<form method="post" action="/?ACT=41">
+
+    <label for="fname">First name:</label><br>
+    <input type="text" id="fname" name="fname" value="John"><br>
+    <label for="lname">Last name:</label><br>
+    <input type="text" id="lname" name="lname" value="Doe"><br><br>
+    <input type="submit" value="Submit">
+
+</form>
+
+```
+
+
 **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.
 
 We would do this in our add-on with something like this:
@@ -238,6 +250,13 @@ $aid = ee()->cp->fetch_action_id(`Amazing_add_on`, `ExampleAction`);
 
 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.
 
+Create our action:
+```
+$ php system/ee/eecli.php make:action --install
+What is the action name? ExampleAction
+What add-on is the action being added to? [amazing_add_on,...]: amazing_add_on
+```
+
 Our action code:
 
 ```
@@ -279,9 +298,7 @@ However, when I attempt to reach this endpoint from another application I get an
 
 The request:
 ```
-curl --location --request POST 'https://anamzingwebsite.test/?ACT=41' \
---form 'id="1
-"'
+curl --location --request POST 'https://anamzingwebsite.test/?ACT=41' --form 'id="1"'
 ```
 
 The response:
@@ -298,21 +315,8 @@ The response:
 </div>
 ...
 ```
-This is because of the [`csrf_exempt` value](#exp_actions) mentioned above. To fix this we can go into the `exp_actions` table of our database and update the `csrf_exempt` column to `1`. However, to adjust for future installations we need to adjust the `$actions` array of our `upd` file. 
-
-Here we are going to set the `csrf_exempt` value on installation of our add-on.
-```
-    public $actions = [
-        [
-            'class' => 'Demo_addon',
-            'method' => 'Example_Action',
-            'csrf_exempt` => true
-        ]
-    ];
-```
+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.
 
-WARN: **Warning:** Use caution when making an action csrf exempt. First ensure you really need to do so, then also provide some sort of key or validation to ensure the incoming request is not malicious.
-
 

docs/development/custom-template-tags.md

@@ -35,7 +35,7 @@ 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.
 
 ```
-amazing_addon
+amazing_add_on
  ┣ Module
  ┃ ┗ Tags
  ┃ ┃ ┗ ExampleTag.php
@@ -66,26 +66,21 @@ As we can see, the CLI has correctly created a new class using our tag's name in
 
 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:[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
 
-A typical ExpressionEngine tag looks like this:
+A typical custom add-on tag looks like this:
 
-    {exp:channel:entries}
+    {exp:amazing_add_on:bold}
 
 The first segment is the tag identifier: {exp:. It tells the template engine that it has just encountered a tag.
 
-The second segment is the "family" name: `{exp:channel`. There are different families of tags: channel, comments, members, email, stats, etc. In programming terms, the second segment is the name of the 'class' that is instantiated by the tag.
-
-The above example would tell the template engine to dynamically instantiate the "channel" class.
-
-The third segment indicates the 'function' from within a particular family of tags: `{exp:channel:entries}`. This example would tell ExpressionEngine you want to use the "entries" method in the "channel" class.
+The second segment is the add-on's name all lowercase and with no spaces or special characters. In this case, we're telling ExpressionEngine to look inside of the Amazing Add-On add-on.
 
-A tag, therefore, mirrors an object oriented approach: `Class->method`:
+The third segment indicates the tag from inside the add-on to use. In this case it is the `bold` tag.
 
-    {exp:class_name:method_name}
 
 ### Two Kinds of Tags
 
@@ -105,9 +100,9 @@ Tag pairs allow you to process the information contained between the tags. In th
 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.
 
 ```
-php system/ee/eecli.php make:tag
+php system/ee/eecli.php make:template-tag
 What is the tag name? Amazing Text
-What add-on is the tag being added to? amazing_add_on
+What add-on is the tag being added to? [amazing_add_on,...]: amazing_add_on
 Tag created successfully!
 ```
 
@@ -160,9 +155,9 @@ You will be able to use this plugin anywhere in a Template. You can even put thi
 To create this tag pair, we'll use the CLI similarly to how we created a single tag.
 
 ```
-php system/ee/eecli.php make:tag
+php system/ee/eecli.php make:template-tag
 What is the tag name? bold
-What add-on is the tag being added to? amazing_add_on
+What add-on is the tag being added to? [amazing_add_on,...]: amazing_add_on
 Tag created successfully!
 ```
 
@@ -238,9 +233,9 @@ We will allow the following parameter choices:
 - `type="italic"`
 
 ```
-php system/ee/eecli.php make:tag
+php system/ee/eecli.php make:template-tag
 What is the tag name? format
-What add-on is the tag being added to? amazing_add_on
+What add-on is the tag being added to? [amazing_add_on,...]: amazing_add_on
 Tag created successfully!
 ```
 
@@ -304,7 +299,7 @@ First, generate the tag (we're calling our tag "date and time" and adding it to
 ```
 php system/ee/eecli.php make:template-tag
 What is the tag name? date and time
-What add-on is the tag being added to? amazing_add_on
+What add-on is the tag being added to? [amazing_add_on,...]: amazing_add_on
 Tag created successfully!
 ``` 
 
@@ -382,4 +377,4 @@ The current date is: November 15, 2022
 The current time is: 02:40 PM
 ```
 
-TIP: Of course, this is only the begining of what you can do with variables in your tag. We created single variables here, but you can create pair variables and much more. For more information about this, and manipulating the tagdata in your plugin, check out the [Template Class](development/legacy/libraries/template.md).
+TIP: Of course, this is only the beginning of what you can do with variables in your tag. We created single variables here, but you can create pair variables and much more. For more information about this, and manipulating the tagdata in your plugin, check out the [Template Class](development/legacy/libraries/template.md).

docs/development/extensions.md

@@ -34,11 +34,11 @@ TIP: Files that interact with ExpressionEngine core hooks are referred to as "ex
 This will create an `ext[addon_name].php` file in our add-on along with an `Extensions` folder where will build out the code we want to run when we interact with a core hook. Inside our `Extensions` folder the CLI will create a file with the same name as the core hook we plan to use.
 
 ```
-amazing_addon
+amazing_add_on
  ┣ Extensions
  ┃ ┣ [HookName].php
  ┃ ...
- ┗ ext.amazing_addon.php
+ ┗ ext.amazing_add_on.php
  ```
 
 TIP: A single add-on can interact with as many hooks as you want.
@@ -55,12 +55,12 @@ Here we have added the ability to interact with the [`typography_parse_type_end(
 So our add-on structure now looks like this:
 
 ```
-amazing_addon
+amazing_add_on
  ┣ Extensions
  ┃ ┣ TypographyParseTypeEnd.php
  ┣ addon.setup.php
- ┣ ext.amazing_addon.php
- ┗ upd.amazing_addon.php
+ ┣ ext.amazing_add_on.php
+ ┗ upd.amazing_add_on.php
  ```