CosmicPerl User Guide














Usage
Guide
Editing the
template file's.
You can edit
the file's using a WYSIWYG HTML editor such as DreamWeaver or AceExpert. You
can also edit these file's as Raw HTML using a text editor. NOTE:- FrontPage
and other editors change the layout of the HTML, this causes serious problems
with template. If you are using FrontPage then please edit Raw HTML.
About the ::symbols::
The symbols
such as ::sitename:: and ::u1:: are very important. Our software replaces these
symbols with data relating to your directory, such as site information, category
information, etc. When editing the template file's do NOT remove these
symbols unless instructed.
Each template
file, what it is, and it's symbols are shown below:-
ADDSITE.TPL
This is the
template file for the "Add your site to this category page". The add
site system works in a similar way to yahoo. In each category there is an addsite
link, clicking this link will take you to the add site page which is generated
using this template. Below is a list of all the symbols and what they represent:-
::category::
- Displays the name of the category the site is being added to, this is also
used in a hidden form field.
When editing
this page you must be sure not to remove the hidden form field. There are extra
user fields u1 to u10, you can delete any extra field you decide not to use.
Extra user fields can make your search directory unique, offering more than
just site name and description. You can change the text from U1, etc to whatever
you require, although the form field name must stay as u1, etc. Be sure the
form action is pointing to your server.
CATEGORYP.TPL
This is the
template file for the category pages. When you create a new category this template
is used having the relevant category details parsed into the page.
::addsitelink::
- This will be swapped for the unique category add site link.
::modifysitelink:: - This will be swapped for the link to user modify sites.
::catname:: - Full category name.
::catnameshort:: - Category name without parent categories.
::catnameshort2:: - Parent category name's.
::banner:: - Category specific banner advert.
::resultshere:: - Three of these should be in your page, the first is where
the sub-categories will appear, second where the top site listings will appear,
third where the standard listings will appear.
If you are
not going to allow user's to modify their listings then you can remove ::modifysitelink::.
If you are not going to have banner advertising in your categories then you
can remove ::banner::. If you are not going to display topsites in your directory
then put the last to ::resultshere:: symbols next to each other. Other template
files are used to setup how the sites and sub-categories are displayed.
CATEGORYB.TPL
This is the
template file for the category banner display. There are also extra user fields
if you want to use them.
::bannerurl::
- URL to the banner image.
::siteurl:: - URL to the advertising site.
::sitedescription:: - Advertising site description.
::u1:: to ::u10:: - User variables allowing you to display extra information.
If you are
not going to have category banner advertising then you can ignore this file.
If you are then adjust this file to match your needs, removing extra user fields,
etc.
CATEGORYS.TPL
This is the
template file for the category site display. This template is repeated into
the category page for each site.
::siteurl::
- URL of the site.
::sitename:: - Name of the site.
::sitedescription:: - Description of the site.
::coolsite:: - Coolsite HTML (if marked as coolsite).
::u1:: to ::u10:: - User fields allowing you to display extra information.
::modify:: - Where modify site link will appear if in modify site view.
If you do not
intend to mark some sites as "Cool sites" then remove ::coolsite::.
Remove any extra user fields you are not using. If you are not allowing users
to modify their listings then remove ::modify::. The ::modify:: link is only
displayed when the modify site link has been clicked.
CATEGORYT.TPL
This is the
template file for the category topsite display. This template is repeated into
the category page for each topsite.
::siteurl::
- URL of the site.
::sitename:: - Name of the site.
::sitedescription:: - Description of the site.
::coolsite:: - Coolsite HTML (if marked as coolsite).
::u1:: to ::u10:: - User fields allowing you to display extra information.
If you are
not going to use topsites then you can ignore this file. If you do not intend
to mark some sites as "Cool sites" then remove ::coolsite::. Remove
any extra user fields you are not using. There is no modify link as only the
admin can modify topsites. Topsites are displayed above normal sites, you may
wish to have them displayed slightly differently so that they stand out.
CATEGORYC.TPL
This is the
template file for the category sub-category display. This template is repeated
into the category page for each sub-category.
::catname::
- Name of the sub-category.
::caturl:: - URL of the sub-category.
::catdescription:: - Description of the sub-category.
Adjust this
file so that is matches your site's style.
SEARCHRESULTSP.TPL
This is the
template file for the search results page. When a search is run the results
are parsed into this page and displayed.
::terms:: -
Search terms.
::Banner:: - Keyword specific banner advert.
::resultshere:: - Three of these should be in your page, the first is where
the category results will appear, second where the top site listings will appear,
third where the standard results will appear.
::nextresults:: - This will be swapped for the next page of results link if
the search generates more matches than your set maximum to display.
Remove ::banner::
is you are not going to be offering keyword specific advertising.
SEARCHRESULTSB.TPL
This is the
template file for the keyword specific banner display. There are also extra
user fields if you want to use them.
::bannerurl::
- URL to the banner image.
::siteurl:: - URL to the advertising site.
::sitedescription:: - Advertising site description.
::u1:: to ::u10:: - User variables allowing you to display extra information.
If you are
not going to have keyword banner advertising then you can ignore this file.
If you are then adjust this file to match your needs, removing extra user fields,
etc.
SEARCHRESULTSS.TPL
This is the
template file for the search results site display. This template is repeated
into the search results page for each site.
::siteurl::
- URL of the site.
::sitename:: - Name of the site.
::sitedescription:: - Description of the site.
::sitenumber:: - Sites rank.
::sitematch:: - Sites score.
::caturl:: - URL to the sites category.
::catname:: - Full name of the sites category.
::catnameshort:: - Category name without parent category.
::catnameshort2:: - Category parent category.
::coolsite:: - Coolsite HTML (if marked as coolsite).
::u1:: to ::u10:: - User fields allowing you to display extra information.
If you do not
intend to mark some sites as "Cool sites" then remove ::coolsite::.
Remove any extra user fields you are not using. You may wish to display the
sites relevancy score, if you are using the topsites feature then this may look
irregular. You may also choose to display the category the site is in.
SEARCHRESULTST.TPL
This is the
template file for the search results topsite display. This template is repeated
into the search results page for each topsite.
::siteurl::
- URL of the site.
::sitename:: - Name of the site.
::sitedescription:: - Description of the site.
::sitenumber:: - Sites rank.
::sitematch:: - Sites score.
::caturl:: - URL to the sites category.
::catname:: - Full name of the sites category.
::catnameshort:: - Category name without parent category.
::catnameshort2:: - Category parent category.
::coolsite:: - Coolsite HTML (if marked as coolsite).
::u1:: to ::u10:: - User fields allowing you to display extra information.
If you are
not going to use topsites then you can ignore this file. If you do not intend
to mark some sites as "Cool sites" then remove ::coolsite::. Remove
any extra user fields you are not using. You may wish to display the sites relevancy
score, if you are using the topsites feature then this may look irregular. You
may also choose to display the category the site is in. Topsites are displayed
above normal sites, you may wish to have them displayed slightly differently
so that they stand out.
SEARCHRESULTSC.TPL
This is the
template file for the search results category display. This template is repeated
into the search results page for each category.
::catname::
- Name of the category.
::catnameshort:: - Category name without parent category.
::catnameshort2:: - Category parent category.
::catnumber:: - Category ranking.
::caturl:: - URL of the category.
::catdescription:: - Description of the category.
::catmatch:: - Category score.
Adjust this
file so that it matches your site.
MODIFYPASS.TPL
This is the
template file for the modify your site password check page. This template contains
a form where the user inputs their password.
::category::
- Sites category.
::site:: - Site name.
If you are
not going to allow users to modify their site then you can ignore this file.
The symbols are used for hidden form fields which must NOT be removed.
MODIFYPAGE.TPL
This is the
template file for the modify your site page. This template contains a form similar
to that of addsite.tpl, allowing the user to make changes to their site listing.
::siteurl::
- Site URL.
::sitename:: - Site name.
::sitedescription:: - Site description.
::u1:: to ::u10:: - User variables 1 to 10.
::email:: - Site email.
::password:: - Site password.
::cool:: - 1 for coolsite 0 otherwise.
::affiltrade:: - Site marked at affiltrade.
::category:: - Sites category.
::site:: - Sites original name.
If you are
not going to allow users to modify their site then you can ignore this file.
Some of the symbols are used for hidden form fields which must NOT be removed.
When editing this page only remove the extra user fields which do not apply,
and check the form action is pointing to your server.
 
Your template
files should now be ready to be uploaded to your server, replacing the default
templates uploaded in the installation.