Loading...
Loading...
Deterministic Jinja template syntax for ERPNext/Frappe Print Formats, Email Templates, and Portal Pages
npx skill4agent add openaec-foundation/erpnext_anthropic_claude_development_skill_package erpnext-syntax-jinjaCorrect Jinja syntax for Print Formats, Email Templates, and Portal Pages in ERPNext/Frappe v14/v15/v16.
| Object | Description |
|---|---|
| The document being printed |
| Frappe module with utility methods |
| Translation function |
| Object | Description |
|---|---|
| The linked document |
| Frappe module (limited) |
| Object | Description |
|---|---|
| Current user |
| Query parameters |
| Current language |
| Custom context | Via Python controller |
See:for complete details.references/context-objects.md
{# RECOMMENDED for fields in print formats #}
{{ doc.get_formatted("posting_date") }}
{{ doc.get_formatted("grand_total") }}
{# For child table rows - pass parent doc #}
{% for row in doc.items %}
{{ row.get_formatted("rate", doc) }}
{{ row.get_formatted("amount", doc) }}
{% endfor %}
{# General formatting #}
{{ frappe.format(value, {'fieldtype': 'Currency'}) }}
{{ frappe.format_date(doc.posting_date) }}{# Full document #}
{% set customer = frappe.get_doc("Customer", doc.customer) %}
{# Specific field value (more efficient) #}
{% set abbr = frappe.db.get_value("Company", doc.company, "abbr") %}
{# List of records #}
{% set tasks = frappe.get_all('Task',
filters={'status': 'Open'},
fields=['title', 'due_date']) %}<h1>{{ _("Invoice") }}</h1>
<p>{{ _("Total: {0}").format(doc.grand_total) }}</p>See:for all methods.references/methods-reference.md
{% if doc.status == "Paid" %}
<span class="label-success">{{ _("Paid") }}</span>
{% elif doc.status == "Overdue" %}
<span class="label-danger">{{ _("Overdue") }}</span>
{% else %}
<span>{{ doc.status }}</span>
{% endif %}{% for item in doc.items %}
<tr>
<td>{{ loop.index }}</td>
<td>{{ item.item_name }}</td>
<td>{{ item.get_formatted("amount", doc) }}</td>
</tr>
{% else %}
<tr><td colspan="3">{{ _("No items") }}</td></tr>
{% endfor %}| Variable | Description |
|---|---|
| 1-indexed position |
| True on first |
| True on last |
| Total items |
{% set total = 0 %}
{% set customer_name = doc.customer_name | default('Unknown') %}| Filter | Example |
|---|---|
| |
| |
| |
| |
| |
See:for all filters.references/filters-reference.md
<style>
.header { background: #f5f5f5; padding: 15px; }
.table { width: 100%; border-collapse: collapse; }
.table th, .table td { border: 1px solid #ddd; padding: 8px; }
.text-right { text-align: right; }
</style>
<div class="header">
<h1>{{ doc.select_print_heading or _("Invoice") }}</h1>
<p>{{ doc.name }}</p>
<p>{{ _("Date") }}: {{ doc.get_formatted("posting_date") }}</p>
</div>
<table class="table">
<thead>
<tr>
<th>{{ _("Item") }}</th>
<th class="text-right">{{ _("Qty") }}</th>
<th class="text-right">{{ _("Amount") }}</th>
</tr>
</thead>
<tbody>
{% for row in doc.items %}
<tr>
<td>{{ row.item_name }}</td>
<td class="text-right">{{ row.qty }}</td>
<td class="text-right">{{ row.get_formatted("amount", doc) }}</td>
</tr>
{% endfor %}
</tbody>
</table>
<p><strong>{{ _("Grand Total") }}:</strong> {{ doc.get_formatted("grand_total") }}</p><p>{{ _("Dear") }} {{ doc.customer_name }},</p>
<p>{{ _("Invoice") }} <strong>{{ doc.name }}</strong> {{ _("for") }}
{{ doc.get_formatted("grand_total") }} {{ _("is due.") }}</p>
<p>{{ _("Due Date") }}: {{ frappe.format_date(doc.due_date) }}</p>
{% if doc.items %}
<ul>
{% for item in doc.items %}
<li>{{ item.item_name }} - {{ item.qty }} x {{ item.get_formatted("rate", doc) }}</li>
{% endfor %}
</ul>
{% endif %}
<p>{{ _("Best regards") }},<br>
{{ frappe.db.get_value("Company", doc.company, "company_name") }}</p>{% extends "templates/web.html" %}
{% block title %}{{ _("Projects") }}{% endblock %}
{% block page_content %}
<h1>{{ _("Projects") }}</h1>
{% if frappe.session.user != 'Guest' %}
<p>{{ _("Welcome") }}, {{ frappe.get_fullname() }}</p>
{% endif %}
{% for project in projects %}
<div class="project">
<h3>{{ project.title }}</h3>
<p>{{ project.description | truncate(150) }}</p>
</div>
{% else %}
<p>{{ _("No projects found.") }}</p>
{% endfor %}
{% endblock %}import frappe
def get_context(context):
context.title = "Projects"
context.projects = frappe.get_all(
"Project",
filters={"is_public": 1},
fields=["name", "title", "description"],
order_by="creation desc"
)
return contextjenv = {
"methods": ["myapp.jinja.methods"],
"filters": ["myapp.jinja.filters"]
}import frappe
def get_company_logo(company):
"""Get company logo URL"""
return frappe.db.get_value("Company", company, "company_logo") or ""<img src="{{ get_company_logo(doc.company) }}">_()get_formatted(){{ value | default('') }}row.get_formatted("field", doc)| safe| Aspect | Jinja (Print Formats) | JS (Report Print Formats) |
|---|---|---|
| Output | | |
| Code | | |
| Language | Python | JavaScript |
<!-- JS Template for Reports -->
{% for(var i=0; i<data.length; i++) { %}
<tr><td>{%= data[i].name %}</td></tr>
{% } %}| Feature | v14 | v15 |
|---|---|---|
| Basic Jinja API | ✅ | ✅ |
| get_formatted() | ✅ | ✅ |
| jenv hook | ✅ | ✅ |
| Portal pages | ✅ | ✅ |
| frappe.utils.format_date with format | ✅ | ✅+ |
| Aspect | v14/v15 (wkhtmltopdf) | v16 (Chrome) |
|---|---|---|
| CSS Support | Limited CSS3 | Full modern CSS |
| Flexbox/Grid | Partial | Full support |
| Page breaks | | |
| Fonts | System fonts | Web fonts supported |
| Performance | Faster | Slightly slower |
/* v14/v15 */
.page-break { page-break-before: always; }
/* v16 - both work, but break-* is preferred */
.page-break { break-before: page; }# In site_config.json
{
"pdf_engine": "chrome", # or "wkhtmltopdf" for legacy
"chrome_path": "/usr/bin/chromium"
}| File | Contents |
|---|---|
| Available objects per template type |
| All frappe.* methods |
| Standard and custom filters |
| Complete working examples |
| Mistakes to avoid |
erpnext-syntax-hookserpnext-impl-jinjaerpnext-errors-jinja