Star Document Markup Manual Ver. 2.1.0

Last update: March 10, 2025

Getting Started Overview Quick Start Specifications Tag References FAQs

Copyright 2023, Star Micronics Co., Ltd..

Table of Contents

■ Getting Started
■ Star Document Markup Overview
■ Quick Start
■ Star Document Markup Specifications
■ Tag References

Star Document Markup Guide
  • Tag reference
    • [align]
    • [barcode]
    • [bold]
    • [buzzer]
    • [column]
    • [comment]
    • [cut]
    • [drawer]
    • [feed]
    • [fixedWidth]
    • [font]
    • [image]
    • [invert]
    • [linespacing]
    • [logo]
      • Parameters
      • Device support
      • key parameter for StarPRNT Mode Thermal printers
      • key parameter for Star Line Mode Thermal printers
      • Line Feed
      • Example
        • Markup
        • Output at 58mm
        • Output at 80mm
    • [magnify]
    • [negative]
    • [plain]
    • [space]
    • [templateArray]
    • [underline]
    • [upperline]

■ FAQs

Star Document Markup Guide
  • »
  • Tag reference »
  • [logo]

[logo]

Print a logo stored in printer memory.
This tag should be used at the beginning of a line.
If data exists before this command, the logo may be truncated or not printed at all.

Parameters

Parameter

Description

key / id

Specify the name/key/id of the logo to be printed.
Range and format depends on the target device.

s

Shorthand for scale .
Magnifies both width and height using a single value.

scale

Magnifies both width and height using a single value.

sh

Scale vertically only.

sw

Scale horizontally only.

Device support

Not all output device have support for printing stored logos, in this case the [logo] command will be ignired.
Other devices have different methods of referencing to internally stored logos, which had a potential to cause incompatibility between devices. In this case, where possible a mapping is supported.
For best compatibility it is recommended to use a key value from 01 to 99 for printing logos.
If more than 99 logos are needed then check the rules below.

key parameter for StarPRNT Mode Thermal printers

Printers based on teh StarPRNT command language can use a two (Ascii compatible) character key for storing and printing logos.
For example “00”, “01”, ” 1”, “ab”, “h5”, “$*”, ” ” are all legal logo keys.
which allows for a very large number of stored logos.
Since StarPRNT devices require a two character Logo key, if a single character key is used (e.g. “1”), then a “0” will be added at the beginning of the key.
For example “1” would be the same as a key “01”.

key parameter for Star Line Mode Thermal printers

Star Line mode based printers support up to 255 logos, and therefore the key value may be any integer from “1” to “255”.
values from “01” to “99” can be supported by both devide types.
For values beyond “99” a two character mapping scheme is supported which allows the use of a StarPRNT style two character key value to print all 255 possible logos.
For details of the mapping scheme, please rever to Appendix section 5.8 of the Star Line Mode command manual.

Line Feed

After printing a logo, the print position will move automatically to the next line below.
Therefore, it may be preferable to put a \ character immediately after a logo command (if it is on a single line of the input data) to escape a subsequent line feed and avoid double spacing.
For example:
[logo: key 01; s 1]This is the next Line
is equivalent to:
[logo: key 01; s 1]\
This is the next Line
but, the following would cause a line feed between the logo and text line.
[logo: key 01; s 1]
This is the next Line

Example

Markup

This is a simple markup example, using the [logo] and [cut] commands.

Logo Example

Prints logo 01 at the standard size.
[logo: key 01; s 1]\

Prints logo  AA (not supported by Star Line Mode devices)
[logo: key AA]\

Prints logo 01 with horizontal and vertical scaling
[logo: key 01; sw 2; sh 2]\

Prints logo " @" on StarPRNT printer models, or logo 132 on Star Line Mode models.
[logo: key " @"]\

[cut]

Output at 58mm

This is the result when using the markup processor to sent to an mC-Print2 58mm(2inch) printer.

../../_images/logo_58mm.jpg

Output at 80mm

This is the result when using the markup processor to sent to a TSP650II 80mm(3inch) printer.

../../_images/logo_80mm.jpg
Previous Next

© Copyright 2023, Star Micronics co., Ltd..

Built with Sphinx using a theme provided by Read the Docs.