Template types

There are 6 different types of templates, which can be distinguished by the prefix of their file name. The maximum length of a template file name must not exceed 128 characters.

The template names listed here correspond to the initial delivery state of a WEBSALE shop. The names may vary depending on your individual configuration.The lists are not exhaustive, as further templates are required depending on the feature scope of your shop.

The following sections introduce the six types one after the other.

Shop templates

Shop templates are marked in the template directory with the prefix “ws_”. These templates contain shop functions — for example the shopping cart, login, or the selection of payment and shipping methods — as well as product information that is displayed using tags and brackets (dynamic content). They are defined in the shop configuration shop.config in the <Templates> section so that the shop can call them up in the corresponding areas.

Template	Parameter	Description
ws_address_combined.htm	CombinedAddress	Template for requesting the billing and delivery address on one template. Reference: Requesting billing and multiple delivery addresses
ws_address_manage.htm	AddressManage	Template for managing the billing address in the customer account. Reference: Requesting billing and multiple delivery addresses
ws_bank_manage.htm	BankManage	Template for managing bank details. Reference: Direct debit — requesting bank details
ws_basket.htm	Basket	Template for the shopping cart page. Reference: Displaying the shopping cart
ws_basket_ajax_error.htm	BasketAjaxError	Template for the error message: adding a product to the cart via AJAX. Reference: Adding a product to the cart via AJAX
ws_basket_ajax_success.htm	BasketAjaxSuccess	Template for the success message: adding products to the cart via AJAX. Reference: Adding a product to the cart via AJAX
ws_category.htm	Category	Template for the category page. Reference: Displaying the currently selected category
ws_confirm.htm	Confirm	Template for the confirmation page after placing an order
ws_connected_externaccounts.htm	ConnectedExternAccountsOverview	Template for connected external accounts. Reference: External login with Facebook
ws_creditcard_manage.htm	CreditCardManage	Template for selecting or deleting stored credit card data. Reference: Payment method “credit card”
ws_deliv_address_manage.htm	DelivAddressManage	Template for managing delivery addresses in the customer account. Reference: Requesting billing and multiple delivery addresses
ws_direct_order.htm	DirectOrder	Template for direct ordering. Reference: Direct ordering/ordering from catalogs
ws_login.htm	Login	Template file for signing in to the shop. Guide: Secure sign-in process
ws_login_start.htm	LoginStart	Name of the template file for signing in at shop start for closed shops. Guide: Secure sign-in process
ws_logout.htm	Logout	Name of the template file for logout. Guide: Logout
ws_memolist.htm	MemoList	Template for the wish list. Reference: Displaying the wish list
ws_notify.htm	Notify	Template for the notice page displaying important messages
ws_order_history.htm	OrderHistory	Template for displaying the order history. Reference: Integrating the order history
ws_pay_deliv.htm	PayDeliv	Template for entering payment/shipping method. Reference: Payment/shipping method combinations
ws_place_order.htm	PlaceOrder	Template for displaying the order overview. Reference: Accepting terms and conditions
ws_product.htm	Product	Template for the product detail view. Reference: Displaying the selected product
ws_product_recmd.htm	ProductRecmd	Template for the product recommendation. Reference: Product recommendation function via AJAX
ws_product_recmd_confirm.htm	ProductRecmdConfirm	Template for the confirmation page “Recommend product”. Reference: Product recommendation function via AJAX
ws_search.htm	Search	Template for displaying the search results and entering the advanced search criteria. Reference: ws_search.htm
ws_start.htm	Start	Start page of the shop
ws_subshop_access_denied.htm	SubShopAccessDenied	This template is displayed when the buyer does not have permission for this subshop. Reference: Subshop access permissions
ws_user_account.htm	UserAccount	Name of the template file for the customer account

Information templates

Information templates are, for example, the “static” pages such as terms and conditions, privacy policy, “About us”, and help. You can find detailed information on information pages under Creating information pages. The information templates listed below are already included in the initial delivery state and can quickly be tailored to your own wishes. In addition, you can create any number of new information templates that are populated with content using text maintenance. In the template directory, these templates are marked with the prefix “tpl_”. Information templates are not managed in the shop configuration shop.config. They are always linked via ~WS-LoadTpl()~ or ~WS-SSLLoadTpl()~. It doesn’t matter which of the two tags is used.

Template	Description
tpl_agb.htm	Terms and conditions
tpl_datenschutz.htm	Privacy notice
tpl_frage_zum_produkt.htm	Question about the product
tpl_impressum.htm	Legal notice
tpl_kontakt.htm	Contact option
tpl_versandkosten.htm	Information about shipping costs
tpl_widerruf.htm	Information about the right of withdrawal
tpl_zahlungsarten.htm	Information about payment methods

Include templates

In the initial delivery state of the shop, include templates are located in the directory “benutzer/templates/translation” and are marked with the prefix “incl_”. These are templates that are not displayed in their entirety on shop pages. Only their contents, or parts of them, are integrated into existing pages or other templates. For general information on the include concept of WEBSALE V8s, see Reuse: includes.

Template
incl_ajax_submenu.htm
incl_emarketing_manager.htm
incl_emarketing_manager_onlineview.htm
incl_fast_includes.htm
incl_prodrating_changenickname.htm
incl_prodrating_confirm.htm
incl_prodrating_edit.htm
incl_prodrating_list.htm
incl_prodrating_mailvalidation.htm
incl_product_seo.htm

INQUIRY templates

In the template directory, INQUIRY templates are marked with the prefix “inquiry_”. With INQUIRY templates you can generate both forms and the incoming notifications for the customer (in the shop or by email) and the transmission of the data to the shop operator. The templates belong to the “INQUIRY4” module and are assigned separately in the INQUIRY configuration files.

Template	Description
inquiry_frage_zum_produkt.htm	Form for “Question about the product”
inquiry_frage_zum_produkt_antwort.htm	Success message for a submitted “Question about the product”
inquiry_frage_zum_produkt_confirmemail.htm	Confirmation email to the customer
inquiry_frage_zum_produkt_inquiryemail.htm	Email of the “Question about the product” to the merchant
inquiry_kontakt.htm	Contact form
inquiry_kontakt_antwort.htm	Success message for a submitted contact request
inquiry_kontakt_confirmemail.htm	Confirmation email to the customer
inquiry_kontakt_inquiryemail.htm	Email of the contact request to the merchant
inquiry_widerruf.htm	Form for the withdrawal
inquiry_widerruf_antwort.htm	Success message for a submitted withdrawal form
inquiry_widerruf_confirmemail.htm	Confirmation email to the customer
inquiry_widerruf_inquiryemail.htm	Email of the withdrawal to the merchant

For more information, see Forms for customer inquiries.

Email templates

In the template directory, email templates are marked with the prefix “mail_”. Dedicated HTML templates are used for all emails that the shop uses (for example the order acknowledgement or a password change). These must be assigned in the respective email sections in the shop configuration shop.config.

Template	Description
mail_change_mail_double_opt_in.htm	Change email address via double opt-in. Reference: ChangeEmailDoubleOptInMail
mail_customer_order.htm	Order acknowledgement email. Reference: CustomerMail
mail_delete_account_double_opt_in.htm	Delete customer account via double opt-in. Reference: DeleteAccountDoubleOptInMail
mail_newcustomer_double_opt_in.htm	New customer registration via double opt-in. Reference: NewCustomerDoubleOptInMail
mail_product_recmd.htm	Email “Recommend product”. Reference: ProdRecmdMail
mail_set_password.htm	Email “Forgot password”/“Set new password”. Reference: SetPasswordMail

Structure of email templates

For correct output, CSS properties must be defined as inline styles, since some email clients do not support external stylesheets.

PDF templates

In the template directory, PDF templates are marked with the prefix “pdf_”. PDF files, such as order confirmations or SEPA mandate documents, are generated with these templates.

Template	Description
pdf_confirm.htm	Order acknowledgement. Guide: PDF attachment of the order acknowledgement
pdf_sepa_company.htm	Company direct debit. Materials: pdf_sepa_company.htm
pdf_sepa_customer.htm	Basic direct debit. Materials: pdf_sepa_customer.htm
pdf_product.htm	Printing the product detail page. Guide: PDF display of the product detail view

Structure of PDF templates

To design print layouts, appropriate CSS properties can be used in the template. The following example forces a page break:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
   <title>Meine Firma - Druckansicht Ihrer Bestellung</title>
   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   <base href="~URL-Template~">
</head>
<body>
   ...
   <div style="page-break-after:always;"></div>
   ...
</body>
</html>

WEBSALE V8s

Basics

Troubleshooting

Shop templates

Information templates

Include templates

INQUIRY templates

Email templates

Structure of email templates

PDF templates

Structure of PDF templates

​Shop templates

​Information templates

​Include templates

​INQUIRY templates

​Email templates

​Structure of email templates

​PDF templates

​Structure of PDF templates

Shop templates

Information templates

Include templates

INQUIRY templates

Email templates

Structure of email templates

PDF templates

Structure of PDF templates