Writing needs in MyST

The MyST forms of the specimens on Writing needs, each rendered live by this page’s own Markdown parser. Their needs carry ids of their own, because a need id must be unique in the project.

A need and its links

Four linked needs

```{req} Export the report as CSV
:id: EX_REQ_MYST_EXPORT
:status: open
:tags: export, reporting

A user can save the report as a CSV file.
```

```{spec} One row per record
:id: EX_SPEC_MYST_EXPORT
:status: open
:links: EX_REQ_MYST_EXPORT

The file has a header row, then one row per record.
```

```{impl} CSV writer
:id: EX_IMPL_MYST_EXPORT
:status: done
:links: EX_SPEC_MYST_EXPORT

The writer emits the rows in the order the report shows them.
```

```{test} CSV writer test
:id: EX_TEST_MYST_EXPORT
:status: passed
:links: EX_IMPL_MYST_EXPORT

Exports a two-record report and compares the file with the expected one.
```

Requirement: Export the report as CSV EX_REQ_MYST_EXPORT

status: open tags: export, reporting links incoming: EX_SPEC_MYST_EXPORT, EX_SPEC_MYST_EXPORT_FILENAME, EX_SPEC_MYST_EXPORT_QUOTING

A user can save the report as a CSV file.

Specification: One row per record EX_SPEC_MYST_EXPORT

status: open links outgoing: EX_REQ_MYST_EXPORT links incoming: EX_IMPL_MYST_EXPORT

The file has a header row, then one row per record.

Implementation: CSV writer EX_IMPL_MYST_EXPORT

status: done links outgoing: EX_SPEC_MYST_EXPORT links incoming: EX_TEST_MYST_EXPORT

The writer emits the rows in the order the report shows them.

Test Case: CSV writer test EX_TEST_MYST_EXPORT

status: passed links outgoing: EX_IMPL_MYST_EXPORT

Exports a two-record report and compares the file with the expected one.

Need parts

A need with two parts

```{req} Report header
:id: EX_REQ_MYST_EXPORT_HEADER
:status: open

The file {need_part}`(columns)starts with a row naming the columns`
and {np}`(encoding)is encoded as UTF-8`.
```

Requirement: Report header EX_REQ_MYST_EXPORT_HEADER

status: open

The file starts with a row naming the columns columns and is encoded as UTF-8 encoding.

Card options

Card options

```{spec} Quote fields that hold a comma
:id: EX_SPEC_MYST_EXPORT_QUOTING
:status: open
:links: EX_REQ_MYST_EXPORT
:collapse: true

A field that holds a comma is written in double quotes.
```

```{spec} Name the file after the report
:id: EX_SPEC_MYST_EXPORT_FILENAME
:status: open
:links: EX_REQ_MYST_EXPORT
:layout: complete
:style: green_border

The file takes the report's title as its name.
```

Specification: Quote fields that hold a comma EX_SPEC_MYST_EXPORT_QUOTING

status: open links outgoing: EX_REQ_MYST_EXPORT links incoming: EX_IMPL_MYST_EXPORT_HELPER

A field that holds a comma is written in double quotes.

EX_SPEC_MYST_EXPORT_FILENAME		Name the file after the report		Specification
status: open			links outgoing: EX_REQ_MYST_EXPORT
The file takes the report’s title as its name.
layout: complete				style: green_border