SiteMapBuilder Quick Reference
Generate XML sitemaps for search engine optimization
Key Features
- Generate sitemap.xml files
- Automatic page discovery
- Configurable page priorities
- Change frequency settings
- Last modified timestamps
- Support for multiple sitemaps
- Search engine submission
Server-Side Usage:
<![CDATA[
// Get the SiteMapBuilder API
var SiteMapBuilder = js.getObject("/OpenForum/AddOn/SiteMapBuilder","SiteMapBuilder.sjs");
// Generate sitemap for entire wiki
SiteMapBuilder.generateSitemap("/");
// Generate sitemap for specific page tree
SiteMapBuilder.generateSitemap("/MySection");
// Generate with options
SiteMapBuilder.generateSitemap("/", {
outputFile: "sitemap.xml",
baseUrl: "https://example.com",
defaultPriority: 0.5,
defaultChangeFreq: "weekly"
});
// Add page to sitemap
SiteMapBuilder.addPage("/MyPage", {
priority: 0.8,
changefreq: "daily"
});
]]>
Client-Side Usage:
<![CDATA[
// Generate sitemap
JSON.post('/OpenForum/AddOn/SiteMapBuilder/Generate', null,
'pageName=/&baseUrl=' encodeURIComponent('https://example.com'))
.onSuccess(function(result) {
console.log('Sitemap generated:', result);
}).go();
// Get sitemap URL
var sitemapUrl = '/sitemap.xml';
]]>
Sitemap Format
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://example.com/PageName</loc>
<lastmod>2025-01-15</lastmod>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
</urlset>
]]>
Change Frequency Options
- always
- hourly
- daily
- weekly
- monthly
- yearly
- never
Configuration
- Base URL for absolute links
- Default priority (0.0 to 1.0)
- Default change frequency
- Pages to exclude from sitemap
- Output file location