New in version 0.5.5.
needsequence adds a sequence-chart to your documentation:
.. needsequence:: My sequence chart :start: USER_A, USER_D :link_types: links, triggers
Show used needs for above example…
User: Mr. A USER_A
Action: Creates issue ACT_ISSUE
User: Ms. B USER_B
Action: Analysis issue ACT_ANALYSIS
Action: Provides solution ACT_SOLUTION
User: Expert C USER_C
Action: Reviews solution ACT_REVIEW
Action: Informs reporter ACT_INFORM
User: Office Dog USER_D
Action: Barks for support ACT_BARKS
Sequence diagrams supports special needs-combinations, in which one type represents some kind of an
and another, linked need is representing the
Examples for this relationship are: Sender-Receiver communication , Role-Activity processes or Tool-Artifact relations.
needsequence needs at least one start-need, defined by its
id in the
This need is the first
participant. The next, linked need(s) is representing the
Needs linked from a
message are interpreted as
participant again and so on.
So the linking must be really clean to get nice, meaningful sequence diagrams out of it.
The used need-type itself is unimportant.
The above, linked example gets interpreted for
needsequence as follows:
start takes a comma separated list of need ids, which shall be used as starting point for
further examination for sequence data.
First need of
start gets painted first. This includes all related messages and other participants.
After that the next need id is taken from
start. And if it was not already part of the prior
examination, it is handled the same way otherwise it is ignored.
filter string is used to filter participants.
All participants must fulfil the filter_string, otherwise they get ignored.
See Filter string for more information.
Default: None (no active filtering)
This function can be used to filter out for instance a specific participant.
As example, same
needsequence from the beginning, but without
USER_C / Expert:
.. needsequence:: My filtered sequence chart :start: USER_A, USER_D :link_types: links, triggers :filter: "Expert" not in title