Tokens Reference in Primary HTML Templates

[2020Execute_filename.asp]

Output: This token can be used to produce custom output. The token activates the Inject_ExecuteFile() function.

How to Use: This token instructs 20/20 DataShed to execute a local ASP file via the Server.Execute() method. This functionality is similar to using a (SSI) server-side include ASP file. For example, instead of creating a file called "menu.inc" (which may be a server-side include file containing an HTML menu), one could create "menu.asp", the contents of which would be written to the web page by this token: [2020Execute_menu.asp]

The server.execute() method has two characteristics that we will mention here:

All current HTTP header information (such as the querystring) is passed to the ASP file being executed. This means that the "menu.asp" in our example can react to querystring values passed by the "parent" script.
The file path to the ASP script being executed is relative to the parent folder of the application. Please study the following examples:
Correct: [2020Execute_menu.asp] (Will execute menu.asp in the 'current' folder.)
Correct: [2020Execute_/menu.asp] (Will execute menu.asp in the 'parent' folder.)
Correct: [2020Execute_/foldername/menu.asp] (Will execute menu.asp in the 'foldername' folder under the 'parent' folder.)
NOT Correct: [2020Execute_../menu.asp] (Written perhaps to execute menu.asp in an up-level folder, but will fail.)

Applies To: all scripts which incorporate the "template.html" or "admin_template.html" files.

[2020Inject_AccountMenuOptions]

Output: This token activates the WriteAccountMenuOptions() subroutine which contains links to the following interfaces: Edit Contact Info, Change Password (Depending on the active permissions of the current user).

How to Use: This token should be used in your template where you would like to inject the menu containing links to the interfaces listed above.

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will cause a runtime error in other templates.

[2020Inject_AdminMenuOptions]

Output: This token activates the WriteAdminMenuOptions() subroutine which contains links to the following interfaces: Add [User], Add Listing, Admin Email, Manage Categories, View [User_plural], Authorize New [User_plural], New Listings, View Listings, SQL Reports (Depending on the active permissions of the current user).

How to Use: This token should be used in your template where you would like to inject the menu containing links to the interfaces listed above.

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will cause a runtime error in other templates.

[2020Inject_AdminPageURL]

Output: This token outputs a relative URL pointing to the main administrative home page: i.e. admin.asp

How to Use: This token should be used in your administrative template where you would like to provide your users with a link to the administrative home page. For example, <a href="[2020Inject_AdminPageURL]">Click here to go back to the Admin Homepage.</a>

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will produce an inaccurate relative URL if used in any other template.

[2020Inject_2020Application_AdminBody]

Output: This token activates the ProcessAdminPage() subroutine.

How to Use: This token should be used in your administrative templates where you would like to inject the main administrative interfaces (i.e. the "View Listings", "Change Password", and all other 'main' interfaces).

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will cause a runtime error in other templates.

[2020Inject_2020Applications_Body]

Output: This token activates the WriteLoginForm(), WriteNewUserRegistration(), WriteListingsModules(), or WriteSearchModules() subroutines depending on the calling script and the current data available in the HTTP header of the HTTP request.

How to Use: This token should be used in your template where you would like to inject the database contents (i.e. the main search form, search results, login form, registration form, and all related pages/views/summaries/etc.)

Applies To: This token applies to login.asp, newuser.asp, and listings.asp (i.e. the "template.html" file) and has no effect in other templates.

[2020Inject_2020ApplicationsToolsOptions]

Output: This token activates the WriteApplicationToolsOptions() subroutine which contains links to the following interfaces: Admin Homepage, Company Info, About [thisAppTitle], [thisAppTitle] Options, Database Utilities (Depending upon the active permissions of the current user).

How to Use: This token should be used in your template where you would like to inject the menu containing links to the interfaces listed above.

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will cause a runtime error in other templates.

[2020Inject_ContextMenuOptions]

Output: This token activates the WriteContextMenuOptions() subroutine which contains links to relevant tools or activites related to the current page.

How to Use: This token should be used in your template where you would like to inject the menu containing links to the interfaces listed above.

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will cause a runtime error in other templates.

[2020Inject_LogOutURL]

Output: This token outputs a relative URL pointing to the "log out" script: i.e. ../login.asp?action=logout

How to Use: This token should be used in your administrative template where you would like to provide your users with a link to "Log Out" of the administrative area. For example, <a href="[2020Inject_LogOutURL]">Click here to log out.</a>

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will produce an inaccurate relative URL if used in any other template.

[2020Inject_QuickFindForm]

Output: This token activates the WriteQuickFindForm() subroutine.

How to Use: This subroutine has not yet been implemented and currently has no effect. In next versions, this subroutine may produce a compact search interface by which to quickly locate data regarding users, items, administrative settings, etc.

Applies To: This token applies to admin.asp (i.e. the "admin_template.html" file) and will cause a runtime error in other templates.

[2020Inject_ThisAppTitle]

Output: This token outputs the friendly title of the application.

How to Use: This token can be used in your HTML template where you would like to print the application title. For example: "Welcome to [2020Inject_ThisAppTitle]" may produce "Welcome to Big Bob's Auto Sales"

Applies To: This token applies to all main templates.

[2020Inject_UserName]

Output: This token outputs the username of the current user (if the cookie value is available): i.e.: request.cookies("login_info")("username")

How to Use: This token can be used in your administrative template where you would like to print the current user's username to the page. For example: [2020Inject_UserName] is logged in.

Applies To: This token applies to all main templates (although it produces no output if the user has not yet logged in).

Tokens Reference in Primary HTML Templates

Related topics