united

united

A package for easy typesetting of numbers with units.

This fork of the unify package, which was inspired by the siunitx package for LaTeX, aims to further enhance the functionality and usability of the original package.

Usage

The package comes with five functions: num, qty, unit, numrange, and qtyrange, which resemble the equally called LaTeX commands:

Function	Description	Basic Example
num	Typesets an integer or decimal number.	#num[3.14159]
qty	Typesets a number with a unit.	#qty[42][meter]
unit	Typesets a unit.	#unit[m/s^2]
numrange	Typesets a range of numbers.	#numrange[1][5]
qtyrange	Typesets a range of numbers with a unit.	#qtyrange[2][4][second]

The parameters can be passed either as strings or as content in markup or math mode. Basic numbers can also be passed as floats or ints.

Numbers

A number consists of a main value, and can be accompanied by an uncertainty and an exponent. The uncertainty can be typed in different ways, which the following examples show:

Units

Units can be passed either as words or as shorthand symbols. A single unit consists of an optional prefix, the base unit, and an optional postfix (exponent). Custom units can be typed by wrapping them in single quotes. The following examples show the different ways of typing units:

Quantities

A quantity is a number accompanied by a unit. The same rules apply as for numbers and units separately. The following examples show how to pass quantities:

Ranges

The range functions work similarly to the num and qty functions, but take an additional number as the second argument. The following examples show how to pass ranges:

Styling

Every function has a multitude of optional parameters intended for customizing the style of the output. Functions that combine numbers and units (qty, qtyrange) have parameters for both numbers and units.

For ease of use, the package comes with a convenience function, that allows setting the same parameters for all functions at once. The following example shows how to set the decimal separator to a comma:

#import "@local/united:0.1.0"
#let (num, qty) = united.with(decimal-sep: ",")

$ pi approx num(3.14159) $

Numbers

Parameter	Description	Default Value
decimal-sep	The decimal separator.	"."
group-sep	The separator between digit groups.	math.thin
product	The symbol to use for the exponent product	math.dot
uncertainty	How to format the uncertainty.	"plusminus"

When changing the group or decimal separator to ",", the spacing is automatically trimmed. To disable digit grouping, set the group-sep parameter to none.

The uncertainty parameter can be one of the following values:

Value	Description
"plusminus"	Show uncertainty with a plus-minus sign.
"parentheses"	Show uncertainty in parentheses.

When using the parentheses option, the main value and the uncertainty are automatically padded with zeros, so that the digits match without losing precision.

Units

Parameter	Description	Default Value
unit-sep	The separator between units.	math.thin
per	How to format inverted units.	"reciprocal"

The per parameter allows the following values:

Value	Description
"reciprocal"	Show unit with negative exponent.
"fraction"	Show unit in denominator of a fraction.
"{symbol}"	Show unit after the given symbol.

The symbol can be any content, for example a math.slash or "/" symbol. When using single letters, they are italicized by default, so it may be necessary to wrap them in math.upright to prevent this.

Ranges

Parameter	Description	Default Value
delim	The delimiter between the numbers.	"to"
delim-space	The space between number and delimiter.	math.space