templates.docgen.stg Maven / Gradle / Ivy

Go to download
main(title, categories) ::= <<


$title$






$topMenu(title)$







>>

categories(categories, title) ::= <<







$title$
All Messages
$categories:{category|$category.name$}$



>>

topMenu(title) ::= <<

$title$
Metadata
Actors
Flows
Messages
Components
Groups
Fields
Code sets
Datatypes

>>

datatypes(datatypes, title) ::= <<








$datatypes:{datatype|$datatype.name$}$


$scripts()$


>>

actors(actors, title) ::= <<







$title$
$actors:{actor|$actor.name$}$

>>

actorStart(actor) ::= <<


Actor $actor.name$




Actor $actor.name$
$documentation(object=actor)$
State Variables
$if(actor.fieldOrFieldRefOrComponent)$

$else$None$endif$
>>

actorPart2(actor) ::= <<
$if(actor.fieldOrFieldRefOrComponent)$

ID
Name
Abbr
Presence
Description
$endif$
>>

stateMachine(states) ::= <<
State Machine $states.name$
$documentation(object=states)$


$state(states.initial)$
$states.state:{state|$state(state)$}$


State
Transition
Target
Description
Guard

>>

state(state) ::= <<
$state.name$$documentation(object=state)$
$state.transition:{transition|$transition(transition)$}$
>>

transition(transition) ::= <<
$transition.name$$transition.target$$documentation(object=transition)$$transition.when$
>>

flows(flows, title) ::= <<







$title$
$flows:{flow|$flow.name$}$



>>

flow(flow) ::= <<


Flow $flow.name$




Flow $flow.name$
$documentation(object=flow)$




Source

Destination


$flow.source$ → $flow.destination$ Messages



>>

messages(messages, title) ::= <<








$messages:{message|$message.name$-$message.scenario$}$


$scripts()$


>>

codeSets(codeSets, title) ::= <<








$codeSets:{codeSet|$codeSet.name$-$codeSet.scenario$}$


$scripts()$


>>

scripts() ::= <<

>>

fields(fields, title) ::= <<








$fields:{field|$field.name$-$field.scenario$ $field.id$}$



$scripts()$

>>

messageStart(message) ::= <<


Message $message.name$ Scenario $message.scenario$




Message $message.name$ Scenario $message.scenario$
$documentation(object=message)$




ID
MsgType
Abbr
Flow

$message.id$ $message.msgType$ $message.abbrName$ $message.flow$

$pedigree(object=message)$
Responses
$if(message.responses.response)$


$else$None$endif$
>>

messageResponse(message, scenario, when) ::= <<

>>

messagePart2(message) ::= <<
$if(message.responses.response)$

Message
Scenario
When
$message$-$scenario$ $scenario$-$scenario$ $when$$endif$
Members
$message.name$ $message.scenario$ members

>>

messageEnd(message) ::= <<


ID
Name
Abbr
Presence
Description



>>

fieldMember(field, presence, assign) ::= <<
$field.id$$field.name$$field.abbrName$
$if(assign)$Assign: $assign$$else$$presence$$endif$
$documentation(object=field)$
>>

componentMember(component, presence) ::= <<
$component.id$$component.name$$component.abbrName$$presence$$documentation(object=component)$
>>

components(components, title) ::= <<








$components:{component|$component.name$-$component.scenario$}$


$scripts()$


>>

groups(groups, title) ::= <<








$groups:{group|$group.name$-$group.scenario$}$


$scripts()$


>>

componentStart(component) ::= <<






Component $component.name$ Scenario $component.scenario$
$documentation(object=component)$




ID
Abbr

$component.id$ $component.abbrName$

$pedigree(object=component)$
Members

>>

groupStart(groupType, fieldType) ::= <<

Group $groupType.name$ Scenario $groupType.scenario$
$documentation(object=group)$



ID
Name
Abbr
Presence
Description








ID
Abbr
NumInGroup ID
NumInGroup name

$groupType.id$ $groupType.abbrName$ $fieldType.id$ $fieldType.name$

$pedigree(object=groupType)$
Members

>>

componentEnd() ::= <<


ID
Name
Abbr
Presence
Description



>>

field(field, typeLink) ::= <<






Field $field.name$ Scenario $field.scenario$
$documentation(object=field)$




ID
Abbr
Datatype

$field.id$ $field.abbrName$ $field.type$

$pedigree(object=field)$


>>

datatype(datatype) ::= <<






Datatype $datatype.name$
$documentation(object=datatype)$


$pedigree(object=datatype)$
Mappings
$mappings(datatype.mappedDatatype)$


>>

mappings(mappings) ::= <<

$mappings:{mapping|}$


Standard
Base type
Parameter
Pattern
$mapping.standard$ $mapping.base$ $mapping.parameter$ $mapping.pattern$
>>

codeSetStart(codeSet) ::= <<






Code Set $codeSet.name$ Scenario $codeSet.scenario$
$documentation(object=codeSet)$




ID
Datatype

$codeSet.id$ $codeSet.type$

Codes

>>

code(code, supported) ::= <<

>>

codeSetEnd(codeSet) ::= <<


ID
Name
Value
Description
Supported
Added
EP
Updated
EP
Deprecated
EP
$code.id$ $code.name$ $code.value$ $documentation(object=code)$ $supported$ $code.added$ $code.addedEP$ $code.updated$ $code.updatedEP$ $code.deprecated$ $code.deprecatedEP$


>>

pedigree(object) ::= <<
Pedigree


Added
EP
Updated
EP
Deprecated
EP

$object.added$ $object.addedEP$ $object.updated$ $object.updatedEP$ $object.deprecated$ $object.deprecatedEP$

>>

metadata(repository, elementList) ::= <<






Repository


Name
Version

$repository.name$ $repository.version$

Metadata

$elementList:{element|}$


Name
Value
$element.name.localPart$ $element.value.content$


>>

documentation(object) ::= <<
$object.annotation.DocumentationOrAppinfo:{doc|$if(doc.purpose)$$doc.purpose$: $endif$$doc.content$
}$
>>