Need views in MyST¶

The MyST forms of the specimens on Need views, each rendered live by this page’s own Markdown parser. The views show the six specimen needs defined on that page, because a view selects needs from the whole project.

Tables¶

A needs table

```{needtable} The view specimens
:tags: ex-views
:columns: id, title, status, links as "Links to"
:sort: title
:style: datatables
:page_size: 5
```

The view specimens¶
ID	Title	Status	Links to
EX_IMPL_VIEWS_1	CSV reader	done	EX_SPEC_VIEWS_1
EX_TEST_VIEWS_1	CSV reader test	open	EX_IMPL_VIEWS_1
EX_REQ_VIEWS_2	Export a PDF report	open
EX_REQ_VIEWS_1	Import a CSV file	done
EX_SPEC_VIEWS_2	Lay out the pages	open	EX_REQ_VIEWS_2
EX_SPEC_VIEWS_1	Read the header row	done	EX_REQ_VIEWS_1

Lists¶

A needs list

```{needlist}
:tags: ex-views
:status: open
:show_status:
:sort_by: id
```

EX_REQ_VIEWS_2: Export a PDF report (open)
EX_SPEC_VIEWS_2: Lay out the pages (open)
EX_TEST_VIEWS_1: CSV reader test (open)

Extracts¶

An extract

```{needextract} EX_REQ_VIEWS_2
```

Requirement: Export a PDF report EX_REQ_VIEWS_2

status: open

tags: ex-views

duration: 3

completion: 20

links incoming: EX_SPEC_VIEWS_2

A user can save the report as a PDF file.

Flow diagrams¶

A flow diagram

```{needflow}
:tags: ex-views
```

Sequence diagrams¶

A sequence diagram

```{needsequence} The CSV reader
:start: EX_IMPL_VIEWS_1
```

@startuml

' Nodes definition

participant "CSV reader" as EX_IMPL_VIEWS_1

' Connection definition

EX_IMPL_VIEWS_1 -> EX_REQ_VIEWS_1: Read the header row

@enduml — The CSV reader¶

Pie charts¶

A pie chart

```{needpie} Needs by status
:tags: ex-views
:labels: open, done
:colors: "#DCB239, #BFD8D2"
:legend:

status == "open"
status == "done"
```

Bar charts¶

A bar chart

```{needbar} Needs by type and status
:tags: ex-views
:xlabels: Requirements, Specifications
:ylabels: open, done
:legend:

type == "req" and status == "open", type == "spec" and status == "open"
type == "req" and status == "done", type == "spec" and status == "done"
```

Gantt charts¶

A Gantt chart

```{needgantt} The import and export plan
:tags: ex-views
```

@startgantt

' Elements definition

[Import a CSV file] as [EX_REQ_VIEWS_1] lasts 2 days
[Export a PDF report] as [EX_REQ_VIEWS_2] lasts 3 days
[Read the header row] as [EX_SPEC_VIEWS_1] lasts 2 days
[Lay out the pages] as [EX_SPEC_VIEWS_2] lasts 4 days
[CSV reader] as [EX_IMPL_VIEWS_1] lasts 3 days
[CSV reader test] as [EX_TEST_VIEWS_1] lasts 1 days

' Element links definition

' Deactivated, as currently supported by plantuml beta only
' Element completion definition

[EX_REQ_VIEWS_1] is 100% completed
[EX_REQ_VIEWS_2] is 20% completed
[EX_SPEC_VIEWS_1] is 100% completed
[EX_SPEC_VIEWS_2] is 50% completed
[EX_IMPL_VIEWS_1] is 100% completed

' Element color definition

[EX_REQ_VIEWS_1] is colored in #BFD8D2
[EX_REQ_VIEWS_2] is colored in #BFD8D2
[EX_SPEC_VIEWS_1] is colored in #FEDCD2
[EX_SPEC_VIEWS_2] is colored in #FEDCD2
[EX_IMPL_VIEWS_1] is colored in #DF744A
[EX_TEST_VIEWS_1] is colored in #DCB239

' Constraints definition

' Constraints definition

[EX_SPEC_VIEWS_1] starts at [EX_REQ_VIEWS_1]'s end
[EX_SPEC_VIEWS_2] starts at [EX_REQ_VIEWS_2]'s end
[EX_IMPL_VIEWS_1] starts at [EX_SPEC_VIEWS_1]'s end
[EX_TEST_VIEWS_1] starts at [EX_IMPL_VIEWS_1]'s end

@endgantt — The import and export plan¶

UML diagrams¶

A UML diagram and an architecture diagram

```{needuml}
{{flow("EX_IMPL_VIEWS_1")}}
{{flow("EX_REQ_VIEWS_1")}}
EX_IMPL_VIEWS_1 --> EX_REQ_VIEWS_1
```

````{impl} PDF writer
:id: EX_IMPL_VIEWS_MYST_ARCH
:status: open

```{needarch}
{{flow(need().id)}}
{{flow("EX_SPEC_VIEWS_2")}}
{{need().id}} --> EX_SPEC_VIEWS_2
```
````

Implementation: PDF writer EX_IMPL_VIEWS_MYST_ARCH

status: open