Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-47

Consistently format ABNF rules for human readability

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: ABNF
    • Labels:
      None
    • Proposal:
      Hide

      Use line length 75 to allow pasting the text file content into the OASIS word template using paragraph style Code (Courier New, 9pt)

      Format rules so that concatenation parts are vertically aligned, alternative parts are aligned with the / as leading character, aligned either under the = or the opening (, place the closing ) on a separate line aligned with its opening counterpart.

      Place all = signs at character position 30 (sufficient for current maximum rule name, which is quite long).

      Illustrated by the following example (use fixed-width font to view

      Rule = subrule
      / alternative-subrule

      Rule = subrule subrule2 subrule4
      concatentated-subrule

      Rule = subrule
      ( alternative
      / alternative
      ( sub-alternative
      / sub-alternative
      )
      )

      Show
      Use line length 75 to allow pasting the text file content into the OASIS word template using paragraph style Code (Courier New, 9pt) Format rules so that concatenation parts are vertically aligned, alternative parts are aligned with the / as leading character, aligned either under the = or the opening (, place the closing ) on a separate line aligned with its opening counterpart. Place all = signs at character position 30 (sufficient for current maximum rule name, which is quite long). Illustrated by the following example (use fixed-width font to view Rule = subrule / alternative-subrule Rule = subrule subrule2 subrule4 concatentated-subrule Rule = subrule ( alternative / alternative ( sub-alternative / sub-alternative ) )
    • Resolution:
      Show
      https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/ABNF/odata-abnf-construction-rules-v1.0-wd01.txt?rev=60 https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/ABNF/odata-abnf-testcases.xml?rev=60 Accepted: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/47096/latest/odata_meeting-10_on-20121004-minutes.html

      Attachments

        Activity

          People

          • Assignee:
            handl Ralf Handl
            Reporter:
            handl Ralf Handl
          • Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: