Skip to content
Myroslava Stavnycha edited this page Nov 1, 2016 · 8 revisions

All pages instruments

We are using liquid templating language to render shop templte. Introduction can be found here.

Our in each template page next variables are accessible. If page has ability to paginate (usually some "index" page then needed parameter is page). The list of output markups available here and tag markups here.

Mailers templates

To be noted here. If your theme doesn't have these templates, then we load defaults.

Order confirmation

Accessible objects are order, shop, customer.

  • subject should be set through admin
  • order.confirmation.text.liquid - if not found will take from default
  • order.confirmation.html.liquid - if not found, then won't send

Order shipping

becoming deprecated

Accessible objects are order, shop, customer.

  • subject should be set through admin
  • order.shipping.text.liquid - if not found will take from default
  • order.shipping.html.liquid - if not found, then won't send

Parcel shipping

Accessible objects are parcel, order, shop, customer.

  • subject should be set through admin
  • parcel.shipment.text.liquid - if not found will take from default
  • parcel.shipment.html.liquid - if not found, then won't send

Customer confirmation

Accessible objects are shop, customer.

  • subject should be set through admin
  • customer.confirmation.text.liquid - if not found will take from default
  • customer.confirmation.html.liquid - if not found, then won't send

Customer password reset

Accessible objects are shop, customer.

  • subject should be set through admin
  • customer.reset_password.text.liquid - if not found will take from default
  • customer.reset_password.html.liquid - if not found, then won't send

Page by page instruments

index.liquid (Index page)

No additional variables

products.liquid (Products index page)

Shows only active products and there's possible pagination.

Additional variables:

product.liquid (Product show page)

If product not active or not found then renders template not_found.liquid. Page also may have a parameter template. If it's filled then we will try to render this template instead of standard one (page.liquid). Admin panel will generate you a list of possible custom templates by searching for page.your_custom_name.liquid.

Additional variables:

  • product - product entity
  • category - category entity product belongs_to
  • meta - product meta information

cart.liquid (Cart show page)

Can respond also on json json object. also actions GET checkout -> redirects client to checkout process, POST add, update

account.liquid

category.liquid

collection.liquid

Additional variables:

collection.liquid

Additional variables:

login.liquid

not_found.liquid

Custom 404 page templates if something wasn't found.

Has no additional variables.

order.liquid

orders.liquid

page.liquid

is used to show custom content. Will use root webpage /slug like /contact-as

Additional params:

wishlist.liquid

password_request.liquid

Template to request a password for customer. Example of content

<form action="{{ form_actions.password_request }}" method="POST">
  {{form_actions.auth_input}}
  <input type="text"     name="email"    placeholder="E-mail" />
  <input type="submit"   value="request" />
</form>

password_token_sent.liquid

Template which we show when password request has been sent

Thank you! your password has been sent.

password_change.liquid

Template to update a password of customer. Example of content:

<form action="{{ form_actions.password_change }}" method="POST">
  {{form_actions.auth_input}}
  <input type="text"     name="token"                 value="{{params.token}}" />
  <input type="password" name="password"              placeholder="Password" />
  <input type="password" name="password_confirmation" placeholder="Password Confirmation" />
  <input type="submit"   value="Save" />
</form>

blog_posts.liquid

Shows only active posts and there's possible pagination.

Additional params:

blob_post.liquid (Blog post show template)

If post not active or not found then renders template not_found.liquid. Post also may have a parameter template. If it's filled then we will try to render this template instead of standard one (blog_post.liquid). Admin panel will generate you a list of possible custom templates by searching for blog_post.your_custom_name.liquid.

Additional params:

Clone this wiki locally