Siblings module allows navigating through a data set by displaying links to first, previous, next and last records.

Syntax

Smartsite SXML	Copy Code
<se:siblings />

Parameters

Name	Data Type	Properties	Description
CurrentKey	Any	Trim	Sets or returns the key value of the current sibling.
DisplayBack	String	-	Value for the Display field of the Back sibling.
DisplayChild	String	-	Value for the Display field of the Child sibling.
DisplayFields	Collection	-	Comma-separated list of fields that should be present in the data set because they are used in formatting. Only relevant when used for content items. Otherwise the dataset has to be passed and the user should include these fields himself.
DisplayFirst	String	-	Value for the Display field of the First sibling.
DisplayLast	String	-	Value for the Display field of the Last sibling.
DisplayNext	String	-	Value for the Display field of the Next sibling.
DisplayParent	String	-	Value for the Display field of the Parent sibling.
Format	String	RawData	Sets the formatting Xml.
InputData	DataTable	-	Sets the dataset through which the siblings module will navigate. Using inputdata will not create Child links. Parent link can be created by including a level field. Level 1 is the parent, all siblings are level 0. Other values for level are ignored.
KeyField	String	Trim	Sets or returns the name of the key field in the data set.
LevelField	String	Trim	The level field is distinguishes between siblings (0) and parent (1) in the dataset.
MaxRows	Integer	-	Sets a limit for the number of rows that the output may contain.
MinimumAccessLevel	String	-	Sets the minimum access level for each item by name. The given level must be defined as an AccessTypeLevel.
MinimumBrowseLevel	Integer	-	Sets the minimum access level for each item to be shown. Leave 0 to forgo security checks.
Parent	Locator	Signature	Sets the parent.
RowDelimiter	String	-	Specifies the delimiter string that separates individual records.
RowFormat	String	RawData	Sets the formatting string.
ShowHidden	Boolean	-	Sets a value indicating whether to show hidden items.
SiblingOrder	String	-	Comma separated list determining the order in which siblings will be returned. Accepted names are "First", "Back" or "Previous", "Next", "Last", "Parent" or "Up" and "Child" or "Down". Child/Down creates a link to the first child of a content folder.
SkipRows	Integer	-	Specifies which row will be the first row in the output.

Shared Parameters

Name	Data Type	Properties	Description
Access	String	-	Friendly name of the minimum access type level required by the site visitor to execute this macro.
AccessDenied	String	RawData	Sets the value that is returned when the site visitor has insufficient access.
AIM	Enum	-	Sets the AIM scanning mode of the macro. Enum values: NotSet Not set. Off No AIM scanning. External Output XML scanning. Internal Internal scanning, implemented by AIM-aware macros. Autonomous Relations are to be linked to the current source item, instead of the rendered page. SoftLink Should generate soft links (in combination with External flag). InternalAutonomous Internal scanning, combined with the Autonomous setting. ExternalAutonomous External scanning, combined with the Autonomous setting. ExternalAutonomousSoftLink External scanning, combined with the Autonomous and softLink settings. ExternalSoftLink External scanning, combined with the Softlink setting.
Condition	String	MustBeAttribute ExpressionSyntax XmlDecode	Sets the Viper expression to evaluate before actually executing the macro. If the expression returns false, the execution of the module and its child modules is skipped.
Default	String	RawData	Sets the default value that will be returned when the execution would otherwise return an empty string.
Error	String	RawData	Sets the value to return in case on error occurs during execution. The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
Id	String	MustBeAttribute Trim	Sets the Id of the macro. Macros with Ids set can be accessed using Viper by referring to page.[id].[methodname()].
LocalId	String	MustBeAttribute Trim	Sets the local id of the macro in the current buffer scope.
Rem	String	RawData NoCache Trim	Sets the remarks. Remarks have no effect on the actual execution of the module. They only improve the readability of the code.
ResultFormat	String	RawData	Sets the resultformat.
ResultType	Enum	-	Sets the type of the result. Enum values: Undefined Not set None No result String Default type Object Generic object Binary Binary data Boolean Boolean DataTable DataTable DateTime Date/time Float Floating point numeric data Integer Integer Locator Extended Uri Xml Xml Data
Save	Collection	-	Sets the buffer names.
Status	Enum	-	Gets a value indicating the ModuleStatus of this module. Enum values: Unknown Unknown BeginInitialize Initializing the module EndInitialize Module has fully initialized BeginSetProperties Properties are about to be set EndSetProperties Properties have been set BeginExecute Execution starts BeginFormatData Starting data formatting. EndFormatData Ended data formatting. BeginFormatResult Before formating result. EndFormatResult After formatting result EndExecute Execution is ending StartLoseScope Execution has completed EndLoseScope Module is about to unload Error Module is in an error state
Timeout	Float	-	Sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
Trim	Enum	MustBeAttribute	Gets a value indicating how the whitespace is trimmed.
Whitespace	Enum	MustBeAttribute	Gets a value indicating whether to preserve whitespace. Enum values: Inherit Inherit from parent. Preserve Keep all whitespace. Remove Remove all whitespace. Normalize Convert all whitespace to single spaces. SimpleFormat Convert all whitespace to single spaces, but keep single line breaks.

Local Viper Methods

Viper	Extension	Description
This.ChildLevelResult		Gets the result of the child levels.
This.ClearForcedResult		Sets the result of the macro. used to override the normal handling of the result creation.
This.ColCount		Gets the number of columns in the datatable.
This.ColName		Gets the name of the current column.
This.ColNumber		Gets the number of the current column.
This.CurrentIndex		Returns the position of the current sibling in the collection of siblings.
This.Field		Gets the field value of the current column in the current row, when using colformat.
This.Field.Exists		Checks whether the given field exists.
This.GetForcedResult		Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
This.Group		Gets the name of the current group.
This.GroupCount		Gets the total number of groups displayed.
This.GroupNumber		Gets the number of the current group.
This.GroupResult		Gets the result of the current group.
This.GroupRowNumber		Gets the number of the current row in the current group.
This.Level		Gets the current formatting level.
This.LevelResult		Gets the result of the current level.
This.LevelRowNumber		Gets the current row of the current level.
This.Location		Gets the location the current row points to, in a macro that can build URLs.
This.MaxRows		Gets a limit for the number of rows that the output may contain.
This.Name		Gets the title or name represented by the current row.
This.param		Gets the value of a parameter with the given index. Useful when using the viper:exec inside xslt formatting.
This.RawField		Gets the raw field value of the current column in the current row, when using colformat.
This.RenderTime	✓	Returns the render time of the macro in milliseconds.
This.RowCount		Gets the total number of rows in the datatable.
This.RowNumber		Gets the current row number.
This.RowResult		Gets the result of the current row.
This.SetForcedResult		Sets the result of the macro. used to override the normal handling of the result creation.
This.SiblingCount		Returns the total amount of siblings.
This.SiblingExists		Returns true if the sibling that is currently being formatted exists
This.SkipRows		Specifies which row will be the first row in the output.
This.Title		Gets the title represented by the current row.
This.VisibleRowCount		Gets the total number of rows displayed.
This.VisibleRowNumber		Gets the current visible row number.

Shared Local Viper Methods

Viper	Extension	Description
This.AIM.Relations	✓	Gets a list of all outgoing AIM relations created by the macro.
This.Buffer.Exists		Checks whether a local buffer exists.
This.Buffer.Get		Gets a local buffer.
This.Buffer.Set		Sets a local buffer.
This.Error.InnerException.Message		Returns the text message of the inner exception of the exception that has occurred.
This.Error.InnerException.SmartsiteCode		Returns Smartsite error code of the inner exception of the exception that has occurred.
This.Error.InnerException.Throw		Makes Smartsite throw the inner exception.
This.Error.InnerException.ToString		Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
This.Error.InnerException.Type		Returns the full Type name of the inner exception of the exception that has occurred.
This.Error.Message		Returns the text message of the exception that has occurred.
This.Error.SmartsiteCode		Returns the Smartsite Error code of the exception that has occurred.
This.Error.Throw		Makes Smartsite throw the current exception.
This.Error.ToString		Returns the full information of the exception that has occurred, including the stack trace.
This.Error.Type		Returns the full Type name of the exception that has occurred.
This.FindExtension		Finds an extension macro.
This.GetParameter	✓	Gets the value of the given parameter/property.
This.ParameterExists	✓	Checks whether the given parameter/property is set.
This.Result		Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result.
This.SXMLPath		Gets the path to the macro in the current execution stack.

Remarks

AIM

Examples

Smartsite SXML	Copy Code
<se:sqlquery save="siblingsdata" resulttype="datatable"> <se:parameters> <se:parameter name="sql">select nr, title from {channel.view()} where parent={itemdata.parent()}</se:parameter> </se:parameters> </se:sqlquery> <se:siblings> <se:parameters> <se:parameter name="displayfirst"> <b><<</b> </se:parameter> <se:parameter name="displaylast"> <b>>></b> </se:parameter> <se:parameter name="displaynext"> <b>></b> </se:parameter> <se:parameter name="displayback"> <b><</b> </se:parameter> <se:parameter name="siblingorder">first,back,next,last</se:parameter> <se:parameter name="inputdata">siblingsdata</se:parameter> <se:parameter name="currentkey">{itemdata.number()}</se:parameter> <se:parameter name="format"> <se:rowformat> <a href="{channel.link(this.field(nr))}" title="{this.field(title)}">{this.field(display)}</a> </se:rowformat> <se:captionformat expression="this.rownr()==3"> {this.currentindex()} / {this.siblingcount()} </se:captionformat> </se:parameter> </se:parameters> </se:siblings>

Smartsite SXML

Copy Code

<se:sqlquery save="siblingsdata" resulttype="datatable">
    <se:parameters>
        <se:parameter name="sql">select nr, title from {channel.view()} where parent={itemdata.parent()}</se:parameter>
    </se:parameters>
</se:sqlquery>

<se:siblings>
    <se:parameters>
        <se:parameter name="displayfirst">&nbsp;<b>&lt;&lt;</b>&nbsp;</se:parameter>
        <se:parameter name="displaylast">&nbsp;<b>&gt;&gt;</b>&nbsp;</se:parameter>
        <se:parameter name="displaynext">&nbsp;<b>&gt;</b>&nbsp;</se:parameter>
        <se:parameter name="displayback">&nbsp;<b>&lt;</b>&nbsp;</se:parameter>
        <se:parameter name="siblingorder">first,back,next,last</se:parameter>
        <se:parameter name="inputdata">siblingsdata</se:parameter>
        <se:parameter name="currentkey">{itemdata.number()}</se:parameter>
        <se:parameter name="format">
            <se:rowformat>
                <a href="{channel.link(this.field(nr))}" title="{this.field(title)}">{this.field(display)}</a>
            </se:rowformat>
            <se:captionformat expression="this.rownr()==3"> 
                {this.currentindex()} / {this.siblingcount()}
            </se:captionformat>
        </se:parameter>
    </se:parameters>
</se:siblings>

Siblings with Input Data Example

A list of users is defined using the XmlDataTable macro. The result is then filtered to remove all user ids less than zero.

The filtered data table is then passed to the siblings macro which generates links to other users. The links work by adding the current user id to the query string. Siblings needs a currentkey to work, so there is a default of 5 (Grumpy) given to the save buffer "userid" when it's read from the query string, which is later passed to the currentkey parameter.

Smartsite SXML	Copy Code
<!--// This is our test data. --> <se:xmldatatable save="userdata" resulttype="datatable"> <se:row><se:col name="nr">-1</se:col><se:col name="fullname">Grimm brothers</se:col></se:row> <se:row><se:col>1</se:col><se:col>Snow white</se:col></se:row> <se:row><se:col>2</se:col><se:col>Bashful</se:col></se:row> <se:row><se:col>3</se:col><se:col>Doc</se:col></se:row> <se:row><se:col>4</se:col><se:col>Dopey</se:col></se:row> <se:row><se:col>5</se:col><se:col>Grumpy</se:col></se:row> <se:row><se:col>6</se:col><se:col>Happy</se:col></se:row> <se:row><se:col>7</se:col><se:col>Sleepy</se:col></se:row> <se:row><se:col>8</se:col><se:col>Sneezy</se:col></se:row> </se:xmldatatable> <!--// Get the user id from the querystring or use Grumpy as the default user. --> <se:text save="userid">{request.query(userid, default=5)}</se:text> <!--// Remove users with a negative nr field. --> <se:filter save="userdata" resulttype="datatable"> <se:parameters> <se:parameter name="inputdata">userdata</se:parameter> <se:parameter name="rowfilter">nr>0</se:parameter> </se:parameters> </se:filter> <!--// Use the siblings macro to browse our snow white and the dwarfs. --> <se:siblings> <se:parameters> <se:parameter name="inputdata">userdata</se:parameter> <se:parameter name="currentkey">{buffer.get(userid)}</se:parameter> <se:parameter name="siblingorder">first,back,next,last</se:parameter> <se:parameter name="format"> <se:rowformat> <span class="sib{this.field(rowname)}">{this.field(display)}</span> </se:rowformat> <se:rowformat expression="this.field(exists)"> <a href="{url.addparameter(channel.link(itemdata.number()),user,this.field(nr))}" title="{this.field(fullname)}" class="sib{this.field(rowname)}"> {this.field(display)} </a> </se:rowformat> <se:captionformat expression="this.rownr()==3">{this.currentindex()}/{this.siblingcount()}</se:captionformat> </se:parameter> </se:parameters> </se:siblings>

Smartsite SXML

Copy Code

<!--// This is our test data. -->
<se:xmldatatable save="userdata" resulttype="datatable">
    <se:row><se:col name="nr">-1</se:col><se:col name="fullname">Grimm brothers</se:col></se:row>
    <se:row><se:col>1</se:col><se:col>Snow white</se:col></se:row>
    <se:row><se:col>2</se:col><se:col>Bashful</se:col></se:row>
    <se:row><se:col>3</se:col><se:col>Doc</se:col></se:row>
    <se:row><se:col>4</se:col><se:col>Dopey</se:col></se:row>
    <se:row><se:col>5</se:col><se:col>Grumpy</se:col></se:row>
    <se:row><se:col>6</se:col><se:col>Happy</se:col></se:row>
    <se:row><se:col>7</se:col><se:col>Sleepy</se:col></se:row>
    <se:row><se:col>8</se:col><se:col>Sneezy</se:col></se:row>
</se:xmldatatable>    

<!--// Get the user id from the querystring or use Grumpy as the default user. -->
<se:text save="userid">{request.query(userid, default=5)}</se:text>

<!--// Remove users with a negative nr field. -->
<se:filter save="userdata" resulttype="datatable">
<se:parameters>
    <se:parameter name="inputdata">userdata</se:parameter>
    <se:parameter name="rowfilter">nr&gt;0</se:parameter>
    </se:parameters>
</se:filter>

<!--// Use the siblings macro to browse our snow white and the dwarfs. -->
<se:siblings>
<se:parameters>
    <se:parameter name="inputdata">userdata</se:parameter>
    <se:parameter name="currentkey">{buffer.get(userid)}</se:parameter>
    <se:parameter name="siblingorder">first,back,next,last</se:parameter>
    
    <se:parameter name="format">
    
        <se:rowformat>
            <span class="sib{this.field(rowname)}">{this.field(display)}</span>
            </se:rowformat>
        <se:rowformat expression="this.field(exists)">
            <a href="{url.addparameter(channel.link(itemdata.number()),user,this.field(nr))}" title="{this.field(fullname)}" class="sib{this.field(rowname)}">
                {this.field(display)}
                </a>
            </se:rowformat>
        <se:captionformat expression="this.rownr()==3">{this.currentindex()}/{this.siblingcount()}</se:captionformat>
        </se:parameter>
    </se:parameters>
</se:siblings>

SXML