Semantic Line Breaks

Our texts in Markdown and AsciiDoc must have Semantic Line Breaks (SLB) to facilitate editing and help keep an organized record of modifications in our version control system (Gitlab). Based on, we consider the following rules:

  • An SLB should not alter the intended meaning of the text.

  • An SLB must occur after a sentence, which ends with a period, exclamation mark or question mark.

  • An SLB should occur after an independent clause that is punctuated by a comma, semicolon, colon, or em dash.

  • An SLB may appear after a dependent clause to clarify grammatical structure or satisfy line length restrictions.

  • An SLB is recommended before an itemized or enumerated list.

  • An SLB may be used after one or more items in a list to logically group related elements or satisfy line length restrictions.

  • An SLB must not occur within a hyphenated word.

  • An SLB may occur before and after a hyperlink.

  • An SLB may occur before inline markup.

  • The maximum number of characters before an SLB must be 80, except in cases with hyperlinks or code elements.

NOTE: This section of our documentation is under construction.