From 5f9646e34553ae4d56ad51fff09ae32f6469f074 Mon Sep 17 00:00:00 2001 From: robinsowell Date: Tue, 10 Sep 2024 15:14:37 -0400 Subject: [PATCH 1/3] Rough draft template generator 'note' I'm wondering if this might be better as a section than a note, and if so, where. Especially with the pro search one, there are some requirements for it to work. But... rough draft, so I shall ponder. --- docs/add-ons/pro-search/tags.md | 1 + docs/channels/channel-form/overview.md | 2 ++ docs/channels/entries.md | 2 ++ docs/member/index.md | 2 ++ 4 files changed, 7 insertions(+) diff --git a/docs/add-ons/pro-search/tags.md b/docs/add-ons/pro-search/tags.md index d77a64782..9deb2bcc1 100644 --- a/docs/add-ons/pro-search/tags.md +++ b/docs/add-ons/pro-search/tags.md @@ -22,6 +22,7 @@ added in X.X.X: This parameter/field is only available from this version forward logged in: This tag is only available if the user is logged in. ``` +NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the keyword search in ExpressionEngine 7.5+. Pro Search must be installed and a Collection created. ## {exp:pro_search:form} diff --git a/docs/channels/channel-form/overview.md b/docs/channels/channel-form/overview.md index 4a866b93d..2fa858cba 100755 --- a/docs/channels/channel-form/overview.md +++ b/docs/channels/channel-form/overview.md @@ -24,6 +24,8 @@ The Channel Form makes it possible to add and edit channel entries from outside - Server-side validation. - Handles AJAX requests and can output responses in JSON. +NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the channel form in ExpressionEngine 7.5+. + ## Basic Usage TIP: Please visit the [Examples](channels/channel-form/examples.md) page to see a variety of implementations. diff --git a/docs/channels/entries.md b/docs/channels/entries.md index 63ea5400b..2a4bb9287 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -33,6 +33,8 @@ The directives that tell the tag how to behave are **parameters**: Within the opening and closing ExpressionEngine Tags are **variables**. `{title}` is replaced with the Title of each entry, and `{body}` is replaced with the content from the "Body" field of each entry. +NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the channel entries in ExpressionEngine 7.5+. + ## Parameters [TOC=3 hide] diff --git a/docs/member/index.md b/docs/member/index.md index 5ddb9317a..926bc53ef 100755 --- a/docs/member/index.md +++ b/docs/member/index.md @@ -34,6 +34,8 @@ NOTE: **Note:** A member account's Username and Screen Name can be identical, bu - [Ignore List Tag](member/ignore-list.md) - [Profile Templates (Legacy)](member/profile-templates.md) +NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the member templates in ExpressionEngine 7.5+. + ### Member Navigation From efe625bdc2067ba23e13af5816172d254888e2c8 Mon Sep 17 00:00:00 2001 From: robinsowell Date: Tue, 8 Oct 2024 13:06:18 -0400 Subject: [PATCH 2/3] Fixed note format and added structure note re template generators --- docs/add-ons/pro-search/tags.md | 2 +- docs/add-ons/structure/overview.md | 4 +++- docs/channels/entries.md | 2 +- docs/member/index.md | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/add-ons/pro-search/tags.md b/docs/add-ons/pro-search/tags.md index 9deb2bcc1..52b927bbe 100644 --- a/docs/add-ons/pro-search/tags.md +++ b/docs/add-ons/pro-search/tags.md @@ -22,7 +22,7 @@ added in X.X.X: This parameter/field is only available from this version forward logged in: This tag is only available if the user is logged in. ``` -NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the keyword search in ExpressionEngine 7.5+. Pro Search must be installed and a Collection created. +NOTE: **Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the keyword search in ExpressionEngine 7.5+. Pro Search must be installed and a Collection created. ## {exp:pro_search:form} diff --git a/docs/add-ons/structure/overview.md b/docs/add-ons/structure/overview.md index 333aebeb7..cb8c068ee 100644 --- a/docs/add-ons/structure/overview.md +++ b/docs/add-ons/structure/overview.md @@ -13,4 +13,6 @@ Structure is a powerful add-on that lets you create pages, generate navigation, It forgoes the default template_group/template setup and creates “static” and “listing” pages that are all editable through a tree sitemap view. With Structure enabled, traditional page style content and multiple entry pages can live within the same area. -NOTE:**Note:** Documentation for Structure is still being migrated. Until this is complete, please reference the [Structure documentation on EEHarbor's website](https://eeharbor.com/structure/documentation). \ No newline at end of file +NOTE:**Note:** Documentation for Structure is still being migrated. Until this is complete, please reference the [Structure documentation on EEHarbor's website](https://eeharbor.com/structure/documentation). + +NOTE:**Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the structure templates in ExpressionEngine 7.5+. \ No newline at end of file diff --git a/docs/channels/entries.md b/docs/channels/entries.md index 2a4bb9287..be2d5eef5 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -33,7 +33,7 @@ The directives that tell the tag how to behave are **parameters**: Within the opening and closing ExpressionEngine Tags are **variables**. `{title}` is replaced with the Title of each entry, and `{body}` is replaced with the content from the "Body" field of each entry. -NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the channel entries in ExpressionEngine 7.5+. +NOTE: **Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the channel entries in ExpressionEngine 7.5+. ## Parameters diff --git a/docs/member/index.md b/docs/member/index.md index 926bc53ef..1ece2396a 100755 --- a/docs/member/index.md +++ b/docs/member/index.md @@ -34,7 +34,7 @@ NOTE: **Note:** A member account's Username and Screen Name can be identical, bu - [Ignore List Tag](member/ignore-list.md) - [Profile Templates (Legacy)](member/profile-templates.md) -NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the member templates in ExpressionEngine 7.5+. +NOTE: **Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the member templates in ExpressionEngine 7.5+. ### Member Navigation From 0fbac7a9c9339b20eaf758d2effeee5d40fc5dc5 Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Mon, 14 Oct 2024 16:16:52 -0400 Subject: [PATCH 3/3] Update cross-references to template generators --- docs/add-ons/pro-search/tags.md | 34 +++++++++++++------------- docs/add-ons/structure/overview.md | 4 +-- docs/channels/channel-form/overview.md | 5 ++-- docs/channels/entries.md | 2 +- docs/control-panel/template-manager.md | 4 +-- docs/member/index.md | 4 +-- docs/templates/generators.md | 2 +- 7 files changed, 26 insertions(+), 29 deletions(-) diff --git a/docs/add-ons/pro-search/tags.md b/docs/add-ons/pro-search/tags.md index 52b927bbe..9d111072b 100644 --- a/docs/add-ons/pro-search/tags.md +++ b/docs/add-ons/pro-search/tags.md @@ -10,19 +10,19 @@ [TOC] -**These terms are used throughout the documentation:** +**These terms are used throughout the documentation:** ``` -required: This parameter/field is required for this tag to function. -form only: This can only be set as a field in the form and not as a parameter in the tag. -param only: This parameter can only be set in the tag and not as a field in the form. -fixed value: This field cannot be edited and is set with a fixed value. -recurring only: This parameter/field only applies to recurring charges. -one-time only: This parameter/field only applies to one-time charges. -added in X.X.X: This parameter/field is only available from this version forward. -logged in: This tag is only available if the user is logged in. +required: This parameter/field is required for this tag to function. +form only: This can only be set as a field in the form and not as a parameter in the tag. +param only: This parameter can only be set in the tag and not as a field in the form. +fixed value: This field cannot be edited and is set with a fixed value. +recurring only: This parameter/field only applies to recurring charges. +one-time only: This parameter/field only applies to one-time charges. +added in X.X.X: This parameter/field is only available from this version forward. +logged in: This tag is only available if the user is logged in. ``` -NOTE: **Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the keyword search in ExpressionEngine 7.5+. Pro Search must be installed and a Collection created. +NOTE: **Note:** See the [template generator](templates/generators.md) for the keyword search in ExpressionEngine 7.5+. Pro Search must be installed and a Collection created. ## {exp:pro_search:form} @@ -157,7 +157,7 @@ Short syntax for the URL tag. When used, it will automatically inherit the query ## {exp:pro_search:filters} The Filters tag works identically to the Form tag, without generating a search form. Use it to show specific search filters anywhere on your page, or to create a list of URL tags in short syntax. The following example shows a list of one-click filters based on the current search that could be used to modify the results display with javascript: - + {exp:pro_search:filters query="{segment_3}"} {exp:channel:categories channel="entries" style="linear"} {if count == 1}
    {/if} @@ -317,7 +317,7 @@ Alternative syntax for the native {if no_results}{/if} conditional. #### `group_id=` Limit shortcuts by given group ID - + {exp:pro_search:shortcuts group_id="1"} {if count == 1}
      {/if}
    • {shortcut_label}
      • @@ -403,7 +403,7 @@ Group ID the shortcut needs to be saved to. **Required**. {/exp:pro_search:save} - + #### `form_attribute=` Specifies any html attribute you want the form to have. For example: `form_id="search"` will add `id="search"` to the form tag, while `form_class="searchform"` will add `class="searchform"` to the tag. @@ -438,7 +438,7 @@ The encoded search query to inherit. Not needed when [not encoding queries](http #### `reset=` -Set to "yes" to stop this tag from inheriting the current query. +Set to "yes" to stop this tag from inheriting the current query. {exp:pro_search:url reset="yes"} @@ -465,7 +465,7 @@ Use this single tag to output a single given parameter value outside of the Form {exp:pro_search:param get="item_size"} You can also use it as a paired loop to output multi-valued parameters. - + {exp:pro_search:param:loop get="category" as="cat_id" query="{segment_3}"} {cat_id} {/exp:pro_search:param:loop} @@ -501,7 +501,7 @@ Use this tag to display a list of popular keywords. The Search Log must be enabl #### `limit=` Maximum number of keywords to display. Defaults to 10. - + {exp:pro_search:popular limit="10"} {if count == 1}
        {/if}
      • {keywords}: {search_count}
        • @@ -625,7 +625,7 @@ Maximum number of suggestions to return. Defaults to 5. The method used for getting the suggestions, either `levenshtein` or `soundex`. Defaults to Levenshtein. {exp:pro_search:suggestions method="soundex"} - + NOTE: **Note:** Using Soundex for generating suggestions is only effective for languages with a latin-based alphabet. The Levenshtein method works regardless of alphabet type. #### `query=` diff --git a/docs/add-ons/structure/overview.md b/docs/add-ons/structure/overview.md index cb8c068ee..5e9335c89 100644 --- a/docs/add-ons/structure/overview.md +++ b/docs/add-ons/structure/overview.md @@ -13,6 +13,6 @@ Structure is a powerful add-on that lets you create pages, generate navigation, It forgoes the default template_group/template setup and creates “static” and “listing” pages that are all editable through a tree sitemap view. With Structure enabled, traditional page style content and multiple entry pages can live within the same area. -NOTE:**Note:** Documentation for Structure is still being migrated. Until this is complete, please reference the [Structure documentation on EEHarbor's website](https://eeharbor.com/structure/documentation). +Structure provides a [Template Generator](templates/generators.md) that demonstrates how to integrate Structure template tags with your site. -NOTE:**Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the structure templates in ExpressionEngine 7.5+. \ No newline at end of file +NOTE:**Note:** Documentation for Structure is still being migrated. Until this is complete, please reference the [Structure documentation on EEHarbor's website](https://eeharbor.com/structure/documentation). \ No newline at end of file diff --git a/docs/channels/channel-form/overview.md b/docs/channels/channel-form/overview.md index 2fa858cba..14ec1d38e 100755 --- a/docs/channels/channel-form/overview.md +++ b/docs/channels/channel-form/overview.md @@ -24,11 +24,10 @@ The Channel Form makes it possible to add and edit channel entries from outside - Server-side validation. - Handles AJAX requests and can output responses in JSON. -NOTE: See the [template generator](control-panel/template-manager.md#template-generators) for the channel form in ExpressionEngine 7.5+. - ## Basic Usage -TIP: Please visit the [Examples](channels/channel-form/examples.md) page to see a variety of implementations. +TIP: You can view the [Examples](channels/channel-form/examples.md) page to see a variety of implementations. + The Channel Form [Template Generator](templates/generators.md) can also help create a functional template that demonstrates the parameters and variables documented below. The first thing you will need is a `{exp:channel:form}` tag pair, along with a few [parameters](#parameters) to determine where to submit the entry: diff --git a/docs/channels/entries.md b/docs/channels/entries.md index be2d5eef5..fc5cdf8bc 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -33,7 +33,7 @@ The directives that tell the tag how to behave are **parameters**: Within the opening and closing ExpressionEngine Tags are **variables**. `{title}` is replaced with the Title of each entry, and `{body}` is replaced with the content from the "Body" field of each entry. -NOTE: **Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the channel entries in ExpressionEngine 7.5+. +The Channel Entries module provides a [Template Generator](templates/generators.md) that creates functional templates while demonstrating the parameters and variables documented below. ## Parameters diff --git a/docs/control-panel/template-manager.md b/docs/control-panel/template-manager.md index 0a8be57fd..3cadca503 100755 --- a/docs/control-panel/template-manager.md +++ b/docs/control-panel/template-manager.md @@ -241,7 +241,7 @@ This section of the Control Panel allows you to create or edit a template group. ## Template Generators -**Control Panel Location: `Developer > Templates > Template Generators`** +**Control Panel Location: `Developer > Templates > Template Generator`** This section of the Control Panel allows you to automatically create the basic tag framework for a variety of modules, including channels, navigation, member tags, etc. using [Template Generators](templates/generators.md). @@ -249,4 +249,4 @@ This section of the Control Panel allows you to automatically create the basic t **Control Panel Location: `Developer > Templates > Export`** -![Export All Templates icon](/_images/export_templates.png) Clicking the Export All Templates Icon will download all templates, partials, and variables as a compressed *.zip archive. +![Export All Templates icon](/_images/export_templates.png) Clicking the Export All Templates Icon will download all templates, partials, and variables as a compressed *.zip archive. diff --git a/docs/member/index.md b/docs/member/index.md index 1ece2396a..6e13c2519 100755 --- a/docs/member/index.md +++ b/docs/member/index.md @@ -14,7 +14,7 @@ You'll find many member management options available at: - The [Members](control-panel/member-manager.md) section, which hosts a comprehensive suite of member management utilities including the [Membership Preferences](control-panel/settings/members.md) page. - The My Account Page, accessible from the Control Panel's sidebar. It can also display information for any member if you choose a particular member from `Members`. - Member [global template variables](templates/globals/single-variables.md#member-variables), which allow you to output information on the current user. -- Member tags can be used to build a robust frontend member area, enabling your site members to manage their personal profile information without having access to your Control Panel. +- Member tags can be used to build a robust frontend member area, enabling your site members to manage their personal profile information without having access to your Control Panel. The Member Management [Template Generator](templates/generators.md) can create a set of functional templates that demonstrate how to use these tags along with their available parameters and variables. NOTE: **Note:** A member account's Username and Screen Name can be identical, but the Username must be unique system-wide. @@ -34,8 +34,6 @@ NOTE: **Note:** A member account's Username and Screen Name can be identical, bu - [Ignore List Tag](member/ignore-list.md) - [Profile Templates (Legacy)](member/profile-templates.md) -NOTE: **Note:** See the [template generator](control-panel/template-manager.md#template-generators) for the member templates in ExpressionEngine 7.5+. - ### Member Navigation diff --git a/docs/templates/generators.md b/docs/templates/generators.md index b12130d5a..609283c4f 100644 --- a/docs/templates/generators.md +++ b/docs/templates/generators.md @@ -15,7 +15,7 @@ ExpressionEngine provides a set of template generators that allow you to quickly ## Control Panel Usage -Before you can use the template generators you will need to set up your channels and custom fields. Once this is done you can navigate to Templates > Template Generator. +Before you can use the template generators you will need to set up your channels and custom fields. Once this is done you can navigate to `Developer > Templates > Template Generator`. ![ExpressionEngine Control Panel Template Generator](_images/cp-template-generators.png)