BlueGit

timfa posprint

Files

posprint / docs / HELP.md

HELP.md

checkboxes
timfa Tim Falken · pushed by timfa · 4 months ago
00ee9454 History
HELP.md 6.7 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, ${text} / $[bool] parameters, and directives. 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

- Groceries
  - Milk
  - Eggs
- Wash car

Indent with two spaces (or a tab) per nesting level. Top-level items print as * ; nested items print as - with the same hanging wrap.

* Groceries
  - Milk
  - Eggs
* Wash car

Long items wrap with a hanging indent:

* this is a
  long line
  - nested item that
    wraps too

Parameters

SyntaxEffect
${Name}Text parameter (filled at print time)
$[Name]Checkbox parameter → [ ] or [x]

${Name} and $[Name] must not share the same name.

Checkboxes

Inline checkboxes use ASCII brackets plus a CP437 check mark so they print in the native font:

SyntaxResult
[] or [ ][ ]
[x], [X], or [x][x] (CP437 x)
[] Unchecked
[ ] Also unchecked
[x] Done
$[Paid]

$[Paid] is a parameter: in the Print dialog it is a true/false checkbox; on the receipt it becomes [ ] or [x]. CLI: --set Paid=true.

Unicode ballot boxes are not used (they become CJK garbage on CP437 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

FormTypePrint dialogCLI
${Name}texttext field--set Name=Value
$[Name]boolcheckbox--set Name=true / false (also 1/0, yes/no)
  • Same name must not appear as both ${…} and $[…].
  • GUI and CLI require every parameter; bools default to unchecked (false) in the dialog.
  • Usable in text; ${…} also in barcode/QR/image paths ($[…] is text-inline only).
# ${StoreName}

$[Paid] Paid in full
[] Pending review

Receipt: ${DocumentNumber}

---

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, `${text}` / `$[bool]` parameters, and directives. 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- Groceries
67 - Milk
68 - Eggs
69- Wash car
70```
71
72Indent with two spaces (or a tab) per nesting level. Top-level items print as `* `; nested items print as `- ` with the same hanging wrap.
73
74```text
75* Groceries
76 - Milk
77 - Eggs
78* Wash car
79```
80
81Long items wrap with a hanging indent:
82
83```text
84* this is a
85 long line
86 - nested item that
87 wraps too
88```
89
90### Parameters
91
92| Syntax | Effect |
93|--------|--------|
94| `${Name}` | Text parameter (filled at print time) |
95| `$[Name]` | Checkbox parameter → `[ ]` or `[x]` |
96
97`${Name}` and `$[Name]` must not share the same name.
98
99### Checkboxes
100
101Inline checkboxes use ASCII brackets plus a CP437 check mark so they print in the native font:
102
103| Syntax | Result |
104|--------|--------|
105| `[]` or `[ ]` | `[ ]` |
106| `[x]`, `[X]`, or `[x]` | `[x]` (CP437 `x`) |
107
108```markdown
109[] Unchecked
110[ ] Also unchecked
111[x] Done
112$[Paid]
113```
114
115`$[Paid]` is a **parameter**: in the Print dialog it is a true/false checkbox; on the receipt it becomes `[ ]` or `[x]`. CLI: `--set Paid=true`.
116
117Unicode ballot boxes are not used (they become CJK garbage on CP437 printers).
118
119### Horizontal rule
120
121```markdown
122---
123```
124
125### Comments
126
127```markdown
128<!-- not printed -->
129```
130
131---
132
133## Directives
134
135Directives start with `@` at the beginning of a line.
136
137### Paper feed / cut
138
139```markdown
140@feed 3
141@cut
142```
143
144Blank lines in the editor also feed one line (same as `@feed 1`).
145
146### Date / time
147
148```markdown
149@date
150@date DD-MM-YYYY
151@time
152@time 12h
153@time 24h
154```
155
156- `@date` with no pattern uses the system regional short date.
157- Custom patterns use tokens such as `YYYY`, `MM`, `DD`.
158- `@time` defaults to 24-hour; use `12h` or `24h`.
159
160### Image
161
162```markdown
163@image logo.png
164@image ${LogoPath} width=50% align=center
165```
166
167### Barcode
168
169**Native** (printer draws barcode via ESC/POS):
170
171```markdown
172@barcode CODE128 ${OrderId}
173@barcode UPC-A 012345678905
174@barcode ITF 12345678 height=80
175```
176
177**Raster** (bitmap). Raster barcodes stretch horizontally to full paper width; height follows `height`.
178
179```markdown
180@barcode RASTER CODE128 ${OrderId}
181@barcode RASTER CODE93 ABC-1234
182```
183
184| Native symbology | Notes |
185|----------------|-------|
186| `CODE128` | Alphanumeric |
187| `EAN13`, `EAN8` | Numeric |
188| `CODE39` | Alphanumeric |
189| `UPC-A`, `UPC-E` | Numeric |
190| `ITF` | Interleaved 2 of 5; even digit count |
191| `CODABAR` | Numeric + A-D start/stop |
192
193| Raster-only | Use `RASTER` prefix |
194|-------------|---------------------|
195| `CODE93`, `CODE11` | No native ESC/POS in firmware |
196
197| Attribute | Description |
198|-----------|-------------|
199| `height` | Height in dots (default `64`) |
200| `align` | `left`, `center`, `right` |
201| `show_text` | Native only: human-readable text under barcode |
202
203### QR code
204
205**Native** (ESC/POS QR, model 2):
206
207```markdown
208@qr https://example.com/${Id}
209@qr ${Url} size=6 ecc=H align=center
210```
211
212**Raster** (bitmap; QR versions 1–40):
213
214```markdown
215@qr RASTER https://example.com/${Id}
216@qr RASTER ${Url} version=5 scale=4 ecc=M
217```
218
219| Attribute | Native | Raster |
220|-----------|--------|--------|
221| `size` | Module dot size 1–16 | — |
222| `scale` | — | Pixels per module (default `4`) |
223| `version` | — | QR version 1–40 (optional) |
224| `ecc` | `L`, `M`, `Q`, `H` | Same |
225| `align` | `left`, `center`, `right` | Same |
226
227---
228
229## Parameters
230
231| Form | Type | Print dialog | CLI |
232|------|------|--------------|-----|
233| `${Name}` | text | text field | `--set Name=Value` |
234| `$[Name]` | bool | checkbox | `--set Name=true` / `false` (also `1`/`0`, `yes`/`no`) |
235
236- Same name must not appear as both `${…}` and `$[…]`.
237- GUI and CLI require **every** parameter; bools default to unchecked (`false`) in the dialog.
238- Usable in text; `${…}` also in barcode/QR/image paths (`$[…]` is text-inline only).
239
240```markdown
241# ${StoreName}
242
243$[Paid] Paid in full
244[] Pending review
245
246Receipt: ${DocumentNumber}
247```
248
249---
250
251## Example receipt
252
253```markdown
254# ${StoreName}
255:center:
256
257Receipt: ${DocumentNumber}
258@date
259@time
260
261@barcode CODE128 ${DocumentNumber}
262@qr RASTER https://shop.example.com/r/${DocumentNumber} scale=4
263
264@feed 4
265@cut
266```
267
268---
269
270## GUI printing
271
2721. **Print** → enter parameters → choose a printer → **Print**.
273
274Printers may appear as:
275
276- **USB printer-class** devices (direct bulk OUT)
277- **Windows spooler** queues (Windows)
278- **Serial / USB-serial** ports (`COMx`, `/dev/ttyUSB0`, …)
279
280**Linux serial:** join the `dialout` group.
281
282---
283
284## CLI
285
286```bash
287posprint print receipt.pos -p COM3 --set StoreName=Shop
288posprint cli-help
289```
290
291`-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`.
292
293---
294
295## `.pos` file format
296
297JSON with `version`, `metadata`, and `body` (template source). See [FILE-FORMAT.md](FILE-FORMAT.md).