docs: add docs for example format; disable format

check_run/check_run/print_format/example_voucher/example_voucher.json

@@ -5,15 +5,15 @@
  "css": "@font-face {\n    font-family: 'EntezareZohoor2';\n    src: url('fonts/EntezareZohoor2.eot'), url('fonts/EntezareZohoor2.ttf') format('truetype'), url('fonts/EntezareZohoor2.svg') format('svg');\n    font-weight: normal;\n    font-style: normal;\n}\n\n.print-format {\n\tpadding: 0px;\n}\n@media screen {\n\t.print-format {\n\t\tpadding: 0in;\n\t}\n}\n#payer_check_window_block {\n    top: 0.7cm; \n    left: 0.7cm;\n    height: 2.2cm;\n    width: 8.8cm;\n    position: absolute;\n    \n}\n\n#payer_name_block{\n    top: 0.1cm; \n    left: 1cm;\n    position: absolute;\n}\n\n#payee_address_window_block {\n    top:4.9cm;\n    left: 1.9cm;\n    position: absolute;  \n    width: 8.8cm; \n    height:2.2cm;\n}\n\n#address_block{\n    top: 0.2cm; \n    left: 0.2cm;\n    position: relative;\n}\n\n\n\n#memo_block {\n top:7.1cm;\n left: 2cm;\n position: absolute;  \n width: 6cm;\n}\n\n\n#check_section_1 {\n    font-size: 15px;\n    width:20.0cm;\n    height:8.9cm;\n}\n\n#check_section_2 {\n    height:8.9cm;\n}\n\n#check_section_3 {\n    height:8.9cm;\n}\n\n\n#payer_name_block {\ntext-align: center; \n\n}\n\n#payer_name_block {\nwidth:4cm;\ntext-align: center; \nposition: absolute;\n}\n\n#bank_info_block {\nfont-size: 10px;\nwidth:2.5cm;\nheight:1.8cm;\ntext-align: center; \nposition: absolute;\n}\n\n\n#payment_in_words_block {\n font-size: 13px;\n}\n\n#memo_block {\nfont-size: 10px;\n}\n\n#signature_block {\ncolor: blue;\nfont-family: cursive;\n\n}\n#payment_amount_block{\n    top:3.3cm;\n    left: 17.6cm;\n\tposition: absolute; \n\tmin-width: 4cm;\n\n}\n\n.payment_reference_block {\npadding-left:1cm; \npadding-right:1cm; \n}\n\n.payment_name_cell {\ntext-align: right; \n}\n\n#payment_amount_number_block {\n   top:3.3cm;\n    left: 17.6cm;\n\tposition: absolute; \n\tmin-width: 4cm;\n}\n\n\n.right_stamp {\n    top:2.8cm;\n    left: 16.6cm;\n    width: 3cm;\n\theight: 1.5cm;\n\tfont-size: 40px;\n  \tfort-weight: bold;\n    position: absolute; \n}\n\n.sig_stamp {\n    top:6.3cm;\n    left: 13.8cm;\n    width: 3cm;\n\theight: 1.5cm;\n\tfont-size: 40px;\n  \tfort-weight: bold;\n    position: absolute; \n}\n\n.big_stamp {\n    top:2.8cm;\n    left: 6.1cm;\n    width: 7cm;\n\theight: 3cm;\n\tfont-size: 80px;\n  \tfort-weight: bold;\n    position: absolute; \n}\n\n\n.stamp {\n\tmargin: 0px;\n\toverflow: hidden;\n    display: flex;\n    justify-content: space-around;\n    align-items: center;\n    vertical-align: middle;\n    text-align: center;\n\n    flex-direction: row;\n    color: #555;\n\tfont-weight: 700;\n\tborder: 0.25rem solid #555;\n\tdisplay: inline-block;\n\t\n\ttext-transform: uppercase;\n\tborder-radius: 1rem;\n\tfont-family: 'Courier';\n\t-webkit-mask-image: url('https://s3-us-west-2.amazonaws.com/s.cdpn.io/8399/grunge.png');\n    -webkit-mask-size: 944px 604px;\n    mix-blend-mode: multiply;\n}\n\n\n.is-nope {\n    color: #ff5858;\n    border: 0.5rem double #D23;\n  \t-webkit-mask-position: 2rem 3rem;\n  \t\n    \n}\n\n.is-draft {\n\tcolor: #ff5858;\n\tborder: 1rem double #ff5858;\n    font-size: 6rem;\n    font-family: \"Open sans\", Helvetica, Arial, sans-serif;\n    border-radius: 0;\n    padding: 0.5rem;\n} ",
  "custom_format": 1,
  "default_print_language": "en",
- "disabled": 0,
+ "disabled": 1,
  "doc_type": "Payment Entry",
  "docstatus": 0,
  "doctype": "Print Format",
  "font": "Default",
  "html": "<div style=\"position: relative; top:0.0cm\">\n    \n\t<div id=\"check_section_1\" >\n\t    {% if doc.docstatus == 0 %}\n            <span class=\"stamp right_stamp is-draft\">VOID DRAFT</span>\n            <span class=\"stamp sig_stamp is-draft\">VOID DRAFT</span>\n        {% elif doc.docstatus == 2 or overwrite_void %}\n            <span class=\"stamp right_stamp is-nope\">VOID</span>\n            <span class=\"stamp sig_stamp is-nope\">VOID</span>\n            <span class=\"stamp big_stamp is-nope\">VOID</span>\n        {% endif %}\n\t    \n\t    <div id=\"payer_check_window_block\" class=\"test_lines\">\n\t\t<span id= \"payer_name_block\">\n\t\t\t{{ doc.company }}\n\t\t</span>\n\t\t</div>\n\t\t<span id=\"check_date_block\" style=\"top:2.0cm; left:17.0cm;\n\t\t\tposition: absolute;\">\n\t\t    {{ doc.get_formatted('posting_date') }} \n\t\t</span>\n\n\t\t<span id=\"payee_name_block\" style=\"top:3.2cm;left: 2.8cm;\n\t\t\tposition: absolute;  min-width: 6cm;\">\n\t\t\t{{ doc.party_name }}\n\t\t</span>\n\t\t\n\t\t<span id=\"payee_address_window_block\"  class=\"test_lines\" >\n\t        <div id=\"address_block\">\n\t        {{ doc.party_name }} <br>\n\t        {% set address = get_default_address(doc.party_type, doc.party) %}\n\t\t\t{% if address %}\n\t\t\t    {{ frappe.get_doc('Address', address).get_display() }}\n\t\t\t{% endif %}\n\t\t\t</div>\n\t\t</span>\n\t\t\n\t\t<span id=\"payment_amount_number_block\">\n\t\t\t{% set money_number = doc.get_formatted('paid_amount')[1:].strip() %} \n\t\t\t\n\t\t\t{% if money_number|length < 18 %}\n\t\t\t\t    {% set money_number = ( money_number + '***************************')[:18] %}\n\t\t\t{% endif %}\n\t\t\t{{ money_number }}\n\t\t</span>\n\t\t<span id=\"payment_in_words_block\" style=\"top:4.05cm; left:2.8cm;\n\t\t\tposition: absolute; display: block; width: 16.5cm;\n\t\t\tline-height:0.5cm; word-wrap: break-word;\">\n\t\t\t\t{% set money_in_words = frappe.utils.money_in_words(doc.paid_amount)[:-5] %}\n\t\t\t\t{% if money_in_words|length < 90 %}\n\t\t\t\t    {% set money_in_words = (money_in_words + '************************************************************************')[:100] %}\n\t\t\t\t{% endif %}\n\t\t\t\t{{ money_in_words }}\n\t\t</span>\n\t\t\n\t\t<span id=\"memo_block\" class=\"test_lines\">\n\t\t\t{{ doc.check_memo or '' }} {% if test_lines %} MEMO {% endif %}\n\t\t</span>\n\n\t\t<span id=\"signature_block\" style=\"top:6.3cm;left: 13.8cm;\n\t\t\tposition: absolute;  min-width: 6cm;\">\n\t\t    SIGNATURE\n\n\t\t</span>\n        <span id=\"check_number_block\" style=\"top:7.9cm;left:4.3cm;\n\t\t\tposition: absolute;  min-width: 1.5cm;\">\n\t\t\tCHECK#\n\t\t</span>\n\t\t\t\t<span id=\"account_number_block\" style=\"top:7.9cm;left:7.15cm;\n\t\t\tposition: absolute;  min-width: 6cm;\">\n\t\t\tACCOUNT NUMBER {{ doc.account_no or '' }}\n\t\t</span>\n\t\t<span id=\"routing_number_block\" style=\"top:7.9cm;left:12cm;\n\t\t\tposition: absolute;  min-width: 6cm;\">\n\t\t\tROUTING_NUMBER\n\t\t</span>\n\t</div>\n</div>\n{% for i in range(0,2) %}\n    {% if i == 0 %}\n        <div id=\"check_section_2\" class=\"test_lines\" style=\"top:9cm;\">\n    {% endif %}\n    {% if i == 1  %}\n        <div id=\"check_section_3\" class=\"test_lines\" style=\"top:17.8cm;\">\n    {% endif %}\n    <div class=\"payment_reference_block\" > \n<table class=\"table table-responsive-sm\">\n\t\t\t\t<tr><td colspan=\"2\">{{doc.party_name}}</td>\n\t\t\t\t\t\t<td> {{ frappe.utils.formatdate(doc.reference_date) or '' }} </td>\n\t\t\t\t\t\t<td style=\"text-align:right;\" colspan=\"2\"> {{doc.get_formatted(\"base_paid_amount\")}} </td>\n\t\t\t\t\t\t<tr>\n\t\t\t\t\t\t\t<th> Date </th>\n\t\t\t\t\t\t\t<th style=\"text-align:left;\"> Reference </th>\n\t\t\t\t\t\t\t<th style=\"text-align:center;\"> Amount </th>\n\t\t\t\t\t\t\t<th style=\"text-align:right;\"> Payment </th>\n\t\t\t\t\t\t</tr>\n\t\t\t\t\t{% for reference in doc.references %}\n\t\t\t\t\t\t<tr>\n\t\t\t\t\t\t    {% if reference.reference_doctype == 'Purchase Invoice' %}\n\t\t\t\t\t\t    <td>{{ frappe.utils.formatdate(frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"bill_date\")) or \"\"}}</td>\n\t\t\t\t\t\t    <td style=\"text-align:left;\"> {{ frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"bill_no\") or \"\" }}</td>\n\t\t\t\t\t\t\t{% elif reference.reference_doctype == 'Sales Invoice' %}\n\t\t\t\t\t\t\t<td style=\"text-align:left;\">{{ frappe.utils.formatdate(frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"po_date\")) or \"\"}}</td>\n\t\t\t\t\t\t    <td style=\"text-align:left;\"> {{ frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"po_no\") or \"\" }}</td>\n\t\t\t\t\t\t    {% elif reference.reference_doctype == 'Expense Claim' %}\n\t\t\t\t\t\t\t<td style=\"text-align:left;\">{{ frappe.utils.formatdate(frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"expense_report_date\")) or \"&#160;\"}}</td>\n\t\t\t\t\t\t    <td style=\"text-align:left;\"> {{ frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"name\") or \"&#160;\" }}</td>\n\t\t\t\t\t\t    {% elif reference.reference_doctype == 'Journal Entry' %}\n\t\t\t\t\t\t\t<td style=\"text-align:left;\"> {{ frappe.utils.formatdate(frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"posting_date\")) or \"&#160;\"}}</td>\n\t\t\t\t\t\t    <td style=\"text-align:left;\"> {{ frappe.db.get_value(reference.reference_doctype, reference.reference_name, \"name\") or \"&#160;\" }}</td>\n\t\t\t\t\t\t\t{% endif %}\n\t\t\t\t\t\t\t<td style=\"text-align:center;\"> {{ frappe.utils.fmt_money(reference.get_formatted('total_amount'), 2, 'USD')}}</td>\n\t\t\t\t\t\t\t<td style=\"text-align:right;\"> {{ reference.get_formatted('allocated_amount')}}</td>\n\t\t\t\t\t\t</tr>\n\t\t\t\t\t{% endfor %}\n\t\t\t\t</table>\n    </div>\n</div>\n{% endfor %}",
  "idx": 0,
  "line_breaks": 0,
- "modified": "2022-08-30 12:53:44.237325",
+ "modified": "2022-08-30 15:09:39.647268",
  "modified_by": "Administrator",
  "module": "Check Run",
  "name": "Example Voucher",

docs/exampleprint.md

@@ -2,6 +2,8 @@
 
 To take advantage of Check Run's check printing functionality, you'll need to set up a print format in ERPNext. Print formats are as unique as the organizations using ERPNext, so a voucher check print format (coming soon) serves as an example template. It can be a starting point from which to customize to suit your needs.
 
+The example print format included with this application can be found at in the Print Format List under Example Voucher. It is disabled by default.
+
 Additional resources:
 
 - [ERPNext print format documentation](https://docs.erpnext.com/docs/v14/user/manual/en/customize-erpnext/print-format)