Tags
{exp:structure:breadcrumb}
The breadcrumb tag displays in a standardized format and has a few parameters to control its output. Format = Path » To » Current » Page » Here
_Several parameters have been contributed by Aaron Gustafson @ easy-designs.net (Thanks, Aaron!)_
Home Link
inc_home="yes|no", defaults to yes
Include Here / Current Page
inc_here="yes|no", defaults to yes
Include Separator
inc_separator="yes|no", defaults to yes
Page Title Instead of Here
here_as_title="yes|no", defaults to no
Separator
separator=":", defaults to »
Spaces are automatically added around the element for you.
Show a Specific Breadcrumb
uri="{page_uri}"
Useful for search results pages to show where item was found (Example: "Found in About » News")
Wrap Each
wrap_each="li"
Do not include < or > around tag, Structure writes it for you.
Wrap Here
wrap_here="em"
Do not include < or > around tag, Structure writes it for you.
Wrap Separator
wrap_separator="span"
Do not include < or > around tag, Structure writes it for you.
{exp:structure:child_ids}
Used in conjunction with the weblog tag to output child content: View the example here
ID
entry_id="XX"
Returns the children of a particular entry.
{exp:structure:nav_main}
The nav_main tag outputs all of your top level pages into an <ul>. The tag will automatically add class="here" to the current page’s <li> and class="last" to the last <li>. It will also automatically add id="nav" to the list. Automatically excludes entries marked with the "closed" status.
Add Span
add_span="yes"
Adds a span tag around the navigation element.
Add Unique ID
add_unique_id="yes"
CSS Class
css_class="nav-main"
Customize the <ul> class attribute
CSS ID
css_id="navigation", defaults to “nav”
Customize the <ul> id attribute
Current Class / Here State
current_class="active", defaults to “here”
Change the markup associated with the current page element
Exclude Status
exclude_status="hidden|no_main_nav"
The parameter "exclude_status=" can be used to hide any single or multiple user defined statuses using the pipe character.
Exclude Entries
exclude="26|76"
The parameter "exclude=" can be used to hide any single or multiple user defined entry numbers using the pipe character.
Include Entries
include="12|98"
The parameter "include=" can be used to add any single or multiple user defined entry numbers using the pipe character.
Include ul
include_ul="no", defaults to wrapping <ul>
Remove the wrapping <ul> if desired
{exp:structure:nav_full}
Outputs a complete location aware tree of your entire site. Intended for use in dropdown menus. Currently, there is no limit_depth parameter, so levels deeper than your desired dropdown should be hidden with CSS.
CSS Class
css_class="sub_navigation"
Assigns a class to the <ul>.
CSS ID
css_id="sub_navigation", defaults to nav
Assigns an ID to the <ul>. You can add "none" to optionally display no ID.
Exclude Entries
exclude="26|76"
The parameter "exclude=" can be used to hide any single or multiple user defined entry numbers using the pipe character.
Exclude Status
exclude_status="status1|status2"
The parameter "exclude_status=" can be used to hide any single or multiple user defined statuses using the pipe character. This is useful for form confirmation or non-structural pages you don't want to appear in the sub-navigation. If a page is excluded all of it's children will be removed from being displayed as well.
{exp:structure:page_slug}
Returns the current page's URI slug (last segment)
Entry Slugs (by entry_id with a number)
entry_id="3", defaults to current page
Returns a slug other than the current page.
Entry Slug (by entry_id with a dynamic tag)
entry_id="{entry_id}", defaults to current page
Returns a slug other than the current page.
{exp:structure:parent_title}
Returns the current page's parent title
{exp:structure:sitemap}
Returns a full tree of all Structure pages with nested <ul>s. Automatically excludes entries marked with the "closed" status.
Exclude Entries
exclude="26|76"
The parameter "exclude=" can be used to hide any single or multiple user defined entry numbers using the pipe character.
Exclude Status
exclude_status="closed|hidden", defaults to closed
The parameter "exclude_status=" can be used to hide any single or multiple user defined statuses using the pipe character. If a page is excluded all of it's children will be removed from being displayed as well.
{exp:structure:nav_sub}
The nav_sub tag is intended for sub-navigation and will show up to two levels of <ul>s at a time. It dynamically shows pages at the same level and jumps to a child’s level if it has children itself. The tag will automatically add class="here" to the current page’s <li> and class="last" to the last <li>. Automatically excludes entries marked with the "closed" status.
Add Span
add_span="yes"
Adds a span tag around the navigation element.
Add Unique Entry ID
add_unique_entry_id="yes"
Format = nav_sub_8291 (where 8291 = the current entry_id)
Add Unique ID
add_unique_id="yes"
Format = toplevelparentfirstsegment_current_page_uri
CSS Class
css_class="sub_navigation"
Assigns a class to the <ul>.
CSS ID
css_id="sub_navigation", defaults to nav(current EE separator)sub
Assigns an ID to the <ul>. You can add "none" to optionally display no ID.
Current Class
current_class="active", defaults to here
Change the class name added to the current page
Exclude Entries
exclude="26|76"
The parameter "exclude=" can be used to hide any single or multiple user defined entry numbers using the pipe character.
Exclude Status
exclude_status="status1|status2"
The parameter "exclude_status=" can be used to hide any single or multiple user defined statuses using the pipe character. This is useful for form confirmation or non-structural pages you don't want to appear in the sub-navigation. If a page is excluded all of it's children will be removed from being displayed as well.
Hide If No Children
hide_if_no_children="yes"
Conditional output display for nav_sub.
Include ul
include_ul="yes|no"
Conditionally output the surrounding <ul> tag
Limit Depth
limit_depth="2"
Limits how deep children pages are shown with the start_from parameter.
Rename Overview Link
rename_overview="Another Name"
Use a different word or term when using the show_overview_link parameter.
Show Level Classes
show_level_classes="yes|no", defaults to yes
Displays class="sub_level_0", class="sub_level_1", etc on <li>s
Show Overview Link
show_overview_link="yes|no", defaults to no
Displays a link for "Overview" as the first subnav point in a section's landing page to designate where you are in the subnav hierarchy right away.
Start From
start_from="/about" or start_from ="/{segment_1}/{segment_2}"
The parameter "start_from=" can be used to display a different page's children. Defaults to the current page's children and the logic above if not set. This is useful for pages outside of Structure to mimic the same hierarchy. This mode switches the tag to "fixed" mode, where it will show ALL levels of children as you drill down instead of just children pages. The "start_from" parameter MUST BE FULL URI! Example: start_from="/about/company" or start_from="/{segment_1}/{segment_2}". This parameter can be used to switch certain pages back to the alternate mode if required.
Show Depth
show_depth="2"
Always show children pages up to a specified depth. Designed to work with the start_from parameter.
{exp:structure:titletrail}
The titletrail tag displays in a standardized format and has a few parameters to control its output. Format = Page You're On » Parent Page » Top Level Nav » Site Name
Reverse
reverse="yes"
Output = "Site Name » Parent Page » Page You're On"
Separator
separator=":"
Spaces are automatically added around the element for you.
