Skip to content

Commit f855404

Browse files
authored
Merge pull request #1124 from ExpressionEngine/7.dev
bunch of docs updates going live
2 parents ed830d5 + b289900 commit f855404

File tree

12 files changed

+49
-19
lines changed

12 files changed

+49
-19
lines changed

docs/add-ons/pro-search/filters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ You can use the native `category` parameter to filter by category. For more adva
177177

178178
### `category`
179179

180-
Like the [native category= parameter](/channel/channel_entries.md#category), but it also accepts category URL titles.
180+
Like the [native category= parameter](channels/entries.md#category), but it also accepts category URL titles.
181181

182182
### `category:group_name`
183183

@@ -235,7 +235,7 @@ You can use the native `search:field_name` parameter to target specific fields.
235235

236236
#### `search:field_name`
237237

238-
Like the [Channel search:field_name= parameter](/channel/entries.md#searchfield_name).
238+
Like the [Channel search:field_name= parameter](channels/entries.md#searchfield_name).
239239

240240
#### `search:field_name:column_name`
241241

@@ -255,7 +255,7 @@ Works just like the `search:field_name` parameter, but targets statuses.
255255

256256
#### `contains_words`
257257

258-
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"`.
258+
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"`.
259259

260260
contains_words="search:field_name"
261261

docs/channels/entries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ NOTE: **Note:** You will often use this parameter in conjunction with the [if no
518518

519519
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.
520520

521-
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.
521+
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.
522522

523523

524524
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.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# make:service
2+
3+
Service Generator -- Creates a new service for an add-on
4+
5+
## Options list:
6+
7+
```
8+
--addon=<value>
9+
-a <value>
10+
Name of the add-on you want to add the service to
11+
12+
--singleton
13+
-s
14+
Register the generated service in `services.singletons`
15+
```
16+
17+
## Examples:
18+
19+
### Generating a service:
20+
21+
`php eecli.php make:service MyService --addon=my_existing_addon`
22+
23+
### Generating a singleton service:
24+
25+
`php eecli.php make:service MyService --addon=my_existing_addon --singleton`

docs/control-panel/file-manager/subfolders.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
-->
99
# Subfolders
1010

11-
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.
11+
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.
12+
13+
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).
1214

1315
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.
1416

@@ -17,4 +19,3 @@ After enabling subfolders, you will see the "New folder" button in the top right
1719
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.
1820

1921
To rename a subfolder, use the Utility Action menu (the `...` at the end of a folder's row) and select the `Rename` option.
20-

docs/control-panel/file-manager/upload-directories.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ Default view type for this upload directory.
6666

6767
Enables creating subfolders within this upload directory and placing files within those.
6868

69+
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).
70+
6971
#### Keep subfolders on top?
7072

7173
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.

docs/development/legacy/helpers/text-helper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The Text Helper file contains functions that assist in working with text. This h
2121

2222
[TOC=3]
2323

24-
### `word_limiter($str[, $limit = 100[, $end_char = '&#8230;']])`
24+
### `word_limiter($str[, $limit = 100[, $end_char = '...']])`
2525

2626
| Parameter | Type | Description |
2727
| ---------- | -------- | ----------------------------------- |
@@ -38,7 +38,7 @@ Truncates a string to the number of _words_ specified. Example:
3838

3939
The third parameter is an optional suffix added to the string. By default it adds an ellipsis.
4040

41-
### `character_limiter($str[, $n = 500[, $end_char = '&#8230;']])`
41+
### `character_limiter($str[, $n = 500[, $end_char = '...']])`
4242

4343
| Parameter | Type | Description |
4444
| ---------- | -------- | ----------------------------------- |

docs/development/legacy/libraries/template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ lang: php
1717

1818
If you are not familiar with the ExpressionEngine template language, you may wish to read the [Template Overview](templates/overview.md).
1919

20-
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:
20+
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:
2121

2222
{exp:addon:method} some template data {/exp:addon:method}
2323

@@ -578,4 +578,4 @@ EE Templates have a special EE Code Comments for site designer notes and are rem
578578

579579
### `sync_from_files()`
580580

581-
Synchronize templates between database and files
581+
Synchronize templates between database and files

docs/development/v3-add-on-migration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ lang: php
1515

1616
[TOC]
1717

18-
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).
18+
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).
1919

2020
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.
2121

2222
If you're just getting started, we recommend reviewing some of the new service documentation as well as the following pages:
2323

2424
- [The addon.setup.php File](development/addon-setup-php-file.md)
2525
- [General Syntax Changes](#syntax-changes)
26-
- [Control Panel Pages](#control-panel-styles)
26+
- [Control Panel Pages](#module-changes)
2727

2828
## Required Changes
2929

@@ -95,7 +95,7 @@ ExpressionEngine 3.0 adopts [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR
9595

9696
#### CP URLs
9797

98-
`cp_url(...)` has been deprecated, please use `ee('CP/URL', '...')`. For the full documentation see [Control Panel Styles](#control-panel-styles).
98+
`cp_url(...)` has been deprecated, please use `ee('CP/URL', '...')`. For the full documentation see [Control Panel Styles](#module-changes).
9999

100100
#### Model Service
101101

docs/fieldtypes/text.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The maximum number of characters this field should allow.
2121

2222
### Text Formatting
2323

24-
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.
24+
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.
2525

2626
### Allow Override?
2727

docs/fieldtypes/textarea.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Height of the editor in rows of text.
2323

2424
### Text Formatting
2525

26-
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.
26+
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.
2727

2828
### Allow Override?
2929

@@ -55,4 +55,4 @@ The supported fields for file tags include:
5555
- `height`: The height of the file in pixels.
5656
- `mime_type`: The MIME type of the file.
5757
- `location`: Where the photo was taken
58-
- `credits`: Photo credits
58+
- `credits`: Photo credits

0 commit comments

Comments
 (0)