Uploaded image for project: 'OASIS Classification of Everyday Living (COEL) TC'
  1. OASIS Classification of Everyday Living (COEL) TC
  2. COEL-92

COEL - Confusing references and structure of 3.2.1 Artefact Format

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Environment:

      Structure

    • Proposal:
      Hide

      Create a separate numbered section (let's say 4 for this example):

      4. JSON Object Format

      4.1 An artefact is a JSON Object with the value names and property types as defined in table 1.

      table 1

      Where you now have "See below for details" replace as appropriate with:
      (see 4.2 Version) or (see 4.3 Common Format)

      4.2 Version (so that it matches your order of values

      table 2

      4.3 Common Format (Cluster, Class, Sub-class, Element)

      The Cluster, Class, Sub-class and Element sections have the same format. That format consists of the value names and data types defined in table 3:

      table 3

      The further text: Each activity is described fully by its cluster, class, sub-class, and element code numbers. When an activity is being used as a general term (or the detail is not sufficient to describe at all four levels) the upper levels can be used in place of the more specialized descriptions (by providing a zero value for the lower level code numbers). For example, Travel by sports car would be coded as cluster = 22, class = 2, subclass=1, element=1, while travel by land would be coded as cluster = 22, class = 2, subclass=0, element=0.

      Needs to be broken into a separate paragraph following the format sections and the example needs to be indented and labeled as an example.

      Show
      Create a separate numbered section (let's say 4 for this example): 4. JSON Object Format 4.1 An artefact is a JSON Object with the value names and property types as defined in table 1. table 1 Where you now have "See below for details" replace as appropriate with: (see 4.2 Version) or (see 4.3 Common Format) 4.2 Version (so that it matches your order of values table 2 4.3 Common Format (Cluster, Class, Sub-class, Element) The Cluster, Class, Sub-class and Element sections have the same format. That format consists of the value names and data types defined in table 3: table 3 The further text: Each activity is described fully by its cluster, class, sub-class, and element code numbers. When an activity is being used as a general term (or the detail is not sufficient to describe at all four levels) the upper levels can be used in place of the more specialized descriptions (by providing a zero value for the lower level code numbers). For example, Travel by sports car would be coded as cluster = 22, class = 2, subclass=1, element=1, while travel by land would be coded as cluster = 22, class = 2, subclass=0, element=0. Needs to be broken into a separate paragraph following the format sections and the example needs to be indented and labeled as an example.

      Description

      3.2.1 Artefact Format could be better organized. There are three distinct sections, Object with its fields, Shared field format defined, version field defined.

      Version appears first in the list under Object (my term, not yours) but appears last in this section.

      All of the descriptions include: "See below for details." (vague, they can't all be pointing to the same place, cf. Version versus Classes)

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              chet-oasis Chet Ensign
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: