/ program / 2.0 / usage.chunks.html

Table of content

Parameters

Templates

Details

Parameters

prg.usage.indentChar="' '"
String representing an indentation level

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

Default value: true()
prg.usage.lineMaxLength="80"
Maximum text line length (for text wrapping)

Default value: 80

Templates

prg.usage.typeDisplay(typeNode)

Literal representation of an option argument/value type
  1. typeNode
    type Node
prg.usage.descriptionDisplay(textNode=".")

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
prg.usage.firstOptionNameDisplay(optionNode=".")
  1. optionNode
    Default value: .
prg.usage.allOptionNameDisplay(optionNode=".")

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

inline display of a switch argument (choose the first option name)
  1. optionNode
    Default value: .
prg.usage.switchDescription(optionNode=".", details="true()")

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

Inline description of argument option
  1. optionNode
    Default value: .
prg.usage.argumentValueDescription(optionNode=".")

Inline description of argument option value type
  1. optionNode
    Default value: .
prg.usage.argumentDescription(optionNode=".", details="true()")
  1. optionNode
    Default value: .
  2. details
    Default value: true()
prg.usage.multiargumentInline(optionNode=".")
  1. optionNode
    Default value: .
prg.usage.multiargumentDescription(optionNode=".", details="true()")
  1. optionNode
    Default value: .
  2. details
    Default value: true()
prg.usage.groupInline(optionNode=".")
  1. optionNode
    Default value: .
prg.usage.groupDescription(optionNode=".", details="true()")
  1. optionNode
    Default value: .
  2. details
    Default value: true()
prg.usage.optionListInline(optionsNode, separator=",")

Display the option list
  1. optionsNode
  2. separator
    Default value: ,
prg.usage.positionalArgumentsInline(valuesNode=".", separator="' '")

Display positional argument list
  1. valuesNode
    prg:values node
    Default value: .
  2. separator
    Element separator string
    Default value: ' '
prg.usage.optionListDescription(optionsNode, details="true()")

Display the full documentation for each option
  1. optionsNode
  2. details
    Default value: true()
prg.usage.positionalArgumentsDescription(valuesNode=".", details="true()")

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