Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions en/building-sites/settings/allow_tv_eval.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "allow_tv_eval"
description: "Select this option to enable or disable eval in TV binding. If this option is set to no, the code/value will just be handled as regular text."
description: "Removed in MODX 3.0. Formerly enabled eval in TV bindings."
---

**Name**: Disable eval in TV binding
**Removed in MODX 3.0.** `@EVAL` TV bindings are gone. Use `@SELECT`, `@SNIPPET`, or other supported bindings instead. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Enable eval in TV bindings
**Type**: Yes/No
**Default**: Yes
**Available In**: Revolution 2.5.0+
**Available In**: Revolution 2.5.0–2.x only

Select this option to enable or disable eval in TV binding. If this option is set to no, the code/value will just be handled as regular text.
On 2.x: enable or disable eval in TV bindings. When No, the value was treated as plain text.
12 changes: 10 additions & 2 deletions en/building-sites/settings/automatic_template_assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@ title: "automatic_template_assignment"
description: "Choose how templates are assigned to new Resources on creation"
---

## automatic_template_assignment

**Name**: Automatic Template Assignment
**Type**: String
**Default**: parent
**Default**: `sibling` (MODX 3.0+; was `parent` in earlier 2.x defaults)

Choose how templates are assigned to new Resources on creation:

- **system** — default template from System Settings
- **parent** — inherit the parent Resource template
- **sibling** — inherit the most used sibling template

Choose how templates are assigned to new Resources on creation. Options include: **system** (default template from system settings), **parent** (inherits the parent template), or **sibling** (inherits the most used sibling template)
See also [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).
16 changes: 8 additions & 8 deletions en/building-sites/settings/cache_action_map.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ _old_id: "35"
_old_uri: "2.x/administering-your-site/settings/system-settings/cache_action_map"
---

## cache\_action\_map
## cache_action_map

**Name**: Enable Action Map Cache
**Type**: Yes/No
**Default**: Yes
**Removed in MODX 3.0.** The action map is gone with `modAction`. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

When enabled, actions (or controller maps) will be cached to greatly reduce manager page load times.
---

## See Also
**Name**: Enable Action Map Cache
**Type**: Yes/No
**Default**: Yes
**Available In**: Revolution 2.x only

- **modmanagerrequest.class.php** `modManagerRequest::loadActionMap()` function
- `$modx->actionMap array`
On 2.x: when enabled, controller action maps were cached to speed up Manager page loads.
12 changes: 8 additions & 4 deletions en/building-sites/settings/compress_js_max_files.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "compress_js_max_files"
description: "The maximum number of JavaScript files MODX will attempt to compress at once"
description: "Removed in MODX 3.0. Formerly the JS compression file threshold for the Manager."
---

**Removed in MODX 3.0.** Dynamic Manager JS/CSS minification and related settings are gone. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Maximum JavaScript Files Compression Threshold
**Type**: String
**Default**: 10
**Available In**: Revolution 2.2.0+
**Default**: 10
**Available In**: Revolution 2.2.0–2.x only

The maximum number of JavaScript files MODX will attempt to compress at once when [compress_js](building-sites/settings/compress_js) is on. Set to a lower number if you are experiencing issues with Google Minify in the manager.
On 2.x: maximum number of JavaScript files MODX would compress at once when [compress_js](building-sites/settings/compress_js) was on.
15 changes: 10 additions & 5 deletions en/building-sites/settings/editor_css_path.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ _old_id: "101"
_old_uri: "2.x/administering-your-site/settings/system-settings/editor_css_path"
---

## editor\_css\_path
## editor_css_path

**Name**: Path to CSS file
**Type**: String
**Default**:
**Removed in MODX 3.0.** Core no longer ships this setting. TinyMCE or other editor Extras may still need their own CSS path configuration. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

The path to your CSS file that you wish to use within the editor. The best way to enter the path is to enter the path from the root of your server, for example: /assets/site/style.css. If you do not wish to load a style sheet into the editor, leave this field blank.
---

**Name**: Path to CSS file
**Type**: String
**Default**: (empty)
**Available In**: Revolution 2.x only

On 2.x: path to a CSS file for the rich-text editor, usually from the server root (for example `/assets/site/style.css`).
15 changes: 11 additions & 4 deletions en/building-sites/settings/editor_css_selectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ _old_id: "102"
_old_uri: "2.x/administering-your-site/settings/system-settings/editor_css_selectors"
---

## editor\_css\_selectors
## editor_css_selectors

**Name**: CSS Selectors for Editor
**Type**: String
**Default**:
**Removed in MODX 3.0.** Core no longer ships this setting. Configure CSS selectors in the editor Extra if it still needs them. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: CSS Selectors for Editor
**Type**: String
**Default**: (empty)
**Available In**: Revolution 2.x only

On 2.x: comma-separated CSS selectors for the rich-text editor.
7 changes: 5 additions & 2 deletions en/building-sites/settings/enable_gravatar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ title: "enable_gravatar"
description: "Enable Gravatar usage"
---

## enable_gravatar

**Name**: Enable Gravatar
**Type**: Yes/No
**Default**: Yes
**Default**: No (MODX 3.0+ for new installs; was Yes in 2.x)
**Available In**: Revolution 2.3.1+

Enable [Gravatar](https://en.gravatar.com/) usage
If enabled, Gravatar is used as the profile image when the user has no uploaded photo.

See also [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).
14 changes: 8 additions & 6 deletions en/building-sites/settings/manager_favicon_url.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ _old_id: "190"
_old_uri: "2.x/administering-your-site/settings/system-settings/manager_favicon_url"
---

## manager\_favicon\_url
## manager_favicon_url

**Name**: Manager Favicon URL
**Type**: Textfield
**Default**:
**Available In:** 2.1+
**Name**: Manager Favicon URL
**Type**: Textfield
**Default**: `favicon.ico` (MODX 3.0+; earlier defaults were often empty)
**Available In**: 2.1+

If set, will load this URL as a favicon for the MODX manager. Must be a relative URL to the manager/ directory, or an absolute URL.
If set, MODX loads this URL as the Manager favicon. Use a path relative to the `manager/` directory, or an absolute URL.

See also [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).
12 changes: 8 additions & 4 deletions en/building-sites/settings/manager_js_cache_file_locking.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "manager_js_cache_file_locking"
description: "Cache file locking. Set to No if filesystem is NFS."
description: "Removed in MODX 3.0. Formerly controlled file locking for manager JS/CSS cache."
---

**Removed in MODX 3.0.** Dynamic manager JS/CSS minification and its cache settings are gone. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Enable File Locking for Manager JS/CSS Cache
**Type**: Yes/No
**Default**: Yes
**Available In**: Revolution 2.2.0+
**Default**: Yes
**Available In**: Revolution 2.2.0–2.x only

Cache file locking. Set to No if filesystem is NFS.
On 2.x: cache file locking. Set to No on NFS filesystems.
12 changes: 8 additions & 4 deletions en/building-sites/settings/manager_js_cache_max_age.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "manager_js_cache_max_age"
description: "Maximum age of browser cache of manager CSS/JS compression in seconds"
description: "Removed in MODX 3.0. Formerly the max age of the manager JS/CSS compression browser cache."
---

**Removed in MODX 3.0.** Dynamic manager JS/CSS minification and its cache settings are gone. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Manager JS/CSS Compression Cache Age
**Type**: String
**Default**: 3600
**Available In**: Revolution 2.2.0+
**Default**: 3600
**Available In**: Revolution 2.2.0–2.x only

Maximum age of browser cache of manager CSS/JS compression in seconds. After this period, the browser will send another conditional GET. Use a longer period for lower traffic.
On 2.x: maximum age of the browser cache for manager CSS/JS compression, in seconds.
22 changes: 13 additions & 9 deletions en/building-sites/settings/manager_js_document_root.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
---
title: "manager_js_document_root"
description: "If your server does not handle the DOCUMENT_ROOT server variable, set it explicitly here to enable the manager CSS/JS compression"
description: "Removed in MODX 3.0. Formerly set DOCUMENT_ROOT for manager CSS/JS compression."
---

**Removed in MODX 3.0.** Dynamic manager JS/CSS minification and its cache settings are gone. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Manager JS/CSS Compression Document Root
**Type**: String
**Default**:
**Available In**: Revolution 2.2.0+
**Default**: (empty)
**Available In**: Revolution 2.2.0–2.x only

If your server does not handle the `DOCUMENT_ROOT` server variable, set it explicitly here to enable the manager CSS/JS compression. Do not change this unless you know what you are doing.
On 2.x: if the server did not provide `DOCUMENT_ROOT`, set it here so manager CSS/JS compression could run.

## See also
## See also (2.x)

- PHP Array [$\_SERVER](https://www.php.net/manual/en/reserved.variables.server.php)
- [manager_js_cache_file_locking](building-sites/settings/manager_js_cache_file_locking)
- [manager_js_cache_max_age](building-sites/settings/manager_js_cache_max_age)
- [manager_js_zlib_output_compression](building-sites/settings/manager_js_zlib_output_compression)
- PHP [`$_SERVER`](https://www.php.net/manual/en/reserved.variables.server.php)
- [manager_js_cache_file_locking](building-sites/settings/manager_js_cache_file_locking)
- [manager_js_cache_max_age](building-sites/settings/manager_js_cache_max_age)
- [manager_js_zlib_output_compression](building-sites/settings/manager_js_zlib_output_compression)
12 changes: 8 additions & 4 deletions en/building-sites/settings/manager_js_zlib_output_compression.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "manager_js_zlib_output_compression"
description: "Whether or not to enable zlib output compression for compressed CSS/JS in the manager"
description: "Removed in MODX 3.0. Formerly enabled zlib output compression for Manager CSS/JS."
---

**Removed in MODX 3.0.** Dynamic Manager JS/CSS minification and related settings are gone. See [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Enable zlib Output Compression for Manager JS/CSS
**Type**: Yes/No
**Default**: No
**Available In**: Revolution 2.2.0+
**Default**: No
**Available In**: Revolution 2.2.0–2.x only

Whether or not to enable zlib output compression for compressed CSS/JS in the manager. Do not turn this on unless you are sure the PHP config variable `zlib.output_compression` can be set to 1. MODX recommends leaving it off.
On 2.x: zlib output compression for compressed Manager CSS/JS. Leave off unless you know `zlib.output_compression` can be set to 1.
13 changes: 12 additions & 1 deletion en/building-sites/settings/manager_language.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,15 @@ _old_id: "192"
_old_uri: "2.x/administering-your-site/settings/system-settings/manager_language"
---

The `manager_language` setting was removed in MODX 3.0. [Learn more.](getting-started/maintenance/upgrading/3.0/manager-language)
## manager_language

**Removed in MODX 3.0.** Language detection and on-the-fly switching replaced this setting. [Learn more about the Manager language in 3.0](getting-started/upgrading-to-3.0/manager-language). Also listed under [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

---

**Name**: Manager Language
**Type**: String
**Default**: `en`
**Available In**: Revolution 2.x only

On 2.x: Manager UI language. Could override `cultureKey` for the `mgr` context.
12 changes: 7 additions & 5 deletions en/building-sites/settings/manager_time_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ _old_id: "194"
_old_uri: "2.x/administering-your-site/settings/system-settings/manager_time_format"
---

## manager\_time\_format
## manager_time_format

**Name**: Manager Time Format
**Type**: String
**Default**: g:i a
**Name**: Manager Time Format
**Type**: String
**Default**: `H:i` (MODX 3.0+; was `g:i a` in earlier 2.x defaults)

The format string, in PHP date() format, for the time settings represented in the manager.
PHP `date()` format string for times shown in the Manager.

See also [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).
10 changes: 7 additions & 3 deletions en/building-sites/settings/preserve_menuindex.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "preserve_menuindex"
description: "When duplicating Resources, the menu index order will also be preserved"
description: "When duplicating Resources, keep the menu index order"
---

## preserve_menuindex

**Name**: Preserve Menu Index When Duplicating Resources
**Type**: Yes/No
**Default**: Yes
**Default**: No (MODX 3.0+; was Yes in 2.x)
**Available In**: Revolution 2.5.0+

When duplicating Resources, the menu index order will also be preserved.
When duplicating Resources, the menu index order is preserved.

See also [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).
11 changes: 7 additions & 4 deletions en/building-sites/settings/resource_tree_node_name_fallback.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
---
title: "resource_tree_node_name_fallback"
description: "Specify the Resource field to use as fallback when rendering the nodes in the Resource Tree"
description: "Resource field used as fallback when rendering nodes in the Resource Tree"
---

## resource_tree_node_name_fallback

**Name**: Resource Tree Node Fallback Field
**Name**: Resource Tree Node Fallback Field
**Type**: String
**Default**: pagetitle
**Default**: `alias` (MODX 3.0+; was `pagetitle` in earlier 2.x defaults)

Specify the Resource field to use as fallback when rendering the nodes in the Resource Tree. This will be used if the resource has an empty value for the configured Resource Tree Node Field.
Resource field used as fallback when rendering nodes in the Resource Tree, if the configured Resource Tree Node Field is empty.

See also [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).
15 changes: 10 additions & 5 deletions en/building-sites/settings/server_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ _old_id: "275"
_old_uri: "2.x/administering-your-site/settings/system-settings/server_protocol"
---

## server\_protocol
## server_protocol

**Name**: Server Protocol
**Type**: String
**Default**: http
**Removed in MODX 3.0.** Use your web server / reverse-proxy HTTPS configuration instead. Listed under removed settings in [System Settings changes in 3.0](getting-started/upgrading-to-3.0/system-settings).

If your site is on a normal http or secure https connection.
---

**Name**: Server Protocol
**Type**: String
**Default**: `http`
**Available In**: Revolution 2.x only

On 2.x: whether the site ran on `http` or `https`.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "MODx.util.Format.dateFromTimestamp"

## MODx.util.Format.dateFromTimestamp

Available in MODX **3.x**. Turns a Unix timestamp into a string that follows the manager date and time formats from System Settings (`manager_date_format`, `manager_time_format`).
Available in MODX **3.0+** (added with the manager date/time helpers). Turns a Unix timestamp into a string that follows the manager date and time formats from System Settings (`manager_date_format`, `manager_time_format`).

Use it in CMP grids and panels when you show file times or other Unix timestamps and want the same look as the core manager UI.

Expand Down
Loading
Loading