The SearchEngineSitemap class generates sitemap files that are used by search engines to spider the website.

Syntax

Smartsite SXML	Copy Code
<se:searchenginesitemap> <se:parameters> <se:parameter name="urls"> </se:parameter> </se:parameters> </se:searchenginesitemap>

Parameters

Name	Data Type	Properties	Description
DefaultPriority	Float	-	Sets the defaultpriority used when no other priority has been specified.
GenerateRobotsTxt	Enum	-	Sets if the robots.txt file should be generated or not. Enum values: Never The robots.txt file is never generated. IfNotExists The robots.txt file is only generated if it doesn't already exist. Always The robots.txt file is always generated.
HostHeader	String	-	Sets the host header that is used for all the urls in the output.
Ping	Boolean	-	Sets if search engines should be pinged that a new sitemap is available.
SitemapFileName	String	-	Sets the file name of the sitemap files and sitemap index file that are generated.
Urls	String	RawData IsRequired	Sets the definition of the url list that will be generated by this macro.
UseCompression	Boolean	-	Sets if the generated files should be compressed or not.
UserName	String	-	Sets the user account that is used to access files and render pages.

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.ClearForcedResult		Sets the result of the macro. used to override the normal handling of the result creation.
This.GetForcedResult		Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
This.RenderTime	✓	Returns the render time of the macro in milliseconds.
This.SetForcedResult		Sets the result of the macro. used to override the normal handling of the result creation.

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

Examples

SearchEngineSitemap Example 1

This example adds item 2 and all its children to the output but excludes the items of the content types JS and CSS and item 2958 and all its children. Only items visible to the user guest are included in the output.

Smartsite SXML	Copy Code
<se:searchenginesitemap hostheader="http://localhost/" username="guest"> <se:parameters> <se:parameter name="urls"> <se:includeitems channel="def" items="2" recurse="true" /> <se:excludeitems contenttypes="js,css" /> <se:excludeitems items="2958" recurse="true" /> </se:parameter> </se:parameters> </se:searchenginesitemap>

Smartsite SXML

Copy Code

<se:searchenginesitemap hostheader="http://localhost/" username="guest">
    <se:parameters>
        <se:parameter name="urls">
            <se:includeitems channel="def" items="2" recurse="true" />
            <se:excludeitems contenttypes="js,css" />
            <se:excludeitems items="2958" recurse="true" />
        </se:parameter>
    </se:parameters>
</se:searchenginesitemap>

SearchEngineSitemap Example 2

This example adds item 2 to the output with priority 1.0 and changefrequency set to daily, adds all other items of the content types PWP and WP with the default priority of 0.5 and adds all files with the extensions Htm, Html, Pdf and Txt with priority 0.3, except for the file /robots.txt which is excluded from the output.

Smartsite SXML	Copy Code
<se:searchenginesitemap hostheader="http://localhost/" username="guest"> <se:parameters> <se:parameter name="urls"> <se:includeitems channel="def" items="2" recurse="false" priority="1" changefrequency="daily" /> <se:includeitems channel="def" contenttypes="pwp,wp" /> <se:includefiles path="/" extensions="htm,html,pdf,txt" recurse="true" priority="0.3" /> <se:excludefiles path="/robots.txt" /> </se:parameter> </se:parameters> </se:searchenginesitemap>

Smartsite SXML

Copy Code

<se:searchenginesitemap hostheader="http://localhost/" username="guest">
    <se:parameters>
        <se:parameter name="urls">
            <se:includeitems channel="def" items="2" recurse="false" priority="1" changefrequency="daily" />
            <se:includeitems channel="def" contenttypes="pwp,wp" />
            <se:includefiles path="/" extensions="htm,html,pdf,txt" recurse="true" priority="0.3" />
            <se:excludefiles path="/robots.txt" />
        </se:parameter>
    </se:parameters>
</se:searchenginesitemap>

More examples

SXML