seitime-frappe/frappe/docs/current/api/website/frappe.website.template.html
2015-12-04 10:22:48 +05:30

147 lines
No EOL
4.1 KiB
HTML

<!-- title: frappe.website.template --><div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/website/template.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p class="docs-attr-name">
<a name="frappe.website.template.add_hero" href="#frappe.website.template.add_hero" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>add_hero</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Add a hero element if specified in content or hooks.
Hero elements get full page width.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.add_index" href="#frappe.website.template.add_index" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>add_index</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Add index, next button if <code>{index}</code>, <code>{next}</code> is present.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.build_template" href="#frappe.website.template.build_template" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>build_template</b>
<i class="text-muted">(context)</i>
</p>
<div class="docs-attr-desc"><p>Returns a dict of block name and its rendered content</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.render_blocks" href="#frappe.website.template.render_blocks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>render_blocks</b>
<i class="text-muted">(template_path, out, context)</i>
</p>
<div class="docs-attr-desc"><p>Build the template block by block from the main template.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.separate_style_and_script" href="#frappe.website.template.separate_style_and_script" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>separate_style_and_script</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Extract <code>style</code> and <code>script</code> tags into separate blocks</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.set_breadcrumbs" href="#frappe.website.template.set_breadcrumbs" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>set_breadcrumbs</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Build breadcrumbs template (deprecated)</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.set_sidebar" href="#frappe.website.template.set_sidebar" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>set_sidebar</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Include sidebar (deprecated)</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.set_title_and_header" href="#frappe.website.template.set_title_and_header" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>set_title_and_header</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Extract and set title and header from content or context.</p>
</div>
<br>
<!-- autodoc -->