W3C home > Mailing lists > Public > public-dwbp-wg@w3.org > December 2015

Automated benefits list (was Re: Some more examples done)

From: Phil Archer <phila@w3.org>
Date: Mon, 7 Dec 2015 12:02:35 +0000
To: Newton Calegari <newton@nic.br>
Cc: Caroline Burle <cburle@nic.br>, Public DWBP WG <public-dwbp-wg@w3.org>, Bernadette Farias Loscio <bfl@cin.ufpe.br>
Message-ID: <5665755B.5000501@w3.org>
I've spent more time on the doc since our last meeting (actually, too 
much time, I need to stop enjoying myself by wiring code and get on with 
some other stuff, including creating the RDF files I promised the vocab 
editors).

Basic aim:
- replace the static image of the lists of benefits with something that 
is auto-generated.

Others have created the HTML/CSS version so I used the styles from 
Bernadette's repo but made various changes and suggestions.

In more detail
==============

There's now some scripting at the top of the page that sets up details 
of the benefits themselves and then looks through the doc for instances 
of ul elements of class 'benefitsList'.

At present, all the BPs end with a set of img elements. I've replaced 
those in the HTML with a ul list. If scripting is disabled then the user 
would see that textual list. With it turned on, they get replaced by the 
icons.

The CSS for the tables was a little tricky. It was all over the shop in 
my version, even though I re-used the styles that work in Berna's 
version. In the end I've set it up using a multi-column layout and that 
seems to work.

I also played with the SVG a little to make the text centralised across 
the icon itself.

I question the value in saying that every BP has the benefit of reuse. 
It's true that they do, but, as you say, that's the point of the doc as 
a whole. I'd be inclined to drop that as a specific benefit. Where it is 
the only benefit for a BP then we may need to come up with a new one :-)

@Newton, on your question here...
Yes, having a live dataset is clearly good. I do worry about having a 
different link in the text than the actual hyperlink. Thinking about it, 
I'd be inclined to make a separate link.

As an example, see http://www.w3.org/TR/powder-dr/#operational

If there's just one CSV file for the whole doc then it can be linked 
from the section where the running example is first introduced?

Also, please note that I've changed the domain data.mycity.gov to 
data.mycity.example (since mycity.gov could potentially exist one day, 
.example will not).

Too much has changed in the main repo for me to make a PR (at least, one 
that can be merged) but you can see everything I've done at 
http://philarcher1.github.io/dwbp/bp.html

HTH

Phil.

On 04/12/2015 12:57, Newton Calegari wrote:
> Hi Phil,
>
> thanks for your contribution :-)
>
> To make the examples more practical, we would like to use “some real examples”, lke to make a dataset available, for instance.
>
> In the example you decied to use the URL http://data.mycity.gov/public-transport/road/bus/dataset/timetable.csv <http://data.mycity.gov/public-transport/road/bus/dataset/timetable.csv>, but we want to make possible to access the “timetable.csv” in the "http://w3.org/TR/dwbp/examples/data.mycity.gov/public-transport…timetable.csv”.
>
> Do you think if it is ok on using something like this, to make the dataset accessible:
> 	<a href=“http://w3.org/TR/dwbp/examples/data.mycity.gov/public-ransport/road/bus/dataset/timetable.csv”>http://data.mycity.gov/public-transport/road/bus/dataset/timetable.csv</a>
>
> The “visible link" will be different of the href.
>
> cheers,
> Newton
>
>> Em 03/12/2015, à(s) 15:35, Bernadette Farias Lóscio <bfl@cin.ufpe.br> escreveu:
>>
>> Hi Phil,
>>
>> Thanks a lot for your message and for your contribution!
>>
>> I've been spending some more time looking at the BP doc - it's looking better all the time.
>>
>> Thanks :)
>>
>> I know you've done a lot on it recently, so much so that I can't merge my changes. Don't care what people say, if 2 people are working on the doc at the same time, 99% of the time one of you is going to trash your local GH fork and start again. C'est la vie :-)
>>
>> Anyway, you can see what I've done at
>> http://philarcher1.github.io/dwbp/bp.html#DataIdentifiers <http://philarcher1.github.io/dwbp/bp.html#DataIdentifiers>
>>
>> The first two BPs there now have examples that build on the running example of My City data.
>>
>> Yes, it's gonna be difficult to merge because now I am reviewing the whole document and I'm trying to include more examples and the BP benefits. In this case, it's better if I include the examples that tou created on the version that I'm working now.
>>
>>
>> As a result of this, I've made a note that I'd really like to change the many instances of :dataset-001 to :timetable-001 (and equivalent changes throughout). This is because it makes more sense in the context of a persistent URI for the dataset.
>>
>> Yes! I like the idea! I'm gonna do this.
>>
>> I've also been working with Christophe on examples for the Data preservation section. See http://philarcher1.github.io/dwbp/bp.html#EvaluateCandD <http://philarcher1.github.io/dwbp/bp.html#EvaluateCandD>
>>
>> I have more I want to do tomorrow before the meeting but that's where I'm up to for now.
>>
>> Great Phil!  I am really happy with the examples.
>>
>>
>> I also want to update the SVG diagram and turn those lists of benefits into HTML/CSS rather than the current image.
>>
>> It sounds great! I used the png because I'm not really good with svg or CSS.
>>
>>
>> And those SVG icons for the benefits should, I think, be separate files and incorporated as <img src="....svg" rather than written inline, no?
>>
>> Yes! I'm gonna do this.
>>
>>
>> And, finally, native-speaker pedantry coming up...
>>
>> Trustworthy should really be "Trustworthiness" but that's very long. How about simply 'Trust'?
>>
>> And one more thing, 'Accessibility' at W3C usually refers to the accessibility of Web pages (WCAG and all that). Would you be OK with simply calling that benefit 'Access'?
>>
>> I think it's ok! I was not really happy with the use of "Accessibility". Let's use Access and wait for the feedback ;)
>>
>>
>> Cheers,
>> Berna
>>
>>
>>
>>
>>
>> Cheers
>>
>> Phil.
>>
>> --
>>
>>
>> Phil Archer
>> W3C Data Activity Lead
>> http://www.w3.org/2013/data/ <http://www.w3.org/2013/data/>
>>
>> http://philarcher.org <http://philarcher.org/>
>> +44 (0)7887 767755 <tel:%2B44%20%280%297887%20767755>
>> @philarcher1
>>
>>
>>
>> --
>> Bernadette Farias Lóscio
>> Centro de Informática
>> Universidade Federal de Pernambuco - UFPE, Brazil
>> ----------------------------------------------------------------------------
>
>

-- 


Phil Archer
W3C Data Activity Lead
http://www.w3.org/2013/data/

http://philarcher.org
+44 (0)7887 767755
@philarcher1
Received on Monday, 7 December 2015 12:02:42 UTC

This archive was generated by hypermail 2.3.1 : Monday, 7 December 2015 12:02:43 UTC