Merge pull request #216 from michaelnt/tutorial

Add some information on headings and markdown formatting

doorstop/cli/test/docs/HLT001.yml

@@ -6,8 +6,10 @@ links:
 - TUT002: 3a4234ca2b58212fa1bd6052b113daa7
 - TUT004: 81b4d9e74572f0a91b46c924de931c36
 - TUT008: 2dbd9266fa287cc3f765c2a81aa57a91
+- TUT017: adde6f14a8ab86bee61ba88db6960815
+- TUT019: 85c96dfa447540b5433a67f1e1114c61
 normative: true
 ref: test_tutorial_section_1
-reviewed: cef0e4c932ef5fe6a13e66fcafb8c8b8
+reviewed: 2e4702d52e9ab2fd24b9d22270bcc4dc
 text: |
   Tutorial Section 1.0:

doorstop/cli/test/test_all.py

@@ -15,8 +15,8 @@
 from doorstop.cli.test import ENV, REASON, ROOT, FILES, REQS, TUTORIAL
 from doorstop.cli.test import SettingsTestCase
 
-REQ_COUNT = 14
-ALL_COUNT = 46
+REQ_COUNT = 17
+ALL_COUNT = 49
 
 
 class TempTestCase(unittest.TestCase):

reqs/tutorial/TUT017.yml

@@ -0,0 +1,59 @@
+active: true
+derived: false
+level: 1.5
+links:
+- REQ004: 94f4db8d1a50ab62ee0edec1e28c0afb
+normative: true
+ref: ''
+reviewed: 98ba42c551fec65d9796fee72d15f844
+text: |
+  ### Headings 3
+
+  Markdown can be used to format text.
+
+  #### Heading 4
+
+  ##### Heading 5
+
+  ### Emphasis
+  Emphasis, aka italics, with *asterisks* or _underscores_.
+
+  Strong emphasis, aka bold, with **asterisks** or __underscores__.
+
+  Combined emphasis with **asterisks and _underscores_**.
+
+  Strikethrough uses two tildes. ~~Scratch this.~~
+
+  ### Paragraphs
+  When exporting to html using doorstop newlines
+  are converted to line breaks.
+
+  An empty line is required to start a new paragraph.
+
+  ### Lists
+  1. First ordered list item
+  2. Another item
+  1. Actual numbers don't matter,
+  just that it's a numbers
+
+  * Unordered list can use asterisks
+  - Or minuses
+  + Or pluses
+
+  ### Tables
+  Colons can be used to align columns.
+
+  | Tables        | Are           | Cool  |
+  | ------------- |:-------------:| -----:|
+  | col 3 is      | right-aligned | $1600 |
+  | col 2 is      | centered      |   $12 |
+  | zebra stripes | are neat      |    $1 |
+
+  There must be at least 3 dashes separating each header cell.
+  The outer pipes (|) are optional, and you don't need to make the
+  raw Markdown line up prettily. You can also use inline Markdown.
+
+  Markdown | Less | Pretty
+  --- | --- | ---
+  *Still* | `renders` | **nicely**
+  1 | 2 | 3

reqs/tutorial/TUT018.yml

@@ -0,0 +1,9 @@
+active: true
+derived: false
+level: 1.6.0
+links: []
+normative: false
+ref: ''
+reviewed: d34af4524b974217cbbd91e635f137a5
+text: |
+  Sub headings

reqs/tutorial/TUT019.yml

@@ -0,0 +1,10 @@
+active: true
+derived: false
+level: 1.6.1
+links:
+- REQ004: 94f4db8d1a50ab62ee0edec1e28c0afb
+normative: true
+ref: ''
+reviewed: e48e28000b262f0165edd2e4cbf7914d
+text: |
+  Sub headings can be created by a level that ends in .0