diff --git a/docs/_images/cp-members.png b/docs/_images/cp-members.png index 197381423..3d4a07684 100644 Binary files a/docs/_images/cp-members.png and b/docs/_images/cp-members.png differ diff --git a/docs/add-ons/pro-search/filters.md b/docs/add-ons/pro-search/filters.md index 4fe1ab03e..a0dca61a9 100644 --- a/docs/add-ons/pro-search/filters.md +++ b/docs/add-ons/pro-search/filters.md @@ -168,7 +168,7 @@ You can use the native `search:field_name` parameter to target specific fields. ### Parameters #### `search:field_name` - Like the [channel search:field_name= parameter](/channel/channel_entries.html#search-field-name). + Like the [channel search:field_name= parameter](/channel/channel_entries.md#search-field-name). #### `search:field_name:column_name` Works just like the `search:field_name` parameter, but targets a specific column in a Grid/Matrix field. #### `search:title` @@ -178,7 +178,7 @@ You can use the native `search:field_name` parameter to target specific fields. #### `search:status` Works just like the `search:field_name` parameter, but targets statuses. #### `contains_words` - Accepts 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.html#contains-matching). Also possible by using `search:field_name="value\W"`. + Accepts 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). Also possible by using `search:field_name="value\W"`. #### `ends_with` Accepts parameter names. Force the given parameter values to match the end of the target field. Also possible by using `search:field_name="value$"`. #### `exact` diff --git a/docs/advanced-usage/front-end/frontend.md b/docs/advanced-usage/front-end/frontend.md index c791e2b13..a57fc85f8 100644 --- a/docs/advanced-usage/front-end/frontend.md +++ b/docs/advanced-usage/front-end/frontend.md @@ -58,7 +58,7 @@ This special conditional allows you to display content if front-end editing is e ## Enable/Disable The Front Edit Link There are several ways to disable front-end editing links: - - Globally with [configuration overrides](/general/system-configuration-overrides.html#enable_frontedit_links) or in [General Settings](/control-panel/settings/front-end-editing.md#enable-automatic-front-end-editing-links) + - Globally with [configuration overrides](/general/system-configuration-overrides.md#enable_frontedit_links) or in [General Settings](/control-panel/settings/front-end-editing.md#enable-automatic-front-end-editing-links) - Per field in the [field settings](control-panel/field-manager/field-manager-settings.md) - Via the Dock on the front-end by toggling Edit Mode on/off. - In the template by using [ExpressionEngine template comments](#expressionengine-comment), [HTML comments](#html-comment), or [field parameter](#field-tag-parameter) diff --git a/docs/control-panel/member-manager.md b/docs/control-panel/member-manager.md index 86d4e2a9c..1f563ed24 100755 --- a/docs/control-panel/member-manager.md +++ b/docs/control-panel/member-manager.md @@ -9,19 +9,25 @@ # Member Manager -**Control Panel Location: `Members`** +[TOC=2-3] -This page is used both to search and to browse through active members within your ExpressionEngine installation. Also, you can filter the members by member role and search members. +## Members Listing -This page also allows you to do the following: +**Control Panel Location: `Members`** -[TOC=2-3] +This page is used both to search and to browse through members within your ExpressionEngine installation. ![Member Manager Control Panel Page](_images/cp-members.png) +Filters and search input can be used to narrow down the list of members displayed. + +The set of columns displayed can be customized using the "Columns" dropdown. By default, the following columns are shown: Member ID, Name (which is composed of avatar, username and screen name), Email, Roles, Join Date, Last Visit Date. Also each member row has "Actions" buttons that contains links to some common actions and a checkbox that allows performing bulk actions on selected members. When "Pending" is selected in the "Role" filter, the bulk action options are "Approve" and "Decline", otherwise "Remove" is the only option. + +All roles assigned to a member are shown in the Roles column. When multiple roles are assigned, the primary role will have an indicator. If the member is pending the column does not say "Pending" but instead shows the role to which the member will be assigned once approved (with pending indicator) and a button to approve. + ## Member Roles -**Control Panel Location: `Members > Member Roles`** +**Control Panel Location: `Members > Roles`** The _Member Roles_ area of the Control Panel permits you to manage your Member Roles. The member roles can be sorted by ID, Role Name, and Status. @@ -31,7 +37,7 @@ You can assign multiple roles to a member. ### Create/Edit All Member Roles -**Control Panel Location: `Members > Member Roles > Create/Edit`** +**Control Panel Location: `Members > Roles > Create/Edit`** This sections allows you to set the various permissions and settings for the selected Member Role. @@ -50,17 +56,41 @@ Edit the role by clicking its name in the list. ## Custom Member Fields -**Control Panel Location: `Members > Member Fields`** +**Control Panel Location: `Settings > Members > Member Fields`** + +The link to this section is also found on top of the Member Listing page. The _Member Fields_ feature permits you to add fields to the member registration form and/or member profile and My Account areas. ### Create/Edit -**Control Panel Location: `Members > Member Fields > New/Edit`** +**Control Panel Location: `Settings > Members > Member Fields > New/Edit`** This section allows you to create or edit Member Fields. -The following fields are available: +The following field types are compatible and can be used for custom member fields: + +- Checkboxes +- Color Picker +- Date +- Duration +- Email Address +- File +- Number Input +- Multi Select +- Radio Buttons +- Range Slider +- Rich Text Editor +- Select Dropdown +- Selectable Buttons +- Text Input +- Textarea +- URL +- Value Slider + +Additionally, third-party field types that specify support for the `MemberField` model can be selected. + +The following fields are available when creating a custom field: - **Type** -- You may choose what type of field this is. There are three choices: 1. **Text Input**: This is a single input line for text. It is the type of field you might use for a title, name, or other short information. 2. **Textarea**: This is a standard text entry box with multiple lines. This is what you would use for larger amount of text. 3. **Drop-down List**: This creates a standard HTML ` +### Custom field + +The custom profile fields can be displayed individually by addressing them using the field's short name prefixed with `field:`: + + {field:birthday} + ## Custom Profile Field Variable Pair All custom fields are output inside the ``{custom_profile_fields}`` variable tag pair. @@ -112,20 +142,53 @@ All custom fields are output inside the ``{custom_profile_fields}`` variable tag

{/custom_profile_fields} -## Custom Profile Field Variables +### Custom Profile Field Variables + +These variables are available inside `{custom_profile_fields}` tag pair. + +#### `{lang:profile_field}` +#### `{field_label}` + +Outputs the custom field's label. -#### {lang:profile_field} +#### `{field_id}` -Outputs the custom field's name. +Field ID -#### {lang:profile_field_description} +#### `{field_name}` + +The field's short name + +#### `{lang:profile_field_description}` +#### `{field_instructions}` Outputs the field's description, if any. -#### {form:custom_profile_field} +#### `{form:custom_profile_field}` +#### `{display_field}` Shows the fully parsed custom member form field. +#### `{field_data}` + +Saved field data for the member + +#### `{if field_required}` + +Checks whether the field is set as required + +#### `{text_direction}` + +Text direction set for field (`rtl` or `ltr`) + +#### `{maxlength}` + +Maximum length set for text fields + +#### `{field_type}` + +Short name of the fieldtype used for field + ## Example {exp:member:edit_profile diff --git a/docs/member/member-roles-tags.md b/docs/member/member-roles-tags.md index b610521ec..81f3cd8f5 100644 --- a/docs/member/member-roles-tags.md +++ b/docs/member/member-roles-tags.md @@ -27,6 +27,12 @@ The `{exp:member:roles}` tag allows you to display all roles that the member bel Specifies a particular member's information to display. By default (if you do not include the `member_id`` parameter), the tag will simply display information pertaining to the currently logged-in user. +### `username=` + + username="admin" + +Username of member to display + ### Variables #### `{role_id}` diff --git a/docs/member/registration.md b/docs/member/registration.md index 5b59f6f08..4ce434879 100644 --- a/docs/member/registration.md +++ b/docs/member/registration.md @@ -28,10 +28,10 @@ NOTE: **Important:** In order for site visitors to be allowed to register for ac ### `form_class=` form_class="register" - + ### `primary_role=` - primary_role="7" + primary_role="7" This parameter allows you to specify the primary role to assign the new member, overriding the default member setting. @@ -40,6 +40,34 @@ This parameter allows you to specify the primary role to assign the new member, This parameter allows you to use inline errors in your registration form. The errors can be displayed using the `{error:field_name}` tag where `field_name` would need to be replaced with the name of the field that has an error, as used to compose the form. +### `include_assets=` + + include_assets="yes" + +Adds the Javascript and CSS that is required by custom member fields to your form. By default, these are **not** included + +### `datepicker=` + + datepicker="no" + +Adds the datepicker to your date fields. Defaults to "yes". + +NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`. + +### `include_css=` + + include_css="no" + +Allows you to manage the inclusion of required CSS independently from the `include_assets` parameter. Defaults to "yes". + +### `include_jquery=` + + include_jquery="no" + +Includes jQuery automatically. Defaults to "yes". + +NOTE: **Note:** If you are using your own copy of jQuery you will need to load it **before** the form. + ## Form Inputs NOTE: Be sure to include the required JavaScript and CSS to use the native [Password Validation](member/password-validation.md). @@ -94,6 +122,44 @@ Please note you need to address those by ID and not name, e.g. `m_field_id_8` +And easier way to display the field's input is to use the special tag: + + + {field:work_title} + +Custom fields can also be output inside the ``{custom_fields}`` variable tag pair. + + {custom_fields} +

+
+ {lang:profile_field_description}
+ + {form:custom_profile_field} + +

+ {/custom_fields} + +### `{custom_fields}` Pair Variables + +#### `{lang:profile_field}` +#### `{field_name}` + +Outputs the custom field's name. + +#### `{lang:profile_field_description}` +#### `{field_description}` + +Outputs the field's description, if any. + +#### `{form:custom_profile_field}` +#### `{field}` + +Shows the fully parsed custom member form field. + +#### `{if required}` + +Indicates whether the field is marked as required + ## Variables ### `{accept_terms}` @@ -137,6 +203,9 @@ This will show errors with the submitted password as well as password confirm. {if error:username}{error:username}{/if} +### `{field:field_name}` + +Displays the custom field input form for the given field (substitute `field_name` with the actual field name). Note that the field must be set as "visible on registration" in order to show up. ## Example diff --git a/docs/templates/embedding.md b/docs/templates/embedding.md index d3d010284..4321e9113 100755 --- a/docs/templates/embedding.md +++ b/docs/templates/embedding.md @@ -21,7 +21,7 @@ Where "template_group" is the name of the group and "template" is the name of th You **must** include both the template group and the template name in the embed tag. -By default, you cannot use embeds inside of Forum templates. See [Other Features](add-ons/forum/other-features.md) for instructions on running the forums through regular templates. +By default, you cannot use embeds inside of Forum templates. See [Other Forum Features](https://github.com/ExpressionEngine/Forum/blob/main/docs/other-features.md) for instructions on running the forums through regular templates. ### Notes diff --git a/docs/templates/engine.md b/docs/templates/engine.md index de2c87e03..82667db62 100755 --- a/docs/templates/engine.md +++ b/docs/templates/engine.md @@ -13,7 +13,7 @@ When ExpressionEngine serves up each Template, the system must go through a rendering process to parse out the Tags, Variables, Template Partials, and Embeds being used in the Template. This page explains the order of those rendering stages. This information can be immensely useful when building pages and troubleshooting problems. -NOTE: **Note:** The information in this article applies only to rendering Templates. It doesn't apply to rendering theme files such as those used for [Member Profiles](control-panel/template-manager.md#member-profile-templates), or the [Discussion Forum](add-ons/forum/themes.md) module. +NOTE: **Note:** The information in this article applies only to rendering Templates. It doesn't apply to rendering theme files such as those used for [Member Profiles](control-panel/template-manager.md#member-profile-templates) (legacy), or the [Discussion Forum](https://github.com/ExpressionEngine/Forum/blob/main/docs/themes.md) module. ## Rendering Order diff --git a/docs/troubleshooting/front-end-content-management.md b/docs/troubleshooting/front-end-content-management.md index 4a223a9d4..10f0a62df 100644 --- a/docs/troubleshooting/front-end-content-management.md +++ b/docs/troubleshooting/front-end-content-management.md @@ -22,13 +22,13 @@ There are several settings that could prevent the Dock from showing on the front - The Dock is disabled via settings or config override. Disabling the Dock will disable all Front-End Content Management on the front-end of your site. - Via [front-end editing settings](control-panel/settings/front-end-editing.md), ensure that the "Enable Dock?" setting is toggled on. - - Via the [`enable_dock` config override](general/system-configuration-overrides.md#enable_dock). If in use, this override must be set to `'y'` for the Dock to work on the front-end. + - Via the [`enable_dock` config override](general/system-configuration-overrides.md#enable-dock). If in use, this override must be set to `'y'` for the Dock to work on the front-end. ### Dock shows, but front edit links do not show on the front-end of the website. - Front edit links are disabled via settings or config override. - Via settings [front-end editing settings](control-panel/settings/front-end-editing.md), ensure that the "Enable front-end editing" setting is toggled on. - - Via the [`enable_frontedit` config override](general/system-configuration-overrides.md#enable_frontedit). If in use, this override must be set to `'y'` for front-end editing to work. + - Via the [`enable_frontedit` config override](general/system-configuration-overrides.md#enable-frontedit). If in use, this override must be set to `'y'` for front-end editing to work. - User does not have proper access to edit channels. Users must be assigned a role which has access to channels and to be able to edit channel content to see related front edit links on the site. @@ -45,4 +45,3 @@ There are several settings that could prevent the Dock from showing on the front - Front edit links are disabled via HTML comments, EE template comments, or `disable` parameter. There are 3 ways to disable Pro's automatic generation of front edit links. Ensure that the template code your inspecting isn't surrounded by template comments or wrapped in a field tag using `disable="frontedit`. For details on these methods read the [docs regarding disabling front-edit links](advanced-usage/front-end/frontend.md#enabledisable-the-front-edit-link) - User does not have proper access to edit channels they are viewing. Users must be assigned access to channels and to be able to edit channel content to see related front edit links on the site. If the user is viewing entries on the front-end for which they do not have content, then no front edit links will show. -