Merge branch '7.dev' into feature/7.x/passthrough-html-form-attrs

Author: intoeetive

AUTHORS.md

@@ -17,6 +17,7 @@ If an entry is incorrect or duplicated, add or correct the entry in `.mailmap` i
 - Derek Jones <derek.jones@ellislab.com>
 - Doug Black Jr <dougblackjr@gmail.com>
 - Douglas Black <dougblackjr@gmail.com>
+- Eric Swierczek <2423727+swierczek@users.noreply.github.com>
 - Erwin Romkes <hello@stoneandstorm.com>
 - Gareth Davies <hello@garethtdavies.com>
 - Gavin * JCOGS <gavin@jcogs.net>
@@ -54,7 +55,7 @@ If an entry is incorrect or duplicated, add or correct the entry in `.mailmap` i
 - Simon Job <simon@job.id.au>
 - Stefan Rechsteiner <info@stefanrechsteiner.com>
 - Stephen G <45797159+stephengalbraith@users.noreply.github.com>
-- Stephen G <45797159+zdravvy@users.noreply.github.com>
+- zdravvy <45797159+zdravvy@users.noreply.github.com>
 - Terry Leigh Britton <terrybritton@users.noreply.github.com>
 - Tom Jaeger <Tom@PacketTide.com>
 - TomJaeger <Tom@PacketTide.com>

README.md

@@ -8,7 +8,7 @@ The ExpressionEngine user guide is written in human-readable Markdown and uses a
 
 ### Prerequisites
 
-Building the docs requires Node and npm.
+Building the docs requires Node and npm (latest stable version).
 
 In the root of the repository, install all the dependencies:
 
@@ -30,6 +30,10 @@ The documentation css and js files are located under `theme/assets-src`.
 
 To build the theme assets, run `npm run buildAssets`. You can also dynamically rebuild the assets when a file changes: `npm run watchAssets`.
 
+### Viewing local changes
+
+Manually load `/build/index.html` in your browser to view your local build. For example, `file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html`. You can use the side navigation to navigate to different local files, but the search functionality always takes you to the live version at docs.expressionengine.com.
+
 ## Contributing
 
 See something that needs fixing? Want to improve the user guide or make it more helpful? Great! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for details.

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

@@ -43,11 +43,15 @@ Set to no to have a given query overwrite a valid shortcut. Defaults to yes (a s
 
 #### form_attribute
 
-Specifies any html attribute you want the form to have. For example: form_id="search" will add id="search" to the
+Specifies any html attribute you want the form to have. For example: form_id="search" will add id="search", or form_class="searchform" will add class="searchform" to the tag.
 
-tag. query Use this parameter to pass through a previously executed encoded search query. Not needed when not encoding queries.
+    {exp:pro_search:form form_id="search" form_class="searchform"}
 
-    {exp:pro_search:form form_id="search"}
+#### query
+
+Use this parameter to pass through a previously executed encoded search query. Not needed when [not encoding queries](https://docs.expressionengine.com/latest/add-ons/pro-search/settings.html#encode-query).
+
+    {exp:pro_search:form query="{segment_3}"}
 
 #### required
 
@@ -667,4 +671,4 @@ Alternative syntax for the native {if no_results}{/if} conditional.
     {exp:pro_search:suggestions keywords="jongle" keywords:lang="en" limit="1"}
     Did you mean {suggestion}?
     {if no_suggestions}No suggestions found.{/if}
-    {/exp:pro_search:suggestions}
+    {/exp:pro_search:suggestions}

docs/channels/entry-tracking.md

@@ -19,6 +19,8 @@ NOTE: **Note:** The view tracking counter works in conjunction with the `{exp:ch
 
 NOTE: **Note:** If you have page caching enabled this feature will not work.
 
+Some people have tags that are used to mimic a single-entry page without it being dynamic (e.g. by using `dynamic="no"` parameter). If you need Entry View Tracking to work for ANY combination that results in only one entry being returned by the tag (including channel query caching), you would need to set the [`relaxed_track_views`](general/system-configuration-overrides.md#relaxed_track_views) configuration override if your config file.
+
 ## Tracking Views
 
 The view tracking feature must be enabled in a specific instance of the `{exp:channel:entries}` tag using the `track_views` parameter. Within the `track_views` parameter you will indicate which one of the four "instances" of the view counter you would like to use, like this

docs/contributing.md

@@ -17,7 +17,7 @@ We're excited that you want to get involved in the ExpressionEngine project. The
 ## Contributing to the Docs
 Good documentation is the foundation of good software and your contributions can help make good documentation great.
 
-If you're an ExpressionEngine user, then you have something to add. There is always room for more examples, clarifications, corrections and updates. Jump in and make a pull request or give us a heads up by reporting an issues. Please visit the [Docs Contributing Guidelines](https://github.com/ExpressionEngine/ExpressionEngine-User-Guide/blob/6.dev/CONTRIBUTING.md) to learn how to get started.
+If you're an ExpressionEngine user, then you have something to add. There is always room for more examples, clarifications, corrections and updates. Jump in and make a pull request or give us a heads up by reporting an issues. Please visit the [Docs Contributing Guidelines](https://github.com/ExpressionEngine/ExpressionEngine-User-Guide/blob/7.dev/CONTRIBUTING.md) to learn how to get started.
 
 *Related ExpressionEngine University articles:* [Contributing to ExpressionEngine Documentation](https://u.expressionengine.com/article/contributing-to-expressionengine-documentation)
 

docs/control-panel/channels.md

@@ -121,8 +121,11 @@ NOTE: **Note:** We recommend using the default base URL variable `{base_url}` de
 - **Maximum characters allowed?** -- You may set a maximum number of characters allowed in any comment. Setting this preference to 0 (zero) will not place a restriction on the number of characters allowed.
 - **Comment time limit** -- This is the optional number of seconds that must lapse after a comment is posted before that same user can post another comment. This setting can help reduce comment "spam". The preference can be left blank or set to 0 (zero) if you do not want to impose a limit.
 - **Comment expiration** -- The number of days after an entry is posted in which to allow comments. After that period has expired, the entry will be closed to commenting and the comment form will no longer appear. Existing comments will still be displayed. Enter 0 (zero) for no expiration. Note that this preference sets the _default_ setting for the channel. The setting can be overridden and changed on a per-entry basis. You may override this setting in the [Comment Module Control Panel](comment/control-panel.md) section of the Comment Module so that comments are set to be moderated rather than closed once the expiration period is passed. If you also select the checkbox accompanying this setting, then all existing entries in this channel will be updated to reflect the new setting when you submit.
-- **Text formatting** -- This setting determines how comments are formatted by the system. There are three possible choices:
+- **Text formatting** -- This setting determines how comments are formatted by the system. There are three possible choices: `Auto line break`, `None`, and `XHTML`
 - **HTML formatting** -- Like the channel setting, this preference determines how raw HTML code within comments is handled. There are three options:
+1. Convert to HTML entities -- This will convert any HTML tags to their encoded versions and output the HTML tag as text without rendering the HTML in the DOM. For example: `<h1>` would become `&lt;h1&gt;`.
+2. Allow only safe HTML -- This will remove any unsafe HTML tags as defined in the [Typography library](development/legacy/libraries/typography.md#html_format).
+3. Allow all HTML (not recommended) -- This will allow any HTML to be saved and output as-is. For example: `<h1>test</h1>` would actually render an `h1` in the DOM.
 - **Allow image URLs?** -- You can determine whether or not you want people to be able to display images within comments by using the URL for the image.
 - **Render URLs and Email addresses as links?** -- When this option is set to "Yes", any full URLs or email addresses in comments will be automatically formatted as a valid HTML link to the address. If the option is "No" then the URL or email address in comment body will be treated and displayed as plain text.
 

docs/control-panel/settings/members.md

@@ -77,19 +77,22 @@ The default member profile theme to be used in the Member Profile area of your s
 
 ![sort by](/_images/member_sort_by.png)
 
-Specifies the sorting criteria to be used. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
+Specifies the default sorting criteria to be used by `{exp:members:memberlist}` tag. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
+Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).
 
 ### Order by
 
 ![order by](/_images/member_order_by.png)
 
-Specifies whether to show the list in _Ascending_ or _Descending_ order.
+Specifies whether to show the `{exp:members:memberlist}` list in _Ascending_ or _Descending_ order.
+Can also be changed using [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by).
 
 ### Total results
 
 ![total results](/_images/member_total_results.png)
 
-Specifies the number of results to return by default.
+Specifies the number of results that `{exp:members:memberlist}` tag will display by default.
+Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).
 
 ### Enable new member notifications?
 

docs/control-panel/utilities/debug.md

@@ -15,6 +15,15 @@ The check are being run automatically when you visit the utility pages and also
 
 [TOC]
 
+## Review Duplicate Template Groups
+
+**Control Panel Location: `Tools > Utilities > Duplicate Template Groups`**
+
+ExpressionEngine expects each template group name to be unique per site. We do have automated checks to prevent duplicates, however in very rare cases the checks could have been skipped leading to duplicate records for template groups in database.
+
+This utility helps to identify such cases and provide ability to remove or rename the duplicates.
+
+
 ## Debug Template Tags
 
 **Control Panel Location: `Tools > Utilities > Debug Template Tags`**
@@ -27,7 +36,7 @@ If it finds a tag that corresponds to the add-on that is missing or not installe
 
 Clicking on the tag name shows the list of templates where it is found.
 
-### Debug Fieldtypes
+## Debug Fieldtypes
 
 **Control Panel Location: `Tools > Utilities > Debug Fieldtypes`**
 

docs/development/legacy/libraries/output.md

@@ -158,3 +158,21 @@ Example:
     exit;
 
 NOTE: **Note:** Calling this method manually without aborting script execution will result in duplicated output.
+
+### `send_ajax_response($msg, [$error = false])`
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| \$msg  | `Array` | Object to be sent to the client. |
+| \$error  | `Bool` | TRUE to set header status to `500` |
+| Returns   | `Void`   | void                 |
+
+Calling this method encode the given `$msg` parameter and will set the header `Content-Type: application/json`.
+
+Example:
+
+    $output = array(
+        'this' => 'that',
+        'foo' => 'bar'
+    );
+    ee()->output->send_ajax_response($output);

docs/development/legacy/libraries/template.md

@@ -477,7 +477,7 @@ Array containing single variables within `TMPL::$tagdata`.
 
 Array containing variable pairs within `TMPL::$tagdata`.
 
-### `TMPL::fetch_param($which[, $default = FALSE])`
+### `fetch_param($which[, $default = FALSE])`
 
 | Parameter | Type     | Description                           |
 | --------- | -------- | ------------------------------------- |
@@ -517,3 +517,65 @@ Write message to template log in Output Profiler.
 | ----------- | --------- | --------------------------------------------------------------- |
 | \$str       | `String`  | Log message                                                     |
 | \$details   | `String`  | More detailed log message, initially hidden behind "read more"  |
+
+
+### `parse_globals($str)`
+
+| Parameter   | Type      | Description                                                     |
+| ----------- | --------- | --------------------------------------------------------------- |
+| \$str       | `String`  | Parsed tempate                                                  |
+
+Parses global variables like the currently logged in member's information, system variables, paths, action IDs, CAPTCHAs. Typically stuff that should only be done after caching to prevent  any manner of changes in the system or who is viewing the page to affect the display.
+
+This function would also strip ExpessionEngine comments from the code. It is being run automatically on each front-end page request, however if you are using TMPL library for other types of requests, you might need to call it manually.
+
+### `show_404()`
+
+Show a 404 page whether one is set in the config or not
+
+### `fetch_template($template_group, $template, $show_default = true, $site_id = '')`
+
+| Parameter        | Type      | Description                                                     |
+| ---------------- | --------- | --------------------------------------------------------------- |
+| \$template_group | `String`  | Template group name                                             |
+| \$template       | `String`  | Tempate name                                                    |
+| \$show_default   | `Bool`    | If `true`, show template from default group in site             |
+| \$site_id        | `Int`     | Site ID                                                         |
+
+Fetch Template Data
+
+Takes a Template Group, Template, and Site ID and will retrieve the Template and its metadata from the database (or file)
+
+### `fetch_and_parse($template_group = '', $template = '', $is_embed = false, $site_id = '', $is_layout = false)`
+
+| Parameter        | Type      | Description                                                     |
+| ---------------- | --------- | --------------------------------------------------------------- |
+| \$template_group | `String`  | Template group name                                             |
+| \$template       | `String`  | Tempate name                                                    |
+| \$is_embed       | `Bool`    | Whether processed template is an embedded template              |
+| \$site_id        | `Int`     | Site ID                                                         |
+| \$is_layout      | `Bool`    | Whether processed template is a layout template                 |
+
+Fetch and Process Template
+
+Determines what template to process, fetches the template and its preferences, and then processes all of it
+
+### `no_results()`
+
+Return template chunk contained inside `{if no_results}...{/if}`
+
+If a tag/class has no results to show, it can call this method. Any `no_results`` variable in  the tag will be followed. May be 404 page, content, or even a redirect.
+
+### `remove_ee_comments($str)`
+
+| Parameter   | Type      | Description                                                     |
+| ----------- | --------- | --------------------------------------------------------------- |
+| \$str       | `String`  | Parsed tempate                                                  |
+
+Remove all EE Code Comment Strings
+
+EE Templates have a special EE Code Comments for site designer notes and are removed during Template processing.
+
+### `sync_from_files()`
+
+Synchronize templates between database and files