/ program / 2.0 / usage.chunks.html

Table of content

Parameters

Templates


Details

Parameters

String representing an indentation level

Default value: ' '
prg.usage.wrap="true()"
Indicates if documentation text have to be wrapped

Default value: true()
Maximum text line length (for text wrapping)

Default value: 80

Templates


Literal representation of an option argument/value type
  1. typeNode
    type Node

Display the option description
  1. textNode
    Default value: .
prg.usage.selectValueList(optionNode=".", mode, wrap="$prg.usage.wrap")

List of enumerated values
  1. optionNode
    Option node
    Default value: .
  2. mode
    Display mode: 'inline' or anything else
  3. wrap
    Indicates if the text have to be wrapped
    Default value: $prg.usage.wrap

Display all option's names like they could appear on the command line
  1. optionNode
    Default value: .
  1. valueNode
    Default value: .
  2. details
    Default value: true()
  3. position
    Default value: position()

inline display of a switch argument (choose the first option name)
  1. optionNode
    Default value: .

Description of a switch argument (all option names + description)
  1. optionNode
    Default value: .
  2. details
    Default value: true()

Inline description of argument option
  1. optionNode
    Default value: .

Inline description of argument option value type
  1. optionNode
    Default value: .
  1. optionNode
    Default value: .
  2. details
    Default value: true()
  1. optionNode
    Default value: .
  2. details
    Default value: true()
  1. optionNode
    Default value: .
  2. details
    Default value: true()

Display the option list
  1. optionsNode
  2. separator
    Default value: ,

Display positional argument list
  1. valuesNode
    prg:values node
    Default value: .
  2. separator
    Element separator string
    Default value: ' '

Display the full documentation for each option
  1. optionsNode
  2. details
    Default value: true()

Display the full documentation for each positional argument
  1. valuesNode
    Default value: .
  2. details
    Default value: true()