s1kd-uom Description khzae.net khzae.net All Add --xml-catalog parser option. The s1kd-uom tool converts between specified units of measure in quantity data, for example, to automatically localize units of measure in data modules. s1kd-uom [-dflqv,.h?] [-D <fmt>] [-F <fmt>] [-u <uom> -t <uom> [-e <expr>] [-F <fmt>] ...] [-s <name>|-S <path> ...] [-U <path>] [-p <fmt> [-P <path>]] [<object>...] -D, --duplicate-format <fmt> Specify a custom format for duplicating quantities (-d). The '%' character acts as a placeholder for the duplicate quantity value. The default format for -d is equivalent to -D ' (%)'. -d, --duplicate When converting, instead of overwriting the original quantity, include the converted quantity after the original in parenthesis. For example, "200 mm" when converting mm to in would become "200 mm (7.87 in)". -e, --formula <expr> Specify the formula for a conversion, given as an XPath expression. -F, --format <fmt> Specify the format for quantity values. When used before -u, this specifies the default format for all conversions. Otherwise, this specifies the format for each individual conversion. Formats specified for individual conversions override the default format set for all conversions. -f, --overwrite Overwrite input CSDB objects. -h, -?, --help Show help/usage message. -l, --list Treat input (stdin or arguments) as lists of filenames of CSDB objects to list references in, rather than CSDB objects themselves. -P, --uomdisplay <path> Use a custom .uomdisplay file. -p, --preformat <fmt> Preformat quantity data to the specified decimal format. The built-in formats are: SI - comma for decimal separator, space for grouping euro - comma for decimal separator, full-stop for grouping imperial - full-stop for decimal separator, comma for grouping -q, --quiet Quiet mode. Errors are not printed. -S, --set <path> Apply a set of conversions defined in an XML file. -s, --preset <name> Apply a set of predefined conversions. The available presets are: SI - convert imperial/US customary units to SI units.imperial - convert SI units to British imperial units.US - convert SI units to US customary units. -t, --to <uom> Unit of measure to convert to. -U, --uom <path> Use a custom .uom file. -u, --from <uom> Unit of measure to convert from. -v, --verbose Verbose output. -,, --dump-uom Dump the default .uom file. -., --dump-uomdisplay Dump the default .uomdisplay file. --version Show version information. <object> CSDB objects to convert quantities in. In addition, the following options allow configuration of the XML parser: --dtdloadLoad the external DTD.--hugeRemove any internal arbitrary parser limits.--netAllow network access to load external DTD and entities.--noentResolve entities.--parser-errorsEmit errors from parser.--parser-warningsEmit warnings from parser.--xincludeDo XInclude processing.--xml-catalog <file>Use an XML catalog when resolving entities. Multiple catalogs may be loaded by specifying this option multiple times. This file contains the rules for converting units of measure. If no specific conversions are given with the -u and -t options, this file also acts as a list of all conversions to perform. By default, the program will search the current directory and parent directories for a file named .uom, but any file can be specified by using the -U option. Example of a .uom file: <uom> <convert from="degF" to="degC" formula="($value - 32) * (5 div 9)"/> <convert from="in" to="cm" formula="$value * 2.54"/> <convert from="lbm" to="kg" formula="$value div 2.205"/> </uom> The tool contains a default set of rules for common units of measure. This can be used to create a default .uom file by use of the -, option: $ s1kd-uom -, > .uom To select only certain common rules when generating a .uom file, the -u and -t options can be used: $ s1kd-uom -, -u in -t cm -u degF -t degC > .uom This will generate a .uom file containing rules to convert inches to centimetres, and degrees Fahrenheit to degrees Celsius. The same file format is used with the -S option to specify a set of conversions to perform. In this case, the attribute formula is optional, as the default formula or the formula in the .uom file will be used if it is not specified. When specifying a formula for conversion, the following variables can be used: $pi The constant π $value The original quantity value For example, the formula to convert degrees to radians can be given as follows: $value * ($pi div 180) The tool can also convert semantic quantity data to presentation quantity data. The -p option specifies which conventions to use for formatting quantity values. For example: <para>Tighten the <quantity> <quantityGroup> <quantityValue quantityUnitOfMeasure="cm">6.35</quantityValue> </quantityGroup> </quantity> bolt.</para> $ s1kd-uom -p SI <DM> <para>Tighten the 6,35 cm bolt.</para> This can also be combined with UOM conversions: $ s1kd-uom -u cm -t in -p imperial <DM> <para>Tighten the 2.5 in bolt.</para> Custom formats for values or UOMs can be defined in the .uomdisplay file. By default, the tool will search the current directory and parent directories for a file named .uomdisplay, but any file can be specified by using the -P option. Example of a .uomdisplay file: <uomDisplay> <format name="custom" decimalSeparator="," groupingSeparator="."/> <uoms> <uom name="cm"> cm</uom> <uom name="cm2"> cm<superScript>2</superScript></uom> </uoms> <currencies> <currency name="CAD"> <prefix>$</prefix> <postfix> CAD</postfix> </currency> <currency name="GBP"> <prefix>£</prefix> <postfix> GBP</postfix> </currency> </currencies> </uomDisplay> Units of measure and currencies that are not defined will be presented as their name (e.g., "cm2") separated from the value by a space. More complex UOM display, such as pluralization of units of measure, can be accomplished with embedded XSLT in the .uomdisplay file: <uoms xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:variable name="value" select="parent::*/> <uom name="in"> <xsl:text> </xsl:text> <xsl:choose> <xsl:when test="$value = 1">inch</xsl:when> <xsl:otherwise>inches</xsl:otherwise> </xsl:choose> </uom> <uom name="ft"> <xsl:text> </xsl:text> <xsl:choose> <xsl:when test="$value = 1">foot</xsl:when> <xsl:otherwise>feet</xsl:otherwise> </xsl:choose> </uom> </uoms> The context for the embedded XSLT is the unit of measure attribute on the value, tolerance or group. XSLT elements in the <uoms> element will be processed for all units of measure, while XSLT elements in <uom> elements will only apply to an individual unit of measure. The tool contains a default set of formats and displays. These can be used to create a default .uomdisplay file by use of the -. option: $ s1kd-uom -. > .uomdisplay Input: <quantity> <quantityGroup> <quantityValue quantityUnitOfMeasure="cm">15</quantityValue> </quantityGroup> </quantity> Command: $ s1kd-uom -u cm -t in <DM> Output: <quantity> <quantityGroup> <quantityValue quantityUnitOfMeasure="in">5.91</quantityValue> </quantityGroup> </quantity> Input: <quantity quantityType="qty02" quantityTypeSpecifics="CAD">10.00</quantity> Command: $ s1kd-uom -u CAD -t USD -e '$value div 1.31' -F '0.00' Output: <quantity quantityType="qty02" quantityTypeSpecifics="USD">7.36</quantity> Markup element: <uom> Attributes: format (O), the number format for all rules. Child elements: <convert> The element <convert> defines a rule to convert one unit of measure to another. Markup element: <convert> Attributes: format (O), the number format for this specific rule. formula (M), the expression used to convert the quantity value. from (M), unit of measure to convert from. to (M), unit of measure to convert to. Child elements: None Markup element: <uomDisplay> Attributes: None Child elements: <format> <groupTypePrefixes> <wrapInto> <uoms> <currencies> Markup element: <format> Attributes: name (M), the name of the format decimalSeparator (M), the decimal separator groupingSeparator (M), the grouping separator Child elements: None The element <groupTypePrefixes> specifies prefixes which are added for specific group types. Markup element: <groupTypePrefixes> Attributes: None Child elements: <nominal>, text placed before a nominal group. <minimum>, text placed before a minimum group. <minimumRange>, text placed before a minimum group that is followed by a maximum group to specify a range. <maximum>, text placed before a maximum group. <maximumRange>, text placed before a maximum group that is preceded by a minimum group to specify a range. Markup element: <wrapInto> Attributes: None Child elements: The element <wrapInto> contains one child element of any type, which quantities will be wrapped in to after formatting. Markup element: <uoms> Attributes: None Child elements: <uom> The element <uoms> may also contain arbitrary XSLT elements which will be processed for all units of measure. Markup element: <uom> Attributes: name (M), the name of the UOM. Child elements: The element <uom> may contain mixed content, which will be used for the display of the unit of measure. This can include XSLT elements, which allows for handling complex cases of UOM display, such as pluralization. Markup element: <currencies> Attributes: None Child elements: <currency> The element <currencies> may also contain arbitrary XSLT elements which will be processed for all currencies. Markup element: <currency> Attributes: name (M), the name of the currency. Child elements: <prefix>, text placed before the currency value. <postfix>, text placed after the currency value. The child elements of <currency> may contain mixed content, which will be used for the display of the unit of measure. This can include XSLT elements, which allows for handling complex cases of currency display.