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

TurboSeek » TurboSeek Documentation >> 4. How templates & their variables work


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
The Directory Manager

Index

Next Page >>
Building indexes

 

4. How templates & their variables work

4.1 The idea behind the HTML templates
4.2 Editing the Default Directory Template Plug-In
4.3 The Rest of the templates
4.4 Using different template html code for different categories
4.5 How to use template includes
       4.5.1 What are template includes?
       4.5.2 How to create a template include
       4.5.3 How to include template includes inside your templates

 

4.1 The idea behind the HTML templates

The idea behind html templates is that you can edit all HTML code displayed to visitors so that the look and feel of your Search Engine & Directory can be the way you want it to be. You may copy and paste the HTML code in your web editor, to edit the layout of the HTML and all aspects of it. Once you have the template the way you want it, you can copy the source of this template (HTML code) out of your web editor and paste it back into the Template Manager. You may also open the .html files in your web editor and edit it.
   
All categories can also have their own unique HTML templates, but more about this later in this section.

 

4.2 Editing the Default Directory Template Plug-In

Go to the 'Template Manager' by clicking on the 'Template Manager' tab located in the Admin Control Panel.

You will see a heading called: Default Directory Templates - Undeneath this heading click on 'Directory Template'. A popup window will appear and will show you the HTML code of the Directory template used when displaying links in your directory.
   
You may edit the HTML or copy and paste the HTML code into your web editor. Please ensure that the variables in the HTML code remains intact. The variable names are surrounded by the %% or !! characters. These variables are replaced with data provided by Turbo Seek, when an end user browses your Directory. Missing variables will have the effect of your directory not operating correctly.
   
Note that when you make use of images in the html code, you must use a URL link to indicate their locations. For example:
<img src="someimage.gif"> will not work. You have to indicate the entire URL
where someimage.gif is located. For example:
<img src="http://www.yourdomain.com/someimage.gif">
   
The templates in Turbo Seek are are normal HTML files which you can edit with your web editor. The only difference between normal HTML files and the Turbo Seek template HTML files is that the HTML used by Turbo Seek requires the variable words in it.

 

4.3 The Rest of the templates

All templates works in the same manner as explained above. You edit the html which is used in the operation of your Directory. In the same way you open an HTML file with your web editor, you can copy the HTML source code and paste it into your web editor and edit it.    

 

4.4 Using different template html code for different categories

To use different HTML in different categories, so that different categories can have it's own look and feel, do the following:

Go to the Template Manager by clicking the 'Template Manager' tab. Then click on 'Create/Define Custom Templates for Different Categories'. Once you clicked the above link you can create an HTML template set. Type in a name and click the 'create' button.
   
When you have created a custom Template set, you may choose to use this template by going to the 'Directory Manager' and by clicking the text in the 'Template' field. Each directory can have it's own custom template.
   
The link that is called 'Default' next to each directory, means 'Default Directory Template Plug-In' is used for the Directory/Category.

 

4.5 How to use template includes

Please note that the template include functionality is only available from Turbo Seek ver 1.7x

4.5.1 What are template includes?

'Template includes' works with Turbo Seek like SSI (server side includes) would work with a web server/host. Template includes are pieces of HTML code that you can include in any of the templates used by Turbo Seek. The pieces of HTML code could be menu bars, footers, headers, search boxes, etc.

You could for example create a 'Template Include' that will be a menu bar that you would like placed on the left side of all your Search Engine & Directory pages. Without template includes you would have to open each template and insert the same menu bar, but with template includes you can just change the include.

With template includes you just insert a variable word inside the templates and the HTML code that is contained within the 'Template Include' is replaced by the variable. In the event where something of your menu bar changes, you just edit the template include and the rest of the templates containing the menu bar via the 'Template Include' changes.

4.5.2 How to create a template include

Go to the Control Panel and click on the Template Manager tab. Now click on the ‘Template Includes’ link.
In the popup Window, go to the ‘Add New Template Include’ form and enter a name and some text or HTML code.

Then click the ‘Add new Template Include’ button.

4.5.3 How to include template includes inside of your templates

'Template Includes' will be listed on the Template Include page when template includes have been added. With all the template include listings there will be a field or section that displays a Turbo Seek variable. The variable is a word enclosed by %% characters. Use this variable word inside any of your templates to include the contents of the 'Template Include' in the templates of your choice. To use template includes inside your templates, go to the template manager and edit your templates by adding the 'include' variable at the location where you would like the contents of the include to be displayed.

Eg. Putting %%incl_header%% inside of a template will display whatever HTML code is in the header include upon runtime (page execution).

 

<< Previous Page
The Directory Manager

Index

Next Page >>
Building indexes

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