Enthusiast 3 - Templates
-----------------------------
Copyright (c) Angela Sabas
http://scripts.indisguise.org
=============================
Enthusiast 3 is fully customizable collective and listing script rolled into
one. It's customizable because it uses templates that the admin/user can edit
to their heart's content.
This text file lists each template variable for each template used in Enth3.
Affiliates Add Email Template
-----------------------------
This is the only installation-wide email template that you cannot delete. You
can edit the template by going to email.php. The template variables used for
this email template (subject and email body) are below:
. $$site_url$$ - URL of your site; this can either be the collective's
url or the url of the listing, depending on which
you are adding the affiliate
. $$site_title$$ - title of your site; this can either be the collective's
title or the title of the listing, depending on which
your are adding the affiliate
. $$site_owner$$ - your name registered on Enthusiast 3
. $$site_email$$ - your email; this can either be the email for your
collective (if adding to a collective) or the email
registered under the listing you're adding the
affiliate to
. $$site_aff_url$$ - url of the affiliate's site
. $$site_aff_title$$ - title of the affiliate's site
Affiliates Template (Collective)
--------------------------------
This is for showing affiliates for the collective. This will loop over for each
affiliate recorded in Enthusiast 3. There are three parts to this template:
a header template, a footer template, and the actual main template. The header
and footer templates are useful if you plan on using a table or an HTML list
(i.e., the OL or UL tags); you would then place the opening
or
or tag in the header and the closing
or or tag
in the footer. Otherwise, you can just leave both header and footer blank.
These can be changed by going to affiliates.php?action=template
. enth3-url - URL of the affiliate's site
. enth3-title - title of the affiliate's site
. enth3-image - image path of the image for the affiliate's site (if present)
. enth3-width - width of the affiliate image (if present)
. enth3-height - height of the affiliate image (if preset)
General Email Templates
-----------------------
For general email templates that you can add/edit/delete using emails.php, the
only email template variables that can be used here are template variables for
listings, and they will only work if you send it to a member or members or
affiliates of a listing.
. $$fanlisting_title$$ - title of the listing site
. $$fanlisting_url$$ - URL of the listing site
. $$fanlisting_subject$$ - subject of the listing site
. $$fanlisting_owner$$ - your name registered on Enth3
. $$fanlisting_email$$ - your email address listed under the listing
. $$fanlisting_update$$ - the URL of the update form (i.e., update.php)
. $$fanlisting_join$$ - the URL of the join form (i.e., join.php)
. $$fanlisting_list$$ - the URL of the members list (i.e., list.php)
. $$fanlisting_lostpass$$ - the URL of the lost password form (i.e.,
lostpass.php)
. $$listing_type$$ - listing type (i.e., fanlisting, hatelisting, etc)
. $$fan_email$$ - email address of the fan being emailed
. $$fan_name$$ - name of the fan being emailed
. $$fan_country$$ - country of the fan being emailed
. $$fan_url$$ - URL of the fan being emailed
. $$fan_FIELD$$ - additional field value of the fan being emailed;
for use in templates, replace "FIELD" with the
fieldname; i.e., if you have an additional field
named 'character', you would put in the template
'$$fan_character$$'
. $$aff_email$$ - email address of the affiliate being emailed
. $$aff_id$$ - affiliate ID of the affiliate being emailed
. $$aff_url$$ - URL of the affiliate's site being emailed
. $$aff_title$$ - title of the affiliate's site being emailed
Joined Listings Template
------------------------
The joined listings template determine how your joined listings will show up
under the drop-down menu. It is set up the same with with the collective
affiliates templates -- there are three parts, the header, footer, and main
template. The header and footer templates are useful if you plan on using a
table or an HTML list (i.e., the OL or UL tags); you would then place the
opening or or tag in the header and the closing
or
or tag in the footer. Otherwise, you can just leave both header
and footer blank. These can be changed by going to joined.php?action=template
. enth3-url - url of the joined listing
. enth3-subject - subject of the joined listing
. enth3-desc - description of the joined listing
. enth3-image - image for the joined listing
. enth3-width - width of the image for the joined listing
. enth3-height - height of the image for the joined listing
Owned Listings Template
-----------------------
The owned listings template determine how your owned listings will show up
under the drop-down menu. It is set up the same with with the collective
affiliates and joined listings templates -- there are three parts, the header,
footer, and main template. The header and footer templates are useful if you
plan on using a table or an HTML list (i.e., the OL or UL tags); you would then
place the opening or or tag in the header and the closing
or or tag in the footer. Otherwise, you can just leave
both header and footer blank. These can be changed by going to
owned.php?action=template
. enth3-url - url of the listing
. enth3-subject - subject of the listing
. enth3-title - title of the listing
. enth3-desc - description of the listing
. enth3-image - image for the listing
. enth3-width - width of the image for the listing
. enth3-height - height of the image for the listing
. enth3-cat - category of the listing
. enth3-listingtype - listing type
. enth3-opened - opened date of the listing
. enth3-updated - last updated date of the listing
. enth3-pending - number of pending members for the listing
. enth3-approved - number of approved members for the listing
Members List Template
---------------------
This is the template for the members list. This can be edited by going to the
Edit page of the fanlisting you want to edit the list template of, and clicking
on "Templates".
. $$fan_name$$ - the name of the member
. $$fan_country$$ - the country of the member
. $$fan_email$$ - the email address of the member; this will show the
actual email address on the page, spam-protected
with javascript
. $$fan_email_plain$$ - the email address of the member; this will show
"user {at} domain.tld" without the quotes; this can
be used to manual mailto: links
. $$fan_email_generic$$ - the email address of the member; this will show a
mailto link spam-protected with javascript but use
'email' as the link text (without the quotes)
. $$fan_url$$ - the url of the member; this will show the actual
url on the page (http://domain.tld) and link to the
url
. $$fan_url_plain$$ - the url of the member; this will just print out
the url (useful for putting in the HREF attribute of
the A tag)
. $$fan_url_generic$$ - the url of the member; this will show "website" on
the page and link to the url
. $$fan_FIELD$$ - additional field value of the member;
for use in templates, replace "FIELD" with the
fieldname; i.e., if you have an additional field
named 'character', you would put in the template
'$$fan_character$$'
Affiliate Template (Listing)
----------------------------
This is the template for the affiliates list. This can be edited by going to
the Edit page of the fanlisting you want to edit the list template of, and
clicking on "Templates".
. $$aff_url$$ - URL of the affiliate's site
. $$aff_title$$ - title of the affiliate's site
. $$aff_image$$ - image for the affiliate's site
. $$aff_width$$ - width of the image for the affiliate's site
. $$aff_height$$ - height of the image for the affiliate's site
Listing Statistics Template
---------------------------
This is for your listing statistics.
. $$stat_updated$$ - last updated date
. $$stat_approved$$ - number of approved members
. $$stat_pending$$ - number of pending members
. $$stat_newmembers$$ - the newly added/updated members