Skip to content

Commit fd150f0

Browse files
committed
Fixed merge conflicts
2 parents cc37e70 + bff7707 commit fd150f0

File tree

30 files changed

+283
-75
lines changed

30 files changed

+283
-75
lines changed

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
nodejs 10.1.0
1+
nodejs 18.0.0

docs/_images/eeu-logo-white.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/_images/rte_js.gif

2.72 MB
Loading

docs/add-ons/pro-variables/tags.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ In most cases, the simple global variable syntax, eg. `{my_var}` will do. Global
1717

1818
{exp:pro_variables:parse var="my_var"}
1919

20-
Use the Parse, Single or Pair tag to parse variables during the Module & Plugin stage ([learn more about the parsing stages](https://u.expressionengine.com/course/ee-conf-spring-summit-2021/eeconf-spring-2021-but-first-parse-order-and-php-in-expressionengines-templates)). You can also use parameters, which will allow for more options than just using the variable syntax. Some variable types, like RTE and Grid, require using the tag syntax to trigger additional processing.
20+
Use the Parse, Single or Pair tag to parse variables during the Module & Plugin stage. You can also use parameters, which will allow for more options than just using the variable syntax. Some variable types, like RTE and Grid, require using the tag syntax to trigger additional processing.
21+
22+
TIP: TIP: **{ee:u}** Learn more about the parsing stages at [ExpressionEngine University](https://u.expressionengine.com/course/ee-conf-spring-summit-2021/eeconf-spring-2021-but-first-parse-order-and-php-in-expressionengines-templates).
2123

2224
NOTE: **Note:** Whenever you need parameters or additional processing, use the **tag syntax** rather than the variable syntax.
2325

docs/add-ons/rte.md

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ Initially RTE installs 4 tool sets:
3232
- Click the **Create New** button and the tool set creation form will appear.
3333
- Enter a tool set name.
3434
- Select tool set type (CKEditor or Redactor)
35-
- Select the toolbar buttons and plugins you wish to have in your new tool set.
35+
- Select the toolbar buttons and plugins you wish to have in your new tool set (or use the [Advanced Configuration option](#advanced-configuration)).
3636
- Click **Save Tool Set** to save your changes.
3737

3838
### Editing a Tool Set
3939

4040
- Click a tool set's name or pencil icon to open the tool set Editor.
4141
- Modify the tool set's name, if desired.
4242
- Change the tool set type, if desired.
43-
- Select the tools you wish to have in this tool set.
43+
- Select the tools you wish to have in this tool set (or use the [Advanced Configuration option](#advanced-configuration)).
4444
- Click **Save Tool Set** to save your changes.
4545

4646
[TOC=3]
@@ -63,37 +63,39 @@ Choose between "Left to right" and "Right to left"
6363

6464
The following are the buttons that can be enabled in tool set to manipulate the data within an RTE field.
6565

66-
- HTML (Redactor only)
67-
- Bold
68-
- Italic
69-
- Strikethrough / Deleted
70-
- Underline
71-
- Subscript
72-
- Superscript
73-
- Block quote
74-
- Code
75-
- Heading / Format
76-
- Remove formatting (CKEditor only)
77-
- Style (Redactor only)
78-
- Properties (Redactor only)
79-
- Undo
80-
- Redo
81-
- Numbered list
82-
- Bulleted list
83-
- Decrease indent
84-
- Increase indent
85-
- Link
86-
- Image / File Browser
87-
- Table
88-
- Media / Video
89-
- Embed HTML / Widget
90-
- Align (left / right / center)
91-
- Justify
92-
- Horizontal line
93-
- Special characters
94-
- "Read More" separator
95-
- Font color / background
96-
- Fullscreen (Redactor only)
66+
<ul style="columns: 4;">
67+
<li>HTML (Redactor only)</li>
68+
<li>Bold</li>
69+
<li>Italic</li>
70+
<li>Strikethrough / Deleted</li>
71+
<li>Underline</li>
72+
<li>Subscript</li>
73+
<li>Superscript</li>
74+
<li>Block quote</li>
75+
<li>Code</li>
76+
<li>Heading / Format</li>
77+
<li>Remove formatting (CKEditor only)</li>
78+
<li>Style (Redactor only)</li>
79+
<li>Properties (Redactor only)</li>
80+
<li>Undo</li>
81+
<li>Redo</li>
82+
<li>Numbered list</li>
83+
<li>Bulleted list</li>
84+
<li>Decrease indent</li>
85+
<li>Increase indent</li>
86+
<li>Link</li>
87+
<li>Image / File Browser</li>
88+
<li>Table</li>
89+
<li>Media / Video</li>
90+
<li>Embed HTML / Widget</li>
91+
<li>Align (left / right / center)</li>
92+
<li>Justify</li>
93+
<li>Horizontal line</li>
94+
<li>Special characters</li>
95+
<li>"Read More" separator</li>
96+
<li>Font color / background</li>
97+
<li>Fullscreen (Redactor only)</li>
98+
</ul>
9799

98100
#### Custom Stylesheet
99101
CSS template with styles to be applied to fields using this tool set. All styles will be automatically prefixed with toolset class, which means that the template should hold rather generic styles for the elements.
@@ -112,19 +114,24 @@ Limits the number of character that can be entered into the field (Redactor only
112114

113115
#### Advanced configuration
114116

115-
Toggling this button hides the visual constructor for toolbar and enables editing the configuration directly in JSON format.
117+
Add custom formatting styles, buttons, and interactions to your RTE toolset by using advanced configurations. Toggling this button hides the visual constructor toolbar and reveals [advanced configuration](#configuration-json) options. These advanced options allow for editing the configuration directly in JSON format.
118+
119+
TIP: **{ee:u}** Checkout the [Advanced RTE Configurations](https://u.expressionengine.com/article/advanced-rte-configurations) article on ExpressionEngine University for examples of how to add custom CSS and JavaScript to your RTE configurations.
116120

117121
#### Configuration JSON
118122

119-
Allows overriding visually constructed tool set with [JSON](https://www.json.org/) object. Please be careful with using this feature and check your work. Remember that all properties need to be quoted.
123+
Allows overriding the visually constructed tool set with a [JSON](https://www.json.org/) object. Remember that all properties need to be quoted.
124+
125+
WARN: **Advanced users only.** Please be careful with using this feature and check your work. Providing invalid configuration can make the RTE fields inaccessible.
120126

121127
Initially the field is loaded with the saved configuration of tool set being edited.
122128

123-
Consult [Redactor Docs](https://imperavi.com/redactor/docs/settings/) or [CKEDitor Docs](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/configuration.html) for the list of properties. Note that not all features might be supported by ExpressionEngine implementation.
129+
Consult [Redactor Docs](https://imperavi.com/redactor/docs/settings/) or [CKEDitor Docs](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/configuration.html) for the list of properties. Note that not all features are supported by the ExpressionEngine implementation.
124130

125131
#### Extra JavaScript
126132
JavaScript template to be included with fields using this tool set. Typically used to include extra plugins when using advanced configuration with Redactor.
127133

134+
128135
### Cloning a Tool Set
129136

130137
- Click a tool set's clone icon to create copy of tool set and open it for editing

docs/channels/categories.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,20 @@ These are totally dynamic in that any field you create for your category will au
272272

273273
You may use this conditional to test whether the category shown is the active category or not, based on the dynamic URI segment.
274274

275+
### `{has_children}`
276+
277+
{exp:channel:categories channel="news" style="nested" show_empty="no"}
278+
<a href="{path='channel/index'}">{category_name}</a>
279+
280+
{if has_children}
281+
<button
282+
type="button"
283+
aria-haspopup="true"
284+
>children categories</button>
285+
{/if}
286+
{/exp:channel:categories}
287+
You may use this conditional to test whether the category shown is or isn't a parent category.
288+
275289
## Category Dropdown Menu
276290

277291
You can also display categories in a dropdown menu using the following code:

docs/channels/category-archive.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,20 @@ There are several variables available for use inside the `{categories}{/categori
249249

250250
You may use this conditional to test whether the category shown is the active category or not, based on the dynamic URI segment.
251251

252+
### `{has_children}`
253+
254+
{categories}
255+
<a href="{path='channel/index'}">{category_name}</a>
256+
257+
{if has_children}
258+
<button
259+
type="button"
260+
aria-haspopup="true"
261+
>children categories</button>
262+
{/if}
263+
{/categories}
264+
You may use this conditional to test whether the category shown is or isn't a parent category.
265+
252266
### `{category_description}`
253267

254268
{categories}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# make:action
2+
3+
Action Generator -- Creates a new action for an add-on
4+
5+
## Options list:
6+
7+
```
8+
--addon=<value>
9+
-a <value>
10+
Folder for third-party add-on you want to add action to
11+
```
12+
13+
## Examples:
14+
15+
### Generating an action:
16+
17+
`php eecli.php make:action MyNewAction --addon=my_existing_addon`

docs/cli/built-in-commands/make-addon.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Check out our video tutorial generating an add-on!
3434
-e <value>
3535
Add-on has settings (yes/no)
3636
37+
--compatibility-mode
38+
-p
39+
Generate add-on that is compatible with ExpressionEngine versions lower than 7.2.0 and lower than 6.4.0
40+
3741
--version=<value>
3842
-v <value>
3943
Version of the add-on
@@ -86,3 +90,7 @@ Check out our video tutorial generating an add-on!
8690

8791
`php eecli.php make:addon my_awesome_mod --mod --description "Description of addon" --version="1.0.0" --author="Joe Shmoe" --author-url='www.example.com' --has-settings='yes'`
8892

93+
### Generating a module in compatibility mode:
94+
95+
`php eecli.php make:addon my_awesome_mod --mod --description "Description of addon" --version="1.0.0" --author="Joe Shmoe" --author-url='www.example.com' --has-settings='yes' --compatibility-mode`
96+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# make:extension-hook
2+
3+
Extension Hook Generator -- Implements an EE extension hook in an add-on
4+
5+
## Options list:
6+
7+
```
8+
--addon=<value>
9+
-a <value>
10+
Folder for third-party add-on you want to add extension hook to
11+
```
12+
13+
## Examples:
14+
15+
### Implementing the sessions_start extension hook:
16+
17+
`php eecli.php make:extension-hook sessions_start --addon=my_existing_addon`

0 commit comments

Comments
 (0)