RE: Output (format) of the Implementation Report Input sheet

Hi Ivan,

unfortunately some emails between Renato and me were not shared properly:

* After having reviewed the Google document at  https://goo.gl/iXnonW Renato said the Exit Criteria should be referenced from the Test Cases listed in the Implementation Report
* I asked how, as they don’t have individual identifiers in the IM and Vocab documents
* Renato created a new list of identified exit criteria: https://github.com/w3c/poe/blob/gh-pages/test/cr-exit.md 
* … and linked it from the Test Regime page https://github.com/w3c/poe/blob/gh-pages/test/test-regime.md

This should explain the ExitCtrlID column – but that is also my feeling: we need a legend for the cryptic acronyms.

 

Finally this was left open: as the (external) Exit Criteria page refers to Test Cases is it required to refer from the Test Cases to the Exit Criteria? I suggested to have a short discussion about the Report page at the call today and only after an agreement I would add more time to the work on the Implementation Report.

 

Best,

Michael

 

From: Ivan Herman [mailto:ivan@w3.org] 
Sent: Monday, October 2, 2017 1:06 PM
To: Michael Steidl <mdirector@iptc.org>
Cc: Dr. Renato Iannella <renato.iannella@monegraph.com>; Benedict Whittam Smith <benedict.whittamsmith@thomsonreuters.com>; W3C POE WG <public-poe-wg@w3.org>
Subject: Re: Output (format) of the Implementation Report Input sheet

 

Michael,

 

thanks!

 

My main problem is that I do not really understand what the entries in the 'TC ID' and 'ExitCrID' mean. If the first column is simply our internal identification following some logic, that is fine. But the Exit Criteria ID is fairly cryptic.

 

The Exit criteria of, say, the model document[1] contain 16 bullet items. What the reviewers will look for is if the implementers fulfill those exit criteria, and the various tests may be there to test one (or several) such exit criteria. So either we try to group the report alongside exit criteria items, with tests as 'sub' items (if that is easy), or we need some additional information relating the test to exit criteria, and we need some easy way of checking that the exit criteria are indeed covered. 

 

With these goals in mind, I do not know what '-05, -02' means, or what it means if the exit criteria cell is empty.

 

I am also not sure what the 'test by val' and 'test by eval' brings me. There are already sections in the table, isn't that enough? I would propose that those two columns be simply removed. 

 

Finally, once this conversion is settled, we will need some static text to the top, but that can be done later I presume.

 

Thanks again!

 

Ivan

 

[1] https://www.w3.org/TR/2017/CR-odrl-model-20170926/#cr-exit

 

 

On 29 Sep 2017, at 18:12, Michael Steidl (IPTC) <mdirector@iptc.org <mailto:mdirector@iptc.org> > wrote:

 

Hi all,

I’ve created a draft HTML output from the Implementation Report Google sheet, posted it quickly on the IPTC server:  <https://iptc.org/temp/ODRL-CR-ImplementationReports.html> https://iptc.org/temp/ODRL-CR-ImplementationReports.html

It’s a standalone document, doesn’t use any external resources.

 

Maybe we can have a look at it at the call on Monday.

 

Best,

Michael

 

From: Ivan Herman [mailto:ivan@w3.org] 
Sent: Friday, September 29, 2017 9:07 AM
To: Michael Steidl <mdirector@iptc.org <mailto:mdirector@iptc.org> >
Cc: Dr. Renato Iannella <renato.iannella@monegraph.com <mailto:renato.iannella@monegraph.com> >; Benedict Whittam Smith <benedict.whittamsmith@thomsonreuters.com <mailto:benedict.whittamsmith@thomsonreuters.com> >; W3C POE WG <public-poe-wg@w3.org <mailto:public-poe-wg@w3.org> >
Subject: Re: Output (format) of the Implementation Report Input sheet

 

 

On 29 Sep 2017, at 08:59, Michael Steidl (IPTC) < <mailto:mdirector@iptc.org> mdirector@iptc.org> wrote:

 

Hi Renato, Ben and Ivan,

we have now the Implementation Report input sheet at  <https://goo.gl/iXnonW> https://goo.gl/iXnonW

 

As I should write a script to generate an output which can be integrated into a formal Implementation Report I need to know:

* Which columns should be in the output?
I guess the columns Formal and Comments of each implementer.
But also any of the “hardwired” columns B to F?

 

I would prefer so.






*  
* Format of the output: HTML or markdown?
(And: is there any basic template for the HTML or markdown, further: is the content of the sheet/table sufficient, or anything else?)

 

Whichever is easier for you. It would go to github, markdown is fine as long as it is readable. That being said, HTML Tables give more possibilities in terms of readability (setting the colours for specific columns or cells (highlighting the successful outcome with green, that sort of things).

 

I think some (static) introductory text before the table would be good; not everything in the table may be self-evident.






*  
* How to style the implementation results?

* In an example of another group they had this colour code
- PASS = green
- FAIL = red
- X (not tested) = yellow

 

Sounds good to me

 






*  
* How to apply a colour to a cell with the result?
Could be: a class with a name following the results (e.g. testpass, testfail, testx) – but where will the CSS be located to do the highlighting?

 

Again, whatever is easy for you. There are no rules, just your own convenience.

 

Thanks!

 

Ivan

 






*  

 

Thanks for letting me know.

 

Best,

Michael

 


----
Ivan Herman, W3C 
Publishing@W3C Technical Lead

Home:  <http://www.w3.org/People/Ivan/> http://www.w3.org/People/Ivan/
mobile: +31-641044153

ORCID ID:  <http://orcid.org/0000-0003-0782-2704> http://orcid.org/0000-0003-0782-2704

 


----
Ivan Herman, W3C 
Publishing@W3C Technical Lead

Home: http://www.w3.org/People/Ivan/
mobile: +31-641044153

ORCID ID: http://orcid.org/0000-0003-0782-2704