Contents

• Switch to complete documentation
• Getting started
  • Installing TSEP
  • Configuration
  • Security
  • Indexing your site
  • Preparing the search pag

^Getting Started

^Installating TSEP

Before you start, backup your files and your database!

Also, when upgrading from a previous version, follow the installation procedure completely. We hope to provide a real upgrade possibility in future.

1. Unzip the downloaded TSEP files. Make sure that you have the folder structure correct.
2. Upload all files to your website, make sure that you have the folder structure correct.
3. If you know what this means: chmod 666 the /include/DBConnectionData.php file
4. Open the install.php file in the admin directory and set the values which are appropriate for your database.

• If everything works fine, all will be done by the install.php, you can even keep your old stopwords and logs. The following should happen:

• a new file called DBConnectionData.php is either created or updated in the include directory. This contains nothing more than the values needed to connect to the database.
• drop.sql, create.sql and insert.sql will run on the database to prepare for the new version of TSEP.

Continue now with the next step: configuration.php (skip the next points of this list!)

• If there is an error: the install.php should tell you about it (=you will see something is not correct) and show you the data which needs to be inserted into the DBConnectionData.php (include directory).You will need to do this manually. Do not change the TSEP table prefix setting! If the installer does not display anything, these are the lines you just need to copy, adjust and save as DBConnectionData.php in the include directory:
  
  <?php
  $db_server = 'localhost'; //your database server address
  $db_name = '...'; //your database name
  $db_usrname = '..'; //your database login name
  $db_pwd = '...'; //your database password
  $db_table_prefix = 'tsep_'; //prefix for all tsep tables (introduced in 0.912)
  ?>
  
  Then run the 3 SQL files in the admin directory in the following order: drop.sql, create.sql, insert.sql You could use phpmyadmin for this.

These files - when correctly executed - will create the database tables with some starting values. See the database model.

^Configuration

This was introduced in v0.912. Open the configutation.php directly after installation and set the correct values, especially for language and the TSEP path - and of course every other value.

Open the configuration.php in the admin directory and make all the changes to your liking.

Continue with Security.

^Security

For security we advise you to protect the include and the admin directory using .htaccess!

Continue with Indexing your Site

^Indexing your Site

For populating the database with the values for the search engine to search for (the content of your pages), you have to run the file 'indexer.php'.

In version 0.938 we added arguments for the indexer. You have now more ways to call it:

indexer.php?startindexing

directly starts indexing with the active profile

 

indexer.php?startindexing&profile=xxx

directly starts indexing with the given profile - in this case xxx. Attention: This works only if your profile name does not contain characters which are encoded (spaces included).

 

 

indexer.php?showcompleteindex

shows complete index currently stored

If you are calling the indexer.php the old fashioned way (for example by the link in any of the administration pages) you need to input the details asked by the form.

You can choose a profile to use, you can save your settings as profiles ("save " and "save as" buttons), you can rename a profile or delete a profile. When you are deleting a profile all pages which belong to that profile only will be removed from the index as well!

By submitting the form with the appropriate values you will see the results of the indexing after a few seconds. The script will provide a detailed information on the number of pages, the title, the URL, the size and the indexed words found by the indexing script as well as the profiles a page belongs to.

Also the entries you have made in the form are saved to the database for later re-use / re-indexing.

^Preparing the Search page

Do you want:

1. to use the pre-made search page?
2. include TSEP into your layout?

1. to use the pre-made search page 'tsepsearch.php', you are done with the installation.
2. to include the search page in your own page / layout, please follow these steps - make sure that the path to the two files are set correctly!
   1. You need to make sure your page is being processed as a PHP page, ususally this is the case when your page has the extension .php or .php3 add the following code between your SEARCH page <head> ..and.. </head> tag - otherwise the search will look ugly! This example assumes that search.php is located in the same directory as your search page, tsep.css is in a subdirectory called "css".
      
      <link href="css/tsep.css" rel="stylesheet" type="text/css" />
   2. add the search.php into your page at the position you wish to add the search function like this:
      
      <?php require ('search.php'); ?>

   You have now integrated TSEP into your own page.