add encoding list

This commit is contained in:
Patrick Kanzler 2023-07-29 00:34:12 +02:00
parent 18365fe653
commit 1309976e6e
5 changed files with 53 additions and 5 deletions

View File

@ -0,0 +1,28 @@
{% for item in data.encodings %}
{% set encoding = data.encodings[item] %}
{% macro draw_with_underline(text, symbol='-') -%}
{{ escape_rst(text) }}
{{ escape_rst(text) | length * symbol }}
{%- endmacro %}
{{ '.. _encoding-label-' + item + ':' }}
{{ draw_with_underline(encoding.name) }}
{{ escape_rst(encoding.notes) }}
Mapping Information
^^^^^^^^^^^^^^^^^^^
====================== ================================================================
identifier {{ escape_rst(item) }}
Name {{ escape_rst(encoding.name|default('Unknown')) }}
Iconv Name {{ escape_rst(encoding.iconv|default('Unknown')) }}
``python_encode`` Name {{ escape_rst(encoding.python_encode|default('Unknown')) }}
====================== ================================================================
{% if encoding.data is defined %}
{{ draw_with_underline('Code page data', symbol='^') }}
{{ encoding.data }}
{% endif %}
{% endfor %}

View File

@ -4,10 +4,13 @@
{{ escape_rst(text) }} {{ escape_rst(text) }}
{{ escape_rst(text) | length * symbol }} {{ escape_rst(text) | length * symbol }}
{%- endmacro %} {%- endmacro %}
{{ '.. _printer-label-' + item + ':' }}
{{ draw_with_underline(printer.name) }} {{ draw_with_underline(printer.name) }}
{{ escape_rst(printer.notes) }} {{ escape_rst(printer.notes) }}
You can select this profile in python-escpos with this identifier: `{{ item }}`. You can select this profile in python-escpos with this identifier: ``{{ item }}``.
Basic information Basic information
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
@ -54,6 +57,8 @@ starCommands clear
Text code pages Text code pages
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
todo example encoding: :ref:`encoding-label-CP3011`
.. todo: list code pages (ID, Encoding, link to Encoding list) .. todo: list code pages (ID, Encoding, link to Encoding list)
{% endfor %} {% endfor %}

View File

@ -1,3 +1,6 @@
Available Encodings Available Encodings
------------------- -------------------
:Last Reviewed: 2023-07-27 :Last Reviewed: 2023-07-27
.. datatemplate:json:: ../../capabilities-data/dist/capabilities.json
:template: capabilities-template-encoding.jinja

View File

@ -2,10 +2,14 @@ Available Profiles
------------------ ------------------
:Last Reviewed: 2023-07-27 :Last Reviewed: 2023-07-27
.. todo:: explain capabilities The following list describes which printer profiles are
.. todo:: explain usage available in this release.
.. todo:: give hints on how to sideload and improve profiles (profile that is bundled with release can be replaced) The existence of a profile is a hint, but no guarantee
.. todo:: Idea: move this to another chapter and create for each printer a page? that this printer actually can be controlled by this library.
If you find any issues with the described capabilities,
please open an issue in the
`ESC/POS printer database <https://github.com/receipt-print-hq/escpos-printer-db>`_.
.. datatemplate:json:: ../../capabilities-data/dist/capabilities.json .. datatemplate:json:: ../../capabilities-data/dist/capabilities.json
:template: capabilities-template.jinja :template: capabilities-template.jinja

View File

@ -1,3 +1,11 @@
Capabilities Capabilities
------------ ------------
:Last Reviewed: 2023-07-27 :Last Reviewed: 2023-07-27
Since the used command set often differs between printers,
a model for supporting different printers is implemented.
This feature is called `capabilities`.
.. todo:: explain capabilities
.. todo:: explain usage
.. todo:: give hints on how to sideload and improve profiles (profile that is bundled with release can be replaced)