Pages have a unique friendly url and are organized as nested tree and represent the structure of your website.
Beside a language, a page has attributes for name, title, visibility, published and restriction status and all SEO relevant attributes like meta tags and meta descriptions.
# Defining page layouts
Page layouts are defined in the
Every page layout needs at least a name. You don't need to set every option. It depends on what you need for pages with that layout type.
# Recommended settings
The name of the layout used for views and inside the database. You can render a layout with the
A list of element names that can be placed on this layout i.e.
Elements are defined inside the
A list of element names that are autogenerated after creating a Page of that type.
trueand the user can only choose this layout once inside a language tree.
falseto disable the cache headers for this kind of pages. Recommended for contact forms and such likes.
Layout pages (or global pages) are outside the normal page tree and can be used to place "global" Elements like a header and footer.
trueto be able to assign tags within page settings.
# Optional settings
trueto hide this layout from the user.
trueto use this type of page for rendering the search results of the build in fulltext search.
trueto enable a RSS feed of news elements from this page.
trueto disable normal page rendering and redirect to a external page instead.
Controller to use instead of the default
Controllers action to use instead of the default
Lets say you want to create a contact page with a headline element, a contactform and a text element on it.
This page should be unique, because you don't want to give your content manager the possibility to create more than one contact form.
This page must not be cached, because of validation messages and user specific form content.
We also want to autogenerate the headline and the contactform element after the page gets created.
# config/alchemy/page_layouts.yml - name: contact cache: false unique: true elements: [headline, contactform, text] autogenerate: [headline, contactform]
Please ensure to restart the Rails server after editing
# Page templates
Each page type (called
page_layout in Alchemy) has a Rails view partial which is yielded on the Rails application layout (
All page layout partials live in the
They are named after the pages
page_layout you defined in the
If no page layout partial is found for a page, the
_standard.html.erb layout gets rendered instead.
# Template generator
There is no need to create these partials manually. AlchemyCMS comes with a Rails generator task which creates these partials for you.
So after defining the page layouts, you can generate all the corresponding partials for them.
bin/rails g alchemy:page_layouts --skip
Using the example above, which defines a contact layout, the generator will create a partial named
You can pass
-e as option to use one of
erb. The default depends on your default template engine in your Rails host app.
# Rendering elements
Alchemy does not place any HTML markup in your generated page layouts partial.
<%= render_elements %>
is all you will see. Feel free to customize the HTML so it fits your needs.
render_elements view helper has lots of options. Please have a look at the
Alchemy::ElementsHelper documentation (opens new window)
# Global pages
Global pages (or layout pages) are pages that are not in the default page tree (your navigation). They will never get rendered on its own. Use them to store shared elements that should be rendered on multiple other pages (ie. footer, header, tracking codes etc) or somewhere directly on the application layout.
To define a global page set
layoutpage: true in the page layout definition of that page.
# Render an element from a global page
To render an element from a global page use the
from_page option of the
<%= render_elements only: 'news_teaser', from_page: 'sidebar' %>
You can pass a
page_layout name as a
Array of page layout names, or an instance of a certain
If using the global caching option (defined in
config/alchemy/config.yml) - which is enabled by default - your page requests will deliver cache headers. Most browsers, CDNs and proxys use these headers to cache the page.
You can disable cache headers for certain pages by using the
cache: false setting.
# Russian doll caching
You can use Rails' "Russian-Doll-Caching" to cache page templates.
<% cache @page do %> <%= render_elements %> <% end %>
Be sure to not cache page templates that have elements with forms on it, like contact or comment forms. Rails' csrf protection token is placed inside the
<form> tag and caching it will break form submissions.
# Translate page layout names
Page layout names are passed through the
You can translate them in your Alchemy locale files.
# config/locales/alchemy.de.yml de: alchemy: page_layout_names: contact: Kontakt search: Suche
All translation keys used by Alchemy are scoped under the