Printing Text Definitions

From PartKeepr Wiki
Revision as of 22:39, 27 January 2013 by Boldie (talk | contribs) (Boldie moved page Printing:Text Definitions to Printing Text Definitions over redirect)
Jump to: navigation, search

For a flexible rendering, we support replacing texts in the predefined text strings for the renderer. This is available to every renderer as a special class (PartKeepr\Printing\Utils\Placeholder) for Plugin developers. For users this has the advantage to alwayse have the same codewords which will be replaced. However the surrounding is dependent on the plugin. For e.g. for the DefaultPDFRenderer these surrounding is a !! , so a replacment looks like !!id!!.

Replacements for Parts

Codeword Description
id The internal id of the database. E.g. 5
name The name of the part.
internalNumber The internal part number field.
description The description for the part.
categoryFull The category including its path as you can see it in the parts list.
categoryLast Only the last (right) part of the category.
footprintName The name of the footprint
storageLocationName The name of the storage location

Replacement for Storage Locations