[image]

Include an image in the document loaded from a URL source - for example from a web server of file system.

Parameters

Parameter	Description
`url`	Required, a text value specifying the URL of the image to be embedded in the document. Urls can follow the http, https or data schemes.
`width` / `w`	Optional parameter, specified the output width of the image. May be specified in printer dots, mm or as a percentage of the printable width.
`min-width`	Optional parameter, minimum allowed width for the image. May be specified in printer dots, mm or as a percentage of the printable width.

Image Scaling

Images may be resized for output based on the values of the width and min-width properties, as well as the printable area of the printer, and pixel size of the source image.

If width/min-width are not specified, then the standard behavior to not apply any resizing to the image, instead it will be printed dot-for-dot on the output device, matching pixels to printer dots.

Exceptions to this rule can occur if:
- The image pixel width exceeds the available print width, and the markup rendered has been instructed to scale output documents to fit the page.
  
  In this case, the image well be resized as if the width parameter was set to “100%”.
- The output printer printing resolution does not provide a 1/1 (square pixel) aspect ratio. In this case, the image will match the output device resolution horizontally, but will be scaled vertically to preserve aspect.
If a width (or shorthand w ) parameter is provided, then the image will always be resized to the requested width.
if a min-width parameter is provided, then the image will be resized according to the above rules, unless the resulting image would be below the requested minimum size.

In this case, the image width will be set according to the min-width value.

Note

Image resizing will always preserve the aspect ratio of the source image, which is why only horizontal scaling parameters are provided.

Color/Grey-scale Output

Dithering will be performed to reduce colors/gray levels to match the output device.
f it is desired to avoid dithering then it is recommended to use a monochrome source image.
However, it is not recommended to pre-dither images unless care is also taken to ensure that the images will not resized (set the width property to match the pixel width of the source image) since resizing an already dithered image will usually conflict with the dither pattern.

Recommended Sizing Pattern

In order to get expected output from the full range of output devices -including high resolution thermal printers with support for paper widths from 58mm (2”) to 112mm (4”) and lower resolution dot-matrix printers, with half-dot pixel support- it is recommended to use the following pattern where possible:

Specify the width parameter as a percentage value.

This will then be calculated at print time as a percentage of the printable width available to the printer, and will resize automatically to fit the page.
If the width is specified as something other than 100%, the set the min-width property to a millimeter based size, choosing the size that provides the best results on the narrowest supported printer (usually a 58mm/2” model).

In most cases Star would recommend setting this to 48mm, which is the default printable area on 58mm paper.

For example:

[image: url https://www.star-emea.com/logo.png; width 60%; min-width 48mm]

Line Feed

After printing an image, the print position will move automatically to the next line below the image.

Therefore, it may be preferable to put a \ character immediately after an image command (if it is on a single line of the input data) to escape a subsequent line feed and avoid double spacing.

For example:

[image: url http://site.com/image.png]This is the next Line

is equivalent to:

[image: url http://site.com/image.png]\
This is the next Line

but, the following would cause a line feed between the image and text line.

[image: url http://site.com/image.png]
This is the next Line

Embedding Image Data

It is possible from version 1.1.0 to embed image data directly into the markup file by using the DataURL scheme .

Data URLs can contain any base64 encoded image that is supported by the markup renderer, such as image/jpeg or image/png.

For example:

[image: url "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAAAjCAIAAADt3TjXAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxMAAAsTAQCanBgAAA0GSURBVGhD7ZoJXM/3H8e7DyWpdBBSk9jjH0lbNMe08nct0jFUmDDib/wxozRmjszRHF2G0kjJ5s7i79gsOeb821zlvnObs/k/f7/Pt0+/Di2Lx47H//X4PHh/3p/j+/m8P+/zh/azZ8+0qoaLFy+dO3dO0C4ujczMzA4cOPD48RO6xsZGrq6uYujvAIRVRXz22VQtLT3R1q/f8PDhQxubOqLr5NRImfRXxq+//ioIHUVmVYCOTvEmurq6WlrauroKR08Pkf218fjx47i4BEG/BGGVB23l77840Kbhw0fs3btXdF+RsP4mSEr6skmTxmpzUeH/wnouvvvu+yNHjoSE9Ea/BOcVCauqEfYPx6lTebNmzZ40aeLHH48PCgoUzD+XzyosLLx7925BQcHVq1cLCm5Aw1HGqgwU5N69e+fPn8/NzX306JHCLQ/379+Pipowc+aMFStWODk5+vi8I/jlRCvOd+XKlSNH/nvz5s2Kr21paeHt3V7plICiWXfu3ElOThG0QNu2bRwcHJROEYjNJ06czMhYmZW16fjxE7dv34aDpyBla9zYxdf3neDgICcnJ23tcg7z9OnTb7/NFpevX79+8+ZuP/yQc+7ceboE5R49/FmF0NetW5+evjInZ9e1a9dMTU2PHz9qY2Oj3qA0uP7IkaPCw/vn5eUfPHh43rzY4u+q8ocicMTdu/d07dqtWjUzkShV3N58sxVnnTp1uuRw24cPH9WuXU9ySrUVK9KVjxXh1KlTYWH9jIxMSs3UbJynb9/38/PzlTUaQLK2tvZiWnj4IDiBge+JrrGxKao0b958BwcnwRHNxKRGQkLStGnTMbHBgyN27coVWwnMmjVn5szZx44d9/XtiI4rXDWKzZBOQkJi27bt165d98svvyjcClHeS/8GNLWDN1ywIN7Do2VKylJErHDLA+dZsiTF09MrMXFhKcNkQ7mljo6K0tADrXbtvIcOHX769BnBQadatvQcPnwYhLu7+3vvBaGSZ84oowAlvXjxYlhY6Nix42JjZ1lYWCgDaiBpBcz78MORjx49Fl2OYGhoqJlwloWBgSF/MqdatWqCo8YzAwP9khyJZ/JmqGRUVPSMGTM1L29sbOzgUB/Tq17dDJU5duxYfv5pSgIxeuXK1SFDhnKZqKjxMpxXABbu3bsPgo82bPjagAH9sco6dergvI8ePXrgwEHME/Pv1KmjmH/06E/z58d9+WXi6NFj+vQJdXFxEfxiCAXDpTk7NxZaamhoEhIShn799NPPeJAK2tmzZ1l748YNyWEfbDkvL09ySjXOxxLmTJz4qY6OgfgiDVMaM2Ysd0CI6hOpAH3w4CH41ta15Uw9PaOYmBmIWMzBLdrZKWY4cOAHcIKCFDMUzdHRGf29d+8+S3BYhA7CnJ9f90aNXkf0q1evuXXrlthqxIh/p6Yu+/HH/a1bt3vw4IFgakJRnA0bsrgJBI8wYULk0qXJXl6tMHiMtgLcvn2HLSgIMBM1VAdiE6VXDu5zf/XnNlJRIjLVt7W0fH199uzZNX36VDs7O4YiIydERAyLjv4EGkWDv3PnDm/vt8VkdoiMjGZIdCsAKt+/f799+3IHDRpw6NChgIBgF5fX3323Ow82Zsyo7OyNXbp0xvNs3bqNk+Xm7h4xYjgu1dbWBlNNS0tXdtGEkNmoUWPEO1hY1CIIopwNGrwmH+d5TTj4KVOmSQ53QPnlU5dtnIb9nZ2bSE63bv5oB74jPj7B3r6+5IvGMeLjExllTufO70q+m5sHWszJn6dZRIw5c77g8S5dutS3b38DA9yCshbT6drV7403WhIiFyyIW7YsbfToj0JC+vj7B/CJQYMG4wG6dPG7cOGiWjbFUIRFrBEbOTk58+BpaSvk1hU0T8/nRcO6klOqpadnTJ8eI7v47Fu3bnNhDqetrS/5mg1+r14hPD5G5OrqJpkIkZOXKyzEsXJlJjTisLMrfRhLSxvcX3Ly0oULF+GkiJ5cgX2wldOnTy9btpwAnZOT07t36JMnT1TSKYJihjVr1hQE73DixAnsolmzZoJTAX7HT2HYbEZGpqBx0p9+OtHMrPpHH33MrTiN4JcC/OXLV6D7lpaWJIrCtcNMSlrIbmJOSWh//nmMv393/FFwcC9uJLhEQBx8amry999vI0PU10dwAM/4JCJicETEv/DU5A3kX7Vq1fL09GzcuDFPq55TBJXE1C8gBR8YGIzaI12CumTSOnXqkpm5atWqr2XD2lHDCvIsKyvbpUu/Sk1VGvSaNWulRbRv78PTZWdv1tc3Fhxa8+YevDabx8bOdXd/Q/KZs3nzFuZ7e/tKDhGtrGZR/aLvnM3U1FzwUcOAgCDclrisABqEZm3btv3SpcskXHwOp75//4HZs2PZB2fPBGStaYyKsJBO06bNxdYEKfwrruf69YKePUNkzEK3UQHsWSyRqEBY9es7Ik1lnhqJiUlyMjQcTU/k5+cvwqUAtI/PP+VoaGgfmGQbkhMXF19WWEiKa+PL5TRujg6qtyyGEBYEEXDcuEhWCT7gzGfOnF20aHFQUM8BAz6QxqgIC2zfvkMm7jwFlo9h8w3SWQsLa/lhDw/PUk9Ugc8qKyxSOTHEJ0gLcPaWlsrmZmY1yaGUeUUgRhsZmYoJ9vYOSAFdEF3asGHDywoLzJ07j/0Fk8cgeRR8TQhh7djxXXBwTxEryoLDX7hwQQq6OOds06b13Lmx+vp8QyVBKikvrzacbOTID3fs2NqiRQsxbc+evW+//Y5wn4LzQsBJC8LExMTGxhrpkAEJDj7C2hrBlYCjY4OmTZVf8VHqq1ev1a1rL3+AvXbtuiA0gY4QB8XxcIgLFyaQJIuhUrh8+fLMmbO49XNSaFUiVbt2bSETUCJB79evT1zcfLny5MmT3bsHoDikv5s2baCaFfl3QcENAi3+S0wrD0UVRxlIEYutNCVOWiSYmoBDISFo3rmw8Kmenr6sK/DNgtDEvn0/yvqmb98+tra2gi6LJUuSY2Km4c6V/m+hhLA42fvv983KWo90BAf9JEVEk4ncKSmLo6Mjxavi48LDB1Lfi2mVh6y22BmhcxNKHMH5+edjJNOCrgpycnbJEoq0UxBlgdC/+GKOs7Oz0q8ESggLIK/Wrd8iYw4NxbWrRnlPwpCPTwcqtaioyMmTJ4ngTfpOyS4Lt5J4roVS9wmCbbFosgF3dwKLCvgv4YlF93cjPz9fEJy/RQt3QZeFn1/Xjh2JHi8ARViYA9/A7gTwDuPGjfXzI04p4NnRLzL7UaNGduum8A8dOpydvUXQ5YI4ApSOGuQv0gVkZKxEBYYOHSKr4pSU1M6duy5fnrZz5w+bN28mtqDCYqjyoFYVRHXKcTNCVvkwMCDKvyAQE0BBiPdEw6JWnaari7NQBRTZ3NxaYClU58bG1QWHoBsT87mc8M03qzWjISGpZcu3evQIFM3fP3DLlv/ILJxECaEgr169QgVHNvIV1nISwl+bNlSFKqaJSQ1KdIK6zNTInspGQ7mbubmlZkJQdRSb4ZMnsh4GD2jS8iXI2bZs2ers3NDCQsn4iW5WVpaCBsQXXV0d6TL5AB4kM/Nr0Ug1KSnIrcUoSodDxO5iY2e1akUCXAyRcECIP/8kKBYWx1Oo56NevboeHirlun9f+XXQysqK0C7D09at24kAw4YNLRvXJAYP/oB9BE1qQgJsZlYjOztr4sRoIr3g/zmBuqr/0tNPSoqv2Lnq6up5ebW0s7Mjl8OpCSYO29XVFSbJG13MEO0jBaH4SktLx0Y0hYaWUHlZW9eaNm1KWFg/YSOLFyeTqScmxk+YEBke3n/jxo25ubuprlFe3PPv8SyvDhy38uDyVF41a1oJp1CjhiV2Bz8qKlpwaHXq1KNQwNzEEk0I4wIYuEzlRXN0dCY/xKjFBAlmVsFnWb1cn6X8Lxp0iuTgzp27QoLlAhdz/vwFDieWgKio8ZMmfQJx48bNpk3dGBV8bJAEvUEDBzIDintNtzN+/Nh27dpBEOYGDRqSkrJU7gZMTU3d3Jq5uv6DKIaxnzqVt3r1qg4dOlGUMMqehw/vR8EbNnQRRhAQ4L9o0cJGjZpQDNMdODA8ISGud+8wShm65uY1rl+/UpkfoCsLlcTU0bBWLTJd1YNUsnEHzd9ed+/eI/+VpYKWnp6hLHj2DOlPnjxFln5lG9GQWPOimiV/Vn6F0bDywI9ERAzJzMwwMjJSWFpaOP7c3J2keRW49lIgFJDNsapDB9/Kr/pNyGjz0sELqMAHSEFlTVsuuE61aiZ49O7du2FiZa9Xr1699evXkIWtXbuOzFZGTE3Y26MFxWAT4sPGjetw6qmpX2VlbcrLy+cNi0ZVE7y921PN0jU0NOAApCaBgT0KC1W/3/NCSJyTExDourur8nUvLy+WQhgbG73ENwAv4X/+vURgNVjZrVs3nz4txNmZm5s7OjoqY384tLT+ByMSArlipQ8SAAAAAElFTkSuQmCC"]

[cut]

Using a local file as an image source

It is possible to embed image data directly into markup from an image stored on the server side.

For example:

[image: url "file:\\\c:Users\\Star\\Pictures\\image.png"]

Example

Markup

This is a simple markup example, demonstrating a middle aligned image with scaling to fit the page.

[align: centre]\
[image: url https://star-emea.com/wp-content/uploads/2015/01/logo.jpg; width 80%; min-width 48mm]\

Image Printing Example

[cut: feed; partial]

Output at 58mm

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

Output at 80mm

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