Next: , Up: Descriptions


4.1 Short Descriptions

     Example: Short descriptions after ‘--  
      1  Element: Item_1 -- This is the short description of Item_1.
      3
      4    And this is the first paragraph
      5    of its long descripion.
      6
      7  Element: Item_2 -- This is the short description
      8    of Item_2.
      9
     10    And this is the first paragraph
     11    of its long descripion.

A short description can start on the header line, after a double hyphen ‘--’ (line 1 and 7), and extends until the next non-text line (line 3 and 9).

     Example: Short descriptions as paragraphs  
      1  Element: Item_1
      2    This is the short description
      3    of Item_1.
      4
      5    And this is the first paragraph
      6    of its long descripion.
      7
      8  Element: Item_2
      9
     10    This is the short description
     11    of Item_2.
     12
     13    And this is the first paragraph
     14    of its long descripion.

If it does not start in the same line, the short description will be the first paragraph found after the header. In the example above, the short description of Item_1 extends from line 2 to 3 and the short description of B from lines 10 to 11.

You can also create an empty description, as in the example below.

     Example: Empty short description  
      1  Element: Item_1 --
      2
      3    This is the first paragraph of
      4    the long descripion of Item_1.