From 56d5a11049745e27c2fc0afd0d70f06cf4ae6da0 Mon Sep 17 00:00:00 2001 From: Sam Whited Date: Fri, 10 Nov 2017 18:54:54 -0600 Subject: [PATCH] styling: more cleanup and feedback addressed --- inbox/styling.xml | 89 ++++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 44 deletions(-) diff --git a/inbox/styling.xml b/inbox/styling.xml index 178bd9ff..3cf19222 100644 --- a/inbox/styling.xml +++ b/inbox/styling.xml @@ -137,23 +137,26 @@ A block is any chunk of text that can be parsed unambiguously in one pass.

- A span are groups of text that do not result in a line break when rendered - (they are rendered inline) and where the entire group is rendered in the - same manner and in the same block. + A span is a group of text that is rendered inline and where the entire + group is rendered in the same manner. Spans may be either plain text with no formatting applied, or may be formatted text that is enclosed by two styling directives. - The following are all single spans: + Spans may not escape from their containing block. + The following all contain spans marked by parenthesis:

Matches of spans between two styling directives MUST contain some text @@ -170,44 +173,44 @@ styling directives.

- For example, each of the following would be emphasized as indicated: + For example, each of the following would be styled as indicated:

- Nothing would be styled in the following messages (where \n represents a + Nothing would be styled in the following messages (where "\n" represents a new line):

- +

- Text enclosed by '*' (U+002A ASTERISK) SHOULD be displayed with a greater - weight than the surrounding text (bold face). + Text enclosed by '*' (U+002A ASTERISK) is strong SHOULD be displayed as + bold.

- - The full title is *Twelfth Night, or What You Will* but + The full title is "Twelfth Night, or What You Will" but *most* people shorten it. ]]> - +

- Text enclosed by '_' (U+005F LOW LINE) SHOULD be displayed in italics. + Text enclosed by '_' (U+005F LOW LINE) is emphasized and SHOULD be + displayed in italics.

@@ -219,7 +222,7 @@

Text enclosed by '~' (U+007E TILDE) SHOULD be displayed with a horizontal - line through the middle (strike through). + line through the middle.

@@ -227,14 +230,14 @@ ]]> - +

- Text enclosed by a '`' (U+0060 GRAVE ACCENT) SHOULD be displayed inline in - a monospace font. - Inline formatting directives inside the inline preformatted text are not + Text enclosed by a '`' (U+0060 GRAVE ACCENT) is a preformatted span SHOULD + be displayed inline in a monospace font. + A preformatted span may only contain plaintext. + Inline formatting directives inside the preformatted span are not rendered. - For example, in the following the word "monospace" is valid pre-formatted - inline text: + For example, the following all contain valid preformatted spans:

  • This is `monospace`
    • @@ -247,20 +250,18 @@ ]]> - +

    - A block of text surrounded by lines consisting of a sequence of three - backticks, "```" (U+0060 GRAVE ACCENT), is preformatted text and should be - displayed exactly as it was entered including whitespace. - If no closing "```" sequence exists, the preformatted block extends to the - end of the input stream or the end of the parent block (whichever comes - first). - No other formatting described in this document should be rendered inside a - preformatted text block. + A preformatted text block is started by a line beginning with "```" + (U+0060 GRAVE ACCENT), and ended by a line containing only three grave + accents or the end of the parent block (whichever comes first). + Preformatted text blocks cannot contain child blocks and other styling + MUST NOT be rendered inside the block. + Text inside a preformatted block SHOULD be displayed in a monospace font.

    - ``` + ```ignored (println "Hello, world!") ```