3.2.2 Archiver Module

Archiver Module can generate highly configurable static pages based on any content sent from any of the input modules such as Pages module or RSS Wizard Module. Within the module settings you can specify templates for page generation, path to directory to store those pages, set filenames and page titles generation pattern.

Based on your settings the module will generate individual pages as well as monthly archive pages (sup-sitemaps) and you will get a brand new website with unique content out of nothing :). A system of special tags is available to dynamically generate pages filenames and titles.

The next diagram reflects the structure of pages generated by Archiver:

The way it works, with fresh content Archiver generates index page and monthly archive for each month with links to individual pages created within that month.

Next time the script runs, the content from the index page goes to individual page and a new index page is generated. Monthly archive is updated accordingly. That way you have your archive growing with always fresh content on the first page.

There are 3 groups of settings in the module:

- for archive index page,

- individual pages, and

- monthly archives.

Take a look at the first two sections of the Archiver module:

Relative path to directory to store archived pages: First you need to create a directory on your server where you want your pages to be generated. Here you need to specify relative path to your archived pages directory on your server with opening slash and without closing slash "/" (For example /archive_pages. Directory permissions should be CHMOD 777. The pages generated by this module will be stored in this directory.

Main archive page settings

Specify the file name:* Here you will need to specify the file name for your index page. it can be with any extension you want, for example: index.php, archiveindex.html, indexnews.ppp etc.

Choose main page template: You can pick one of the templates or choose “Any on random basis” which is very powerful feature. Every time your index page is regenerated it will be based on random template.

Template operations: You can preview and edit your templates right from your module.

Recommendation: Do not use the default templates in order to avoid footprints. Please edit the existing templates or upload your own ones. The templates can be uploaded to:

SGW/modules/archive/templates/

Make sure that this folder and template files are CHMOD 777.

There are 5 custom tags that can be used in the template:

<$SGW_page_title$> - Page title (News title, article title, etc.)

<$SGW_page_content$> - Page content (news body text, article text, etc.)

<$SGW_page_previous_page$> - link to previous page

<$SGW_month_archive$> - link to monthly archive

<$SGW_index_link$> - link to main/index page of archive

You can use all or some of these custom tags in the template.

Make sure you preview your template for any errors before leaving the script to work on its own.

Below you can see how template editor looks:

Individual archive pages settings

Filenames will be created as:* To generate individual archive pages filenames there are several special tags available. Use only these available tags!!! Add a file extension at the end. For example: .html or .php

The following special tags are available for use to create file names:

%title% - Title of page, without changes
%title-% - Title of page, with dashes, for example: Title-of-page
%title_% - Title of page, with underscores for example: Title_of_page
%year% - The year of the post, four digits, for example: 2006
%fullmonth% - Full name of the month, for example: February
%month% - Month of the year, two digits, for example: 02
%day% - Day of the month, 2 digits, for example: 14

Several examples:

archive_%month%_%year%.html will look like: archive_03_2006.html
%title-%.html will look like Title-of-page.html

Number of hours to change file's date and timestamp: Let’s say you select 5. When the cron job runs, SGW will pick random time within 5 hours of current time and will change this file’s date and timestamp to that time.

This will help to eliminate footprints for the search engines and even make your machine generated content look like human content because it wasn’t created at the same time.

Crosslink individual pages: Will place a link on current page to previous page (to make sure that all your individual pages get indexed by the search engines).

Link title to previous page: Here you can specify what you want to see in that link title. You can use the same special tags as above.

Several examples:

Previous news: %day% %fullmonth% %year% will look like Previous news: 24 March 2006
%title-% will look like Title-of-page

Choose individual pages template: You can pick one of the templates or choose “Any on random basis” which is very powerful feature. Every time individual page is generated it will be based on random template.

Template operations: You can preview and edit your templates right from your module, using special tags.

Recommendation: Do not use the default templates in order to avoid footprints. Please edit the existing templates or upload your own ones. The templates can be uploaded to:

SGW/modules/archive/templates/

-------------------------------------------------------------------------------------------

Monthly archive page settings

Link text for monthly archive pages: Here you can specify what you want to see in that link title. You can use the same special tags mentioned above.

Several examples:

Archived news: %fullmonth% %year% will look like Archived news: March 2006
%title-% - %fullmonth% %year% will look like Title-of-page – March 2006

Monthly archive filename: Use the same special tags to generate monthly archive filenames. Add a file extension at the end. For example: .html or .php

Choose monthly archive template: You can pick one of the templates or choose “Any on random basis” which is very powerful feature. Every time monthly archive page is generated it will be based on random template.

New links will be added to monthly archive: You can choose where to add new links at the top or at the bottom of the page.

Template operations: You can preview and edit your templates right from your module, using special tags.

Recommendation: Do not use the default templates in order to avoid footprints. Please edit the existing templates or upload your own ones. The templates can be uploaded to:

SGW/modules/archive/templates/

After you are done with templates you can choose to add links to your sitemap and activate Pinger module to ping remote websites with updates on your newly created pages.

Don’t forget to click on “Update settings” after you make any changes.

After you are done setting up the module go to Test & Log tab (more info in Chapter 4 – Testing the script).