SiteMap XML Dynamic SiteMap Generator

Help File

Version 3.0 - The latest version is always available from www.softswot.com
Copyright © softSWOT

Register SiteMap XML Dynamic SiteMap Generator to maintain this software and enable all features. Only registered software and code built using registered software will continue functioning.

Overview

SiteMap XML is a php based sitemap generator, it crawls your web site to build an sitemap in XML, RSS, HTML, or Text format. It also includes the new Sitemaps Protocol. It includes a range of configurable variables to define the sitemap content and can be run as an online form or to build Dynamic SiteMap Code to create real time dynamic site maps that can be directly called.

SiteMap XML can generate sitemaps in XML (both Google and the new Sitemaps Protocol), RSS, HTML or Text format. These can be used to assist indexing of your site by Google, Yahoo, MSN and other search engines. Adding a HTML sitemap to your site will also provide a human viewable display of your site pages and enhance search engine indexing.

You can use our online SiteMap XML version at Try SiteMap XML to generate a site map for your web site. If your server supports php you can also Download SiteMap XML and run SiteMap XML directly on your server. Running SiteMap XML on your server is recommended. When run on your server you can set the default variables and run Dynamic SiteMap code to build real time dynamic site maps.

Key Features

To run SiteMap XML on your web server your server must support the php scripting language. Most commercial web servers support php. For information on php and how to check if it is available on your server goto What is php?

Operation

SiteMap XML Sofware is designed to run on a server that supports the php scripting language. You can see it running on our server at Try SiteMap XML. To run the software on your server the software files (sitemapxml.php and smxpc.js) must both be uploaded to your server. Once uploaded you can open the file sitemapxml.php from your server in a browser.

Once the software is running on a server it can be used in two modes. Generate Static SiteMap will create and return in the output text area a static site map based on the set variables. Generate Dynamic SiteMap Code will create code that when uploaded and run on a server will build a dynamic site map based on the set variables.

The variables applied for site map generation are set using the SiteMap XML Sofware input fields or default values can be hardcoded into the SiteMap XML Sofware or the Generated Dynamic SiteMap Code by editing these files in a text editor, for details please refer to the Instructions for Use.

Application

SiteMap XML provides a site map type suitable for any search engine. By including a HTML SiteMap link on your home page all search engines will be able to crawl and index all site pages. If you use a Dynamic SiteMap any changes to your site will be automatically reflected in the site map allowing search engines to find and update their index.

You can submit specifically formatted sitemaps directly to some search engines. This guarantees that the search engine is aware of your site map and is not simply waiting for the next crawl to identify it. Specific site map submission links and recommended site map types include:

The new Sitemaps Protocol is designed to be supported by major search engines including Google, Yahoo and MSN.

HTML site maps are generally suitable for all other search engines, many will also accept RSS and Text formats.

Instructions for Use

While SiteMap XML can be run directly from our server at http://www.softswot.com/sitemap/sitemapxml.php it is recommended that you Download SiteMap XML Dynamic SiteMap Generator and run it on your server. To set default variables for a Static SiteMap the SiteMap XML software must be run on your server. To build a Dynamic SiteMap the Dynamic SiteMap Code must be run on your server. See the Installation section for download and installation instructions.

When the software is run a Control Menu is located at the top of the window.

  1. From the Control Menu click Input.
  2. Set the Input Variables as required. You must provide a Start URL.
  3. Click Generate Static SiteMap to generate a static SiteMap and display it in the Output text area.

    or

  4. Click Generate Dynamic SiteMap Code to generate Dynamic SiteMap Code and display it in the Output text area.
  5. Select All selects the contents of the Output text area.
  6. Using a text editor copy/paste and save the contents of the Output text area.
  7. Upload your file to your web server. Open your file from your server in your browser. This will display your SiteMap and its url can be submitted to search engines.
Input

Start here and set the input variables for your SiteMap.

Set the Input variables as required and then click Generate Dynamic SiteMap Code or Generate Static SiteMap. Dynamic SiteMap Code can be uploaded to your server and when ever it is called will automatically build a SiteMap reflecting the current status of your site. A Static SiteMap can be uploaded to your site and when it is called will display a SiteMap of your site as it was when the Static SiteMap was generated. The SiteMap processing time depends upon the number of links extracted and the settings applied. It will generally range from less than a second to several minutes. An indicative processing time is 1 sec per 100 links extracted. Selecting Last Modified Date, Title, or Description variables will result in a slower processing time.

SiteMap Type

Select the desired SiteMap type.

Google SiteMap

Generates a SiteMap in the XML format required by Google Sitemaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A SiteMap Type set as Google SiteMap appears as $siteMapType="google";. This is the standard default value. If required this variable can be directly edited using a text editor.

RSS SiteMap

Generates a SiteMap in RSS format which is accepted by Yahoo and other search engines.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A SiteMap Type set as RSS SiteMap appears as $siteMapType="rss";. If required this variable can be directly edited using a text editor.

HTML SiteMap

Generates a SiteMap in HTML format for your site showing the site pages for visitors and providing search engines with page links.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A SiteMap Type set as HTML SiteMap appears as $siteMapType="html";. If required this variable can be directly edited using a text editor.

Text SiteMap

Generates a text SiteMap which is suitable as an alternative site map format for some search engines.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A SiteMap Type set as Text SiteMap appears as $siteMapType="text";. If required this variable can be directly edited using a text editor.

Sitemaps Protocol

Generates a SiteMap in the Sitemaps Protocol XML format supported by major search engines.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A SiteMap Type set as Sitemaps Protocol appears as $siteMapType="sitemapsprotocol";. If required this variable can be directly edited using a text editor.

The new Sitemaps Protocol is designed to be supported by major search engines including Google, Yahoo and MSN.

SiteMap URL's

Set the variables for the urls to be included in the SiteMap.

Start URLs


Input the starting URLs (ie http://www.mydomain.com/). If more than one starting url is used each url must be separated by a comma (ie ,). SiteMap XML will extract href links from each of these and if the set Depth is greater than 0 and the set Links has not been reached extract href links from each of the links. The domain of the first URL will be set as the site domain and only URLs relating to this site and that pass the Include, Exclude tests will be used in the generated SiteMap.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of http://www.mydomain.com/ appears as $startUrls="http://www.mydomain.com/";. If required this variable can be directly edited using a text editor.

The standard default value is $startUrls="";

Include URLs with


Only URLs that include these character combinations will be used. Each character combination must be separated by a comma (ie ,). Standard character combinations to include would be .htm, .php to use urls with .htm or .html and .php extensions and not other file types ie .gif .css etc. URLs that match the site domain home page are included by default.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of .htm,.php appears as $incUrls=".htm,.php";. If required this variable can be directly edited using a text editor.

The standard default value is $incUrls=".htm,.php";

Exclude URLs with


Only URLs that do not include these character combinations will be used. Each character combination must be separated by a comma (ie ,). Standard character combinations to exclude would be PHPSESS (a common session id used for php sites). This test is applied after the Include URL's test.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of PHPSESS appears as $excUrls="PHPSESS";. If required this variable can be directly edited using a text editor.

The standard default value is $excUrls="PHPSESS";

Depth


Sets the page depth applied. A depth of 0 will extract links only from the Start URLs. A depth of 1 will also extract links from the links found in the Start URLs. This process continues until the set Depth or Links limit is reached.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of 1 appears as $depthNum=1;. When setting this variable in the script it is not limited to the options displayed in the form, any value can be applied (ie it can be greater than 5). If required this variable can be directly edited using a text editor.

The standard default value is $depthNum=1;

Limit


Sets the maximum number of links extracted. Once the number of links extracted (checked) exceeds the Limit value no further pages will be examined for links regardless of the Depth set.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of 1000 appears as $limitNum=1000;. When setting this variable in the script it is not limited to the options displayed in the form, any value can be applied (ie it can be greater than 5000). If required this variable can be directly edited using a text editor.

The standard default value is $limitNum=1000;

Delay


This is the time the program waits before extracting links from each page. Processing pauses for this duration decreasing the load on the server but increasing the running time.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of 0.1 seconds appears as $delaySec=0.1;. If required this variable can be directly edited using a text editor.

The standard default value is $delaySec=0.1;

SiteMap Formatting

Set the desired variables for your SiteMap. Only variables applicable to the selected SiteMap Type are displayed.

Include Date Last Modified

 Include Date Last Modified
Include the Last Modified Date of the url file in the generated SiteMap. To use this feature your server must include a Last-Modified: date in the response headers when the url file is requested.

Using the HTTP Header Viewer you can see the HTTP Headers returned when your web pages are called. For a Last Modified Date to be included in your SiteMap the HTTP Header Viewer Received Response for your web pages must include a Last-Modified: date. If your server will run php in your web pages you can add the following code:

<?php header("Last-Modified: ".gmdate("D, d M Y H:i:s", getlastmod())." GMT"); ?>

to the very top of your web page (above all other code) so that when the page is called the server returns the Last-Modified: date. If a Last-Modified: date is not returned by your server the current UTC/GMT date/time will be applied.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $urlLastMod="true";. If required this variable can be directly edited using a text editor.

The standard default value is $urlLastMod="";

Sort URL's

 Sort URL's
Sorts the url's in the SiteMap in alphabetical order.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $urlSort="true";. If required this variable can be directly edited using a text editor.

The standard default value is $urlSort="";

Include Title

 Include Title
Includes the contents of the title tag in the SiteMap for each url if available. Not applicable for Google SiteMaps.

When set this variable results in the full content of the url file being retrieved. Due to web page size, encoding and content variations this may have an adverse effect on the site crawl. It is recommended that the performance implications of using this feature be assessed using a Static SiteMap before it is implemented in a Dynamic SiteMap. If a Static SiteMap does not complete correctly then this feature should not be used. If when Generating a Static SiteMap the browser becomes unresponsive Refresh SiteMap XML from the Input section or use your browser refresh/reload.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $urlTitle="true";. If required this variable can be directly edited using a text editor.

The standard default value is $urlTitle="";

Include Description

 Include Description
Includes the contents of the description tag in the SiteMap for each url if available. Not applicable for Google SiteMaps.

When set this variable results in the full content of the url file being retrieved. Due to web page size, encoding and content variations this may have an adverse effect on the site crawl. It is recommended that the performance implications of using this feature be assessed using a Static SiteMap before it is implemented in a Dynamic SiteMap. If a Static SiteMap does not complete correctly then this feature should not be used. If when Generating a Static SiteMap the browser becomes unresponsive Refresh SiteMap XML from the Input section or use your browser refresh/reload.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $urlDesc="true";. If required this variable can be directly edited using a text editor.

The standard default value is $urlDesc="";

Include Url

 Include Url
Includes the URL value as displayed text. Only applicable for HTML SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $urlUrl="true";. If required this variable can be directly edited using a text editor.

The standard default value is $urlUrl="";

Include Count

 Include Count
Includes a count number for each URL. Only applicable for HTML SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $urlCount="true";. If required this variable can be directly edited using a text editor.

The standard default value is $urlCount="";

Full HTML

 Full HTML
When selected the generated HTML SiteMap is a complete valid web page and can be displayed as a stand alone document. When not selected the generated HTML SiteMap is content only and should be included within an existing web page. Only applicable for HTML SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. When selected (checked) it appears as $htmlFull="true";. If required this variable can be directly edited using a text editor.

The standard default value is $htmlFull="true";

HTML Title Tag

 HTML Title Tag
This is the tag type that surrounds the Title in a HTML SiteMap when you Include Title. The default value is 'p' a paragraph tag. Only applicable for HTML SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of p appears as $htmlTitleTag="p";. If required this variable can be directly edited using a text editor.

The standard default value is $htmlTitleTag="p";";

HTML Description Tag

 HTML Description Tag
This is the tag type that surrounds the Description in a HTML SiteMap when you Include Description. The default value is 'p' a paragraph tag. Only applicable for HTML SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of p appears as $htmlDescTag="p";. If required this variable can be directly edited using a text editor.

The standard default value is $htmlDescTag="p";";

For URLs with


URLs that include these character combinations will use the corresponding Set Priority and Set Change Frequency. Each character combination must be separated by a comma (ie ,), you can place each on a new line to easily see the corresponding Set values on the same line number. Only applicable for Google SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of priority appears as $urlVals="priority";. If required this variable can be directly edited using a text editor.

The standard default value is $urlVals="";

Set Priority as


The Set Priority will be applied to corresponding For URLs. Each Set Priority value must be one of the numbers 1.0 0.9 0.8 0.7 0.6 0.5 0.4 0.3 0.3 0.2 0.1 0.0, each value must be separated by a comma (ie ,), you can place each on a new line to easily see the corresponding For URL on the same line number. Only applicable for Google SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of 0.1 appears as $priVals="0.1";. If required this variable can be directly edited using a text editor.

The standard default value is $priVals="";

Set Change Frequency as


The Set Change Frequency will be applied to corresponding For URLs. Each Set Change Frequency value must be one of the values always hourly daily weekly monthly yearly never, each value must be separated by a comma (ie ,), you can place each on a new line to easily see the corresponding For URL on the same line number. Only applicable for Google SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of daily appears as $freqVals="daily";. If required this variable can be directly edited using a text editor.

The standard default value is $freqVals="";

Default Priority


Default Priority is used for any URL that does not match a For URLs character combination. Only applicable for Google SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of 0.5 appears as $priDef="0.5";. If required this variable can be directly edited using a text editor.

The standard default value is $priDef="0.5";

Default Change Frequency


Default Change Frequency is used for any URL that does not match a For URLs character combination. Only applicable for Google SiteMaps.

When SiteMapXML software or the Dynamic SiteMap code is run on your server you can set the default value of this variable. A value of weekly appears as $freqDef="weekly";. If required this variable can be directly edited using a text editor.

The standard default value is $freqDef="weekly";

Generate Dynamic SiteMap Code

Click Generate Dynamic SiteMap Code to create code you can upload to your server to Dynamically generate your SiteMap. Once uploaded whenever this code is called it will dynamically build a SiteMap in real time and return a current SiteMap of your site.

As Dynamic SiteMaps are re-built every time the Dynamic SiteMap Code is called they are not recommended for very large sites (ie greater than 5,000 pages). This is due to the time required to extract the links and possible server loading. For most sites on reliable servers Dynamic SiteMap Code can be considered similar to calling each of the web pages on the site one after the other. It is recommended that before Dynamic Site Map Code is run on your server you Generate a Static Site Map with the same variable settings. This allows you to easily verify the created SiteMap and provides an indication of the processing time required. Setting the Depth and Limit to the lowest values that will fully index the site will minimize server load and processing time. Including the Last Modified Date, Title or Description in a SiteMap increases the processing time and server load.

Generate Static SiteMap

Click Generate Static SiteMap to build a SiteMap that for your site as it is now. This returns a SiteMap in the set format reflecting your site at this point in time. This SiteMap can be saved and provided to search engines or displayed on your site however if your site changes a new SiteMap will need to be built for the changes to be included. Alternately you can Generate Dynamic SiteMap Code that once uploaded to your server will always return a current valid and up to date SiteMap.

Depending on your browser, the structure/size of your site and the settings used for your SiteMap you may receive a Unresponsive Script prompt. This is simply a prompt giving you an exit option. Allow the script to continue processing to complete the SiteMap. Setting the Depth and Limit to the lowest values that will fully index the site will minimize processing time. Including the Last Modified Date, Title or Description in a SiteMap increases the processing time.

Refresh SiteMap XML

Reloads SiteMap XML Dynamic SiteMap Generator Software, and returns variables to default values.

Output

Generated output for Dynamic SiteMap Code or a Static SiteMap.

This section displays the generated output based on the input values set.

Generated Output

This is the Generated output for Dynamic SiteMap Code or a Static SiteMap.

Generated output is displayed in the text area. Select and copy this output to a text editor. For Dynamic SiteMap Code from the text editor save the output as a file with a .php extension ie sitemap.php. For Static SiteMaps save the output code as a file with a .xml extension for Google and RSS SiteMaps ie sitemap.xml, a file with a .html or .htm extension for HTML SiteMaps ie sitemap.html and a file with a .txt extension for Text SiteMaps ie sitemap.txt. Then upload the saved file to your server.

Do not use a html editor for any of this process when you are saving php code as it may be corrupted. Only a text editor should be used. It is recommended that any file that includes php code (this includes Dynamic SiteMap Code or the SiteMap XML software) be saved with a .php extension (i.e sitemapxml.php). Some servers require files to have the extension .php before they will execute php code within the file. If using NotePad as your text editor when you Save, select Save As Type "All Files" and then provide the full File Name i.e "sitemap.php" to ensure a .txt extension is not applied to the file.

Select All

Selects all the contents of the text area.

Display Static SiteMap

Display Static SiteMap sends and displays the Generated Static SiteMap directly to your browser allowing you to see how it will be displayed in a browser without having to upload it. As an alternative to saving the SiteMap from the text area you can view source of this display and then use Save As from your browser. This display will not run Dynamic SiteMap Code and should not be used with Dynamic SiteMap Code. Dynamic SiteMap Code must be uploaded and run on your server.

Clear Output

Clear generated output.

Reset

Reset all input and output values.

Help

Open the online Help file in a new window.

Registration

Access registration and support details.

Displays registration status and links for registration. Register software using the secure online payment link. Registration details are sent by return email and will enable all functions. Once registered the current registration and an Upgrade to Additional Licenses link are displayed. Only registered software and code built using registered software will continue functioning.

softSWOT.com

Go to software developer web site, www.softswot.com.

About Google Sitemaps

Open the About Google Sitemaps web page. Learn how Google uses sitemaps to index your site.

Google Sitemap Account

Open the Google Sitemap Account web page to directly access your Google Sitemap Account. Add and monitor your Google sitemaps.

Yahoo Sitemap Submit

Open the Yahoo submission page to submit an RSS SiteMap to Yahoo.

Trouble Shooting

If the software displays a Browser Error notice:

Once you have current browser software with JavaScript enabled you will be able to access all software functions.

If php code displays in your browser when it is run on your server:

Make sure all your variable values are correct. This includes the case of letters, A is not the same as a.

Requirements for Use

The software runs directly in your browser. Your browser must support JavaScript and the Document Object Model. Current browsers all support these features. If your browser does not support these features a Browser Error notification will be provided when you open the software.

It is recommended that the SiteMap XML software is run on your server. To build Dynamic siteMaps the Generated Dynamic SiteMap code must run on your web server. To run software and code on your server it must support the php scripting language. Most commercial web servers support php. For information on php and how to check if it is available on your server go to What is php?

Installation

SiteMap XML software can be run directly from our server at http://www.softswot.com/sitemap/sitemapxml.php or you can Download SiteMap XML Dynamic SiteMap Generator and run it on your server. It is recommended that software be run on your server. To set default variables for a Static SiteMap the SiteMap XML software must be run on your server. To build a Dynamic SiteMap the Dynamic SiteMap Code must be run on your server. If run from our server no installation is required but default Depth, Limit and Delay values cannot be changed.

To install software on your server download the latest version software file. The latest version software is always available for download from softSWOT.com. If software is downloaded as a Self-Extracting SetUp file (.exe) when you run the .exe file it will extract and save the software files. If software is downloaded as a Compressed Zip file (.zip) it must be unzipped before you can save the software files. Trial Zip software is available free from Winzip or a simple freeware zip utility is available from JustZIPit.

For the software to function your server must support php. To run the software on your server the software files (sitemapxml.php and smxpc.js) must both be uploaded to your server. They can be uploaded exactly the same as any normal web page. Once uploaded you can open the file sitemapxml.php from your server in a browser; JavaScript must be enabled; and follow the Instructions for Use.

This software does not access or alter your system or system files in any way. To uninstall you can simply delete the directory and included software files created and saved when you installed the software (both on your computer and on your server). Alternatively if a Self-Extracting SetUp file was used for installation you will be able to remove the software from your computer using Uninstall from the shortcut menu.

Conditions of Use

The specific suitability of this software must be independently assessed. Software is provided as is, use is entirely at the users risk, and use acknowledges that softSWOT and all associated parties are held harmless from any claims or losses relating to software provided.

Software Support and Contact Details

For items not addressed here please visit softSWOT.com where you can access our Question and Answer Items. In our Question and Answer Items we post responses to a range of topics related to this software. It provides a growing knowledge base and allows you to benefit from the experience of others, if you have read all of the Help file and still have a question this is a good place to start. If after completely reading and following the Help file, and reviewing our Question and Answer Items your question is unanswered please Contact Us.

Web Site: www.softswot.com

Full contact details are provided at Contact Us.

softSWOT is a member of the Bizpep Group
ABN: 24 312 166 103

Regards
David Morcom
www.softswot.com