RE: [oslc-promcode] Re: Fw: [oslc-core] Specification authoring tools + usage of vocabs and shapes

[Steve K Speicher <sspeiche@us.ibm.com>]

Hi Kaz,

I have responded below


> From: Kazuhiro Funakoshi <k-f@bk.jp.nec.com>
> To: Steve K Speicher/Raleigh/IBM@IBMUS
> Cc: Arthur Ryman <ryman@ca.ibm.com>, "oslc-promcode@lists.oasis-open.org"
> <oslc-promcode@lists.oasis-open.org>
> Date: 01/28/2015 09:27 PM
> Subject: RE: [oslc-promcode] Re: Fw: [oslc-core]
Specification authoring 
> tools + usage of vocabs and shapes
> 
> Dear Steve,
> 
> I'm Kaz from PROMCODE-TC. We are using your ReSpec and think it's
a really 
> productive tool.
> 
> I have two questions:
> 
> * for shape documents, following tag provides URI, but it seems a
URI to the
> resource in namespace, not shape URI. Is it a intended
> behavior?
>         <div title='RDF Shape for Template'
>                 data-include='./template-spec-shape.ttl'
>                 data-
>                 data-include-sync='true'
>                 data-include-replace='true'
>                 data-include-format='html'></div>

Can you elaborate on what you mean that the tag provides
URI?  The attribute "data-include" takes a parameter the
file name the document to include and the attribute 'data-oninclude' instructs
the tool which function to use to process the document it loads, which
using the function name of 'shapeToSpec' invokes the function I wrote to
transform the shape into ReSpec/HTML.

This seems to work fine in the template spec and I
used it yesterday for the discovery spec.

http://sspeiche.github.io/respec/examples/oslc/template-spec.html

> * my another question is the trick you are using at oslc-core svn
repository
> to provide html file. 
> In our repository, clicking html files just gives us html source code
not 
> rendered html.
> Is it possible to do that with TC member privileges?
> e.g. <https://tools.oasis-open.org/version-control/browse/wsvn/oslc-
> promcode/shape/trunk/shape.html>
> 
> Currently, when I updated our spec on svn, then copy its js rendered
html to TC wiki.
> If we can see the html document from repository, then it can be much
easier.
> 
You simply need to set some svn metadata about the
file in the repository.

Here is a sample of the commands you need to run:
$svn propset svn:mime-type
text/html <filename> 
$svn commit -m "Serve html, as
html"

See thread on core TC about this: http://markmail.org/message/g3tfr6sr55ysvdct
Also on how to have your client set it by default:
http://stackoverflow.com/questions/4100121/serving-html-thru-svn-server

Hope this helps,
Steve

> Thank you in advance,
> Kaz
> 
> -----Original Message-----
> From: oslc-promcode@lists.oasis-open.org [mailto:oslc-promcode@lists.oasis-open.org
> ] On Behalf Of Arthur Ryman
> Sent: Thursday, November 27, 2014 4:40 AM
> To: Steve K Speicher; oslc-promcode@lists.oasis-open.org
> Subject: [oslc-promcode] Re: Fw: [oslc-core] Specification authoring
tools +
> usage of vocabs and shapes
> 
> Steve,
> 
> Thx for the pointer. This looks like it will be useful when it comes
time to
> producing the OASIS specification.
> 
> fyi, Kaz has been using Markdown, pandoc, and doclit to generate Turtle
and 
> HTML. This partially overlaps with your tool. We could
> still use your tool to generate HTML tables within the overall 
> specification. I've asked Kaz to create a writeup of his approach.
> _________________________________________________________
> Arthur Ryman
> Chief Data Officer
> SWG | Rational
> 905.413.3077 (phone) | 416.939.5063 (cell) IBM InterConnect 2015
> 
> 
> 
> 
> From:   Steve K Speicher/Raleigh/IBM@IBMUS
> To:     Arthur Ryman/Toronto/IBM@IBMCA
> Date:   11/25/2014 05:32 PM
> Subject:        Fw: [oslc-core] Specification
authoring tools + usage of 
> vocabs and shapes
> 
> 
> This post to the PROMCODE list failed.  I think it has to do
with me being 
> an observer and not a member of the list.
> 
> Anyway, if you don't mind please forwarding to the list and interested
in 
> your feedback as well on this.
> 
> ----- Forwarded by Steve K Speicher/Raleigh/IBM on 11/25/2014 05:31
PM
> -----
> 
> From:   Steve K Speicher/Raleigh/IBM
> To:     oslc-promcode@lists.oasis-open.org
> Date:   11/25/2014 05:17 PM
> Subject:        Fw: [oslc-core] Specification
authoring tools + usage of 
> vocabs and shapes
> 
> 
> Hopefully your TC could find this tool as useful.  It is fairly
limited on 
> documentation of the extensions currently provided, I've
> been trying to keep the template spec complete with all the new features.
> 
> ----- Forwarded by Steve K Speicher/Raleigh/IBM on 11/25/2014 05:15
PM
> -----
> 
> From:   Steve K Speicher/Raleigh/IBM@IBMUS
> To:     "OASIS OSLC Core TC Discussion List" 
> <oslc-core@lists.oasis-open.org>
> Date:   11/25/2014 05:13 PM
> Subject:        [oslc-core] Specification authoring
tools + usage of 
> vocabs and shapes
> Sent by:        <oslc-core@lists.oasis-open.org>
> 
> 
> 
> For some time and in various WGs, we've discussed whether certain
items are 
> considered "spec" or not.  It also has been desired
to
> limit the amount of specification development we need to do, so we've
done 
> some work in the past to automate generation of human
> readable HTML tables from things such as OSLC Resource Shapes. 
> 
> I've completed some initial work (some more to do), that shows promise
in 
> automating this.  So I wanted to share the progress with
> you. 
> 
> Take for example this sample specification, namely these 2 sections:
> Shapes : 
> http://sspeiche.github.io/respec/examples/oslc/template-spec.html#shape
> Vocabulary : 
> http://sspeiche.github.io/respec/examples/oslc/template-spec.html#rdf-vocabulary
> 
> 
> To enable the first, all that is needed is to include the OASIS version
of 
> ReSpec and this bit of HTML: 
> 
>         <div title='RDF Shape for Template'
>                 data-include='./template-spec-shape.ttl'
>                 data-
>                 data-include-sync='true'
>                 data-include-replace='true'
>                 data-include-format='html'></div>
> 
> and obviously provide the shape in Turtle format. 
> 
> Likewise for vocabulary definition, you can just do: 
> 
>         <div title='RDF Vocabulary for Template'
>                 data-include='./template-spec-vocab.ttl'
>                 data-
>                 data-include-sync='true'
>                 data-include-replace='true'
>                 data-include-format='html'></div>
                
> 
> This gives us great flexibility in being able to change the template
and 
> generation of the HTML without needing to go touch every spec under
> development.  Note, when we are ready to publish a document through
the 
> OASIS publication process it will be transformed to raw HTML and scripts
> removed. 
> 
> I've already started to use this in real specs and is looking to be
a 
> great aide 
> http://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/specs/
> attachments-v3.html#resources 
> 
> 
> Feedback welcome (positive, problems, ideas to make it better)  Not
> welcoming criticism of my JS skills, well maybe on a different thread.
> 
> Thanks,
> Steve Speicher
> IBM Rational Software
> OSLC - Lifecycle integration inspired by the web -> 
> http://open-services.net
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe from this mail list, you must leave the OASIS TC that
> generates this mail.  Follow this link to all your TCs in OASIS
at:
> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
>