Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Panel
Table of Contents

Anchor
1155036
1155036
Syntax

Wiki Markup
*format* _variable\_name_ \[\{_string\_1_\|_expression\_1_\} \[align=\{*center*\|*left*\|*right*\|*justify*\}\] \[pad=_sequence_\] \[trunc=*yes*\|*no*\] \[length=_length_\]\]...\[\{_string\_n_\|_expression\_n_\} \[align=*center*\|*left*\|*right*\|*justify*\] \[pad=_sequence_\] \[trunc=*yes*\|*no*\] \[length=_length_\]\]

Anchor
1155042
1155042
Description

Anchor
1155043
1155043
The format command creates a formatted string.

Anchor
1155044
1155044
The first parameter, variable_name, is the variable or list element in which the newly formatted string is stored.

Anchor
1155045
1155045
The second parameter, string_1 (or expression_1), is the first section of the string. Each additional, optional parameter specifies formatting that affect that string.

Anchor
1155046
1155046
All following parameters, string_n (or expression_n), are the next sections of the string. Each additional, optional parameter specifies formatting that affect that string.

Anchor
1155047
1155047
Parameters

HTML Table
cellspacing0
styletext-align: left; width: 100%;
classTable_with_Header
Table Row (tr)
Table Cell (td)
stylebackground-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 144pt;

Anchor
1155052
1155052
Parameter

Table Cell (td)
stylebackground-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 360pt;

Anchor
1155054
1155054
Description

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155056
1155056
variable_name

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155058
1155058
Variable or list element in which the newly formatted string is stored

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155060
1155060
string_1 | expression_1

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155062
1155062
First section of the string

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155064
1155064
align=center | left | right | justify

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155066
1155066
Method of how the value is aligned within the given space.

Anchor
1155067
1155067
Default alignment is left.

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155069
1155069
pad=sequence

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155071
1155071
Character(s) used to pad out the formatted value.

Anchor
1155072
1155072
Default is space character.

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155074
1155074
trunc=yes | no

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155076
1155076
Truncates the value to the length given by length if it is longer than that value.

Anchor
1155077
1155077
Default is to not truncate.

Table Row (tr)
Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155079
1155079
length=length

Table Cell (td)
styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

Anchor
1155081
1155081
Length of the formatted field.

Anchor
1155082
1155082
Default is length of the value specified.

Anchor
1155085
1155085
Examples


Anchor
1155086
1155086
The following examples demonstrate the format command.

Panel

Anchor
1154381
1154381