module (Page)
This module component fetches data relating to Pages.
Possible use cases for this are creating dynamic menus or automatic on-page sitemaps. Specifically, creating a dynamic on-page sub-menu (of all the pages within the current folder/directory).
Pages are based on the same structure as many other modules in WebinOne. So you can retrieve, list, sort and filter your site pages just like you might Blog Posts or Custom Modules.
{% component type: "module", source: "Page", layout: "Page Detail" %}
Parameters and Options
module (default)
This is the name of the entity that needs to be used for the component retrieving function.
Page (default)
Page Detail (default)
<Your Layout name>
The layout name you want to use for rendering the component. The layout name is referenced from the available Layouts of the source specified.
While this parameter is required to render your Layout markup, if the parameter is blank, has an incorrectly referenced Layout, or is removed altogether then the component will still output the modules item data to a Liquid collection which can be accessed via the collectionVariable
parameter.
id
parentid
name
weighting
url
urlslug
releasedate
expirydate
LastUpdatedDate
Author
ItemCategories
ItemTags
<CustomPropertyName>
...and any other top level properties available for the module
Remove spaces from custom property names here.
<your value>
Liquid variables can be used here also. If present but no value set, no items will be returned.
id
parentid
name
weighting
url
urlslug
releasedate
expirydate
LastUpdatedDate
Author
ItemCategories
ItemTags
<CustomPropertyName>
...and any other top level properties available for the module
Remove spaces from custom property names here.
ASC (default)
DESC
ASC
sorts the items in ascending order while DESC
sorts in descending order (based on alpha/numeric or date sorting).If empty or not present, alpha/numeric sorting will be used.
false (default)
true
false
items will sort by their weighting values first, followed by any sortBy properties (or the default alpha/numeric sorting if sortBy is empty or not present). If true
item weightings will be ignored and sorting will only be applied via sortBy or default sorting.false (default)
true
If used in conjunction with sortBy, that sorting criteria will be applied to the randomly retrieved results. So, if retrieving all, or most, of the items they will not appear to be random since they will then be sorted back into a logical order. To overcome this, set the sortBy parameter to 'enabled' (or another unused property) as this will not provide any viable sorting criteria* and the items will not be sorted from their initial random order.
* Unless there are weighted items, which will always override the random option.
10 (default)
<integer>
true (default)
false
This is useful for avoiding pagniation affects for a specific component when multiple components of the same module are output on the same page and do use pagination.
false (default)
true
<Your custom message>
Liquid variables are supported here, although Liquid logic tags and HTML are not.
If using Liquid variables with filters added, be sure to change any double quotes to single quotes. For eg: emptyMessage: “{{ myVariable | prepend: 'Error: ' }}”
To use HTML in your empty message, first capture it using a Liquid capture, then insert the capture variable into the emptyMessage parameter.
item (default)
collection
item
returns each item iteratively, one after another, for output (generally, output to a container element with no need for looping through the data).collection
returns all items as one collection for output (your container element and looping logic would be handled in the Components Layout).<yourLiquidVariableName>
Your collectionVariable value must only contain English letters, numbers or underscores. Spaces or special characters are not supported.
false (default)
true
Allows search parameters in the URL to override the components output. Therefore, this parameter can be used to output module specific search results from a submitted search form.
Likewise, Tag, Category, and Archive components can be used in conjunction with this parameter for filtering the module's output.
URL search parameters will override any corresponding parameters in the component. If no search parameters are present in the URL, isSearchResult will be ignored.
Any value
other than true
, (including an empty value), will disable the search functionality and the component will output its regular data.
{'prop_ParentId':'1234', 'prop_ReleaseDate_Min':'2018-07-01', 'prop_ReleaseDate_Max':'2018-07-31', 'prop_KeyWords':'Your Keywords', 'prop_ItemTags':['tag1','tag2'], 'page':'2'}
Allows a search on the module without search parameters needed in the URL. Instead, search parameters are added to the value
of this parameter. Therefore, this parameter can be used to output module specific search results from hard-coded (or Liquid) values without the use of a search form.
Added search parameters will override any corresponding parameters otherwise configured on the component. If no search parameters are present, searchScope will be ignored.
This value
supports Liquid and can therefore be constructed with Liquid data/variables.
<your custom value>
Your <customParameter> name must only contain English letters, numbers or underscores. Spaces or special characters are not supported.
You can use HTML as the value here, just be sure to change any double quotes in your HTML to single quotes.
Also, see here for a tutorial on using Custom Paramters.
Liquid Output
The below example has 3 sample items
(due to a limit
applied) but is otherwise the default structure you will get from this Component.
{
"Params": {
"source": "Page",
"layout": "",
"type": "module",
"collectionvariable": "allPages",
"limit": "3"
},
"Pagination": {
"CurrentPage": 1,
"ItemsPerPage": 3,
"NumberOfPages": 7,
"TotalItemsCount": 20
},
"Parent": {
"Id": 2160,
"Name": "module (Page)",
"Url": "/component-types/module-page",
"Url_List": [
"/component-types/module-page"
],
"UrlSlug": "module-page",
"ParentId": 2127,
"ParentId_List": [
2127
],
"ParentName": "Liquid Components",
"ParentUrl": "/component-types",
"TemplateName": "Docs Template",
"Module_Alias": "DocumentationPost",
"Module_ID": 1870,
"Enabled": true,
"ReleaseDate": "2018-09-19T23:00:00",
"ExpiryDate": "2099-12-10T00:00:00",
"SiteSearchKeywords": [],
"Description": "<p>This module component fetches data relating to Pages.</p>\n<p>Possible use cases for this are creating dynamic menus or automatic on-page sitemaps. Specifically, creating a dynamic on-page sub-menu (of all the pages within the current folder/directory).</p>\n<p class=\"notice-tip\">Pages are based on the same structure as many other modules in WebinOne. So you can retrieve, list, sort and filter your site pages just like you might Blog Posts or Custom Modules.</p>\n\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n\n{% component type: \"snippet\", alias: \"section_parameters\" %}\n\n{% component type: \"json\", source_type:\"string\", source:\"{{tabularData}}\", layout:\"/snippets/tabularJSON.layout\" %}\n</section>\n\n{% component type: \"snippet\", alias: \"section_output\" %}\n\n{% component source: \"Page\", layout: "", type: \"module\", collectionVariable: \"allPages\", limit: \"3\" %}\n<p>The below example has 3 sample <code>items</code> (due to a <code>limit</code> applied) but is otherwise the default structure you will get from this Component.</p>\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{allPages}}\", lang: \"json\" %}\n</section>\n\n{% component type: \"snippet\", alias: \"section_accessing_data\" %}\n\n<p>This data is accessible in two main ways:</p>\n\n<p>1. Using Liquid in the specified Layout via the <code>this</code> object.</p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p>2. Directly on the Page or Template via a Liquid Collection if <code>collectionVariable</code> was added to the Component tag.</p>\n\n<p>An example using <code>collectionVariable</code> with value \"allPages\" to list all \"Page items\" across the site:</p>\n<p class=\"notice-note\">Here we suppress any Layout from rendering by setting <code>layout: \"\"</code> as an empty attribute.</p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p><em>Looping through the collection to render all the item names in a list, giving us:</em></p>\n\n<ul>\n \n <li>AJAX Form</li>\n \n <li>AJAX Form reCaptcha v3</li>\n \n <li>All Blogs</li>\n \n</ul>\n<br>\n<p><em>The code:</em></p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p><em>Accessing a specific item within the collection. In this case the second item (zero based index), which in our example would render the value <code>AJAX Form reCaptcha v3</code></em></p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p class=\"notice-warning\">Avoid calling all pages, while rendering their content description, via this module when on a Page as this will cause the module to retrieve itself and trigger an infinite loop and a system error will occur.<br>\nInstead, try being specific with the page/s you need to retrieve using the <code>filterBy</code> options or avoid rendering the content description field.</p>\n</section>\n</section>\n\n<section id=\"secListFiltered\">\n <h2>List a Specific Page</h2>\n<p>If you want to only list a single specific Page you could filter the items using the Page's ID or perhaps even its name.</p>\n<p>To do this we add the <code>filterBy</code> and <code>filterValue</code> attributes to the Component tag using the specific Page's ID (or their name) to get just that item. For example:</p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n<section id=\"secDynamicSubPageMenu\">\n<h3>Dynamic Sub-Page Menu</h3>\n<p>Let's say you want to have a dynamic on-page menu that lists all pages with the currently viewed folder/directory.</p>\n<p>To do this, we can get the parent ID of the current page (which is the Folder ID) and filter the Page list by <code>parentID</code>.</p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p class=\"notice-note\">You <b>cannot</b> use the Component Manager to configure the Component tag for Pages as it's not generally part of the content management process that clients may need to utilise.</p>\n</section>\n</section>\n\n{% component type: \"snippet\", alias: \"section_counter\" %}\n</section>\n",
"Weighting": 900,
"DisableForSiteSearch": false,
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [
"Pages"
],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"Active": true,
"IgnoreUpdates": true,
"UpdatesLog": "<ul><li>27-Oct-2020 | 5.6.0 | Added 'ignoreWeighting' parameter</li><li>'isSearchResult' and 'searchScope' parameter details added.</li></ul>",
"ExternalResources": "",
"AdditionalRelatedArticle": 0,
"AdditionalRelatedArticle2": 0,
"Authors": "2418",
"ShowPageForSearchEngine": true,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.0,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": null,
"type": null,
"url": null,
"locale": null,
"image": null
},
"ExternalId": 0,
"Params": {
"type": "snippet",
"alias": "section_output",
"data": "\n{% component type: \"module\", source: \"Page\", layout: \"Page Detail\" %}\n",
"lang": "liquid",
"name": "SECTION Output",
"content": "<section id=\"secOutput\">\n <h2>Liquid Output</h2>",
"enabled": true,
"required": "true",
"values": "Page Detail <em>(default)</em><br><Your Layout name>"
}
},
"Items": [
{
"Id": 2227,
"Name": "AJAX Form",
"Url": "/demo-cs/ajax-form",
"Url_List": [
"/demo-cs/ajax-form"
],
"UrlSlug": "ajax-form",
"ParentId": 2224,
"ParentId_List": [
2224
],
"ParentName": "demo-cs",
"ParentUrl": "/demo-cs",
"TemplateName": "DEMO Companion Site",
"Module_Alias": "Page",
"Module_ID": 1522,
"Enabled": true,
"ReleaseDate": "2018-11-24T18:00:00",
"ExpiryDate": "2099-12-10T18:00:00",
"SiteSearchKeywords": [],
"Description": "{% component type: \"form\", alias: \"demo_ajax_example\", layout: "", collectionVariable: \"formData\" %}\r\n\r\n\r\n<h1>Basic AJAX Form Submission Demo</h1>\r\n<div class=\"grid-x grid-padding-x\">\r\n <div class=\"cell medium-6\">\r\n <p>{% component type: \"form\", alias: \"demo_ajax_example\" %}</p>\r\n </div>\r\n <div class=\"cell medium-6\">\r\n <ul class=\"tabs\" data-tabs id=\"code-tabs\">\r\n <li class=\"tabs-title is-active\"><a href=\"#panel1\" aria-selected=\"true\">Form Code</a></li>\r\n <li class=\"tabs-title\"><a data-tabs-target=\"panel2\" href=\"#panel2\">Liquid Output</a></li>\r\n </ul>\r\n <div class=\"tabs-content\" data-tabs-content=\"code-tabs\">\r\n <div class=\"tabs-panel is-active\" id=\"panel1\">\r\n <p class=\"callout warning\">NOTE: This script assumes jQuery is being loaded on your site.</p>\r\n <pre>{% component type: \"form\", alias: \"demo_ajax_example\" %}</pre>\r\n </div>\r\n <div class=\"tabs-panel\" id=\"panel2\">\r\n <pre></pre>\r\n </div>\r\n </div>\r\n </div>\r\n</div>",
"Weighting": 0,
"DisableForSiteSearch": false,
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"ShowPageForSearchEngine": true,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.5,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": null,
"type": null,
"url": null,
"locale": null,
"image": null
},
"ExternalId": 0,
"Params": {}
},
{
"Id": 2612,
"Name": "AJAX Form reCaptcha v3",
"Url": "/demo-cs/ajax-form-recaptcha-v3",
"Url_List": [
"/demo-cs/ajax-form-recaptcha-v3"
],
"UrlSlug": "ajax-form-recaptcha-v3",
"ParentId": 2224,
"ParentId_List": [
2224
],
"ParentName": "demo-cs",
"ParentUrl": "/demo-cs",
"TemplateName": "DEMO Companion Site",
"Module_Alias": "Page",
"Module_ID": 1522,
"Enabled": true,
"ReleaseDate": "2018-11-24T18:00:00",
"ExpiryDate": "2099-12-10T18:00:00",
"SiteSearchKeywords": [],
"Description": "{% component type: \"form\", alias: \"demo_ajax_example-recaptcha_v3\", layout: "", collectionVariable: \"formData\" %}\r\n\r\n\r\n<h1>Basic AJAX Form Submission Demo (with reCaptcha v3)</h1>\r\n<div class=\"grid-x grid-padding-x\">\r\n <div class=\"cell medium-6\">\r\n <p>{% component type: \"form\", alias: \"demo_ajax_example-recaptcha_v3\" %}</p>\r\n </div>\r\n <div class=\"cell medium-6\">\r\n <ul class=\"tabs\" data-tabs id=\"code-tabs\">\r\n <li class=\"tabs-title is-active\"><a href=\"#panel1\" aria-selected=\"true\">Form Code</a></li>\r\n <li class=\"tabs-title\"><a data-tabs-target=\"panel2\" href=\"#panel2\">Liquid Output</a></li>\r\n </ul>\r\n <div class=\"tabs-content\" data-tabs-content=\"code-tabs\">\r\n <div class=\"tabs-panel is-active\" id=\"panel1\">\r\n <pre>{% component type: \"form\", alias: \"demo_ajax_example-recaptcha_v3\" %}</pre>\r\n </div>\r\n <div class=\"tabs-panel\" id=\"panel2\">\r\n <pre></pre>\r\n </div>\r\n </div>\r\n </div>\r\n</div>",
"Weighting": 0,
"DisableForSiteSearch": false,
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"ShowPageForSearchEngine": true,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.5,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": null,
"type": null,
"url": null,
"locale": null,
"image": null
},
"ExternalId": 0,
"Params": {}
},
{
"Id": 2289,
"Name": "All Blogs",
"Url": "/demo-cs/all-blogs",
"Url_List": [
"/demo-cs/all-blogs"
],
"UrlSlug": "all-blogs",
"ParentId": 2224,
"ParentId_List": [
2224
],
"ParentName": "demo-cs",
"ParentUrl": "/demo-cs",
"TemplateName": "DEMO Companion Site",
"Module_Alias": "Page",
"Module_ID": 1522,
"Enabled": true,
"ReleaseDate": "2018-12-14T18:00:00",
"ExpiryDate": "2099-12-10T18:00:00",
"SiteSearchKeywords": [],
"Description": "<h1>All Blogs</h1>\r\n<p>A list of all Blogs on the site.</p>\r\n\r\n<div class=\"grid-x grid-padding-x\">\r\n <div class=\"cell medium-6\">\r\n <h3>Standard Rendering from Component tag</h3>\r\n <pre>{% component type: \"module\", source: \"Blog\", layout: \"Blog List Layout\" %}</pre>\r\n {% component source: \"Blog\", layout: \"Blog List Layout\", type: \"module\", collectionVariable: \"blogData\" %}\r\n <hr>\r\n <h3>Custom Rendering from Liquid Collection</h3>\r\n <pre>{% component type: \"module\", source: \"Blog\", layout: \"\", collectionVariable: \"blogData\" %}</pre>\r\n\r\n <pre><ul>\r\n {% for i in blogData.items %}\r\n <li><a href=\"{{i.url}}\">{{i.name}}</a></li>\r\n {% endfor %}\r\n</ul></pre>\r\n <ul>\r\n \r\n </ul>\r\n </div>\r\n <div class=\"cell medium-6\">\r\n <ul class=\"tabs\" data-tabs id=\"code-tabs\">\r\n <li class=\"tabs-title is-active\"><a href=\"#panel1\" aria-selected=\"true\">Liquid Output</a></li>\r\n </ul>\r\n <div class=\"tabs-content\" data-tabs-content=\"code-tabs\">\r\n <div class=\"tabs-panel is-active\" id=\"panel1\">\r\n <pre></pre>\r\n </div>\r\n </div>\r\n </div>\r\n</div>",
"Weighting": 0,
"DisableForSiteSearch": false,
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"ShowPageForSearchEngine": true,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.0,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": null,
"type": null,
"url": null,
"locale": null,
"image": null
},
"ExternalId": 0,
"Params": {}
}
]
}
Accessing the Data
JSON Output
You can output the full JSON for your component data by referencing the root Liquid object {{this}}
in your module’s layouts, or directly on your page, if using the collectionVariable
parameter in your component tag.
For example:
{% component type: ... collectionVariable: "myData" %}
You can then render the JSON like so:
{{myData}}
For more details on using this approach, see Part 2 of the free ‘Learning Liquid Course’.
Rendering Property Values
This data is accessible in two main ways:
1. Using Liquid in the specified Layout via the this
object.
{{this['name']}}
2. Directly on the Page or Template via a Liquid Collection if collectionVariable
was added to the Component tag.
An example using collectionVariable
with value "allPages" to list all "Page items" across the site:
Here we suppress any Layout from rendering by setting layout: ""
as an empty attribute.
{% component type: "module", source: "Page", layout: "", collectionVariable: "allPages" %}
Looping through the collection to render all the item names in a list, giving us:
- AJAX Form
- AJAX Form reCaptcha v3
- All Blogs
The code:
<ul>
{% for i in allPages.items %}
<li>{{i['name']}}</li>
{% endfor %}
</ul>
Accessing a specific item within the collection. In this case the second item (zero based index), which in our example would render the value AJAX Form reCaptcha v3
{{allPages.items[1]['name']}}
Avoid calling all pages, while rendering their content description, via this module when on a Page as this will cause the module to retrieve itself and trigger an infinite loop and a system error will occur.
Instead, try being specific with the page/s you need to retrieve using the filterBy
options or avoid rendering the content description field.
List a Specific Page
If you want to only list a single specific Page you could filter the items using the Page's ID or perhaps even its name.
To do this we add the filterBy
and filterValue
attributes to the Component tag using the specific Page's ID (or their name) to get just that item. For example:
{% component type: "module", source: "Page", layout: "Page Detail", filterBy: "id", filterValue: "1865" %}
or
{% component type: "module", source: "Page", layout: "Page Detail", filterBy: "name", filterValue: "Documentation" %}
Dynamic Sub-Page Menu
Let's say you want to have a dynamic on-page menu that lists all pages with the currently viewed folder/directory.
To do this, we can get the parent ID of the current page (which is the Folder ID) and filter the Page list by parentID
.
{% component type: "module", source: "Page", filterBy: "parentid", filterValue: "{{this.parentID}}", collectionVariable: "subPages" %}
<ul>
{% for i in subPages.items %}
<li><a href="{{i.url}}">{{i.name}}</a></li>
{% endfor %}
</ul>
You cannot use the Component Manager to configure the Component tag for Pages as it's not generally part of the content management process that clients may need to utilise.
Counter
Along with the data output above, there is also a special liquid tag available {{counter}}
which increments for each item. This tag is only available within Layouts when object: "item"
is used in the Component tag.
Related Articles
- Site Settings & Management
System Pages
System Pages, under 'Settings', is where you’ll find all those pages required by certain system... - Content Modules
Pages
Pages allow the creation and management of standard page content and folders. Pages can be arranged within folders, secured from unauthorised access, hidden from either site search or search engines, assigned to templates and given full SEO properties among various other settings. - Liquid Components
module (Page Folder)
This module component fetches data relating to Page Folders. Possible use cases for this are...
External Resources
There are currently no external resources available.
Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.
Questions?
We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@webinone.com and we will consult you as soon as possible.