Using Atomz Search

The Atomz search engine is quite flexible, but setting it up involves a few steps. Note that Atomz will only index up to 500 pages for free, and any pages beyond that will not get indexed.

Set Up an Atomz Account

The first step is to make sure you have an account. When you go to the Atomz site, and fill out the form which asks for your email address. You will receive email from Atomz with a link which you should click, as well as your initial account password. Click on the link and fill out the necessary information to get started.

Set Up Search URL

The next step is to set up which URL you wish to search, which should be the next screen you see.. For webinfo, http://www.washington.edu/webinfo/ was used. Atomz will start at this point and follow all links that are under that URL, but will not go to other hosts or directories. If you have more than one URL to search, you'll be able to change that after the initial setup has been done (via "Accounts" and then "Update Account".)

Change Your Password

Atomz will start an indexing of your site after you've entered the URL. While that's going on would be a good time to change the initial password. In the left column, click on "Accounts" and then "Update Membership." You will need the initial password in the email from Atomz to set a new password.

Check Indexing Progress and Results

After you've changed your account password, you can check on the progress of the initial indexing. In the left column, click on "Index" and then "Full Index." If the indexing is still running, you'll see the current status. After the indexing has completed, you'll see how many pages were indexed and how long it took, as well as if there were any errors. You'll want to glance through the errors to see if there are any which need fixing.

Set Automatic Indexing

If you'd like Atomz to automatically index your site on a weekly basis, you set that by clicking in the left column on "Index" and then "Full Index Schedule." The free Atomz search does not let you choose anything other than indexing once per week or no automatic indexing.

Modify Results Template

There are several ways you can modify your results template, and there are many features which you can include. One way to proceed would be to go to the basic template selection page (click on "Templates" and then "Choose A Template") and pick one with the basic look and feel which you desire. Once you've set that as your default template, then you may wish to alter it to look more like the rest of your pages. There's no getting around a lot of hand editing to do this, however.

Generate Blank Page

To make the Atomz results page look like your other pages, it's easiest to start with a blank page. Also, since Atomz does not support chtml or other server-side processing, you'll need to use a browser to capture the HTML after processing.

Create a .html page with very little content (perhaps with "Content Here" where the content should go, so it's easier to find it.) The blank file used for the webinfo search results template is atomz-template.html:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--chtml include "//webinfo/incs/header.inc"-->

<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
	<title>Webinfo Search Results</title>
	<link href="/webinfo/webinfo.css" type="text/css" rel="stylesheet" />
    </head>

    <body>
	<h1>Webinfo Search Results</h1>
	<!--chtml include "//webinfo/incs/navbar.inc"-->
	Content Here
	<!--chtml include "//webinfo/incs/footer.inc"-->
    </body>
</html>

View that page with a browser (making sure to do so by connecting to a web server, not opening a local file) and save the source to a file, using a different name than your blank page, such as atomz-results.html. Note you do not need for this page to be pushed into production, since you're just viewing it once to expand any chtml code.

Prepare the HTML Source

Once you've saved your HTML source, you need to make a slight change in the <body> and </body> tags; they should be changed to <SEARCH-BODY> and </SEARCH-BODY> so Atomz knows where the body starts and stops. It will automatically replace these two tags with the actual <body> and </body> tags. You should be able to preserve any attributes you set in the <body> tag.

Also, immediately after the opening <head> tag of your file, insert a base statement which will help make sure all the links on your page work correctly. For the webinfo search template, the statement is:

<base href="http://www.washington.edu/webinfo/" />

Be sure to replace the target with your directory. Also make sure that all the links on the page will work relative to the base target, as if that base were the actual page being viewed by your browser. In this example, all the links on the page work as if we were visitng the webinfo home page.

Insert the Atomz Results Content

In your browser, click on "Templates" and "Template Editor" which will show the text of the template you chose. Select all the text between, but not includeing, the <SEARCH-BODY> and </SEARCH-BODY> tags and do a Copy. Note that with some browsers, you may have to do this in chunks rather as one big block. Go back to the editor window and find the "Content Here" text in your HTML source. Remove those words and Paste the rest of the Atomz template into your HTML source. Save the file at this point.

Publish the New Template

While still in the Template Editor, select the entire template text and delete it (so that you end up with a completely empty template in your browser.) Copy the contents of your newly-edited HTML source and paste them into the box. If at this point you wish to take a look at your template, select the "Test" tab at the top of the page; you'll need to use the Back button on your browser to return to the Template Editor. Once you're satisfied with your changes, click on the "Publish Changes" button, and click once more on the "Publish" button on the next page.

Put Search Form on Your Page

Now that you have your pages indexed and your results template published, you can put the search form on your page. Atomz supplies text for a simple and a complex search form which you can view by clicking on "HTML" on the left navigation bar. As an example, a simple webinfo search form would look like:


And the source HTML looks like:

<!-- Atomz Search HTML for webinfo -->
<form method="get" action="http://search.atomz.com/search/">
<input size=15 name="sp-q" /><br />
<input type=submit value="Search" />
<input type=hidden name="sp-a" value="sp10017a98" />
</form>

Search Reports

Atomz will periodially email a report showing which search terms were most popular. You can also look at these reports on their site by going to the "Reports" link in the left column.