diff --git a/README.md b/README.md
index 030d076c102e4e2f1bb7c36da1c5e7048869677e..c1d01d9251925d42289311abdabe1d3cae0c540c 100644
--- a/README.md
+++ b/README.md
@@ -13,13 +13,14 @@ For Linux, the execution bit must still be set.
chmod u+x reqman
```
-## Commands
+## Commands
The date format for the output can be specified with the parameter `--date-format`.
The format can be looked up in the first column of the table below.
+
| Layout | Java notation | C notation | Notes |
-|------------------|---------------|------------|----------|
+| ------------------ | --------------- | ------------ | ---------- |
| 2006-01-02 | yyyy-MM-dd | %F | ISO 8601 |
| 20060102 | yyyyMMdd | %Y%m%d | ISO 8601 |
| January 02, 2006 | MMMM dd, yyyy | %B %d, %Y | |
@@ -45,7 +46,7 @@ reqman --help
### New Requiremants
-A new request can be created with the following command.
+A new request can be created with the following command.
```bash
reqman requirements add --id 1425
@@ -73,7 +74,7 @@ reqman overview \
In this case the markdown files in the path `requirement/documents` are read.
-A table with all requirements is created in the file and the two columns
+A table with all requirements is created in the file and the two columns
`ID` and `Title` are used. Additional columns can be added using additional options `--column`.
File `template/schukai.md` is used as a template.
@@ -92,10 +93,10 @@ reqman tasks print --path=examples/
The output is then of the type:
-| AUFGABE | BIS | ERLEDIGT | DATEI |
-|--------------------------------|------------|----------|----------------------|
-| das ist das erste todo 1 | — | — | ./req1/001-1425.md |
+| AUFGABE | BIS | ERLEDIGT | DATEI |
+| -------------------------- | ----- | ---------- | -------------------- |
+| das ist das erste todo 1 | — | — | ./req1/001-1425.md |
### Output of the items
@@ -105,9 +106,10 @@ reqman requirements print --path examples/ --column ID --column Title
The output is then of the type:
-| ID | TITEL |
-|-----|----------------|
-| A1 | My requirement |
+
+| ID | TITEL |
+| ---- | ---------------- |
+| A1 | My requirement |
More columns can be added with `--column`.
@@ -125,10 +127,10 @@ reqman requirements print --path=example/ --column=ID --column=
The output is then of the type:
-| ID | GRUPPE | NAME | TYP | BESCHREIBUNG | BIS | ERLEDIGT | AM | VON | DATEI |
-|--------------------|--------------|--------------------------|------|--------------|------------|----------|------------|-----|----------------------|
-| 23423-Beistellung1 | A1 | Beistellung eines Bildes | Bild | Großes Logo | 2022-12-12 | ✓ | 2022-12-01 | Me | ./req1/002/002-01.md |
+| ID | GRUPPE | NAME | TYP | BESCHREIBUNG | BIS | ERLEDIGT | AM | VON | DATEI |
+| -------------------- | -------- | -------------------------- | ------ | -------------- | ------------ | ---------- | ------------ | ----- | ---------------------- |
+| 23423-Beistellung1 | A1 | Beistellung eines Bildes | Bild | Großes Logo | 2022-12-12 | ✓ | 2022-12-01 | Me | ./req1/002/002-01.md |
### Output changelog
@@ -157,8 +159,9 @@ requirements report --grouped-by ID
This command produces two tables:
-| Anforderung | Gesch | TIME SPENT |
-|-------------|-------|------------|
+
+| Anforderung | Gesch | TIME SPENT |
+| ------------- | ------- | ------------ |
| ID1 | 40 | 1 |
| ID2 | 40 | 1 |
| ID3 | 40 | 1 |
@@ -185,27 +188,27 @@ This command produces two tables:
| ID24 | 40 | 6 |
| ID25 | 40 | 6 |
-
-
1) Groups all estimates and adds up the estimate and the booked times. This allows you to see how much time you have spent.
+
| KEY | PLANNED VALUE | TIME SPENT | RATIO |
-|:----|---------------|------------|-------|
+| :---- | --------------- | ------------ | ------- |
| ID1 | 1000 | 75h0m0s | 7.50 |
2) This table shows for each plan value the hours needed, the mean, the variance and the standard deviation.
+
| PLAN VALUE | TIME SPENT | MEAN | VARIANCE | STANDARD DEVIATION |
-|------------|------------|------|----------|--------------------|
+| ------------ | ------------ | ------ | ---------- | -------------------- |
| 40 | 75h0m0s | 3.00 | 2.08 | 1.44 |
On average, we needed 3 hours in the example.
However, we needed 6 hours for 2 requirements.
-The variance, or standard deviation, gives us a measure of how accurate we are.
+The variance, or standard deviation, gives us a measure of how accurate we are.
The smaller the standard deviation, the better.
-So what decision can we derive? If a new requirement is estimated at
+So what decision can we derive? If a new requirement is estimated at
40, the hours offered should be between 3 and 5.
## Structure
@@ -234,6 +237,28 @@ For example, the following statement can be used to include the items within the
If the PDF function is used, LaTeX commands can also be included in the text. For example, the LaTex instruction `/newline' leads to a line break.
+## YAML
+
+
+| | `>` | `|` | | `"` | `'` | `>-` | `>+` | `|-` | `|+` |
+| --------------------------------- | ----- | ------ | --- | ---- | --- | ----- | ------ | ------ | ------ |
+| **Spaces/newlines converted as:** | | | | | | | | | |
+| Trailing space → | \_ | \_ | | | | \_ | \_ | \_ | \_ |
+| Leading space → | \\n\_ | \\n\_ | | | | \\n\_ | \\n\_ | \\n\_ | \\n\_ |
+| Single newline → | \_ | \\n | \_ | \_ | \_ | \_ | \_ | \\n | \\n |
+| Double newline → | \\n | \\n\\n | \\n | \\n | \\n | \\n | \\n | \\n\\n | \\n\\n |
+| Final newline → | \\n | \\n | | | | | \\n | | \\n |
+| Final double newline → | | | | | | | \\n\\n | | \\n\\n |
+| **How to create a literal:** | | | | | | | | | |
+| Single quote | ' | ' | ' | ' | '' | ' | ' | ' | ' |
+| Double quote | " | " | " | \\" | " | " | " | " | " |
+| Backslash | \\ | \\ | \\ | \\\\ | \\ | \\ | \\ | \\ | \\ |
+| **Other features** | | | | | | | | | |
+| In-line newlines with `\n` | 🚫 | 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 |
+| Spaceless newlines with `\` | 🚫 | 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 |
+| `#` or `:` in value | ✅ | ✅ | 🚫 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Can start on same line as key | 🚫 | 🚫 | ✅ | ✅ | ✅ | 🚫 | 🚫 | 🚫 | 🚫 |
+
## Latex
@@ -242,4 +267,4 @@ Individual LaTeX commands can be looked up here:
* [tug.ctan.org/info/latex-refsheet/LaTeX_RefSheet.pdf](http://tug.ctan.org/info/latex-refsheet/LaTeX_RefSheet.pdf)
* [www.uni-frankfurt.de/53485609/latexsheet.pdf](https://www.uni-frankfurt.de/53485609/latexsheet.pdf)
* [www.latex4ei.de/downloads/LaTeX_CheatSheet.pdf](https://www.latex4ei.de/downloads/LaTeX_CheatSheet.pdf)
-* [download.schukai.com/tools/reqman/](http://download.schukai.com/tools/reqman/)
\ No newline at end of file
+* [download.schukai.com/tools/reqman/](http://download.schukai.com/tools/reqman/)
diff --git a/development/examples/example1/req1/1/test1.md b/development/examples/example1/req1/1/test1.md
index 1812bde443fc88f8d99b36f69c98ef6afec6c1b4..a844e40259a03830021cac8744f3e0ac24b46075 100644
--- a/development/examples/example1/req1/1/test1.md
+++ b/development/examples/example1/req1/1/test1.md
@@ -45,7 +45,7 @@ Issues:
- Gitlab:
Title: Test 1
Status: offen
- Description: Lorem Ipsum
+ Description: > Lorem Ipsum
Lila Rot Blau1
Lila Rot Blau2
Labels:
@@ -103,6 +103,11 @@ Privacy:
# Where possible, a general description of the technical and organisational
# security measures referred to in Article 32(1).
TOM: null
+Issues:
+ - Gitlab:
+ ID: 1
+ - Gitlab:
+ ID: 41
...
### {{ .Title }} - {{ .ID }}