From a34709e3623838dedb3972b2502f9e353079734e Mon Sep 17 00:00:00 2001 From: Yuri Salimovskiy Date: Wed, 21 Jun 2023 15:53:01 +0300 Subject: [PATCH 1/2] add missing CLI commands docs --- docs/advanced-usage/front-end/dock.md | 2 +- docs/cli/built-in-commands/make-action.md | 17 - docs/cli/built-in-commands/make-addon.md | 351 ++++++++++++++++++ docs/cli/built-in-commands/make-command.md | 26 -- .../built-in-commands/make-extension-hook.md | 17 - docs/cli/built-in-commands/make-migration.md | 47 --- docs/cli/built-in-commands/make-model.md | 22 -- docs/cli/built-in-commands/make-prolet.md | 30 -- docs/cli/built-in-commands/make-tag.md | 17 - docs/cli/built-in-commands/make-widget.md | 18 - docs/cli/built-in-commands/migrate.md | 2 +- .../sync-conditional-fields.md | 29 -- docs/cli/built-in-commands/sync.md | 45 +++ docs/cli/intro.md | 60 ++- docs/control-panel/access.md | 5 +- .../file-manager/upload-directories.md | 2 +- .../settings/front-end-editing.md | 6 +- docs/control-panel/utilities.md | 2 +- .../utilities/data-operations.md | 8 +- .../development/addon-development-overview.md | 4 +- docs/development/extensions.md | 4 +- docs/development/fieldtypes/fieldtypes.md | 2 +- docs/development/services/model.md | 2 +- .../services/model/building-your-own.md | 2 +- docs/development/tab-files.md | 2 +- docs/fieldtypes/relationships.md | 4 +- docs/toc_sections/_advanced_usage_toc.yml | 17 +- 27 files changed, 462 insertions(+), 281 deletions(-) delete mode 100644 docs/cli/built-in-commands/make-action.md create mode 100644 docs/cli/built-in-commands/make-addon.md delete mode 100644 docs/cli/built-in-commands/make-command.md delete mode 100644 docs/cli/built-in-commands/make-extension-hook.md delete mode 100644 docs/cli/built-in-commands/make-migration.md delete mode 100644 docs/cli/built-in-commands/make-model.md delete mode 100644 docs/cli/built-in-commands/make-prolet.md delete mode 100644 docs/cli/built-in-commands/make-tag.md delete mode 100644 docs/cli/built-in-commands/make-widget.md delete mode 100644 docs/cli/built-in-commands/sync-conditional-fields.md create mode 100644 docs/cli/built-in-commands/sync.md diff --git a/docs/advanced-usage/front-end/dock.md b/docs/advanced-usage/front-end/dock.md index f681188dd..7aedba740 100644 --- a/docs/advanced-usage/front-end/dock.md +++ b/docs/advanced-usage/front-end/dock.md @@ -61,6 +61,6 @@ Developers may create third-party prolets that can be installed with add-ons. Re ![dock prolets](_images/ee-pro-dock-prolets.png) ## Disabling -The Dock can be disabled by either the setting in the [Control Panel](control-panel/settings/front-end-editing.md#general-settings) or [config override](general/system-configuration-overrides.md#enable_dock). +The Dock can be disabled by either the setting in the [Control Panel](control-panel/settings/front-end-editing.md#enable-dock) or [config override](general/system-configuration-overrides.md#enable_dock). WARN **Warning**: If the Dock is disabled, all of ExpressionEngine's [Front-End Content Management](advanced-usage/front-end/overview.md) is turned off for the front-end. \ No newline at end of file diff --git a/docs/cli/built-in-commands/make-action.md b/docs/cli/built-in-commands/make-action.md deleted file mode 100644 index 436c17f09..000000000 --- a/docs/cli/built-in-commands/make-action.md +++ /dev/null @@ -1,17 +0,0 @@ -# make:action - -Action Generator -- Creates a new action for an add-on - -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add action to -``` - -## Examples: - -### Generating an action: - -`php eecli.php make:action MyNewAction --addon=my_existing_addon` diff --git a/docs/cli/built-in-commands/make-addon.md b/docs/cli/built-in-commands/make-addon.md new file mode 100644 index 000000000..04f8f3bff --- /dev/null +++ b/docs/cli/built-in-commands/make-addon.md @@ -0,0 +1,351 @@ +# Add-on Generator + +Set of CLI commands that allows scaffloding add-on files. + +TIP: Read the [Add-on Development Overview](development/addon-development-overview.md) to learn about the files your add-on will need. + +[TOC] + +## `make:addon` + +Generates add-on files that are bare necessity and places those in `system/user/addons` directory. + +### Options list: + +The first (unnamed) parameter is the add-on name. + +Other options are: + + --version= + -v + Version of the add-on + + --description= + -d + Description of the add-on + + --author= + -a + Author of the add-on + + --author-url= + -u + Author url of the add-on + +### Examples: + +#### Interactive example + + $ php system/ee/eecli.php make:addon + Let's build your add-on! + What is the name of your add-on? Amazing Add-On + Add-on description? [Amazing Add-on description] This add-on does amazing things! + Add-on version? [1.0.0]1.0.0 + Add-on author? ExpressionEngine Developer + Add-on author URL? www.expressionengine.com + Let's build! + Your add-on has been created successfully! + +#### One-line example + +`php ../../system/ee/eecli.php make:addon "My Example Addon" -v 0.1.0 -d "Some good description" -a "ExpressionEngine" -u https://expressionengine.com` + + +## `make:action` + +Action Generator -- Creates a new action for an add-on + +### Options list: + +The first (unnamed) parameter is the action name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add action to + +### Examples: + +#### Generating an action: + +`php eecli.php make:action MyNewAction --addon=my_existing_addon` + + + +## `make:command` + +Command Generator -- Creates a new CLI command for an add-on + +### Options list: + +The first (unnamed) parameter is the command name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add command to + + --description= + -d + Description of command + + --signature= + -s + Signature for command (i.e. make:magic) + +### Examples: + +#### Generating a command: + +`php eecli.php make:command "Awesome CLI Command" --addon=my_example_addon --description='This command is awesome' --signature='my_addon:awesome-example'` + + + +## `make:cp-route` + +This interactively generates a control panel route in an existing third-party addon + +### Options list: + +The first (unnamed) parameter is the route name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add Mcp Route to. + +### Examples: + +` php eecli.php make:cp-route MyNewRoute --addon=my_existing_addon` + + + +## `make:extension-hook` + +Extension Hook Generator -- Implements an EE extension hook in an add-on + +### Options list: + +The first (unnamed) parameter is the extension hook name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add extension hook to + +### Examples: + +#### Implementing the sessions_start extension hook: + +`php eecli.php make:extension-hook sessions_start --addon=my_existing_addon` + + + +## `make:fieldtype` + +Fieldtype Generator -- This interactively generates a fieldtype in an existing third-party addon + +### Options list: + +The first (unnamed) parameter is the fieldtype name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add fieldtype to + +### Examples: + +#### Generating a fieldtype: + +`php eecli.php make:fieldtype MyNewFieldtype --addon=my_existing_addon` + + + +## `make:jump` + +Jumps File Generator -- Generates a jump menu file for a given third-party add-on. + +### Options list: + + --addon= + -a + Folder for third-party add-on you want to add fieldtype to + +### Examples: + +#### Generating a fieldtype: + +`php eecli.php make:jump --addon=my_existing_addon` + + +## `make:migration` + +Make migration -- Creates a new migration + +Check out our video tutorial on making migrations! +
+ +
+ +### Options list: + + --name= + -n + Name of migration + + --table= + -t + Table name + + --status= + -s + Status name + + --location= + -l + Migration location. Current options are ExpressionEngine or shortname of an add-on that is currently installed. Defaults to ExpressionEngine. + + --create + -c + Specify command is a create command + + --update + -u + Specify command is an update command + +### Examples: + +#### Generating a create table migration: + +`php eecli.php make:migration --location=my_addon --name create_myaddon_table --create --table=addon_data` + +#### Generating an update table migration: + +`php eecli.php make:migration --location=my_addon --name add_field_to_myaddon_table --update --table=addon_data` + + + +## `make:model` + +Model Generator -- Creates a new model for an add-on + +Check out our video tutorial on generating a model! +
+ +
+ +### Options list: + +The first (unnamed) parameter is the model name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add model to + +### Examples: + +#### Generating a model for an add-on: + +`php eecli.php make:model MyAwesomeModel --addon=my_existing_addon` + + + +## `make:prolet` + +Prolet Generator -- Creates a new prolet for an add-on + +### Options list: + +The first (unnamed) parameter is the prolet name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add prolet to + + --description= + -d + Description of prolet + + --has-widget + -w + Create a widget for the add-on after generating the prolet (optional) + + --widget-name= + -n + Name of widget + + +### Examples: + +#### Generating a prolet: + +`php eecli.php make:prolet MyNewProlet --addon=my_addon --description="This is my prolet description"` + + + +## `make:sidebar` + +Creates a control panel sidebar for an add-on + +### Options list: + + --addon= + -a + Folder for third-party add-on you want to add sidebar to. + +### Examples: + +`php eecli.php make:sidebar --addon=my_existing_addon` + + + +## `make:template-tag` + +Tag Generator -- Creates a new template tag for an add-on + +### Options list: + +The first (unnamed) parameter is the template tag name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add tag to + +### Examples: + +#### Generating a new tag: + +`php eecli.php make:template-tag MyNewTag --addon=my_existing_addon` + + +## `make:widget` + +Widget Generator -- Creates a new CP Dashboard Widget for an add-on + +### Options list: + +The first (unnamed) parameter is the widget name. + +The other options are + + --addon= + -a + Folder for third-party add-on you want to add the widget to + +## Examples: + +### Generating a widget: + +`php eecli.php make:widget MyNewWidget --addon=my_existing_addon` diff --git a/docs/cli/built-in-commands/make-command.md b/docs/cli/built-in-commands/make-command.md deleted file mode 100644 index 07667823c..000000000 --- a/docs/cli/built-in-commands/make-command.md +++ /dev/null @@ -1,26 +0,0 @@ -# make:command - -Command Generator -- Creates a new CLI command for an add-on - -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add command to - - --description= - -d - Description of command - - --signature= - -s - Signature for command (i.e. make:magic) - -``` - -## Examples: - -### Generating a command: - -`php eecli.php make:command "Awesome CLI Command" --addon=my_example_addon --description='This command is awesome' --signature='my_addon:awesome-example'` diff --git a/docs/cli/built-in-commands/make-extension-hook.md b/docs/cli/built-in-commands/make-extension-hook.md deleted file mode 100644 index 9b73c9b25..000000000 --- a/docs/cli/built-in-commands/make-extension-hook.md +++ /dev/null @@ -1,17 +0,0 @@ -# make:extension-hook - -Extension Hook Generator -- Implements an EE extension hook in an add-on - -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add extension hook to -``` - -## Examples: - -### Implementing the sessions_start extension hook: - -`php eecli.php make:extension-hook sessions_start --addon=my_existing_addon` diff --git a/docs/cli/built-in-commands/make-migration.md b/docs/cli/built-in-commands/make-migration.md deleted file mode 100644 index 1d9b6d719..000000000 --- a/docs/cli/built-in-commands/make-migration.md +++ /dev/null @@ -1,47 +0,0 @@ -# make:migration - -Make migration -- Creates a new migration - -Check out our video tutorial on making migrations! -
- -
- -## Options list: - -``` - --name= - -n - Name of migration - - --table= - -t - Table name - - --status= - -s - Status name - - --location= - -l - Migration location. Current options are ExpressionEngine or shortname of an add-on that is currently installed. Defaults to ExpressionEngine. - - --create - -c - Specify command is a create command - - --update - -u - Specify command is an update command - -``` - -## Examples: - -### Generating a create table migration: - -`php eecli.php make:migration --location=my_addon --name create_myaddon_table --create --table=addon_data` - -### Generating an update table migration: - -`php eecli.php make:migration --location=my_addon --name add_field_to_myaddon_table --update --table=addon_data` diff --git a/docs/cli/built-in-commands/make-model.md b/docs/cli/built-in-commands/make-model.md deleted file mode 100644 index 1db59ec72..000000000 --- a/docs/cli/built-in-commands/make-model.md +++ /dev/null @@ -1,22 +0,0 @@ -# make:model - -Model Generator -- Creates a new model for an add-on - -Check out our video tutorial on generating a model! -
- -
- -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add model to -``` - -## Examples: - -### Generating a model for an add-on: - -`php eecli.php make:model MyAwesomeModel --addon=my_existing_addon` diff --git a/docs/cli/built-in-commands/make-prolet.md b/docs/cli/built-in-commands/make-prolet.md deleted file mode 100644 index 713583238..000000000 --- a/docs/cli/built-in-commands/make-prolet.md +++ /dev/null @@ -1,30 +0,0 @@ -# make:prolet - -Prolet Generator -- Creates a new prolet for an add-on - -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add prolet to - - --description= - -d - Description of prolet - - --has-widget - -w - Create a widget for the add-on after generating the prolet (optional) - - --widget-name= - -n - Name of widget - -``` - -## Examples: - -### Generating a prolet: - -`php eecli.php make:prolet MyNewProlet --addon=my_addon --description="This is my prolet description"` diff --git a/docs/cli/built-in-commands/make-tag.md b/docs/cli/built-in-commands/make-tag.md deleted file mode 100644 index e420e245f..000000000 --- a/docs/cli/built-in-commands/make-tag.md +++ /dev/null @@ -1,17 +0,0 @@ -# make:tag - -Tag Generator -- Creates a new tag for an add-on - -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add tag to -``` - -## Examples: - -### Generating a new tag: - -`php eecli.php make:tag MyNewTag --addon=my_existing_addon` diff --git a/docs/cli/built-in-commands/make-widget.md b/docs/cli/built-in-commands/make-widget.md deleted file mode 100644 index 48b43aaed..000000000 --- a/docs/cli/built-in-commands/make-widget.md +++ /dev/null @@ -1,18 +0,0 @@ -# make:widget - -Widget Generator -- Creates a new Dashboard Widget for an add-on - -## Options list: - -``` - --addon= - -a - Folder for third-party add-on you want to add the widget to - -``` - -## Examples: - -### Generating a widget: - -`php eecli.php make:widget MyNewWidget --addon=my_existing_addon` diff --git a/docs/cli/built-in-commands/migrate.md b/docs/cli/built-in-commands/migrate.md index 36e3bfc03..83ce6654c 100644 --- a/docs/cli/built-in-commands/migrate.md +++ b/docs/cli/built-in-commands/migrate.md @@ -2,7 +2,7 @@ Generate, run and rollback migrations via the CLI. -TIP: If you would like to make your own migrations, see [make:migration](cli/built-in-commands/make-migration.md) for details on how to generate a migration. +TIP: If you would like to make your own migrations, see [make:migration](cli/built-in-commands/make-addon.md#makemigration) for details on how to generate a migration. Check out our video tutorial on running migrations and rolling back!
diff --git a/docs/cli/built-in-commands/sync-conditional-fields.md b/docs/cli/built-in-commands/sync-conditional-fields.md deleted file mode 100644 index acec810f3..000000000 --- a/docs/cli/built-in-commands/sync-conditional-fields.md +++ /dev/null @@ -1,29 +0,0 @@ -# sync:conditional-fields - -Sync Conditional Field Logic -- Checks each channel entry to see if its connditional logic is correct. If it is not, it updates the conditional logic and saves the entry. - -## Options list: - -``` - --channel_id= - -c - Channel ID to sync. Defaults to all channels - - --verbose - -v - Verbose - - --clear - -x - Clear -``` - -## Examples: - -### Sync all conditional fields: - -`php eecli.php sync:conditional-fields` - -### Sync conditional fields for channel_id 1 in verbose mode: - -`php eecli.php sync:conditional-fields --channel_id=1 -v` diff --git a/docs/cli/built-in-commands/sync.md b/docs/cli/built-in-commands/sync.md new file mode 100644 index 000000000..46c0b7050 --- /dev/null +++ b/docs/cli/built-in-commands/sync.md @@ -0,0 +1,45 @@ +# Data Synchronization + +## `sync:conditional-fields` + +Sync Conditional Field Logic -- Checks each channel entry to see if its connditional logic is correct. If it is not, it updates the conditional logic and saves the entry. + +### Options list: + +``` + --channel_id= + -c + Channel ID to sync. Defaults to all channels + + --verbose + -v + Verbose + + --clear + -x + Clear +``` + +### Examples: + +#### Sync all conditional fields: + +`php eecli.php sync:conditional-fields` + +#### Sync conditional fields for channel_id 1 in verbose mode: + +`php eecli.php sync:conditional-fields --channel_id=1 -v` + + + +## `sync:file-usage` + +Running this command will convert saved file information from `{filedir_X}filename.ext` format to `{file:XX:url}` format and update information on where each file is being used. + +### Options list: + +This command has no options + +### Example: + +`php eecli.php sync:file-usage` diff --git a/docs/cli/intro.md b/docs/cli/intro.md index 0360580a1..f1f58fd90 100644 --- a/docs/cli/intro.md +++ b/docs/cli/intro.md @@ -8,28 +8,48 @@ By default the CLI is located `system/ee/eecli.php` . - [Basic Usage](cli/usage.md) - Built In Commands - - [Clear Cache](cli/built-in-commands/cache-clear.md) - - [List](cli/built-in-commands/list.md) + - Addons + - [addons:install](cli/built-in-commands/addons.md#addonsinstall) - Installs add-on and all its components + - [addons:list](cli/built-in-commands/addons.md#addonslist) - List the add-ons + - [addons:uninstall](cli/built-in-commands/addons.md#addonsuninstall) - Uninstalls add-on and all its components + - [addons:update](cli/built-in-commands/addons.md#addonsupdate) - Updates an add-on to the latest version + - Backup + - [backup:database](cli/built-in-commands/backup-database.md) - Backup the database + - Cache + - [cache:clear](cli/built-in-commands/cache-clear.md) - Clears all ExpressionEngine caches + - Config + - [config:config](cli/built-in-commands/config-management.md#configconfig) - Updates config values in config.php file + - [config:env](cli/built-in-commands/config-management.md#configenv) - Updates env values in .env.php file + - List + - [list](cli/built-in-commands/list.md) - Lists available commands - Make - - [make:action - Creates a new action for an add-on](cli/built-in-commands/make-action.md) - - [make:addon - Creates a new add-on](development/addon-development-overview.md) - - [make:command - Creates a new CLI command for an add-on](cli/built-in-commands/make-command.md) - - [make:extension-hook - Implements an EE extension hook in an add-on](cli/built-in-commands/make-extension-hook.md) - - [make:migration - Creates a new migration](cli/built-in-commands/make-migration.md) - - [make:model - Creates a new model for an add-on](cli/built-in-commands/make-model.md) - - [make:prolet - Creates a new prolet for an add-on](cli/built-in-commands/make-prolet.md) - - [make:tag - Creates a new tag for an add-on](cli/built-in-commands/make-tag.md) - - [make:widget - Generates widgets for existing add-ons](cli/built-in-commands/make-widget.md) + - [make:addon](cli/built-in-commands/make-addon.md#makeaddon) - Creates a new add-on + - [make:action](cli/built-in-commands/make-addon.md#makeaction) - Creates a new action for an add-on + - [make:command](cli/built-in-commands/make-addon.md#makecommand) - Creates a new CLI command for an add-on + - [make:cp-route](cli/built-in-commands/make-addon.md#makecp-route) - Generates a control panel route for a given third-party add-on* + - [make:extension-hook](cli/built-in-commands/make-addon.md#makeextension-hook) - Implements an EE extension hook in an add-on + - [make:fieldtype](cli/built-in-commands/make-addon.md#makefieldtype) - Generates a fieldtype for a given third-party add-on* + - [make:jump](cli/built-in-commands/make-addon.md#makejump) - Generates a jump menu file for a given third-party add-on* + - [make:migration](cli/built-in-commands/make-addon.md#makemigration) - Creates a new migration for an add-on + - [make:model](cli/built-in-commands/make-addon.md#makemodel) - Creates a new model for an add-on + - [make:prolet](cli/built-in-commands/make-addon.md#makeprolet) - Creates a new prolet for an add-on + - [make:sidebar](cli/built-in-commands/make-addon.md#makesidebar) - Creates a control panel sidebar for an add-on + - [make:template-tag](cli/built-in-commands/make-addon.md#maketemplate-tag) - Creates a new template tag for an add-on + - [make:widget](cli/built-in-commands/make-addon.md#makewidget) - Generates widgets for existing add-ons - Migrate - - [migrate - Runs specified migrations (all, core, or add-ons)](cli/built-in-commands/migrate.md) - - [migrate:addon - Runs add-on migrations](cli/built-in-commands/migrate.md) - - [migrate:all - Runs core migrations, then each add-on's migrations](cli/built-in-commands/migrate.md) - - [migrate:core - Runs core migrations](cli/built-in-commands/migrate.md) - - [migrate:reset - Rolls back all migrations](cli/built-in-commands/migrate.md) - - [migrate:rollback - Rolls back most recent migration group](cli/built-in-commands/migrate.md) + - [migrate](cli/built-in-commands/migrate.md) - Runs specified migrations (all, core, or add-ons) + - [migrate:all](cli/built-in-commands/migrate.md) - Runs core migrations, then each add-on's migrations + - [migrate:addon](cli/built-in-commands/migrate.md) - Runs add-on migrations + - [migrate:core](cli/built-in-commands/migrate.md) - Runs core migrations + - [migrate:reset](cli/built-in-commands/migrate.md) - Rolls back all migrations + - [migrate:rollback](cli/built-in-commands/migrate.md) - Rolls back most recent migration group - Sync - - [sync:conditional-fields - Sync channel entry conditional logic](cli/built-in-commands/sync-conditional-fields.md) - - [Update ExpressionEngine](cli/built-in-commands/update.md) + - [sync:conditional-fields](cli/built-in-commands/sync.md#syncconditional-fields) - Sync channel entry conditional logic + - [sync:file-usage](cli/built-in-commands/sync.md#syncfile-usage) - Syncs the file usage for all files + - Update ExpressionEngine + - [update](cli/built-in-commands/update.md) Updates ExpressionEngine + - [update:prepare](cli/built-in-commands/update.md) Prepare a site to be upgraded using these files + - [update:run-hook](cli/built-in-commands/update.md) Runs update hooks from your upgrade.config.php file - [Creating a Command](cli/creating-a-command.md) - [Defining Input](cli/defining-input.md) -- [Displaying Output](cli/displaying-output.md) +- [Displaying Output](cli/displaying-output.md) \ No newline at end of file diff --git a/docs/control-panel/access.md b/docs/control-panel/access.md index a1ae2d9b9..cf587e96b 100644 --- a/docs/control-panel/access.md +++ b/docs/control-panel/access.md @@ -25,7 +25,7 @@ How long a user stays logged into the control panel is determined by two factors Session Time to Logout (TTL) refers to how long a user stays logged into the control panel after logging in. By default, after 1 hour of inactivity, administrators will be logged out of the control panel and required to log back in with their username and password. The default TTL length can be overriden by the [cp_session_length](general/system-configuration-overrides.md#cp_session_length) setting. -If control panel sessions are set to use cookies only, the 'Remember me' login option will allow the session cookie to persist for 2 weeks. This may be overriden using the [remember.php configuration file](config/config-files.md#remember_me). +If control panel sessions are set to use cookies only, the 'Remember me' login option will allow the session cookie to persist for 2 weeks. This may be overriden using the [remember.php configuration file](config/config-files.md#remember-me-expiration). ***Adminstrator Idle Check*** @@ -39,6 +39,3 @@ Sessions are stored in cookies, session ID (URL) or both, see [Security and Priv So if you're logged into the control panel but the website acts like you're a guest? You probably don't have session data stored in a cookie per the control panel session settings. - - - diff --git a/docs/control-panel/file-manager/upload-directories.md b/docs/control-panel/file-manager/upload-directories.md index fe2d968fd..4396ced0a 100644 --- a/docs/control-panel/file-manager/upload-directories.md +++ b/docs/control-panel/file-manager/upload-directories.md @@ -86,7 +86,7 @@ Optionally set the maximum allowed height in pixels for uploaded images. Images ##### Constrain or Crop -Specify one or more alternate versions of an image that automatically get created when the original image is uploaded. A manipulation can include a resized version, a [watermark](control-panel/file-manager/file-manager.md#watermarks), or both. You can refer to a particular Image Manipulation in your templates via a File Field's [single variable tag](fieldtypes/file.md#single-variable-usage) or its [variable pair tag](fieldtypes/file.md#url). The resize type will determine whether the image is constrained (resized) or cropped to the specified dimensions. If only height or width is specified, the thumbnails will be created using that as the master dimension. For example, setting the height to 200 and leaving the width blank will result in an image that is no higher than 200 pixels, with the width resized proportionately. Setting both the height and the width to 200 would result in an image that is no higher or wider than 200 pixels. +Specify one or more alternate versions of an image that automatically get created when the original image is uploaded. A manipulation can include a resized version, a [watermark](control-panel/file-manager/watermarks.md), or both. You can refer to a particular Image Manipulation in your templates via a File Field's [single variable tag](fieldtypes/file.md#single-variable-usage) or its [variable pair tag](fieldtypes/file.md#url). The resize type will determine whether the image is constrained (resized) or cropped to the specified dimensions. If only height or width is specified, the thumbnails will be created using that as the master dimension. For example, setting the height to 200 and leaving the width blank will result in an image that is no higher than 200 pixels, with the width resized proportionately. Setting both the height and the width to 200 would result in an image that is no higher or wider than 200 pixels. ##### Allowed member roles diff --git a/docs/control-panel/settings/front-end-editing.md b/docs/control-panel/settings/front-end-editing.md index 4310a5600..e0c4a1f56 100644 --- a/docs/control-panel/settings/front-end-editing.md +++ b/docs/control-panel/settings/front-end-editing.md @@ -16,13 +16,13 @@ ## **Enable Dock** -(Default: On, Matching Config Override: [`enable_dock`](#enable_dock) ) +(Default: On, Matching Config Override: [`enable_dock`](general/system-configuration-overrides.md#enable_dock) ) Enabling the Dock controls whether ExpressionEngine Pro is turned on for the front-end of your website. When the Dock is disabled all front-end editing, prolets, and Dock features will be disabled. ## **Enable front-end editing** -(Default: On, Matching Config Override: [`enable_frontedit`](#enable_frontedit)) +(Default: On, Matching Config Override: [`enable_frontedit`](general/system-configuration-overrides.md#enable_frontedit)) Enabling front-end editing allows users with respective permissions to edit channel entries and content on the front-end of your website using provided edit links ( pro edit icon ) . ## **Enable automatic front-end editing links** -(Default: On, Matching Config Override: [`enable_frontedit_links`](#enable_frontedit_links)) +(Default: On, Matching Config Override: [`enable_frontedit_links`](general/system-configuration-overrides.md#enable_frontedit_links)) By default ExpressionEngine Pro automatically inserts edit links ( pro edit icon ) where editable content is found in templates. These can be disabled on a per field basis or globally when using this toggle. When toggled off, ExpressionEngine Pro will no longer automatically generate edit links and links will need to be [added manually](/advanced-usage/front-end/frontend.md#customizing-the-link-location) where needed in templates. \ No newline at end of file diff --git a/docs/control-panel/utilities.md b/docs/control-panel/utilities.md index 70a91fc9c..375e33b79 100755 --- a/docs/control-panel/utilities.md +++ b/docs/control-panel/utilities.md @@ -38,7 +38,7 @@ ExpressionEngine provides a number of useful tools and utilities to make managin **[Data Operation Tools](control-panel/utilities/data-operations.md)** - [Cache Manager](control-panel/utilities/data-operations.md#cache-manager) - - [Search Reindex](control-panel/utilities/data-operations.md#search-reindex) + - [Content Reindex](control-panel/utilities/data-operations.md#content-reindex) - [Sync Conditional Logic](control-panel/utilities/data-operations.md#sync-conditional-fields) - [Update File Usage Information](control-panel/utilities/data-operations.md#update-file-usage-information) - [Manage Statistics](control-panel/utilities/data-operations.md#manage-statistics) diff --git a/docs/control-panel/utilities/data-operations.md b/docs/control-panel/utilities/data-operations.md index 16428d4e4..783d36e6a 100644 --- a/docs/control-panel/utilities/data-operations.md +++ b/docs/control-panel/utilities/data-operations.md @@ -21,11 +21,11 @@ This section of the Control Panel allows you clear the cached data for the diffe TIP: **Tip:** To quickly access this section, press `Ctrl / cmd` + `J` to invoke the Jump Menu and pick "Cache Manager" -## Search Reindex +## Content Reindex -**Control Panel Location:** `Tools > Utilities > Search Reindex` +**Control Panel Location:** `Tools > Utilities > Content Reindex` -Search reindexing refreshes the searchable words stored by Grid and Fluid fields that are used by the search module when performing a search. Reindexing is needed when: +Content reindexing refreshes the searchable words stored by Grid and Fluid fields that are used by the search module when performing a search. Reindexing is needed when: - a Grid field's search setting changes - the search settings for columns in a Grid field change @@ -47,7 +47,7 @@ This utility syncs the conditional logic for each of the channels. You will be r ![Sync Conditional Logic](_images/utilities-sync-conditional-fields.png) -NOTE: **Note:** You can also use `php eecli.php sync:conditional-fields` [CLI command](cli/built-in-commands/sync-conditional-fields.md) +NOTE: **Note:** You can also use `php eecli.php sync:conditional-fields` [CLI command](cli/built-in-commands/sync.md#syncconditional-fields) ## Update File Usage Information diff --git a/docs/development/addon-development-overview.md b/docs/development/addon-development-overview.md index b79f3d16b..c4fbb05f2 100644 --- a/docs/development/addon-development-overview.md +++ b/docs/development/addon-development-overview.md @@ -11,7 +11,7 @@ With custom add-ons you can add new fieldtypes, features, template tags, and much more to ExpressionEngine. Here we are going to look at different parts of an add-on, and how to define just what our add-on is going to do. -TIP: In this section, we're explaining the parts of an add-on. No need to memorize everything though, the [CLI](/cli/intro.html) will generate all the pieces we need based on what functions we want our add-on to have. +TIP: In this section, we're explaining the parts of an add-on. No need to memorize everything though, the [CLI](cli/intro.md) will generate all the pieces we need based on what functions we want our add-on to have. [TOC] @@ -32,7 +32,7 @@ Here are some ideas of what you can accomplish with a custom add-on: These are just a few ideas of what you can do with custom add-ons. The possibilities are almost endless. ## Getting Started -Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the `make:addon` command from the [CLI](/cli/intro.html). +Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the `make:addon` command from the [CLI](cli/intro.md). TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md) diff --git a/docs/development/extensions.md b/docs/development/extensions.md index 8a363a7e7..05071192f 100755 --- a/docs/development/extensions.md +++ b/docs/development/extensions.md @@ -59,7 +59,7 @@ TIP: Extensions need to be enabled to work. When you create an extension, a migr ## Anatomy Of An Extension Once we've added the ability to hook into the core with our add-on, an `Extensions` folder is created. The CLI will generate a class and a respective file for each core hook we wish to use. -Here we have added the ability to interact with the [`typography_parse_type_end()`](/development/extension-hooks/global/typography.html#typography_parse_type_endstr-this-prefs) hook. +Here we have added the ability to interact with the [`typography_parse_type_end()`](development/extension-hooks/global/typography.md#typography_parse_type_endstr-this-prefs) hook. So our add-on structure now looks like this: @@ -99,7 +99,7 @@ Inside our class is the `process()` function. Again the CLI has already added al TIP:Reference the [Available Core Hooks](development/extension-hooks/extension-hooks-overview.md) section of the docs to read on what parameters your hook uses. -From the [`typography_parse_type_end()`](/development/extension-hooks/global/typography.html#typography_parse_type_endstr-this-prefs) docs we can see that this hook modifies a string after all other typography is processed. Thus we should be able to take a string, manipulate it, then pass it back to ExpressionEngine to be rendered in the template. +From the [`typography_parse_type_end()`](development/extension-hooks/global/typography.md#typography_parse_type_endstr-this-prefs) docs we can see that this hook modifies a string after all other typography is processed. Thus we should be able to take a string, manipulate it, then pass it back to ExpressionEngine to be rendered in the template. We know that we should expect the following parameters for this hook: diff --git a/docs/development/fieldtypes/fieldtypes.md b/docs/development/fieldtypes/fieldtypes.md index 51f4367bc..39d16a1f6 100644 --- a/docs/development/fieldtypes/fieldtypes.md +++ b/docs/development/fieldtypes/fieldtypes.md @@ -221,7 +221,7 @@ Display the field data as column in the Entry Manager #### `EE_Fieldtype::getTableColumnConfig()` -Sets [table column configuration](development/services/table.html#setting-the-columns) for Entry Manager +Sets [table column configuration](development/services/table.md#setting-the-columns) for Entry Manager Returns `Array` diff --git a/docs/development/services/model.md b/docs/development/services/model.md index 9097ecf65..42875007e 100755 --- a/docs/development/services/model.md +++ b/docs/development/services/model.md @@ -17,7 +17,7 @@ lang: php ExpressionEngine has a complex set of data types, such as Channels, Members, Templates, and Categories. These have properties and constraints, as well as relationships and complex storage requirements. The model service helps smooth out interacting with ExpressionEngine's data types by providing an API that mimics their natural language description as closely as is feasible. You do not query for `channel_data` joined on `channel_titles`; instead, you simply get a channel entry with its fields. -NOTE: Models can also be **generated quickly by the Command Line Interface (CLI)**. Refer to the [make:model command](cli/built-in-commands/make-model.md) for more information. +NOTE: Models can also be **generated quickly by the Command Line Interface (CLI)**. Refer to the [make:model command](cli/built-in-commands/make-addon.md#makemodel) for more information. ## Naming Conventions diff --git a/docs/development/services/model/building-your-own.md b/docs/development/services/model/building-your-own.md index 6c6b79875..76386d156 100755 --- a/docs/development/services/model/building-your-own.md +++ b/docs/development/services/model/building-your-own.md @@ -17,7 +17,7 @@ lang: php This section gives a detailed description on how to implement your own models. -NOTE: Models can also be **generated quickly by the Command Line Interface (CLI)**. Refer to the [make:model command](cli/built-in-commands/make-model.md) for more information. +NOTE: Models can also be **generated quickly by the Command Line Interface (CLI)**. Refer to the [make:model command](cli/built-in-commands/make-addon.md#makemodel) for more information. NOTE: **Note:** Please review the basic [Model Usage](development/services/model.md) before attempting to write your own. Creating a model does not automatically create the corresponding database tables if they do not exist; you should use DB Forge to create your add-on's tables. diff --git a/docs/development/tab-files.md b/docs/development/tab-files.md index 8bc2ed702..12c393b5f 100644 --- a/docs/development/tab-files.md +++ b/docs/development/tab-files.md @@ -227,6 +227,6 @@ Display the tab data as column in the Entry Manager #### `getTableColumnConfig()` -Sets [table column configuration](development/services/table.html#setting-the-columns) for Entry Manager +Sets [table column configuration](development/services/table.md#setting-the-columns) for Entry Manager Returns `Array` diff --git a/docs/fieldtypes/relationships.md b/docs/fieldtypes/relationships.md index 552408af3..dcab2b244 100755 --- a/docs/fieldtypes/relationships.md +++ b/docs/fieldtypes/relationships.md @@ -80,7 +80,7 @@ The order of selected entries can be rearranged with drag&drop. ![Relationship Field UI](_images/ee73-relationship-status.png) -NOTE: **Note:** The described Relationship UI is only available when using Control Panel or [Pro Front-end Content Management](advanced-usage/front-end/frontend). If you need to use this field in [Channel Form](channels/channel-form/fields.md#relationship-field) then HTML Select input will be used. +NOTE: **Note:** The described Relationship UI is only available when using Control Panel or [Pro Front-end Content Management](advanced-usage/front-end/frontend.md). If you need to use this field in [Channel Form](channels/channel-form/fields.md#relationship-field) then HTML Select input will be used. ## Template Tags @@ -107,7 +107,7 @@ The following parameters are available to all looping relationship tags, allowin Some relationship tags may have additional parameters available. These are included in the usage instructions below. -NOTE: **NOTE:** The [`disable`](fieldtypes/relationships.md#optimizing-relationships-rerformance) parameter should be applied to the containing `{exp:channel:entries}` call, not to the relationship tag itself. +NOTE: **NOTE:** The [`disable`](fieldtypes/relationships.md#optimizing-relationships-performance) parameter should be applied to the containing `{exp:channel:entries}` call, not to the relationship tag itself. ## Accessing Children diff --git a/docs/toc_sections/_advanced_usage_toc.yml b/docs/toc_sections/_advanced_usage_toc.yml index 2d4fb8191..5c8747062 100644 --- a/docs/toc_sections/_advanced_usage_toc.yml +++ b/docs/toc_sections/_advanced_usage_toc.yml @@ -640,6 +640,8 @@ href: cli/usage.md - name: Built In Commands items: + - name: List Commands + href: cli/built-in-commands/list.md - name: Add-on Management href: cli/built-in-commands/addons.md - name: Add-on Generator @@ -648,25 +650,14 @@ href: cli/built-in-commands/backup-database.md - name: Clear Cache href: cli/built-in-commands/cache-clear.md - - name: Command Generator - href: cli/built-in-commands/make-command.md + - name: Sync Data + href: cli/built-in-commands/sync.md - name: Config Management href: cli/built-in-commands/config-management.md - name: Migrations href: cli/built-in-commands/migrate.md - - name: List - href: cli/built-in-commands/list.md - - name: Make migration - href: cli/built-in-commands/make-migration.md - - name: Model Generator - href: cli/built-in-commands/make-model.md - name: Update ExpressionEngine href: cli/built-in-commands/update.md - - name: Prolet Generator - href: cli/built-in-commands/make-prolet.md - - name: Widget Generator - href: cli/built-in-commands/make-widget.md - - name: Entry Cloning href: channels/entry_cloning.md From cf2bf5be0e3aeeada11fcbdb114df38ea90bbcf7 Mon Sep 17 00:00:00 2001 From: Yuri Salimovskiy Date: Wed, 21 Jun 2023 15:58:53 +0300 Subject: [PATCH 2/2] revert changes that don't belong to this PR --- docs/control-panel/utilities.md | 2 +- docs/control-panel/utilities/data-operations.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/control-panel/utilities.md b/docs/control-panel/utilities.md index 375e33b79..70a91fc9c 100755 --- a/docs/control-panel/utilities.md +++ b/docs/control-panel/utilities.md @@ -38,7 +38,7 @@ ExpressionEngine provides a number of useful tools and utilities to make managin **[Data Operation Tools](control-panel/utilities/data-operations.md)** - [Cache Manager](control-panel/utilities/data-operations.md#cache-manager) - - [Content Reindex](control-panel/utilities/data-operations.md#content-reindex) + - [Search Reindex](control-panel/utilities/data-operations.md#search-reindex) - [Sync Conditional Logic](control-panel/utilities/data-operations.md#sync-conditional-fields) - [Update File Usage Information](control-panel/utilities/data-operations.md#update-file-usage-information) - [Manage Statistics](control-panel/utilities/data-operations.md#manage-statistics) diff --git a/docs/control-panel/utilities/data-operations.md b/docs/control-panel/utilities/data-operations.md index 783d36e6a..bf8d0cb6e 100644 --- a/docs/control-panel/utilities/data-operations.md +++ b/docs/control-panel/utilities/data-operations.md @@ -21,11 +21,11 @@ This section of the Control Panel allows you clear the cached data for the diffe TIP: **Tip:** To quickly access this section, press `Ctrl / cmd` + `J` to invoke the Jump Menu and pick "Cache Manager" -## Content Reindex +## Search Reindex -**Control Panel Location:** `Tools > Utilities > Content Reindex` +**Control Panel Location:** `Tools > Utilities > Search Reindex` -Content reindexing refreshes the searchable words stored by Grid and Fluid fields that are used by the search module when performing a search. Reindexing is needed when: +Search reindexing refreshes the searchable words stored by Grid and Fluid fields that are used by the search module when performing a search. Reindexing is needed when: - a Grid field's search setting changes - the search settings for columns in a Grid field change