OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

oslc-core message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: [OASIS Issue Tracker] (OSLCCORE-28) Update ReSpec to support multiple vocabulary files


    [ https://issues.oasis-open.org/browse/OSLCCORE-28?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=60903#comment-60903 ] 

James Amsden commented on OSLCCORE-28:
--------------------------------------

The complete OSLC Core vocabulary needs to be published as a single file at http://open-services.net/ns/core. So separating the core vocabulary into different files in order to support ReSpec providing the terms section does not seem practical since it would result in duplicate vocabulary content. 

I propose:
1. Put all the OSLC vocabulary into vocab/core-vocab.ttl

2. Don’t include the vocabulary details in the Terms section in each multi-part specification, its not that pretty or useful. Instead, add a link to the Terms section and publish the whole vocabulary in the common-vocab.html specification. Rely on the generated shape tables for the Terms and Constraints in each sub-specification instead.

3. Continue to keep the shapes in separate files.

> Update ReSpec to support multiple vocabulary files
> --------------------------------------------------
>
>                 Key: OSLCCORE-28
>                 URL: https://issues.oasis-open.org/browse/OSLCCORE-28
>             Project: OASIS OSLC Lifecycle Integration Core (OSLC Core) TC
>          Issue Type: Task
>            Reporter: James Amsden
>            Assignee: James Amsden
>              Labels: ReSpec
>
> 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



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]