Update ReSpec to support multiple vocabulary files

XMLWordPrintable

    • Type: Task
    • Resolution: Won't Fix
    • Priority: Major
    • Component/s: None
    • Hide

      Partitioning the vocabularies by the specification documents is sufficient. There is no need to separate v2 and v3 content (mostly for discovery) and no need to worry about separating things for possible future deprecation. This is especially the case since all these vocabulary files have to be merged into a single document for publishing to the open-service.net namespace.

      Show
      Partitioning the vocabularies by the specification documents is sufficient. There is no need to separate v2 and v3 content (mostly for discovery) and no need to worry about separating things for possible future deprecation. This is especially the case since all these vocabulary files have to be merged into a single document for publishing to the open-service.net namespace.

      It may be useful to keep the OSLC2 and OSLC3 vocabulary contributions separate in the specification so that implementers can more easily distinguish between them. This is especially true for OSLC2 discovery since it defines so many resources that may not be used by future OSLC3 servers that use Link headers on LDPCs for discovery.

      An easy way to do this is to update the ReSpec oasis/templates/vocab.html template from:

      <section>
      <h2>Vocabulary Details</h2>
      <p>The namespace URI for this vocabulary is:
      <code>vocabURI</code></p>
      <p>description</p>
      #if seeAlso<strong>See Also:</strong><ul>/if

      To:

      <section>
      <h2>description</h2>
      <p>The namespace URI for this vocabulary is:
      <code>vocabURI</code></p>
      #if seeAlso<strong>See Also:</strong><ul>/if

      Then simply including two <div> sections in the appendix section will generate an appendix for each file.

      A ReSpec issue has been raised for this: https://github.com/sspeiche/respec/issues/6

            Assignee:
            James Amsden (Inactive)
            Reporter:
            James Amsden (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: