This text describes the user tokens for user templates. Print this page.

User templates are sets of HTML allowing users to have their content displayed in any number of ways as articulated by the hosting institution. For example, an institution can create a user template that is very simple and devoid of graphics making it easily readable by page reading machines. On the other hand, templates can be created that are graphically rich and portray the institution's identity. Furthermore, given enough user templates to choose from, this option also allows users to define, to some extent, how they want their content arranged.

Like the "free templates", user templates contain HTML tag plus tokens, listed below. Tokens are variables representing content from the underlying database. They are case-sensitive and must be surrounded by pairs of percent signs (%%) in order for them to be reconized by the system.

For example, if you wanted your template only to display the system's banner, the user's custom title, their list of customized "Reference Shelf" items, and a link allowing them to change their selections, then your template my look something like this:

<.head>
<.title>%%title%%<./title>
<./head>

%%banner%%
<.h1>%%referenceShelf%%<./h1>
<.p>Listed here are your customized selections.
Change them here.<./p>
%%listReferenceShelf%%

Remember, you don't have to supply any closing HTML because that is done by way of the system's footer.

Be forewarned. This system is not a text editor; it's a database. Create your templates outside this system, import them here, and do only minor tweaks in the system itself.

Here is a list of all the "user tokens" and their definitions:

patronFirst
The user's first name

title
The title as defined in the global preferences
bgcolor
The background color as defined by the user's layout preferences
link
The link color as defined by the user's layout preferences
alink
The active link color as defined by the user's layout preferences
vlink
The visited link color as defined by the user's layout preferences
text
The text color as defined by the user's layout preferences
bannerColor
The banner color as defined by the user's layout preferences

banner
The contents of the banner
motd
The contents of the global message of the day
messageFromLibrarian
The name of the "Message From the Librarian" section as defined in the global preferences
aboutMessageFromLibrarian
A relative URL pointing to the Simple Help Text allowing users to customize their profile (ID #42)
disciplineMotd
The content of the user's discipline-specific "Message From the Librarian"

aboutMyLibrary
A relative URL pointing to the Simple Help Text describing this system (ID #39)
customizeProfile
A relative URL pointing to the Simple Help Text allowing users to customize their pofile (ID #43)
logout
A relative URL allowing patrons to log out

yourLibrarians
The name of the "Your Librarians" section as defined in the global preferences
aboutLibrarians
A relative URL pointing to the Simple Help Text describing the librarians (ID #36)
librarians
A concationation of the various librarian blurbs as defined in the global preferences as well as a list of the librarians associated with the user's discipline

libraryLinks
The name of the "Library Links" section as defined in the global preferences
aboutLibraryLinks
A relative URL pointing to the Simple Help Text describing the "Library Links" (ID #38)
customizeLibraryLinks
A relative URL pointing to a form allowing users to customize the "Library Links"
listLibraryLinks
An HTML ordered list of all "Library Links" associated with the user.

universityLinks
The name of the "Community Links" section as defined in the global preferences
aboutUniversityLinks
A relative URL pointing to the Simple Help Text describing the "Community Links" (ID #37)
customizeUniversityLinks
A relative URL pointing to a form allowing users to customize the "Community Links"
listUniversityLinks
An HTML ordered list of all "Community Links" associated with the user.

currentAwareness
The name of the "New Bookshelf" section as defined in the global preferences
aboutCurrentAwareness
A relative URL pointing to the Simple Help Text describing the "New Bookshelf" (ID #45)
customizeCurrentAwareness
A relative URL pointing to a form allowing users to customize the "New Bookshelf"
formCurrentAwareness
An HTML form allowing the user to search the content of the "New Bookshelf"

personalLinks
The name of the "Personal Links" section as defined in the global preferences
aboutPersonalLinks
A relative URL pointing to the Simple Help Text describing the "Personal Links" (ID #31)
customizePersonalLinks
A relative URL pointing to a form allowing users to customize the "Personal Links"
listPersonalLinks
An HTML ordered list of all the user's "Personal Links"

quickSearches
The name of the "Quick Searches" section as defined in the global preferences
aboutQuickSearches
A relative URL pointing to the Simple Help Text describing the "Quick Searches" (ID #32)
customizeQuickSearches
A relative URL pointing to a form allowing users to customize the "Quick Searches"
formQuickSearches
An HTML form allowing users to use the "Quick Searches" associated with the user

referenceShelf
The name of the "Reference Shelf Links" section as defined in the global preferences
aboutReferenceShelf
A relative URL pointing to the Simple Help Text describing the "Reference Shelf Links" (ID #33)
customizeReferenceShelf
A relative URL pointing to a form allowing users to customize the "Reference Shelf Links"
listReferenceShelf
An HTML ordered list of all "Reference Shelf Links" associated with the user

databaseLinks
The name of the "Database Links" section as defined in the global preferences
aboutDatabaseLinks
A relative URL pointing to the Simple Help Text describing the "Database Links" (ID #34)
customizeDatabaseLinks
A relative URL pointing to a form allowing users to customize the "Database Links"
listDatabaseLinks
An HTML ordered list of all "Database Links" associated with the user

journalLinks
The name of the "Etext Links" section as defined in the global preferences
aboutJournalLinks
A relative URL pointing to the Simple Help Text describing the "Etext Links" (ID #35)
customizeJournalLinks
A relative URL pointing to a form allowing users to customize the "Etext Links"
listJournalLinks
An HTML ordered list of all "Etext Links" associated with the user

# fill up the token list
%tokens = (
			css                       => $gStyleSheet,
			title                     => $gPage_title,
			bgcolor                   => $backgroundColor->{color_code},
			link                      => $linkColor->{color_code},
			alink                     => $alinkColor->{color_code},
			vlink                     => $vlinkColor->{color_code},
			text                      => $textColor->{color_code},
			bannerColor               => $bannerColor->{color_code},
			banner                    => $gBanner,
			footer                    => $gFooter,
			motd                      => $gGlobalMessage,
			aboutMyLibrary            => './?cmd=about&id=39',
			customizeProfile          => './?cmd=about&id=43',
			logout                    => './?cmd=killCookie',

			yourLibrarians            => $gYourLibrarians,
			aboutLibrarians           => './?cmd=about&id=36',
			librarians                => $gGenericBlurb,

			libraryLinks              => $gLibraryLinks,
			aboutLibraryLinks         => './?cmd=about&id=38',
			customizeLibraryLinks     => './?cmd=customizeLibraries',
			listLibraryLinks          => $listLibraryLinks,

			universityLinks           => $gUniversityLinks,
			aboutUniversityLinks      => './?cmd=about&id=37',
			customizeUniversityLinks  => './?cmd=customizeUniversity',
			listUniversityLinks       => $listUniversityLinks,
			
			currentAwareness          => $gCurrentAwarenessManager,
			aboutCurrentAwareness     => './?cmd=about&id=45',
			customizeCurrentAwareness => './?cmd=customizeCAMProfile',
			formCurrentAwareness      => $formCurrentAwareness,
			
			personalLinks             => $gPersonalLinks,
			aboutPersonalLinks        => './?cmd=about&id=31',
			customizePersonalLinks    => './?cmd=customizePersonalLinks',
			listPersonalLinks         => $listPersonalLinks,
			
			quickSearches             => $gQuickSearches,
			aboutQuickSearches        => './?cmd=about&id=32',
			customizeQuickSearches    => './?cmd=customizeQSearches',
			formQuickSearches         => $formQuickSearches,
			
			referenceShelf            => $gReferenceShelf,
			aboutReferenceShelf       => './?cmd=about&id=33',
			customizeReferenceShelf   => './?cmd=customizeReference',
			listReferenceShelf        => $listReferenceShelf,
			
			databaseLinks             => $gBibliographicDatabaseLinks,
			aboutDatabaseLinks        => './?cmd=about&id=34',
			customizeDatabaseLinks    => './?cmd=customizeDatabases',
			listDatabaseLinks         => $listDatabaseLinks,
			
			journalLinks              => $gElectronicJournals,
			aboutJournalLinks         => './?cmd=about&id=35',
			customizeJournalLinks     => './?cmd=customizeJournals',
			listJournalLinks          => $listJournalLinks,

			todaysDate		  => $gtodaysDate
			
);