5.1 Document Layout Tags

All document field elements have an associated tag. These can be reviewed from the Types Menu in System Administration. Each Element is referenced simply by its name. For instance, a standard document might comprise the following elements:

Title
Description
Document
ImageReference (shows associated images attached to this entry)
LinkReference (shows associated link documents attached to this entry)
PublishArray
SubjectName (a repeating field)

The following table lists the common field names which can be used when designing a Document Layout.

Information from the Document or Document Collection will automatically be inserted at each occurrence of these tags in the layout. Commonly used Tags are listed below. You should review the fields available within the specific document type being published for a full list of tags available to a given document type. You can create your own document types and fields.

Tag Description
<<DocumentID>> Document identifier
<<DepartmentName>> Name of the Department to which the document belongs (and its heading in the Table of Contents)
<<SectionName>> Name of the Section to which the document belongs
<<Title>> Title of the document
<<Author>> Last Author of the document
<<TimeCreated>> Date/Time the document was created
<<DocumentStatus>> Published status - Published, Draft, Archived, etc
<<PublishURL>> Published URL for the document
<<PublishName>> Show only the name portion of the URL
<<PublishingDestination>> Insert the URL path of the page
<<Description>> Document abstract/summary
<<Document>> Full document or web page details
<<DocumentTable>> Format the document automatically as a table, replacing TAB characters with column tags.
<<Keywords>> Free-form keywords
<<Today>> Day of the week
<<ThisYear>> The current year in yyyy format (for copyright and other uses)
<<ThisMonth>> The current month number
<<ThisDay>> The current day number
<<ThisMonthName>> The current month name
<<ThisHour>> The current hour
<<ThisMinute>> The current minute
<<MetaDescription>> The contents of the Description element with html tags removed and truncated to 200 characters
<<tab>> Inert a “tab” chr(9) character
<<DcumentTable>> Format the document element converting tab rows to a table
<<xmlnamevalue>> Insert a XML name-value pair set of all elements in the document
<<autoform>> Create an HTML maintenance form for the current document


The title would be referenced in a layout as <<Title>>.

The subject name, being a repeating field, would be referenced as follows:

<<Repeat_SubjectName>> <<SubjectName>> <</Repeat>>.
[see Repeating Information below]


In addition to the normal document fields, the following have specific functions:

<<NextTitle>> Substitutes with the NEXT published document id in the document id sequence (for the Program to which the document belongs) from the currently displayed document.

<<PreviousTitle>> Substitutes with the PREVIOUS published document id (for the Program to which the document belongs) in the document id sequence form the currently displayed document.

<<AuthorName>> Insert the name of the last content editor.


Date Tags

Where you have date input fields there are several date presentation tags which you may use to format this date information in a specific way. Note: these are at present limited to English-language presentation of dates:

Tag Description
<<DayNumber_elementname>> Show only the day of month number from the nominated date element. Leading zeroes are suppressed.
<<DayNumber2_elementname>> Show only the day of month number from the nominated date element. The format of display is “##” – eg 02. Leading zeroes are suppressed.
<<MonthNumber_elementname>> Show only the day of month number from the nominated date element
<<MonthNumber2_elementname>> Show only the day of month number from the nominated date element. The format of display is “##” – eg 02.
<<YearNumber_elementname>> Show only the year number from the nominated date element
<<MonthName_elementname>> Shows the English equivalent of the month name (in full) – eg “July”.
<<DayName_elementname>> Shows the English equivalent of the day of week name (in full) – eg “Monday”.
<<Today>> Day of the week today.
<<ThisYear>> The current year in yyyy format (for copyright and other uses)



Conditional Tags

Conditional tags control the display of blocks of static content and replacement tags based on the presence or absence of information within Inter-Publish data fields. The syntax is:

<<HasValue_Field>> {contents to be shown} <</ HasValue_Field>>

eg <<HasValue_Description>> Brief summary
<<Description>> <</HasValue_Description>>

The above example would display a heading of "Brief Description" followed by the contents of the "Description" field ONLY if the Description Field contains some text.

To show content only where a value is absent, The syntax is:

eg <<HasNoValue_Description>> No Information Supplied <</HasNoValue_Description>>


The above example would display the message "No Information Supplied" if the content of Description has no value.

To test for a particular value the following syntax is available:

<<contains=”valuetotest” field>>(contents to be shown)<</contains=”valuetotest” field>>

For example:




All the standard Inter-Publish tags can be qualified by conditional tags.


Including other Documents and Indexes

The following tag will include and process the contents of any other document:

<<Include “SectionName!!Title of the document”>>

eg

<<Include “Mysite – Includes!!Feature Feedback Item”>> or just

<<Include “Feature Feedback Item”>> or just