Syntax Guide

Article number: 300857
Last updated: 04 October 2018

<COMMENT> based syntax

Page layout place markers

The following are mainly used as place markers in Sitekit page layouts .spl files, though they can be applied in Content layout .scl files and within page bodies;

Syntax

What it does

<COMMENT>TOP</COMMENT>

Replaced with whatever is in the System global variables (reserved global variables) called ‘Top'.

<COMMENT>HEADER</COMMENT>

Replaced with whatever is in the System global variables (reserved global variables) called ‘Header'.

<COMMENT>FOOTER</COMMENT>

Replaced with whatever is in the System global variables (reserved global variables) called ‘Footer'.

<COMMENT>NAV</COMMENT>

Replaced with the navigation type as defined in site settings, short way, can also be done using XML configuration.

<COMMENT>CONTENT</COMMENT>

Used in layouts to define where the content container is. Replaced by the relevant content layout at run time.

Content layout place markers

The following are normally used for content layouts;

Syntax

What it does

<COMMENT>PIC#</COMMENT>

Place marker for picture number #.

<PIC>
	<INDEX>#</INDEX>
	<WIDTH>300</WIDTH>
	<HEIGHT>200</HEIGHT>
</PIC>

Place marker for picture number # which also fixes either the height or width of the image.

<sitekit:zone id="zone-name"/>

Place marker for an editable zone on page titled 'zone-name' . This can be added to page or content layouts to replace body fields and images fields below. Allows multiple editable text, image, form, variable block and dataislands to be dragged into it on the editing screen. See zone editing. Added in 11.0

<COMMENT>BODY#</COMMENT>

Place marker for body field number # providing a rich text editor interface in admin.

<COMMENT>TEXT#</COMMENT>

Place marker for body field number # providing a plain HTML text editor interface in admin (added in v10)

<BODY>
	<NAME>introbox</NAME>
</BODY>

Place marker for body field number # which when used in v8 column layouts also labels each box with its respective 'name'.

<COMMENT>REFERENCE</COMMENT>

Place marker for all references to page both internal, external and child. Encompasses the next three.

<COMMENT>CHILD</COMMENT>

Used to give more control over references shows only child pages of the page.

<COMMENT>INTERNAL</COMMENT>

Used to give more control over page shows only internal links associated with the page.

<COMMENT>EXTERNAL</COMMENT>

Used to give more control over references shows only external links.

<COMMENT>DOWNLOAD</COMMENT>

Shows the files associated with the page.

<COMMENT>WHATSNEWPAGE</COMMENT>

Used to replace some content with a latest update page can be used in both layouts and content layouts.

<INTERNAL-LINKS>
	<SHOWSUMMARY>1</SHOWSUMMARY>
</INTERNAL-LINKS>

Same as internal with option to show/hide summaries.

<EMAILTHISPAGE>Your Text Here</EMAILTHISPAGE>

For example, "Email a Friend". Deprecated in 11.1

Embedding page elements within a page

The following are used for embedding element that normally stand-alone no their own pages

Syntax

What it does

<ENQUIRYFORM>
	<FORMID>#</FORMID>
</ENQUIRYFORM>

Replaces place marker with a form identified by its formID number. Allows easy embedding of multiple forms in a page. See also option below

:::form-formname:::
:::form-formid:::

Alternative to above. Replaces place marker with a form identified by its formID number or its form name. Introduced in 11.1

<FORUM>
	<FORUMID>#</FORUMID>
</FORUM>

Replaces place marker with a forum identified by its forumID number. Allows easy embedding of multiple forums in a page.

<SITEMAP>
	<ROOTEDITORIALID>0dt</ROOTEDITORIALID>
</SITEMAP>

Replaces place marker with a sitemap identified by its starting point in terms of root editorial ID (probably soon to be deprecated as nav tree position replaces editorialID).

<GUESTBOOK>
	<BLOG>#</BLOG>
	<SHOWADDRESS>0</SHOWADDRESS>
</GUESTBOOK>

Replaces place-marker with guestbook, option to show.

<unsubscribe/>

Used in newsletter templates only to add an automatic unsubscribe link to the mailed out newsletter. It only replaces with the following text for newsletters:
© Powered by Sitekit Mailing Lists
To unsubscribe, please go to this page:
http://<your domain>/Unsubscribe.aspx?email=ian.stewart@sitekit.net&channelID=2155



Admin Commenting

These allow you to add descriptive markup to templates that is visible in admin but not on the rendered page

Syntax

What it does

<ADMINCOMMENT>content...</ADMINCOMMENT>

The tags themselves are stripped and everything between them is rendered in the WYSIWYG page editor in admin. This is intended to be used to insert markup and/or styles that provide explanatory notes on how to edit the page and allow hard-to-edit blocks to be made editable by inserting CSS. The admincomments are stripped totally and never rendered from the front-end. Added in 10.5 .



Related questions


This article was last updated on 04 October 2018. Did you find it helpful?