corner black line corner
black line
the Hazel Logo Hazel Enterprise: The Internet Merchandising System The Netsville Logo
start red bar Home News Info Features Examples Purchase Support Contact Us end red bar
Documentation: Templates

Hazel uses "templates" to communicate with the shopper. You may edit these templates to further customize your catalog. They're all located within the templates subdirectory of your catalog support root.

In versions of Hazel prior to 3.0, some of the templates below had names prefixed with "hazel_". That superfluous prefix has been eliminated in the latest distribution, but the templates serve the same purpose.

view.html (the view template)

The view template is shown as a result of a VIEW action, or a non-quiet, non-frames ADD. Its purpose is to show all items selected and present options for returning to the catalog or checking out.

empty.html (the empty template)

The empty template is shown when a shopper attempts to enter the checkout process without having selected anything.

minorder.html (the minimum order template)

If you've a MINIMUM_ORDER field set to a dollar value in your hazel.config file, and the shopper attempts to enter the checkout process with an order total less than that amount, this template is displayed, preventing further progress.

checkout.html (the checkout template)

The checkout template is shown as a result of the CHECKOUT action. It is usually the first screen to ask for billing and shipping information. Depending on what payment method is specified, one of the templates in the payment subdirectory is displayed next for confirmation of data entered.

detail.html (the detail template)

The detail template is used to show product information for a given SKUID via the DETAIL action. The whole file acts as if it was wrapped in a products loop with one SKUID.

error.html (the error template)

The error template is presented when a shopper enters bad or incomplete information, or when Hazel can't find, read, or write one of her support files. %HZM_MESSAGE within this template is replaced by Hazel's gripe.

message.html (the message template)

The message template is presented when Hazel needs to tell the shopper something without scaring them off with the connotations of the error template. %HZM_MESSAGE within this template is replaced by Hazel's love note.

receipt.html (the receipt template)

The receipt template is served when the order is finished. The default template includes a link back to %HZM_STORE_HOMEPAGE.

frameset.html (the frameset template)

The frameset template is served when the user intitiates a RETURN_FRAMES action. It should contain at least an HZ_MAIN frame into which Hazel will serve her catalog pages, and a view frame to display selected items.

view_frame.html (the view frame)

The view frame is updated when an item is added in frames mode. It is typically a compact version of the full view template.

order_format.txt (the order format template)
store_invoice.txt (the store invoice)
shopper_invoice.txt (the shopper invoice)

These three templates define order recording and notification. Note they are .txt files, not .html. All Hazel tags and tokens will be recognized in these templates, but you can't guarantee the recipient's mail reader will render HTML.

order_format.txt is the format of text logged to your orders file, if activated.

store_invoice.txt is the format of mail sent to ORDER_RECIPIENTS.

If the MAIL_SHOPPER flag is set true and the shopper has entered an eMail address, shopper_invoice.txt will be mailed to that address.

%HZM_PAYMENT_INFO (previously %HZM_CREDIT_INFO) is used in these text templates to describe the method of payment. It is not included in the order format or shopper invoice template by default, but you may add it if you feel comfortable with the credit information being saved to disk or mailed outside your domain.

Payment Templates

The following templates are used dependent on which payment method the shopper has specified via the checkout template. Each serves the purpose of confirming billing and shipping data (a double-check before finally submitting the order) and collecting credit information (or redirecting to a program which will). They are located within the payment subdirectory.

payment/standard.html (the standard payment template)

This template handles a STANDARD web payment transaction, providing form fields for credit information. If you're going to allow entry of credit info through your catalog, you should be using a secure server, or make it clear to the shopper that their data will be sent unencrypted.

payment/printout.html (the printout template)

Served from the PRINTOUT payment method, this template presents order information in a format suitable for printing or faxing. It's essentially the same as the standard payment template, but without the form submit button. It's a nice option for those still skeptical about transmitting personal information online.

There is a space at the bottom of the template to enter your store's address and fax number. Be sure to add them before going online.

payment/callme.html (the call-me template)

Served from the CALLME payment method, this template contains no fields for credit information. The shopkeeper is expected to call the customer for payment details when the order is received.

payment/cod.html (the COD template)

Served from the COD payment method. You should give the shopper an idea how long the shipment will take, whether you take cash or checks, and so on. The COD charge is handled in your surcharge.rules file, and displayed as both an order note and as a line item included with the %HZT_SURCHARGE.

Search Templates

These templates are used with the optional Hazel search engine to describe the results of a query. They are located within the search subdirectory.

search/failed.html (the failed search template)

Shown when a search query returned no matches.

search/matches.html (the search matches template)

This template is used for each page of matches resulting from a successful Hazel search query. It uses the matches loop to print a list of matching products with any kind of information on each.

Getting Started HZML Rules Extras Advanced Reference
Products File
Order Reporting
Known Problems
HZML Tokens
HZML Loops
Sales Tax
Input Fields
Search Engine
Optioned Products
Design Tips
Payment Methods
Regular Expressions
Perl API
HTML Basics
CGI and You

Hazel Home - Help Contents - Searchable Knowledge Base - Live Technical Support

black line
corner black line corner