This module belongs to the Literature Markup Language Version 2.0
Code elements indicate texts in specific structures or languages intended for programs or machines to be interpreted. However if this appears in LML, this is not directly interpreted by machines as machine code, it is typically used to provide samples for example for educational purposes.
Type: Inline
Provides fragments from programs, scripts, markup language and similar text types. If quoted from other authors, this needs additionally quoting and a citation.
code
code
code
programlisting
code
Type: Block
A block container for code or markup.
This corresponds to the code
element for inline content.
Provides fragments from programs, scripts, markup language and similar text types.
If quoted from other authors, this needs additionally quoting and a citation.
programlisting
blockcode
Type: Inline
Indicates an attribute or property, typically for an element in a markup language.
If a more detailed identification of the language is required,
the attribute property
can be used.
Type: Inline
Indicates an element, typically in a markup language.
If a more detailed identification of the language is required,
the attribute property
can be used.
Type: Inline
Indicates an object, function, procedure, module of a programming or scripting language.
If a more detailed identification of the language is required,
the attribute property
can be used.
Type: Inline
Indicates the content of the element to represent an operator.
This is not really required for the usual operators like +,-,*,/,
but for specific operators, especially defined for this specific piece of literature.
This differs slightly from a function as well due to the typical notation:
Operator: c = a + b
Function: c = plus(a,b)
Type: Inline
A name of a variable in a programming or scripting language.
Typically only required as indication outside a code context.
If a more detailed identification of the language is required,
the attributes datatype
,
respectively typeof
can be used.
Type: Inline
Indicates a matrix. The content is not the matrix itself, this is for example a letter as a name representing a matrix.
Type: Inline
Indicates an entity or variable representing a number or scalar by its name.
Many quantities consist of a number and a unit u
.
The content is not the number itself, this is for example a letter representing a number.
This is only intended for simple scalar objects like integers, real or complex numbers.
Type: Inline
Indicates a tensor. The content is not the tensor itself, this is for example a letter as a name representing a tensor.
Type: Inline
Indicates a vector. The content is not the vector itself, this is for example a letter as a name representing a vector.
Type: Inline
A value of an entity like a variable, parameter, attribute or property in general.
Typically only required as indication outside a code context.
If a more detailed identification of the language is required,
the attributes datatype
,
respectively typeof
can be used.
Values are not just numbers or strings, they can be of a more complex type with the requirement for more subelements to markup such an entity.
Type: Inline
Indicates a unit, many quantities consist of a number and a unit. There are international standards for units, typically those units should be preferred compared to legacy units. For example the basis standard unit for a length is m (meter), for time is s (second) for masses kg (kilogram, this is an exception were the base unit already contains a prefix). Prefixes belong to the unit as for kg, km, ms etc.
Note, that for the abbreviations the choice of lower or upper case letters is important.
Caution has to be taken, that the meaning is not corrupted for example by styling.
There is no whitespace between a prefix and the base unit and there should be no line break between the number and the unit,
even if a small space is recommended between the number and the unit for written text
(what can be realised with styling, because within the markup the unit is already separated from the number by
the begin tag for the u
element).
Type: Inline
Indicates a predicted or expected value of some entity or observable, often it includes as a subelement some information
about the uncertainty of the prediction with the element un
.
Typically such a value results from a theoretical model (in physics for example) including some (numerical) computation
or it can result from a specification (in techniques for example) as well.
It implicates always, that this prediction can be tested somehow, typically with a measurement.
Type: Inline
Indicates a measured value, usually it includes as a subelement some information
about the uncertainty of the measured value with the element un
.
<p>The table has indeed a width of <mv>0.90 <u>m</u></mv> and a length of <mv>2.10 <u>m</u></mv>, however specified was a width of <pv>1.00 <u>m</u></pv> and a length of <pv>2.00 <u>m</u></pv>.</p>
Here the uncertainty of the measurement is implicated by the number of digits.
Type: Inline
Indicates the uncertainty of a measured value mv
or predicted value pv
or in general a value val
as a subelement.
Of course, sometimes the information about the uncertainty is not directly given next to the value,
in such a case, the un
may appear outside of pv
, mv
or val
as well.
<p>The table has indeed a width of <mv>(0.901 <un>± 0.002</un>)<u>m</u></mv> and a length of <mv>(2.093 <un>± 0.002</un>)<u>m</u></mv>, however specified was a width of <pv>1.00<u>m</u></pv> and a length of <pv>2.00<u>m</u></pv>.<br /></p>
<p>The statistical error for all our measurements is about <un>± 0.001</un><u>m</u>.</p>