Document changes in Coilpack 2.0

Author: bryannielsen

README.md

@@ -1,3 +1,5 @@
+![coilpack-logo](https://github.com/user-attachments/assets/5f161c5d-3944-413a-869f-26bea39e32c6)
+
 # Coilpack Documentation
 
 This is the documentation for [Coilpack by ExpressionEngine](https://github.com/ExpressionEngine/Coilpack) built

docs/configuration.md

@@ -20,4 +20,18 @@ Certain configuration variables in ExpressionEngine will be overwritten by your
 
 ## Accessing ExpressionEngine Config Values
 
-After Coilpack bootstraps ExpressionEngine you will be able to access any of your ExpressionEngine `system/user/config.php` values through the Laravel `config()` helper.  For example to get your `app_version` you could call `config('coilpack.expressionengine.app_version')`  within your Laravel application.
+After Coilpack bootstraps ExpressionEngine you will be able to access any of your ExpressionEngine `system/user/config.php` values through the Laravel `config()` helper.  For example to get your `app_version` you could call `config('coilpack.expressionengine.app_version')`  within your Laravel application.
+
+## Default Template Engine
+
+ExpressionEngine 7.5 added a new configuration option to control the site's default template engine.  This setting will be considered whenever you create a new template, run a template generator or copy template code for a channel or field.
+
+```
+# system/user/config/config.php
+
+...
+/*
+ * Set the default template engine
+ * Default: null (native). Can be 'twig' or 'blade' with Coilpack
+ */
+$config['default_template_engine'] = 'twig';

docs/getting-started.md

@@ -11,21 +11,22 @@ Read more about how URLs are handled inside of Coilpack in the [Routing Section]
 If you are new to Laravel and Coilpack we strongly recommend you follow the rest of this guide for getting started.  However, if you have installed Coilpack before or are familiar with setting up a Laravel application you can get started quickly with the commands below.
 
 ```sh
-composer create-project --prefer-dist "laravel/laravel:<=10" project-name
+composer create-project --prefer-dist "laravel/laravel:<=11" project-name
 cd project-name
-composer require expressionengine/coilpack:1.x
+composer require expressionengine/coilpack:2.x
 php artisan coilpack
 ```
 
 ## Choosing a Laravel Version
 
-We recommend using the latest version of Laravel whenever possible.  The only reason you should not use the latest version is if you are limited to a certain version of PHP.  The table below shows which versions of Laravel are supported on different versions of PHP.
+We recommend using the latest version of Laravel whenever possible.  The only reason you should not use the latest version is if you are limited to a certain version of PHP.  The table below shows which versions of Laravel and Coilpack are supported on different versions of PHP.
 
-| PHP     | Laravel |
-| ------- | ------- |
-| 8.1.0+  | 10.x    |
-| 8.0.2+  | 9.x     |
-| 7.4.0+  | 8.x     |
+| PHP     | Laravel | Coilpack |
+| ------- | ------- | -------- |
+| 8.2.0+  | 11.x    | 2.x      |
+| 8.1.0+  | 10.x    | 2.x, 1.x |
+| 8.0.2+  | 9.x     | 2.x, 1.x |
+| 7.4.0+  | 8.x     | 1.x      |
 
 ## Installation
 
@@ -43,7 +44,7 @@ composer create-project --prefer-dist laravel/laravel project-name
 Alternatively you can specify a major version of Laravel:
 
 ```sh
-composer create-project --prefer-dist laravel/laravel:^8.0 project-name
+composer create-project --prefer-dist laravel/laravel:^9.0 project-name
 ```
 
 :::caution
@@ -96,15 +97,15 @@ We recommend keeping your version of ExpressionEngine updated to the latest 7.x
 
 ### Using a New ExpressionEngine Install
 
-If you want Coilpack to create a new ExpressionEngine install, it will be placed in an `ee` folder within your Laravel project.  You now need to setup ExpressionEngine via the `admin.php` file in your `ee` folder. Example: `http://localhost/admin.php`. Follow the on-screen instructions to finalize your ExpressionEngine install.
+If you want Coilpack to create a new ExpressionEngine install, it will be placed in an `ee` folder within your Laravel project.  You now need to setup ExpressionEngine via the installer. The default url is `/admin` for example: `http://localhost/admin`. Follow the on-screen instructions to finalize your ExpressionEngine install.
 
 For more help with installing ExpressionEngine reference the [ExpressionEngine Docs](https://docs.expressionengine.com/latest/installation/installation.html).
 
 ### Using an Existing ExpressionEngine Install
 
 If you want to use an existing ExpressionEngine install you will be prompted for a path that is accessible from your Laravel project.  The path can be relative or absolute and should point to the root folder of your ExpressionEngine install.  You will also be asked for relative paths to system and config folders.  The typical locations are provided as default answers but if you have a customized setup it is important to let Coilpack know where to find these directories.
 
-After you have linked your site with Coilpack you will need to change the way you access the site.  For example if your ExpressionEngine site is located at `https://example.com`, and your Laravel application is setup to be accessed via `https://coilpack.example.com`, after setting up Coilpack you will need to access your ExpressionEngine site via `https://coilpack.example.com` (`https://coilpack.example.com/admin.php` to access the Control Panel).
+After you have linked your site with Coilpack you will need to change the way you access the site.  For example if your ExpressionEngine site is located at `https://example.com`, and your Laravel application is setup to be accessed via `https://coilpack.example.com`, after setting up Coilpack you will need to access your ExpressionEngine site via `https://coilpack.example.com` (`https://coilpack.example.com/admin` to access the Control Panel).
 
 For the sake of SEO, current links in place, etc, once you decide to use Coilpack for your website, you will probably want to update your webserver to point your site's current URL to your Laravel project. Talk to your webserver admin for information on how to accomplish this.
 

docs/routing.md

@@ -6,7 +6,7 @@ Coilpack works by bootstrapping ExpressionEngine inside of a Laravel application
 
 Coilpack sets up a few special routes for you:
 
-- `/admin.php` - Access the ExpressionEngine Control Panel
+- `/admin` - Access the ExpressionEngine Control Panel
 - `/graphql` - GraphQL Data endpoint when [GraphQL is enabled](./graphql#enabling-graphql-support)
 - `/graphiql` - Interactive GraphQL testing endpoint when [GraphiQL is enabled](./graphql#tools)
 

docs/templates/generators.md

@@ -0,0 +1,30 @@
+# Template Generators
+
+Coilpack expands support for [ExpressionEngine's Template Generator](https://docs.expressionengine.com/latest/templates/generators.html) feature to include the Twig and Blade templating engines.  This is accomplished by providing translations of ExpressionEngine's native template and fieldtype stubs.
+
+## Usage
+
+### Control Panel
+
+The Channel and Field Manager display a shortname next to each item's title which you can click to copy example template code.  This code will be generated using the site's [default template engine](/configuration#default-template-engine).  If not specified this will use the Native Template Language so be sure to change this if you wish to copy code in Twig or Blade.
+
+:::warning
+Due to security restrictions in modern browsers copying code via the shortname is only supported when on HTTPS.
+:::
+
+When using Coilpack you will also notice that the `Developer > Templates > Template Generator` page will have an extra option for "Template Engine".  You can select from the available options and the generated templates will use the proper syntax for your specified engine.
+
+:::info
+If you generate a template that is missing a translated stub (perhaps a third-party fieldtype) ExpressionEngine will default back to the native syntax for that stub.
+:::
+
+### Command Line Interface
+
+You may access the Template Generator functionality through the Command Line Interface (CLI) as well by running `php artisan eecli generate:templates`.  For more information about the available options please consult the [ExpressionEngine Documentation](https://docs.expressionengine.com/latest/templates/generators.html#command-line-usage)
+
+## Add-on Development
+
+If you are developing an add-on and wish to support Template Generators you should first familiarize yourself with the [Template Generator Service](https://docs.expressionengine.com/latest/development/services/template-generator.html).
+
+You can add support for the Twig and Blade templating engines by creating additional stubs in your `addon_name/stubs` folder that use the template engine suffix.  For instance if your add-on has a fieldtype your Native template stub might be `addon_name/stubs/field.php` and you could create a variant for Twig at `addon_name/stubs/field.twig.php` and similarly for Blade at `addon_name/stubs/field.blade.php`.
+

docs/upgrade-guide.md

@@ -4,14 +4,16 @@ You can upgrade to the latest version of Coilpack by running `composer update --
 
 ## Review the Changelog
 
-It's always a good idea to be aware of what is changing in each release. You can see a list of all changes in our [current changelog](https://github.com/ExpressionEngine/Coilpack/blob/1.x/CHANGELOG.md).
+It's always a good idea to be aware of what is changing in each release. You can see a list of all changes in our [current changelog](https://github.com/ExpressionEngine/Coilpack/blob/2.x/CHANGELOG.md).
 
 ## Configuration Changes
 
-Between versions the Coilpack configuration file may change.  We recommend comparing the most [recent changes](https://github.com/ExpressionEngine/Coilpack/blob/1.x/config/coilpack.php) with your own `config/coilpack.php` file.
+Between versions the Coilpack configuration file may change.  We recommend comparing the most [recent changes](https://github.com/ExpressionEngine/Coilpack/blob/2.x/config/coilpack.php) with your own `config/coilpack.php` file.
 
 ## Upgrading to 2.0 from 1.x
 
+The default value for `admin_url` has been changed from `/admin.php` to `/admin` to avoid routing issues with certain webserver configurations.
+
 The GraphQL signature for the Range Slider Fieldtype has changed to allow requesting specific subfields like `value`, `from`, and `to`.
 
 `Expressionengine\Coilpack\View\FormTag` has been deprecated in 2.0, so if you were extending this class please be aware and update your subclasses.  The new trait `Expressionengine\Coilpack\View\Traits\CreatesHtmlForm` provides similar functionality.

docusaurus.config.js

@@ -76,7 +76,6 @@ const config = {
                     position: 'left',
                     label: 'Documentation',
                 },
-                { to: '/blog', label: 'Blog', position: 'left' },
                 {
                     type: 'search',
                     position: 'right',

sidebars.js

@@ -64,6 +64,7 @@ const sidebars = {
                         { type: 'autogenerated', dirName: 'templates/tags' },
                     ],
                 },
+                { type: 'doc', id: 'templates/generators', label: 'Generators' },
                 'templates/troubleshooting'
             ]
         },