corner1.gif (159 bytes) corner2.gif (159 bytes)

TurboSeek » TurboSeek Documentation >> 2. Settings and Options (After installation)


Turbo Seek Documentation

Index

1. Installation
2. Settings and Options (After installation)
3. The Directory Manager
4. How templates & their variables work
5. Building a Search Index
6. Running your directory
7. Tips, Tricks & Notes
8. Plug-In's

<< Previous Page
Installation

Index

Next Page >>
The Directory Manager

 

2. Settings and Options (After installation)

2.0 Overview
2.1 General Configuration
         2.1.1 Directory File Extensions:
         2.1.2 Default Index File:
         2.1.3 When Indexes builds from command line:
         2.1.4 Directory listings sorted by:
         2.1.5 Number of items per page:
         2.1.6 How to link url's of link listings in directory:
         2.1.7 Date format when listing a date with a link listing:
         2.1.8 Number of items per page: (Searches)
         2.1.9 Next Page Text:
         2.1.10 Previous Page Text:
         2.1.11 Text before number of pages:
         2.1.12 Text when link has no rating:
         2.1.13 Review Text:
         2.1.14 'Rate it' Text:
         2.1.15 Open a javascript window when rate-it is clicked:
         2.1.16 Open a javascript window when reviews clicked:
         2.1.17 Separator between next and previous page:
         2.1.18 Separator when displaying category location:
         2.1.19 Text when a search revealed no matches:
         2.1.20 Text when there is no reviews to display:
         2.1.21 When links from the search results are clicked open them in a new window?
         2.1.22 When links from the directories/categories are clicked open them in a new window?
         2.1.23 Name of 'Add Url' Link:
         2.1.24 Display the @ character next to directories if the directories contains sub directories?
         2.1.25 Display the number of links present in directories when listing directories:
         2.1.26 Number of links per page:
         2.1.27 Display Link Counts: (Turning this off will improve speed in the control panel)
         2.1.28 Enable Image Authentication when visitors submit links?
         2.1.29 Enable Image Authentication when visitors post comments/reviews?
         2.1.30 Strip HTML tags from fields when new submissions are received:
         2.1.31 Block referrers other than the domain Turbo Seek is running on.
         2.1.32 Maximum Number of Characters allowed in description field when a link is submitted:
         2.1.33 Check for duplicates when new URL's are submitted?
2.2 Error Text Configuration
2.3 New User Submission Email
2.4 Rejected User Submission Email
2.5 Spam Keyword Filter
        2.5.1 How to add a new keyword filter
2.6 How to use the banner manager
        2.6.1 Introduction
        2.6.2 How it works (Short Description)
        2.6.3 How to rotate banners in your directory/category listings using the default 'directory HTML template'.
        2.6.4 How to rotate banners in your directory/category by using custom templates.
        2.6.5 How to target banners at content
        2.6.6 Displaying banners with search results
        2.6.7 Rotating banners on normal web pages
2.7 How to add your own fields/keys
        2.7.1 How to add a fields/keys
        2.7.2 Editing your fields/keys
        2.7.3 Deleting fields/keys
        2.7.4 Integrating your fields/keys into your link listings
        2.7.5 Integrating your fields/keys into your add url form/template
2.8 Submissions Mailing List Management

 

2.0 Overview

Once Turbo Seek has been installed, you may want to change the way in which your directory operates. Turbo Seek has been created with the idea to customize everything that is displayed to the end user. No matter what you want to do, you should be able to change any graphics, details & texts displayed to the end user.

Click on the 'Settings & Options' button in the control panel to set the settings & options. 2.1, 2.2, 2.3 below describes each setting and option in detail.

 

2.1. General Configuration

2.1.0 Would you like to run a static or dynamic Directory?

  • Static: A complete browsable set of HTML files are generated (created) that is browsable. Light on server resources, search engine friendly and highly recommended. Note that you will have to generate the files by clicking the 'Build Indexes' tab. Then click 'Build Directory Index'. When any links are changed or added, the HTML files will have to be regenerated to reflect the changes

  • Dynamic: Pages are displayed on the fly while users browse the Directory. All changes to links and directories/categories are immediate and no HTML files need to be generated.

2.1.1 Directory File Extensions: This should normally be set to .html
This would be the extension of HTML files when you decide to run your directory from generated HTML files. You may also set it to .shtml or whatever would suite your needs. If you are not sure what this is, leave as is.

2.1.2 Default Index File:
This is the default index file your server uses to recognize that this is the default front page. For example, if you type
http://www.focalmedia.net - The server searches for index.html because it has been set to recognize index.html as the default front/index page of any directory accessible by the web server.

2.1.3 When Indexes builds from command line:
Turbo Seek has 3 scripts that you
can run from the command line. More about this later in the manual.
Setting this option 'verbose' will display information to you when scripts
are run from the Unix command prompt. Setting it to silent will display
no information when scripts are run from the Unix command prompt.

2.1.4 Directory listings sorted by:
Here you can specify how turbo seek should
present links to users in the directory. The links will be sorted by
whatever you choose here - from highest to lowest.

2.1.5 Number of items per page:
This is the amount of links that is displayed on a page when listing
links to end users when they browser your directory.

2.1.6 How to link url's of link listings in directory:

  • Count Clinks - All links displayed in the directory will go to a script which will first count clicks when links are clicked and then redirect to the web site's url.

  • Directly Go To URL - Go directly to a url address when clicked from a link listing without first counting the click.

2.1.7 Date format when listing a date with a link listing:
Here you specify in which format you would like dates to display.

2.1.8 Number of items per page: (Searches)
This is the number of results (links) displayed per page when an end user uses the search engine to search the index.

2.1.9 Next Page Text:
This is the link text used where the end user can click to go to a next page of link listings.

2.1.10 Previous Page Text:
This is the link text used where the end user can click to go to a previous page of link listings.

2.1.11 Text before number of pages:
When there is more than 1 page containing link listings the number of pages with links are displayed. This text is used to the left of listing all the pages available. Example: Pages: 1 2 3 4 5 6 7

2.1.12 Text when link has no rating:
When a link does not have a rating, this text will be displayed.

2.1.13 Review Text:
This text is linked to the review cgi script. A user would click this text link to review a link.

2.1.14 'Rate it' Text:
This text is linked to the rate-it cgi script. A user would click this
text link to rate a link.

2.1.15 Open a javascript window when rate-it is clicked:
If you don't want a popup window to appear when a user has clicked to rate
a link, set this to 'No'.

2.1.16 Open a javascript window when reviews clicked:
If you don't want a popup window to appear when a user has clicked, to review
a link, set this to 'No'.   

2.1.17 Separator between next and previous page:
This separator will be used when for example the text 'Next Page' and
'previous page' are displayed next to each other.
Example: Next Page | Previous Page

2.1.18 Separator when displaying category location:
This is the separator used when displaying the current location of where the
end user is currently residing.
Examples:
Top : Entertainment : Movies : By Genre : Action
Top >> Entertainment >> Movies >> By Genre >> Action

2.1.19 Text when a search revealed no matches:
This text is displayed to a user when the search engine could not find
a match for the keywords he used.

2.1.20 Text when there is no reviews to display:
This text will be used when no reviews has been added for a link listing.

2.1.21 When links from the search results are clicked open them in a new window?
Setting this to 'Yes' will have the effect of links opening in a new window from search results.

2.1.22 When links from the directories/categories are clicked open them in a new window?
Setting this to 'Yes' will have the effect of links opening in a new window where users browse directory listings.

2.1.23 Name of 'Add Url' Link:
This is the text that will be displayed which a user clicks when he/she wants to submit a url.

2.1.24 Display the @ character next to directories if the directories contains sub directories?
The @ character indicates that there is sub directories within the directory when the directory is browsed.

2.1.25 Display the number of links present in directories when listing directories:
This number will display the entire amount of links residing in directories.

2.1.26 Number of links per page:
This is the number of links that is displayed per page when browsing directories in the directory manager of the control panel.

2.1.27 Display Link Counts: (Turning this off will improve speed in the control panel)
Displays the number of links next to directories of the control panel when browsing directories in the directory manager.

2.1.28 Enable Image Authentication when visitors submit links? - If this is enabled then 'Submission Services' won't be able to submit links to your search engine. This function has been implemented so that 'Submission Services' are not able to do spam submissions. Letterboxes are displayed to submitters where they need to type the letters displayed when submitting a link. This will disable automated submission scripts.

2.1.29 Enable Image Authentication when visitors post comments/reviews? - Will block automated submission scripts to avoid spammers spamming  links with spam reviews/comments.

2.1.30 Strip HTML tags from fields when new submissions are received:
HTML tags will be removed from new submissions if this is set to 'Yes'.

2.1.31 Block referrers other than the domain Turbo Seek is running on. Users will only be able to submit new url's from your 'add url' form if this is set to 'Yes'
This is useful to block submission services from submitting new urls.

2.1.32 Maximum Number of Characters allowed in description field when a link is submitted:
The maximum length of a description when users submits new submissions.

2.1.33 Check for duplicates when new URL's are submitted?
Duplicates are matched against the 'search index'

 

2.2 Error Text Configuration

These texts are used to display problems to users when they submit 'data'. For example if a user left out a field when doing a new submission, text will be displayed from this section to the user.

 

2.3 New User Submission Email

This is an email sent to a user to inform him/her that his/her link was successfully added, when he/she submitted a new link. You may edit this email according to your needs. If you don't understand how the variables in this email message works, please see '4. How templates & their variables works' of this manual.

 

2.4 Rejected User Submission Email

This email is sent to a user when his/her new submitted link has been rejected. If you don't understand how the variables in this email message works, please see '5. How templates & their variables works' of this manual.

 

2.5 Spam Keyword Filter

The Spam/Keyword filter enables you to block submissions which you do not want included in your new submissions area for approval. This can be useful to completely ignore spam, a spammer, or to keep your directory family friendly. Note that once you added keywords here, the submission containing those keywords will be blocked completely and the blocked submission will only show in the 'blocked log'. The submitter will get the idea he submitted successfully but the submission will have been in fact blocked. Use with caution as you can block submissions that you don't want blocked.

2.5.1 How to add a new keyword filter

Click on the 'Add New Keyword' button and supply your keyword and the rest of the details required. You will need to choose how keywords will be matched when new submissions are made.

Whole or Partial Word Match:

Whole Word Matching
Whole word matching matches whole words. For example: Spam
This will only match Spam and not Spammed
      
Partial Word Matching
Partial matching matches any word in words. Let's say you specified Spam as a keyword. If Spammed was found within a submission the submission will be blocked because Spammed contained the word Spam

You will also need to choose where this keyword will be looked for.

Check For This Keyword in:

Title, Description and Keyword Field
If you choose this to be checked for keyword matches, the title, description and keyword field in the submission form will be checked for matches.

URL Field
URL fields will be checked for keywords/URL's when new submissions is received.

Email Field
Email addresses will be checked for keywords or email addresses when new submissions is received.
      
Referrer
If keywords or URL addresses matches a referrer trying to submit data, the submission will be blocked. What is a referrer? In this instance a referrer is a URL address somewhere on internet that is trying to submit data directly to the submission script. The submission form will most probably be bypassed having the effect of receiving a referrer. This is mostly useful if you want to block submissions from certain submission services.

 

2.6 How to use the banner manager

2.6.1 Introduction

The banner manager is a banner rotation system that comes with Turbo Seek. This banner system has not only been created to rotate banners but also enables you to target banners at the contents of your directories/categories.

This section of the Turbo Seek documentation assumes that you have already added directories/categories and listings to your search engine. If you are not familiar with the template system in use, it might be a good idea to customize your search engine according to the look and feel you have in mind, and then come back to this section to implement banner rotations.

See 'How templates & their variables work' for complete documentation on how you can customize the look and feel of your directory by using your own HTML and graphics.

2.6.2 How it works (Short Description)

You can rotate banners in your directories/categories by defining/creating banner slots in the directory/category template(s). Groups of banners can be assigned to these banner slots from the 'Directory Manager' on specific categories/directories. You create groups of banners in the 'Banner Manager'.

To make use of banner rotation when end users do searches, you can make use of banner HTML code in the 'search HTML template Plug-in'.

2.6.3 How to rotate banners in your directory/category listings using the default 'directory HTML template'.

The instructions below assumes that you are using the default directory HTML template in your directories/categories. There is more information about custom HTML templates and banners later in this section of the documentation.

To rotate banners in your directory/category listings you can do the following.

Step 1
Go to the template manager and click on 'Default Directory Template 'Plug-In'.

Step 2
Open defdir.html with your web editor or copy and paste the HTML code into your web editor from the 'template manager'.

Step 3
Lets say you have 4 locations in this HTML template where you want to place banners. These 4 locations should each rotate banners. Place the word/variable %%bannerslot1%% in the location where you want the first banner rotated.

Place the word/variable %%bannerslot2%% in the location where you want the second banner rotated.

Place the word/variable %%bannerslot3%% in the location where you want the third banner rotated.

Do the same with the fourth banner you want rotated.
 
Step 4
Now you have defined banner slots. You may define up to 5 banner slots in a template or the 'default HTML template plug in'. Save defdir.html or copy and paste the HTML code from your web editor into the 'template manager' and click the save button.

Step 5
Click the 'Settings & Options' button and then click 'Banner Manager' to go to the banner manager.

Step 6
In the banner manager you can add groups of banners. Each group can contain banners that are to be rotated. Create a group by filling in a name in the 'group name' box and by clicking the 'add new banner group' button.

Step 7
Click on the group name you have just created to add banners to this group.

Step 8
Add all the banners that you would like to be rotated for this group.

Step 9
Now you should have defined banner slots in your 'default HTML template plug-in' and you should have created a banner group.

Go to the directory manager and to any category that you would like the banners of the group that you created to be rotated. In the 'Banners' column listed next to each directory/category you will see the word/link 'None'. Click on this link and a popup window will appear. The group that you have defined/created will be available for selection for any of the banner slots that you added in the 'default HTML template plugin.' Select the group for the specific banner-slot where you would like the banners rotated.

Step 10
Now you can add more banner groups so that other banners can be rotated in the banner slots that you have defined.

2.6.4 How to rotate banners in your directory/category by using custom templates.

Lets say you have created/defined some custom templates for different categories. You would like banners rotated in the categories that uses these custom templates. To use banners in these custom templates, insert the banner slot variables in these custom templates ( %%bannerslot1%% or %%bannerslot2%%, etc). Once these custom templates has banner slots you can assign banner groups from the 'Directory Manager' to categories/directories that makes use of these custom templates.

2.6.5 How to target banners at content

Targeting banners should be self explanatory. You insert banner slots in the template(s) that is used for your directories/categories. Once the banner slots are present you go to the 'Directory Manager' and assign groups of banners to be displayed in specific directories/categories.

For example: You can create a banner group called 'Entertainment' and just add entertainment related banners to this group. Lets say you have an entertainment category/directory with link listings. Ensure that the template used by the 'Entertainment' category or directory has banner slots. From the 'Directory' manager choose what groups of banners needs to be displayed in Entertainment.

2.6.6 Displaying banners with search results

You will need to define/create a banner group in the 'Banner Manager'. Add the banners that you would like to be rotated when displaying search results.

After you have banners in the group that you plan on using in search results, insert the following code in the 'Search Results Template Plug-in'. (Go to the 'template manager' and click on 'Search Results Template Plug-ins' in the admin control panel)

<!-- Start of Banner Code -->
<SCRIPT LANGUAGE="JavaScript">
<!--
random = parseInt(Math.random()*10000)
banner = '<a href="http://www.yourdomain.com/cgi-bin/tseek/tclick.cgi?grp=SomeGroup&'
banner += 'pg=' + random + '" TARGET="_blank">'
banner += '<img src="http://www.yourdomain.com/cgi-bin/tseek/tbanner.cgi?grp=SomeGroup&'
banner += 'pg=' + random + '" alt="Click Here!" BORDER=0></a>'
document.write(banner)
// -->
</SCRIPT>
<NOSCRIPT>
<a href="http://www.yourdomain.com/cgi-bin/tseek/tclick.cgi?grp=SomeGroup&pg=01">
<img src="http://www.yourdomain.com/cgi-bin/tseek/tbanner.cgi?grp=SomeGroup&pg=01"
alt="Click Here!" BORDER=0></a>
</NOSCRIPT>
<!-- End of Banner Code -->

Replace the url path that is in red with the path to tclick.cgi on your server/hosting-account. Also replace SomeGroup with the group name you defined/created.

2.6.7 Rotating banners on normal web pages

You may use the HTML code in '2.6.5 Displaying banners with search results'to rotate banners on any web page on your web site.

 

2.7 How to add your own fields/keys

Fields/keys is extra data fields that you can add to your directory. If you would want your link listings to carry, extra information like for example pricing information, extra descriptions, etc... you would want to add extra fields/keys to carry this information for each link listing in your search engine.

Adding fields/keys is a simple process and should be easy. You can add up to 10 fields/keys to your search engine. Follow the instructions and info below carefully and you should have your own data fields/keys serving you in no time.

2.7.1 How to add a fields/keys

To add fields/keys, go to the admin control panel and click on the 'Settings * Options' button. Then click on 'Define Edit or Delete Keys/Fields'. You will be presented with a screen where you can add fields/keys. Below is a description of each box that you have to complete in order to create a field/key.

Field/Key Descriptive Name:
Here you can just enter a name that describes your new field/key. This is only for the purpose of you recognizing the field/key when working with your links.

Field/Key Name:
This is the name of your field/key. Note that only English alphabetical and numerical characters are allowed in this name.

Length of Field/Key:
This is the length of characters that will be assigned for the use of this field/key. Try to keep it below 255 if you want this field to be searched by the search engine. If the length of this field/key is longer than 255 it may slow searching down. If it is a must that you use more than 255 characters and have thousands of links, use MySQL for optimum performance.

Include this Field/Key in Searches:
This is to indicate if you would you like this field/key to be searched by the searched engine when a user enters keywords to search your search engine. If you do not choose to have this field searched by the search engine, you would not be able to display the data of this field in search results. Read more about displaying field/key data a bit later in this section.

Required to enter data?
This is to indicated if an end user submits a link, would he/she be required to enter something in this field or not.

Text displayed when there is no data present?
When end users view your links and the field/key has no data to display what should be displayed. You can also leave this blank.

2.7.2 Editing your fields/keys

This option enables you to change some things about your keys. Rebuilding is required of your search index if you make any changes to your keys. To rebuild your search index, click on the 'Build Indexes' button and then on the 'Build Search Index' link.

2.7.3 Deleting fields/keys

This is not recommended if you already entered data in fields/keys. Note that if you delete fields/keys, that the data of the old field/key will stay behind if you define a new field/key in the place of the old field/key. Plan your fields/keys well to avoid any such situations in the future.

2.7.4 Integrating your fields/keys into your link listings

This should be a snap if you have worked with templates before. If you have not worked with the templates please first read and understand how the templates work. See 'How templates & their variables work' before you continue here, and come back to this section.

Let's say you now know how the template side of things work. In order to add your fields/keys to link listings you will have to supply variable words in your templates. The variable words should be enclosed by %%. Let's say you created an extra field/key called %%price%%. In order to display the data of this extra field in your directory's link listings you can just add %%price%% to tmplsearch.html (You can also edit this template when you go to the template manager in the control panel and click on 'Default Directory Template Plug-In')

These extra fields/keys also works with custom templates for your directory.

The extra fields/keys is always indicated in the template manager where you can add the variable names of your fields/keys. You can use the variable names of your fields/keys in all your link listings.

Note that if you have chosen that a field/key should not be searched when an end user searches your search engine, that you won't be able to display the field's/key's data in the search results.

2.7.5 Integrating your fields/keys into your add url form/template

When users submits new links you will most probably want them to add data to your extra fields/keys. To accomplish this you must edit add_url.html   - You can also edit this template by going to the template manager and then by clicking on 'Add URL Page Template Plug-In's'

You will want to add extra HTML field boxes where users can supply data to be added when they submit a new link listing. These HTML field boxes will need the names of your fields/keys. Below is an example of an 'Add URL Page Template Plug-In' (add_url.html) that has extra fields/keys. The names of these 3 extra fields/keys are price, version and releasedate
(Notice the orrange HTML code)

<!-- Hide Start of add url example HTML template // End Hide -->
<form method="POST" action="!!addurlcgi!!">
<input type="hidden" name="fct" value="addurl">
<input type="hidden" name="location" value="!!curloc!!">

Email Address: <input type="text" name="email" size="30"><br>
Title: <input type="text" name="title" size="30"><br>
Description: %%submissionbox%%<br>
Keywords: <input type="text" name="keywords" size="30"><br>
URL: <input type="text" name="url" size="30" value="http://"><br>

Price: <input type="text" name="cost" size="11"><br>
Version: <input type="text" name="version" size="11"><br>
Release Date:<input type="text" name="csuggestion" size="11"> (yyyy/mm/dd)<br>

<input type="submit" value="Submit" name="B1"></p>
</form>
<!-- Hide End of add url example HTML template // End Hide -->

Overview of implementing fields/keys in your add url template
In order to let users add extra data for your extra fields/keys, you have to edit add_url.html and add HTML field boxes with the exact names of your fields/keys so that this extra data for your fields/keys can show up in your search engine.

 

2.8 Submissions Mailing List Management

Email addresses can be captured from users when new submissions are made. The Submissions Mailing List Management section enables you to retrieve email addresses obtained from submissions, so that you can copy and paste it into your mailing list software. There is an excellent free mass emailer called Aureate Group Mail which we found really well suited for the task.

If you are upgrading from a previous version to version 1.60
Look at the sample 'Add Url' template (add_url.html) to see the check box you need to include so that users are able to specify that they would like to subscribe to the mailing list. You will need to include this check box into your current add_url.html for mailing list support. You can also use a hidden variable as explained below.

If you would like to automatically add users to the mailing list without them checking a check box when submitting a link you can do this by using a hidden form variable instead of the check box. You will want to use the line of HTML code below in the form section of the template instead of the check box:
<input type="hidden" name="mlist" value="Y">

 

<< Previous Page
Installation

Index

Next Page >>
The Directory Manager

ffbotl.gif (1447 bytes) FocalMedia.Net Support ffbotr.gif (1456 bytes)