diff --git a/docs/add-ons/pro-search/filters.md b/docs/add-ons/pro-search/filters.md index 98c97b94e..884c26940 100644 --- a/docs/add-ons/pro-search/filters.md +++ b/docs/add-ons/pro-search/filters.md @@ -177,7 +177,7 @@ You can use the native `category` parameter to filter by category. For more adva ### `category` -Like the [native category= parameter](/channel/channel_entries.md#category), but it also accepts category URL titles. +Like the [native category= parameter](channels/entries.md#category), but it also accepts category URL titles. ### `category:group_name` @@ -235,7 +235,7 @@ You can use the native `search:field_name` parameter to target specific fields. #### `search:field_name` -Like the [Channel search:field_name= parameter](/channel/entries.md#searchfield_name). +Like the [Channel search:field_name= parameter](channels/entries.md#searchfield_name). #### `search:field_name:column_name` @@ -255,7 +255,7 @@ Works just like the `search:field_name` parameter, but targets statuses. #### `contains_words` -Accepts search field parameter names. Force the given parameter values to match the full term, to ensure that the values are [not contained within other words](/channel/channel_entries.md#contains-matching). Similar to forcing full term matching by using `search:field_name="value\W"`. +Accepts search field parameter names. Force the given parameter values to match the full term, to ensure that the values are [not contained within other words](channels/entries.md#contains-matching). Similar to forcing full term matching by using `search:field_name="value\W"`. contains_words="search:field_name" diff --git a/docs/channels/entries.md b/docs/channels/entries.md index 9520aebec..ae384cdcc 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -518,7 +518,7 @@ NOTE: **Note:** You will often use this parameter in conjunction with the [if no The "search:" parameter allows you to constrain Channel Entries output based on content within your fields. You specify which field to search by using the field's short name immediately after "search:". You can search based on whether a field is an exact match to your provided term or whether or not a field simply contains your term. -NOTE: **Note:** Some fields store their content in a manner that affects the ability to work with this parameter. Grid fields, for instance, can only use this parameter for columns with "Include in search?" enabled (For performance, EE groups those columns into a searchable blob.). You can, however, search on Grid columns by using Pro Search's [`{exp:pro_search:results}`](add-ons/pro-search/tags.md#exppro_searchresults) tag and the [Field Search filter](/add-ons/pro-search/filters.md#field-search). Pro Search can also be used to filter entries by [title](/add-ons/pro-search/filters.md#searchtitle), [url_title](/add-ons/pro-search/filters.md#searchurltitle), [status](/add-ons/pro-search/filters.md#searchstatus), and [more](/add-ons/pro-search/filters.md#field-search). Relationship fields cannot be searched using the "search:" parameter. +NOTE: **Note:** Some fields store their content in a manner that affects the ability to work with this parameter. Grid fields, for instance, can only use this parameter for columns with "Include in search?" enabled (For performance, EE groups those columns into a searchable blob.). You can, however, search on Grid columns by using Pro Search's [`{exp:pro_search:results}`](add-ons/pro-search/tags.md#exppro_searchresults) tag and the [Field Search filter](/add-ons/pro-search/filters.md#field-search). Pro Search can also be used to filter entries by [title](/add-ons/pro-search/filters.md#searchtitle), [url_title](/add-ons/pro-search/filters.md#searchurl_title), [status](/add-ons/pro-search/filters.md#searchstatus), and [more](/add-ons/pro-search/filters.md#field-search). Relationship fields cannot be searched using the "search:" parameter. NOTE: **Note:** You can also use search:title and search:url_title in addition to searching field content. Remember that it is best to use url_title="something" if you're looking for an exact url_title match. diff --git a/docs/cli/built-in-commands/make-service.md b/docs/cli/built-in-commands/make-service.md new file mode 100644 index 000000000..cc9916e7c --- /dev/null +++ b/docs/cli/built-in-commands/make-service.md @@ -0,0 +1,25 @@ +# make:service + +Service Generator -- Creates a new service for an add-on + +## Options list: + +``` + --addon= + -a + Name of the add-on you want to add the service to + + --singleton + -s + Register the generated service in `services.singletons` +``` + +## Examples: + +### Generating a service: + +`php eecli.php make:service MyService --addon=my_existing_addon` + +### Generating a singleton service: + +`php eecli.php make:service MyService --addon=my_existing_addon --singleton` diff --git a/docs/control-panel/file-manager/subfolders.md b/docs/control-panel/file-manager/subfolders.md index bbcb3762a..1594db975 100644 --- a/docs/control-panel/file-manager/subfolders.md +++ b/docs/control-panel/file-manager/subfolders.md @@ -8,7 +8,9 @@ --> # Subfolders -Subfolders can be uses to help better organize your files. In order to do that, subfolders need first to be enabled in [Upload Directory](control-panel/file-manager/upload-directories.md) preferences. +Subfolders can be used to help better organize your files. In order to do that, subfolders need first to be enabled in [Upload Directory](control-panel/file-manager/upload-directories.md) preferences. + +NOTE: **Note:** Creating subfolders requires File Manager Compatibility Mode to be disabled. If Compatibility Mode is enabled, the New Folder option and subfolder features are unavailable. You can disable it in [Settings -> Content & Design](control-panel/settings/content-design.md#run-file-manager-in-compatibility-mode). After enabling subfolders, you will see the "New folder" button in the top right of the File Manager when viewing the contents of an Upload Directory. Clicking the "New Folder" button will show the folder creation dialog. This option is not available from the "All Files" view. @@ -17,4 +19,3 @@ After enabling subfolders, you will see the "New folder" button in the top right From the New Folder dialog, subfolders can be created in the current location as well as any other locations where subfolders are enabled. Subfolders can also be nested within other subfolders. To rename a subfolder, use the Utility Action menu (the `...` at the end of a folder's row) and select the `Rename` option. - diff --git a/docs/control-panel/file-manager/upload-directories.md b/docs/control-panel/file-manager/upload-directories.md index 3d18ee93c..3161b8cd3 100644 --- a/docs/control-panel/file-manager/upload-directories.md +++ b/docs/control-panel/file-manager/upload-directories.md @@ -66,6 +66,8 @@ Default view type for this upload directory. Enables creating subfolders within this upload directory and placing files within those. +NOTE: **Note:** Subfolders are available only when File Manager Compatibility Mode is disabled in [Settings -> Content & Design](control-panel/settings/content-design.md#run-file-manager-in-compatibility-mode). + #### Keep subfolders on top? Group subfolders at the top of the files list when browsing, irrespective of sorting order. When turned off, the folders will be mixed with the files list. diff --git a/docs/development/legacy/helpers/text-helper.md b/docs/development/legacy/helpers/text-helper.md index 364920e3f..d4b1c04f4 100755 --- a/docs/development/legacy/helpers/text-helper.md +++ b/docs/development/legacy/helpers/text-helper.md @@ -21,7 +21,7 @@ The Text Helper file contains functions that assist in working with text. This h [TOC=3] -### `word_limiter($str[, $limit = 100[, $end_char = '…']])` +### `word_limiter($str[, $limit = 100[, $end_char = '...']])` | Parameter | Type | Description | | ---------- | -------- | ----------------------------------- | @@ -38,7 +38,7 @@ Truncates a string to the number of _words_ specified. Example: The third parameter is an optional suffix added to the string. By default it adds an ellipsis. -### `character_limiter($str[, $n = 500[, $end_char = '…']])` +### `character_limiter($str[, $n = 500[, $end_char = '...']])` | Parameter | Type | Description | | ---------- | -------- | ----------------------------------- | diff --git a/docs/development/legacy/libraries/template.md b/docs/development/legacy/libraries/template.md index 55e397cb6..64f923960 100755 --- a/docs/development/legacy/libraries/template.md +++ b/docs/development/legacy/libraries/template.md @@ -17,7 +17,7 @@ lang: php If you are not familiar with the ExpressionEngine template language, you may wish to read the [Template Overview](templates/overview.md). -When you create a [Plugin](development/plugins.md) or [Module](development/modules.md), the name of your add-on and any of its public methods become available as ExpressionEngine tags for use in templates: +When you create a [Plugin](development/custom-template-tags.md) or [Module](development/modules.md), the name of your add-on and any of its public methods become available as ExpressionEngine tags for use in templates: {exp:addon:method} some template data {/exp:addon:method} @@ -578,4 +578,4 @@ EE Templates have a special EE Code Comments for site designer notes and are rem ### `sync_from_files()` -Synchronize templates between database and files \ No newline at end of file +Synchronize templates between database and files diff --git a/docs/development/v3-add-on-migration.md b/docs/development/v3-add-on-migration.md index 1eeec5252..6507c1588 100755 --- a/docs/development/v3-add-on-migration.md +++ b/docs/development/v3-add-on-migration.md @@ -15,7 +15,7 @@ lang: php [TOC] -This guide is an overview of the changes you will need to make to have your add-ons up and running under 3.0. The most notable changes to add-ons are the [addon.setup.php file](development/addon-setup-php-file.md) and the new [Control Panel Style Reference](#control-panel-styles). +This guide is an overview of the changes you will need to make to have your add-ons up and running under 3.0. The most notable changes to add-ons are the [addon.setup.php file](development/addon-setup-php-file.md) and the new [Control Panel Style Reference](#module-changes). There are some deprecated features and code, so be sure to check the [Developer Logs](control-panel/system-logs.md#developer-logs) in the control panel for messages regarding method deprecation to make sure your add-on is not calling any deprecated code. @@ -23,7 +23,7 @@ If you're just getting started, we recommend reviewing some of the new service d - [The addon.setup.php File](development/addon-setup-php-file.md) - [General Syntax Changes](#syntax-changes) -- [Control Panel Pages](#control-panel-styles) +- [Control Panel Pages](#module-changes) ## Required Changes @@ -95,7 +95,7 @@ ExpressionEngine 3.0 adopts [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR #### CP URLs -`cp_url(...)` has been deprecated, please use `ee('CP/URL', '...')`. For the full documentation see [Control Panel Styles](#control-panel-styles). +`cp_url(...)` has been deprecated, please use `ee('CP/URL', '...')`. For the full documentation see [Control Panel Styles](#module-changes). #### Model Service diff --git a/docs/fieldtypes/text.md b/docs/fieldtypes/text.md index c32f53b3c..b2ed1f7c4 100755 --- a/docs/fieldtypes/text.md +++ b/docs/fieldtypes/text.md @@ -21,7 +21,7 @@ The maximum number of characters this field should allow. ### Text Formatting -Specifies how the entered-text will be formatted when rendered on the front-end. Choices include replacing each linebreak with a `BR` tag, automatically surrounding paragraphs with `P` tags, or Markdown processing. [Additional plugins](development/plugins.md) may be installed to provide more text formatting options. +Specifies how the entered-text will be formatted when rendered on the front-end. Choices include replacing each linebreak with a `BR` tag, automatically surrounding paragraphs with `P` tags, or Markdown processing. [Additional plugins](development/text-formatting.md) may be installed to provide more text formatting options. ### Allow Override? diff --git a/docs/fieldtypes/textarea.md b/docs/fieldtypes/textarea.md index 14e67ea7e..3d23042a4 100755 --- a/docs/fieldtypes/textarea.md +++ b/docs/fieldtypes/textarea.md @@ -23,7 +23,7 @@ Height of the editor in rows of text. ### Text Formatting -Specifies how the entered-text will be formatted when rendered on the front-end. Choices include replacing each linebreak with a `BR` tag, automatically surrounding paragraphs with `P` tags, or Markdown processing. [Additional plugins](development/plugins.md) may be installed to provide more text formatting options. +Specifies how the entered-text will be formatted when rendered on the front-end. Choices include replacing each linebreak with a `BR` tag, automatically surrounding paragraphs with `P` tags, or Markdown processing. [Additional plugins](development/text-formatting.md) may be installed to provide more text formatting options. ### Allow Override? @@ -55,4 +55,4 @@ The supported fields for file tags include: - `height`: The height of the file in pixels. - `mime_type`: The MIME type of the file. - `location`: Where the photo was taken -- `credits`: Photo credits \ No newline at end of file +- `credits`: Photo credits diff --git a/docs/installation/changelog.md b/docs/installation/changelog.md index 03e409f3c..648e4c797 100755 --- a/docs/installation/changelog.md +++ b/docs/installation/changelog.md @@ -470,7 +470,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved an issue where curl requests on Windows could not use the native root certificate store - Resolved an issue where updates from the CLI would not increment the version number -NOTE: **Important:** If your site uses any textareas that contain multiple image links, you should [Update File Usage Information](/latest/control-panel/utilities/data-operations.md#update-file-usage-information) after upgrading to trigger a re-count of file usage statistics. +NOTE: **Important:** If your site uses any textareas that contain multiple image links, you should [Update File Usage Information](control-panel/utilities/data-operations.md#update-file-usage-information) after upgrading to trigger a re-count of file usage statistics. ## Version 7.5.8 @@ -2238,7 +2238,7 @@ NOTE: **Important:** This version includes important security updates. - **Developers** 💻 - - New [Add-on Classes](development/best-practices/about.md) + - New [Add-on Classes](development/addon-development-overview.md) - `make:addon` CLI command now generates add-on's with Add-on controller classes ## Version 7.1.6 @@ -2526,7 +2526,7 @@ NOTE:**Note:** If multiple members are needed, an ExpressionEngine Pro license i - Ability to organize content into [subfolders](/control-panel/file-manager/subfolders.md) - Folders can now be created directly on the filesystem through the File Manager - Implemented [FlySystem PHP library](https://flysystem.thephpleague.com/docs/) to add more extensiblity to the File Manager. - - Added support for cloud based file storage through [Adapters](/control-panel/file-manager/adapters.md) + - Added support for cloud based file storage through [Adapters](control-panel/file-manager/upload-directories.md#adapter) - Changed how files are referenced in the database. Previously files were referenced using `{filedir_X}filename.ext`. Files are now referenced using `{file:XX:url}`. [Compatibility Mode](/control-panel/file-manager/file-manager.md#compatibility-mode) is recommended for upgrades until there is confirmation that all add-ons will work with new file data format. - File usage is now available in the File Manager to display where a file is used throughout the Control Panel as well as notify users if a file is in use before deleting the file diff --git a/docs/toc_sections/_advanced_usage_toc.yml b/docs/toc_sections/_advanced_usage_toc.yml index b6ff02618..0d7172eae 100644 --- a/docs/toc_sections/_advanced_usage_toc.yml +++ b/docs/toc_sections/_advanced_usage_toc.yml @@ -688,6 +688,8 @@ href: cli/built-in-commands/migrate.md - name: Model Generator href: cli/built-in-commands/make-model.md + - name: Service Generator + href: cli/built-in-commands/make-service.md - name: Prolet Generator href: cli/built-in-commands/make-prolet.md - name: Sync Conditional Fields