SiteMap
SiteMap
SiteMap
I am site map and i create site maps for a site
Metadata
addSite()
adds a site to the site map
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| site |
farcry.core.packages.googlesitemap.sitemap.Site |
No |
|
|
|
buildIndexSite()
create an index xml string for the site map index file
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| aSites |
array |
No |
[runtime expression] |
|
|
| siteMapsDirectoryName |
string |
No |
sitemap |
|
|
| indexFileXMLNameSpace |
string |
No |
http://www.sitemaps.org/schemas/sitemap/0.9 |
|
|
| lastmod |
string |
No |
[runtime expression] |
|
|
| changefreq |
string |
No |
monthly |
|
|
| servername |
string |
No |
[runtime expression] |
|
|
cleanUpExistingDir()
removes old sub folder with site maps if it exists
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| siteMapsDirectoryName |
string |
Yes |
|
|
|
createFilePath()
create a file path to the root of the website
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| siteMapFileName |
string |
No |
siteMap |
|
|
| siteMapsDirectoryName |
string |
No |
|
|
|
createSiteMaps()
creates site maps for all sites that have been added
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
generate()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| stSiteConfig |
String |
Yes |
|
|
|
| siteMapType |
String |
No |
siteMap |
|
sitemap or newsSiteMap |
| types |
String |
No |
siteMap |
|
sitemap or newsSiteMap |
| newstypes |
String |
No |
dmNews:publishDate |
|
list of news types in with name of field for publish date |
| bIncludeNavigation |
String |
No |
false |
|
|
generateSiteMaps()
generates site maps from googleSiteMapSites type
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| siteMapFileName |
String |
No |
sitemap |
|
|
| newsTypes |
String |
No |
|
|
|
getGoogleSiteMapSite()
gets all current google site map sites
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
getIndexSite()
returns xml object created by createSiteMap
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
getSiteMaps()
gets the site maps for all sites and returns them in an array
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
getSites()
returns all the sites in this sitemap
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
init()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| None |
outputSite()
out puts a site as an xml file to the hard drive
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| oSite |
farcry.core.packages.googlesitemap.sitemap.Site |
Yes |
|
|
|
| filePath |
string |
Yes |
|
|
|
outPutSiteMaps()
gets all the site maps and writes them in files in the root directory
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| aSites |
array |
No |
[runtime expression] |
|
|
| siteMapFileName |
string |
No |
siteMap |
|
|
| siteMapsDirectoryName |
string |
No |
[runtime expression] |
|
|
outputSites()
writes the site maps to disc
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| aSites |
array |
No |
[runtime expression] |
|
|
| siteMapFileName |
string |
No |
siteMap |
|
|
| siteMapsDirectoryName |
string |
No |
[runtime expression] |
|
|
setIndexSite()
sets the index site map
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| oSite |
farcry.core.packages.googlesitemap.sitemap.Site |
Yes |
|
|
|