To create user-defined patchport/general box port names,
you must define a format string to the cabinet definition. A format
string consists of any sequence of characters that may be embedded
with proxy strings. Proxy strings are delimited by '%' characters
and are replaced with the appropriate text when a port name is displayed.
Following proxies are allowed:
- %CABINET% or %NAME%
- ID of the cabinet or name of the general box. Both proxies are
synonyms and can be used for either cabinets or general boxes.
- %PANEL%
- panel number
- %GROUP%
- port group number
- %PORT%
- patchport/general box port number
- %ROW%
- the row within the panel containing the port
- %COLUMN%
- the column within the panel containing the port
The numerical proxies (%PANEL%, %GROUP%, %PORT%, %ROW% and %COLUMN%)
can be qualified by width, conversion, and ordering specifications,
so that the general syntax of a numerical proxy is:
%[width][conversion] <proxy>{/<qualifier>}%
where [ ] indicates that the enclosed items
are optional, and { } indicates that the enclosed items may appear
zero or more times. The individual items are broken down as follows:
- width
- A decimal number in the range of 0 to 4. This indicates the
width in characters of the actual text that should appear here. If
the conversion is decimal or hex (see below, leading zeroes are used
to pad to the appropriate width; if the conversion is alphabetical,
leading underscore characters are used. If the width is zero or omitted,
the actual text uses only as many characters as necessary.
- conversion
- d
- Convert number to text using decimal format
- x
- Convert number to text using hexadecimal format
- c
- Convert number to text using alphabetical format (i.e. 0 converts
to A, 1 converts to B, etc. ). The letters 'I' and 'O' are left out
of the alphabet. Wrapping past Z will use an extra letter (e.g.
AA).
If no conversion character is specified, decimal conversion
is used.
- <proxy>
- CABINET, NAME, PANEL, GROUP, PORT, ROW or COLUMN
- <qualifier>
- Always preceded by '/'
- 0
- Start numbering at zero (not valid for alphabetical conversion)
- 1
- Start numbering at one (not valid for alphabetical conversion)
- L
- Start numbering at left (numbers increase as we move from left
to right)
- R
- Start numbering at right (numbers increase as we move from right
to left)
- T
- Start numbering at top (numbers increase as we move from top
to bottom)
- B
- Start numbering at bottom (numbers increase as we move from
bottom to top)
- H
- Numbering proceeds in horizontal direction from origin, proceeding
to the next row when the end of the row is reached
- V
- Numbering proceeds in vertical direction from origin, proceeding
to the next column when the end of the column is reached
- G
- Port numbering is with respect to group
- P
- Port or group numbering is with respect to panel
- C
- Port, group, or panel numbering is with respect to cabinet
- Note:
- Those qualifiers that are grouped together above may not
be used in combination; for instance %PORT/0/1% would not be valid
(numbering may start from either 0 or 1, but not both).
- Defaults:
- The default qualifiers are /0/L/T/H,
indicating that ordering starts at zero from the top left and proceeds
horizontally first.
For the scope qualifier (G, P, or C), the
default is /G for proxy %PORT%, /P for proxy %GROUP%, and /C for proxy %PANEL%.
Regular text can be included in the format string.
Comments, delimited by curly braces, can be embedded in the format
string. All characters between the leading '{' and the trailing '}'
will be ignored. Comments are not allowed within the proxy delimiters.
The backslash '\' character can be used (outside of comments
and proxies) to allow the '%', '{', and '}' characters to be treated
as regular characters.
In addition, '\\' is treated as a single backslash.