# Install/Uninstall instruction for the Geeklog sitemap plugin

## Sitemap plugin [ver. 1.1.9: 2010-01-23]

In the following descriptions

- <geeklog_dir> is the directory where the system config.php file resides
- <public_html> is the directory where the lib-common.php file resides
- <admin> is the directory where the administration files reside (usually, under <public_html>)

## PRE-INSTALL

CAUTION: Sitemap plugin requires that Dataproxy plugin be installed beforehand. Besides, if you installed Google sitemap generator, uninstall it beforehand.

## INSTALL:

1. Back up your Geeklog Database. The sitemap plugin adds tables to your Geeklog database. You can do this with the built in admin backup facility.
2. Uncompress the sitemap plugin archive while in the <geeklog_dir>/plugins directory. The archive will create a directory called sitemap in the plugins directory.
3. Create the public_html and admin directories. Under your html directory (usually <public_html>) create a directory called sitemap. Under your <admin>/plugins/ directory create a directory called sitemap.
4. Change to your <geeklog_dir>/plugins/sitemap/ directory. Copy the files in the admin directory to the <admin>/plugins/sitemap/ directory your created in step 3. Copy the files and directories in the public_html directory to the <public_html>/sitemap/ directory your created in step 3.
5. Edit the config.php in the sitemap directory and confirm the table prefix and anonymous access settings and other display settings. The default is to use the geeklog table prefix and not allow anonymous access.
6. Log in to your Geeklog as a root user and run install.php in your <admin>/plugins/sitemap/ directory. The install page will tell you if the install was successful or not. If not, examine Geeklog system errorlog for possible problems. The sitemap plugin should now be installed and functioning. Clicking on the sitemap Icon will take you to the admin page.
7. Set up security. On install only the root users have access to sitemap administration and Viewing. You can delegate control for either of these functions through the user and group editors.

## UNINSTALL:

1. Run the install.php page in your <admin>/plugins/sitemap directory. This will remove all the data from your database.
2. Delete the three plugin directories created in the install process: <geeklog-dir>/plugins/sitemap/, <public_html>/sitemap/ and <admin>/plugins/sitemap/

## AFTER INSTALL

- [Sitemap]
  Log in as sitemap admin. All you have to do is choose items you would like to display.
- [Google sitemap]
  - Log in as sitemp admin. Specify items to be included in Google sitemap, frequency, priority and the file name of Google sitemap. The Google sitemap file has to exist in the public_html directory (where lib-common.php resides) and be written into by the Web server.
  - Google sitemap file will automatically be updated with the interval specified with $_CONF['cron_schedule_interval'] (in /private/config.php). The default value is 86400 seconds (1 day). If you want to update the file immediately, log in as sitemap admin and check "Update now!" and then click "submit".

## Static Pages IDs to be excepted from the sitemap

Since version 1.1.7, you can use regular expressions in specifying Static Pages IDs to be excepted. The IDs you have already exntered are valid. Regular expressions start with "/" and ends with "/". In regular expressions, characters / . [ ] ^ $ | ? * + ( ) { } have special meanings.

### Specifying an ID starting with "form"

/^form/

### Specifying an ID starting with "form" followed by digits

/^form\d+/

### Specifying an ID starting with "form" followed by 5 digits

/^form\d{5}/

### Specifying an ID starting with "form" followed by 1-5 digits

/^form\d{1,5}/

### Specifying an ID ending with "form"

/form$/

### Specifying an ID containing "form"

/form/

### Specifying an ID starting with "event" and ending with "form"

/^event.*form$/

### Specifying an ID starting with "event", followed by 5 digits and ending with "form"

/^event\d{5}form$/

### Specifying an ID containing either "apply" or "confirm"

/(apply|confirm)/

### Specifying an ID starting with "event_", followed by either "apply" or "confirm"

/^event_(apply|confirm)/

### Specifying an ID starting with "event_", followed by either "apply", "confirm" or "submit"

/^event_(apply|confirm|submit)/

### Specifying an ID starting with "event_", followed by 5 digits, ending with either "apply", "confirm" or "submit

/^event_\d{5}(apply|confirm|submit)$/

If you would like to specify more complicated patterns, please visit sites such as this page and learn for yourself.

## HISTORY

Version | Date | Description
--- | --- | ---
1.1.9 | 2010-01-23 | New Added a feature to re-create the sitemap when a new article was posted.
1.1.8 | 2009-11-04 | Fixed Fixed an error when you choose a language other than English or Japanese.
1.1.7 | 2009-10-23 | New Supported regular expressions in specifying Static Pages IDs to be excepted. See above. Fixed Fixed a bug in specifying Static Pages IDs to be excepted. Thanks, dengen!
1.1.6 | 2009-08-27 | New Added support for Calendarjp plugin. Thanks, dengen!
1.1.5 | 2009-04-01 | Fixed Fixed to hold a longer string in configuration.
1.1.4 | 2008-12-26 | Fixed Fixed to properly output entries of static pages into Google sitemap. New Now you can configure settings for static pages from admin GUI menu.
1.1.2 | 2008-09-26 | Fixed Upgraded to prevent include-files to be directly accessed in some case-insensitive file systems (e.g. MS Windows).
1.1.1 | 2008-09-14 | Fixed Upgraded to work well with PHP-4.x by not using htmlentities() and html_entity_decode() functions.
1.1.0 | 2008-08-15 | New Upgraded to work well with Geeklog-1.5.0.
1.0.3 | 2007-12-26 | Fixed to write into Google sitemap all stories in all the languages when you enable multilingual stories.
1.0.2 | 2007-12-25 | Fixed doubly escaped & chars. Fixed not to put formmail (staticpages) in the sitemap.
1.0.1 | 2007-11-10 | Fixed only to pick out such static pages as are displayed in the center block. Fixed not to display such data sources as are not enabled in admin/sitemap. New Now, you can change the display order of data sources from the admin screen.
1.0 | 2007-11-04 | Initial version