XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Unresolved
    • Icon: Major Major
    • Backlog
    • None
    • documentation
    • None
    • 5
    • False
    • Hide

      None

      Show
      None
    • False

      Use of hard line breaks

      The current docs use hard line breaks extensively, especially in the description entries in properties tables and description lists. Although they serve a useful purpose, generally speaking, the rendering that they effect can be preserved through other means.

      Alternate markup, such as the use of list continuations vs. hard breaks can accomplish a similar, yet "legal" result for these entries. These look similar, because they both use the + character, but continuations, which just tie together paragraphs within a block don't place a space before the character. In some cases, it might be possible to dispense with the extra markup altogether. For example:

      property name:: 
      Description

      Default value::: VALUE
      option1::: blah blah blah
      option2::: blah blah blah

      property name 2::
      Description
      Default value::: VALUE
      option1::: blah blah blah
      option2::: blah blah blah

      This renders correctly as:

      property name
         Description
         Default value 
            VALUE
         option1
            blah blah blah
         option2
            blah blah blah 

      property name 2
         Description
         Default value 
           VALUE

         option1
            blah blah blah
         option2
            blah blah blah

       

              broldan@redhat.com Robert Roldan
              broldan@redhat.com Robert Roldan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: