Table Of Contents

Previous topic

Translating Content

Next topic

Satchmo Template Filters and Tags

Documentation Version:

Satchmo Templates

One of the powerful options available to all Satchmo stores is the availability of the robust Django templating language to control all of the visual elements of this store. There are over 140 templates used within Satchmo. This section of the document describes where they are and the high level overview of what they are used for. Until more details are included in this section, the best way to learn more about these templates is to browse through and review the ones you are interested in. If you have a particular view that you would like to customize and are unsure which templates are being rendered, then the django_debug_toolbar can help you out. Go ahead and install it and use it for debugging and troubleshooting your site.

It is also important that you review and understand how to setup your templates so that they are easy to modify and maintain. Please review Template Customization before modifying templates.

Templates by View

See Satchmo Views.

Templates by App

Payment

These templates control some of the payment specific display elements.

payment/templates/payment/admin/charge_remaining_confirm.html

Used in the admin to support paying any remaining balance on an order.

payment/templates/payment/_order_payment_summary.html

Used in the checkout process to show a summary of all the payments that have been applied to an order.

Payment/modules/

Templates in this directory are used to modify the behavior of the giftcertificate payment process. They are useful for understanding how to further modify the checkout process.

giftcertificate/templates/shop/checkout/giftcertificate/pay_ship.html
giftcertificate/templates/shop/checkout/giftcertificate/confirm.html
giftcertificate/templates/shop/checkout/confirm.html
giftcertificate/templates/giftcertificate/balance.html
giftcertificate/templates/giftcertificate/_order_summary.html
giftcertificate/templates/product/detail_giftcertificateproduct.html
giftcertificate/templates/plugins/order_details.html

L10n

L10n is used for localizing Satchmo.

l10n/templates/l10n/_language_selection_form.html

Displays the language selection form that can be enabled through the admin.

Satchmo_ext

Satchmo externals contains several useful applications that you may optionally enable for your store.

wishlist

wishlist/templates/wishlist/login_required.html
wishlist/templates/wishlist/plugins/product_add_buttons.html
wishlist/templates/wishlist/plugins/shop_sidebar_actions.html
wishlist/templates/wishlist/index.html

upsell

upsell/templates/upsell/plugins/product_form.html
upsell/templates/upsell/product_upsell.html

recentlist

recentlist/templates/recentlist/_recently_viewed.html
recentlist/templates/recentlist/plugins/shop_sidebar_primary.html

productratings

satchmo_ext/productratings/templates/productratings/_product_ratings.html
satchmo_ext/productratings/templates/productratings/plugins/sidebar_links.html
satchmo_ext/productratings/templates/productratings/plugins/product_footer.html
satchmo_ext/productratings/templates/productratings/product_rating_form.html
satchmo_ext/productratings/templates/productratings/_render_product_ratings.html

productfeeds

satchmo_ext/product_feeds/templates/product_feeds/plugins/admin_tools.html

newsletter

satchmo_ext/newsletter/templates/newsletter/update_form.html
satchmo_ext/newsletter/templates/newsletter/update_results.html
satchmo_ext/newsletter/templates/newsletter/unsubscribe_form.html
satchmo_ext/newsletter/templates/newsletter/ajah.html
satchmo_ext/newsletter/templates/newsletter/subscribe_form.html

brand

satchmo_ext/brand/templates/brand/view_brand.html
satchmo_ext/brand/templates/brand/index.html

Product

The product templates are used to display all aspects of products in your store. The admin templates are used to manage various portions of Satchmo’s custom admin interface.

product/templates/product/detail_configurableproduct.html
product/templates/product/category_index.html
product/templates/product/minimum_order.html
product/templates/product/cart_detail_customproduct.html
product/templates/product/detail_customproduct.html
product/templates/product/product.html
product/templates/product/best_sellers.html
product/templates/product/category.html
product/templates/product/recently_added.html
product/templates/product/some_discount_eligible.html
product/templates/product/product_discount_eligible.html
product/templates/product/cart_detail_subscriptionproduct.html
product/templates/product/sale_details.html
product/templates/product/detail_subscriptionproduct.html
product/templates/product/best_ratings.html

admin

product/templates/product/admin/inventory_form.html
product/templates/product/admin/product_export_form.html
product/templates/product/admin/variation_manager.html
product/templates/product/admin/product_import_result.html
product/templates/product/admin/variation_manager_list.html
product/templates/admin/product/productvariation/change_form.html
product/templates/admin/product/product/change_form.html
product/templates/admin/product/configurableproduct/change_form.html
product/templates/admin/product/change_form.html

Keyedcache

keyedcache/templates/keyedcache/view.html
keyedcache/templates/keyedcache/stats.html
keyedcache/templates/keyedcache/delete.html

Satchmo_Store

satchmo_store/shop/templates/404.html
satchmo_store/shop/templates/500.html
satchmo_store/shop/templates/base.html
satchmo_store/shop/templates/shop/json.html
satchmo_store/shop/templates/shop/order_tracking.html
satchmo_store/shop/templates/shop/google-analytics/receipt.html
satchmo_store/shop/templates/shop/google-analytics/signup.html
satchmo_store/shop/templates/shop/google-analytics/tracker.html
satchmo_store/shop/templates/shop/google-analytics/adwords_conversion.html
satchmo_store/shop/templates/shop/_messages.html
satchmo_store/shop/templates/shop/contact_form.html
satchmo_store/shop/templates/shop/404.html
satchmo_store/shop/templates/shop/contact_thanks.html
satchmo_store/shop/templates/shop/base.html
satchmo_store/shop/templates/shop/order_history.html
satchmo_store/shop/templates/shop/admin/_orderpayment_list.html
satchmo_store/shop/templates/shop/admin/_ordercount_list.html
satchmo_store/shop/templates/shop/admin/order_sidebar.html
satchmo_store/shop/templates/shop/admin/_customorder_management.html
satchmo_store/shop/templates/shop/_search.html
satchmo_store/shop/templates/shop/download.html
satchmo_store/shop/templates/shop/_order_details.html
satchmo_store/shop/templates/shop/email/contact_us.txt
satchmo_store/shop/templates/shop/email/order_complete.txt|html

This template is used to render the order receipt email to the customer. If html email sending is configured and there is a corresponding ”.html” file, an html formatted email will be sent to the customer.

satchmo_store/shop/templates/shop/email/order_placed_notice.txt|html

This template is used to render the store owner notification that an order has been placed. If html email sending is configured and there is a corresponding ”.html” file, an html formatted email will be sent to the store owner.

satchmo_store/shop/templates/shop/email/order_shipped.txt

Note

For all of the email templates, if there is a corresponding .html template and the admin setting “Send HTML Email” is enabled, an html formatted email will be sent to the recipient.

satchmo_store/shop/templates/shop/_order_tracking_details.html

This template can be modified to include additional information about the completed purchase. For instance, if you have a downloadable product and would like to provide a link to it when the purchase is completed, modify the template with this code:

{% if order.downloadlink_set.all %}
<h4>Download now</h4>
{% for dl_link in order.downloadlink_set.all %}
<a href="{{ dl_link.get_absolute_url }}">{{ dl_link.product_name }}</a><br/>
{% endfor %}
{% endif %}
satchmo_store/shop/templates/shop/_jquery.html

The path to jquery is included here. If you choose to host jquery somewhere else or use a different version, override this template.

satchmo_store/shop/templates/shop/_jquery_form.html

Similar to the _jquery.html template, this template holds the location of the jquery form library. Override this template to point to a new location.

satchmo_store/shop/templates/shop/multiple_product_form.html
satchmo_store/shop/templates/shop/_blackbird_logging.html
satchmo_store/shop/templates/shop/checkout/failure.html
satchmo_store/shop/templates/shop/checkout/form.html
satchmo_store/shop/templates/shop/checkout/purchaseorder/pay_ship.html
satchmo_store/shop/templates/shop/checkout/purchaseorder/confirm.html
satchmo_store/shop/templates/shop/checkout/base_confirm.html
satchmo_store/shop/templates/shop/checkout/authentication_required.html
satchmo_store/shop/templates/shop/checkout/success.html
satchmo_store/shop/templates/shop/checkout/cod/pay_ship.html
satchmo_store/shop/templates/shop/checkout/cod/confirm.html
satchmo_store/shop/templates/shop/checkout/paypal/pay_ship.html
satchmo_store/shop/templates/shop/checkout/paypal/confirm.html
satchmo_store/shop/templates/shop/checkout/protx/pay_ship.html
satchmo_store/shop/templates/shop/checkout/protx/confirm.html
satchmo_store/shop/templates/shop/checkout/pay_ship.html
satchmo_store/shop/templates/shop/checkout/sermepa/pay_ship.html
satchmo_store/shop/templates/shop/checkout/sermepa/confirm.html
satchmo_store/shop/templates/shop/checkout/google/pay_ship.html
satchmo_store/shop/templates/shop/checkout/google/confirm.html
satchmo_store/shop/templates/shop/checkout/balance_remaining.html
satchmo_store/shop/templates/shop/checkout/empty_cart.html
satchmo_store/shop/templates/shop/checkout/confirm.html
satchmo_store/shop/templates/shop/checkout/base_pay_ship.html
satchmo_store/shop/templates/shop/checkout/auto/pay_ship.html
satchmo_store/shop/templates/shop/search.html
satchmo_store/shop/templates/shop/index.html
satchmo_store/shop/templates/shop/cart.html
satchmo_store/shop/templates/admin/base_site.html
satchmo_store/shop/templates/admin/index.html
satchmo_store/contact/templates/comments/form.html
satchmo_store/contact/templates/comments/preview.html
satchmo_store/contact/templates/comments/posted.html
satchmo_store/contact/templates/admin/contact/order/change_form.html
satchmo_store/contact/templates/contact/view_profile.html
satchmo_store/contact/templates/contact/update_form.html
satchmo_store/contact/templates/contact/login_signup_address.html
satchmo_store/contact/templates/contact/_country_match_script.html
satchmo_store/contact/templates/contact/login_signup.html
satchmo_store/contact/templates/contact/_addressblock.html
satchmo_store/contact/templates/registration/registration_form.html
satchmo_store/contact/templates/registration/account_info.html
satchmo_store/contact/templates/registration/registration_complete.html
satchmo_store/contact/templates/registration/password_reset_done.html
satchmo_store/contact/templates/registration/activate.html
satchmo_store/contact/templates/registration/repeat_activation.html
satchmo_store/contact/templates/registration/login.html
satchmo_store/contact/templates/registration/password_change_form.html
satchmo_store/contact/templates/registration/password_reset_form.html
satchmo_store/contact/templates/registration/logout.html
satchmo_store/contact/templates/registration/password_change_done.html

Livesettings

livesettings/templates/livesettings/site_settings.html
livesettings/templates/livesettings/group_settings.html
livesettings/templates/livesettings/_admin_site_views.html

Shipping

shipping/templates/shipping/options.html

Satchmo_utils

satchmo_utils/thumbnail/templates/widget/file.html