mirror of
https://github.com/python-escpos/python-escpos
synced 2025-08-24 09:03:34 +00:00
Add printer profile list to documentation (#536)
* add first draft of printer profile listing * add todos * Update doc/capability_templates/capabilities-template.jinja * Update doc/capability_templates/capabilities-template.jinja * restructure documentation * add encoding list * add color and encoding table * add notes on usage * add feature table
This commit is contained in:
6
doc/printer_profiles/available-encodings.rst
Normal file
6
doc/printer_profiles/available-encodings.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
Available Encodings
|
||||
-------------------
|
||||
:Last Reviewed: 2023-07-29
|
||||
|
||||
.. datatemplate:json:: ../../capabilities-data/dist/capabilities.json
|
||||
:template: capabilities-template-encoding.jinja
|
17
doc/printer_profiles/available-profiles.rst
Normal file
17
doc/printer_profiles/available-profiles.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. _available-profiles:
|
||||
|
||||
Available Profiles
|
||||
------------------
|
||||
:Last Reviewed: 2023-07-29
|
||||
|
||||
The following list describes which printer profiles are
|
||||
available in this release.
|
||||
The existence of a profile is a hint, but no guarantee
|
||||
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
|
||||
:template: capabilities-template.jinja
|
24
doc/printer_profiles/capabilities.rst
Normal file
24
doc/printer_profiles/capabilities.rst
Normal file
@@ -0,0 +1,24 @@
|
||||
Capabilities
|
||||
------------
|
||||
:Last Reviewed: 2023-07-29
|
||||
|
||||
Since the used command set often differs between printers,
|
||||
a model for supporting different printers is implemented.
|
||||
This feature is called `capabilities`.
|
||||
|
||||
The `capabilities`-feature allows this library to know
|
||||
which features are supported.
|
||||
If no further information is specified, python-escpos will
|
||||
try to automatically use features based on the supplied information.
|
||||
|
||||
In order to use the `capabilities`-database, the printer instance
|
||||
simply has to be created with the parameter `profile` set to the
|
||||
relevant identifier.
|
||||
The identifier can be found in :ref:`available-profiles`.
|
||||
|
||||
This documentation describes the profiles in the database file that
|
||||
is bundled with this release.
|
||||
If another configuration is to be used, this chapter can be followed
|
||||
for information on how to sideload another `capabilities`-database:
|
||||
:ref:`advanced-usage-change-capabilities-profile`.
|
||||
|
Reference in New Issue
Block a user