BlueGit

timfa posprint

Files

posprint / docs / HELP.md

HELP.md

HELP.md 5.9 KiB Download Raw

posprint Help

Built-in reference for the template editor and POS markup language.

---

Application tabs

TabPurpose
DesignSide-by-side template editor and live preview
HelpThis documentation

Toolbar actions

ActionDescription
NewEmpty template with defaults
OpenLoad a .pos file
Save / Save AsWrite .pos file (metadata + body)
InsertImages, barcodes, QR, date/time, parameters, @feed, @cut
PrintEnter parameters, pick a printer, send ESC/POS bytes

While the Print dialog is open, the rest of the UI (including editor autocomplete) is disabled so parameter fields keep focus.

Editor assistance

  • Type @ at the start of a line for directive autocomplete (feed, cut, image, barcode, qr, date, time).
  • Use Insert → Barcode / QR code to pick native or raster type before inserting a snippet.

Page settings

SettingDescription
Page width (mm)Paper width — match your physical roll (e.g. 53, 58, 80)
Preview zoomScreen zoom; 100% is calibrated to typical receipt width on screen

Preview width and text use the same calibrated screen scale. Preview font size is bumped to match printed Font A. Blank lines / @feed use the same line spacing as printed text. Heading # uses double width/height like GS ! on the printer; ## uses bold only.

If the document does not end with @cut (ignoring blank lines after it), a red warning appears next to Help.

---

Template language

A template is plain text: paragraphs, headings, lists, checkboxes, directives, and ${parameters}. There is no inline bold/italic/code markup — asterisks and backticks print literally.

Paragraphs

Consecutive non-empty lines form one paragraph.

Headings

# Large heading
## Bold heading

Alignment

:left:, :center:, or :right: before a paragraph.

Bullet lists

- first item
- second item

Long items wrap with a hanging indent (printed/previewed as ASCII *):

* this is a
  long line

Parameters

SyntaxEffect
${Name}Parameter (filled at print time)

Checkboxes

Inline checkboxes use ASCII so they print correctly on CP437 ESC/POS printers (same font as surrounding text):

SyntaxResult
[] or [ ][ ]
[x] or [X][x]
[] Unchecked
[ ] Also unchecked
[x] Done

Unicode ballot boxes and custom bit-images are not used: UTF-8 becomes garbage/CJK on CP437 printers, and ESC * / ESC & graphics often leave the text line on micro-printers.

Horizontal rule

---

Comments

<!-- not printed -->

---

Directives

Directives start with @ at the beginning of a line.

Paper feed / cut

@feed 3
@cut

Blank lines in the editor also feed one line (same as @feed 1).

Date / time

@date
@date DD-MM-YYYY
@time
@time 12h
@time 24h
  • @date with no pattern uses the system regional short date.
  • Custom patterns use tokens such as YYYY, MM, DD.
  • @time defaults to 24-hour; use 12h or 24h.

Image

@image logo.png
@image ${LogoPath} width=50% align=center

Barcode

Native (printer draws barcode via ESC/POS):

@barcode CODE128 ${OrderId}
@barcode UPC-A 012345678905
@barcode ITF 12345678 height=80

Raster (bitmap). Raster barcodes stretch horizontally to full paper width; height follows height.

@barcode RASTER CODE128 ${OrderId}
@barcode RASTER CODE93 ABC-1234
Native symbologyNotes
CODE128Alphanumeric
EAN13, EAN8Numeric
CODE39Alphanumeric
UPC-A, UPC-ENumeric
ITFInterleaved 2 of 5; even digit count
CODABARNumeric + A-D start/stop
Raster-onlyUse RASTER prefix
CODE93, CODE11No native ESC/POS in firmware
AttributeDescription
heightHeight in dots (default 64)
alignleft, center, right
show_textNative only: human-readable text under barcode

QR code

Native (ESC/POS QR, model 2):

@qr https://example.com/${Id}
@qr ${Url} size=6 ecc=H align=center

Raster (bitmap; QR versions 1–40):

@qr RASTER https://example.com/${Id}
@qr RASTER ${Url} version=5 scale=4 ecc=M
AttributeNativeRaster
sizeModule dot size 1–16—
scale—Pixels per module (default 4)
version—QR version 1–40 (optional)
eccL, M, Q, HSame
alignleft, center, rightSame

---

Parameters

${ParameterName} in text, barcode data, QR data, or image paths.

  • Same name → one input at print time (GUI or CLI).
  • CLI requires every parameter via --set Name=Value.

---

Example receipt

# ${StoreName}
:center:

Receipt: ${DocumentNumber}
@date
@time

@barcode CODE128 ${DocumentNumber}
@qr RASTER https://shop.example.com/r/${DocumentNumber} scale=4

@feed 4
@cut

---

GUI printing

1. Print → enter parameters → choose a printer → Print.

Printers may appear as:

  • USB printer-class devices (direct bulk OUT)
  • Windows spooler queues (Windows)
  • Serial / USB-serial ports (COMx, /dev/ttyUSB0, …)

Linux serial: join the dialout group.

---

CLI

posprint print receipt.pos -p COM3 --set StoreName=Shop
posprint cli-help

-p accepts a serial port name, USB device label from discovery, or (on Windows) a spooler queue name. See platform CLI help via posprint cli-help.

---

.pos file format

JSON with version, metadata, and body (template source). See FILE-FORMAT.md.

Source
1# posprint Help
2
3Built-in reference for the template editor and POS markup language.
4
5---
6
7## Application tabs
8
9| Tab | Purpose |
10|-----|---------|
11| **Design** | Side-by-side template editor and live preview |
12| **Help** | This documentation |
13
14## Toolbar actions
15
16| Action | Description |
17|--------|-------------|
18| **New** | Empty template with defaults |
19| **Open** | Load a `.pos` file |
20| **Save / Save As** | Write `.pos` file (metadata + body) |
21| **Insert** | Images, barcodes, QR, date/time, parameters, `@feed`, `@cut` |
22| **Print** | Enter parameters, pick a printer, send ESC/POS bytes |
23
24While the Print dialog is open, the rest of the UI (including editor autocomplete) is disabled so parameter fields keep focus.
25
26## Editor assistance
27
28- Type `@` at the start of a line for **directive autocomplete** (`feed`, `cut`, `image`, `barcode`, `qr`, `date`, `time`).
29- Use **Insert → Barcode / QR code** to pick native or raster type before inserting a snippet.
30
31## Page settings
32
33| Setting | Description |
34|---------|-------------|
35| **Page width (mm)** | Paper width — match your physical roll (e.g. `53`, `58`, `80`) |
36| **Preview zoom** | Screen zoom; `100%` is calibrated to typical receipt width on screen |
37
38Preview width and text use the same calibrated screen scale. Preview font size is bumped to match printed Font A. Blank lines / `@feed` use the same line spacing as printed text. Heading `#` uses double width/height like GS `!` on the printer; `##` uses bold only.
39
40If the document does not end with `@cut` (ignoring blank lines after it), a red warning appears next to **Help**.
41
42---
43
44## Template language
45
46A template is plain text: paragraphs, headings, lists, checkboxes, directives, and `${parameters}`. There is **no** inline bold/italic/code markup — asterisks and backticks print literally.
47
48### Paragraphs
49
50Consecutive non-empty lines form one paragraph.
51
52### Headings
53
54```markdown
55# Large heading
56## Bold heading
57```
58
59### Alignment
60
61`:left:`, `:center:`, or `:right:` before a paragraph.
62
63### Bullet lists
64
65```markdown
66- first item
67- second item
68```
69
70Long items wrap with a hanging indent (printed/previewed as ASCII `*`):
71
72```text
73* this is a
74 long line
75```
76
77### Parameters
78
79| Syntax | Effect |
80|--------|--------|
81| `${Name}` | Parameter (filled at print time) |
82
83### Checkboxes
84
85Inline checkboxes use ASCII so they print correctly on CP437 ESC/POS printers (same font as surrounding text):
86
87| Syntax | Result |
88|--------|--------|
89| `[]` or `[ ]` | `[ ]` |
90| `[x]` or `[X]` | `[x]` |
91
92```markdown
93[] Unchecked
94[ ] Also unchecked
95[x] Done
96```
97
98Unicode ballot boxes and custom bit-images are not used: UTF-8 becomes garbage/CJK on CP437 printers, and ESC `*` / ESC `&` graphics often leave the text line on micro-printers.
99
100### Horizontal rule
101
102```markdown
103---
104```
105
106### Comments
107
108```markdown
109<!-- not printed -->
110```
111
112---
113
114## Directives
115
116Directives start with `@` at the beginning of a line.
117
118### Paper feed / cut
119
120```markdown
121@feed 3
122@cut
123```
124
125Blank lines in the editor also feed one line (same as `@feed 1`).
126
127### Date / time
128
129```markdown
130@date
131@date DD-MM-YYYY
132@time
133@time 12h
134@time 24h
135```
136
137- `@date` with no pattern uses the system regional short date.
138- Custom patterns use tokens such as `YYYY`, `MM`, `DD`.
139- `@time` defaults to 24-hour; use `12h` or `24h`.
140
141### Image
142
143```markdown
144@image logo.png
145@image ${LogoPath} width=50% align=center
146```
147
148### Barcode
149
150**Native** (printer draws barcode via ESC/POS):
151
152```markdown
153@barcode CODE128 ${OrderId}
154@barcode UPC-A 012345678905
155@barcode ITF 12345678 height=80
156```
157
158**Raster** (bitmap). Raster barcodes stretch horizontally to full paper width; height follows `height`.
159
160```markdown
161@barcode RASTER CODE128 ${OrderId}
162@barcode RASTER CODE93 ABC-1234
163```
164
165| Native symbology | Notes |
166|----------------|-------|
167| `CODE128` | Alphanumeric |
168| `EAN13`, `EAN8` | Numeric |
169| `CODE39` | Alphanumeric |
170| `UPC-A`, `UPC-E` | Numeric |
171| `ITF` | Interleaved 2 of 5; even digit count |
172| `CODABAR` | Numeric + A-D start/stop |
173
174| Raster-only | Use `RASTER` prefix |
175|-------------|---------------------|
176| `CODE93`, `CODE11` | No native ESC/POS in firmware |
177
178| Attribute | Description |
179|-----------|-------------|
180| `height` | Height in dots (default `64`) |
181| `align` | `left`, `center`, `right` |
182| `show_text` | Native only: human-readable text under barcode |
183
184### QR code
185
186**Native** (ESC/POS QR, model 2):
187
188```markdown
189@qr https://example.com/${Id}
190@qr ${Url} size=6 ecc=H align=center
191```
192
193**Raster** (bitmap; QR versions 1–40):
194
195```markdown
196@qr RASTER https://example.com/${Id}
197@qr RASTER ${Url} version=5 scale=4 ecc=M
198```
199
200| Attribute | Native | Raster |
201|-----------|--------|--------|
202| `size` | Module dot size 1–16 | — |
203| `scale` | — | Pixels per module (default `4`) |
204| `version` | — | QR version 1–40 (optional) |
205| `ecc` | `L`, `M`, `Q`, `H` | Same |
206| `align` | `left`, `center`, `right` | Same |
207
208---
209
210## Parameters
211
212`${ParameterName}` in text, barcode data, QR data, or image paths.
213
214- Same name → **one input** at print time (GUI or CLI).
215- CLI requires **every** parameter via `--set Name=Value`.
216
217---
218
219## Example receipt
220
221```markdown
222# ${StoreName}
223:center:
224
225Receipt: ${DocumentNumber}
226@date
227@time
228
229@barcode CODE128 ${DocumentNumber}
230@qr RASTER https://shop.example.com/r/${DocumentNumber} scale=4
231
232@feed 4
233@cut
234```
235
236---
237
238## GUI printing
239
2401. **Print** → enter parameters → choose a printer → **Print**.
241
242Printers may appear as:
243
244- **USB printer-class** devices (direct bulk OUT)
245- **Windows spooler** queues (Windows)
246- **Serial / USB-serial** ports (`COMx`, `/dev/ttyUSB0`, …)
247
248**Linux serial:** join the `dialout` group.
249
250---
251
252## CLI
253
254```bash
255posprint print receipt.pos -p COM3 --set StoreName=Shop
256posprint cli-help
257```
258
259`-p` accepts a serial port name, USB device label from discovery, or (on Windows) a spooler queue name. See platform CLI help via `posprint cli-help`.
260
261---
262
263## `.pos` file format
264
265JSON with `version`, `metadata`, and `body` (template source). See [FILE-FORMAT.md](FILE-FORMAT.md).