-
Notifications
You must be signed in to change notification settings - Fork 34
/
bp.html
4293 lines (4114 loc) · 259 KB
/
bp.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type">
<meta name="generator" content="HTML Tidy for HTML5 (experimental) for Linux https://github.com/w3c/tidy-html5/tree/c63cc39">
<meta content="width=device-width,initial-scale=1" name="viewport">
<title>Data on the Web Best Practices</title>
<script class="remove" src="http://www.w3.org/Tools/respec/respec-w3c-common"></script>
<script class="remove" src="bpconfig.js"></script>
<script src="cross-dom.js" type="text/javascript"></script>
<script>
/* *********************************************
This script auto-generates the lists of BPs by benefit. It works by picking
up the ul of class 'benefitsList'. If there is no JavaScript, that list still
exists as a normal ul. If JS is active, the list is replaced by the icons
************************************************ */
window.onload=init;
function bpObject(t,id,b,reqs) {
this.title = t; // The BP's title
this.id = id // Its id
if (b != undefined) {
var benefitList = new Array () ;
for (var i = 0; i < b.length; i++) {
benefitList.push(b[i].textContent);
}
this.benefits = benefitList; // Its benefits in an array
}
var requirementList = new Array();
for (var i = 0; i < reqs.length; i++) {
requirementList.push(reqs[i].hash.substring(1));
}
this.requirements = requirementList;
}
function benefitObject(b) {
this.name = b; // The benefit's name
this.id = b.toLowerCase(); // The benefit's id which is an all lower case version of the name
// I'd like to create the image object here and reuse it but it doesn't seem to work properly sadly.
/* var img = document.createElement('img');
img.src= 'images/' + b.toLowerCase() + '.svg';
img.alt= b;
img.classList.add('benefitIcon');
this.img = img; */
}
function createBenefitsTable(BPList) {
// function to generate table of bp vs. benefits
var benefitsTable = document.getElementById('bpbenefitstable');
var tbody = benefitsTable.getElementsByTagName('tbody')[0];
BPList.forEach(function(bp){
var row = tbody.insertRow(tbody.rows.length); // new row for the table
var cellBp = row.insertCell(0); // cell for BP title
var cellBenefits = row.insertCell(1); // cell for benefits
var bpTitle = document.createTextNode(bp.title);
var bpLink = document.createElement('a');
bpLink.setAttribute('href', '#'+bp.id);
bpLink.appendChild(bpTitle);
cellBp.appendChild(bpLink); // put BP link on the cell
var ul = document.createElement('ul');
ul.setAttribute('class', 'benefitsList'); // create a new ul for benefitsList
bp.benefits.forEach(function(benefit){ // iterate over benefits of the BP
var li = document.createElement('li');
var benefitText = document.createTextNode(benefit);
li.appendChild(benefitText);
ul.appendChild(li);
});
cellBenefits.appendChild(ul);
});
}
function updateBenefitListReuse() {
var benefitListReuse = document.getElementById('benefitListReuse');
var ul = benefitListReuse.getElementsByTagName('ul')[0];
benefitListReuse.removeChild(ul);
var p = document.createElement('p');
p.appendChild(document.createTextNode('All Best Practices'));
benefitListReuse.appendChild(p);
}
function createRequirementsTable(BPlist) {
var reqs = new Array();
var requirmentsTable = document.getElementById('requirementsbpstable');
var tbody = requirmentsTable.getElementsByTagName('tbody')[0];
BPlist.forEach(function(bp){
bp.requirements.forEach(function(req){
if (reqs[req] !== undefined) {
reqs[req].push(bp);
}
else {
reqs.push(req);
reqs[req] = new Array();
reqs[req].push(bp);
}
});
});
reqs.forEach(function(req){
var row = tbody.insertRow(tbody.rows.length); // new row for the table
var cellReq = row.insertCell(0); // cell for requirement
var cellBps = row.insertCell(1); // cell for BPs
var reqLink = document.createElement('a');
reqLink.setAttribute('href', 'https://www.w3.org/TR/dwbp-ucr/#'+req);
reqLink.appendChild(document.createTextNode(req));
cellReq.appendChild(reqLink);
reqs[req].forEach(function(bp){
var p = document.createElement('p');
var bpLink = document.createElement('a');
bpLink.setAttribute('href', '#'+bp.id);
bpLink.appendChild(document.createTextNode(bp.title));
p.appendChild(bpLink);
cellBps.appendChild(p);
});
});
}
function init() {
// Need an array of objects for the benefits
var theBenefits = new Array ();
theBenefits.push(new benefitObject('Reuse')) ;
theBenefits.push(new benefitObject('Access')) ;
theBenefits.push(new benefitObject('Discoverability')) ;
theBenefits.push(new benefitObject('Processability')) ;
theBenefits.push(new benefitObject('Trust')) ;
theBenefits.push(new benefitObject('Interoperability')) ;
theBenefits.push(new benefitObject('Linkability')) ;
theBenefits.push(new benefitObject('Comprehension')) ;
// Get list of our BPs and put them in an array of objects
var BPlist = new Array (); // This will be our array of BPs from the document
var BPdivs = new Array ();
BPdivs = document.getElementsByClassName('practice'); // This is the info we have effectively scraped from the page
// Need the title and id of each one
for (var i = 0; i < BPdivs.length; i++) {
var t; var id; var b; var reqs;
var BPtop = BPdivs[i].getElementsByClassName('practicelab');
t = BPtop[0].textContent; // There should only be values in BPtop[0]
id = BPtop[0].id;
// Now we need the list of benefits for that BP
var BPbenefitsList = BPdivs[i].getElementsByClassName('benefitsList');
if (BPbenefitsList[0] != undefined) {
b = BPbenefitsList[0].getElementsByTagName("li");
} else {
b = undefined;
}
var BPrequirementsList = BPdivs[i].getElementsByClassName('ucr')[0].getElementsByTagName('a');
reqs = BPrequirementsList;
BPlist.push(new bpObject(t, id, b, reqs)) ;
}
createBenefitsTable(BPlist); // Call function to create Benefits Table
createRequirementsTable(BPlist); // Call function to create Requirements Table
// Now create the panels
var r;
for (var i = 0; i < theBenefits.length; i++) { // Working through the list of benefits
r = document.createElement('div'); // Need to create the div, ready to add the list items for this benefit
r.classList.add('benefit-list-panel');
r.id = 'benefitList' + theBenefits[i].name;
/* var img = document.createElement('img'); // Put the icon at the top
img.src= 'images/' + theBenefits[i].name.toLowerCase() + '.svg';
img.alt= theBenefits[i].name;
img.classList.add('benefitIconPanel');
r.appendChild(img); */
var h = document.createElement('p');
h.classList.add('benefitsPanelTitle');
var ht = document.createTextNode(theBenefits[i].name); // Create the heading for the div which is the benefit
h.appendChild(ht);
r.appendChild(h);
// And add a UL
var ul = document.createElement('ul'); // Create the ul element that we're going to add each relevant BP to
ul.id = theBenefits[i].id + 'BPs';
for (var j = 0; j < BPlist.length; j++) { // Go through list of BPs in the doc
if (typeof BPlist[j].benefits == 'object') { // Do we have a list of benefits for this BP?
for (var k = 0; k < BPlist[j].benefits.length; k++) { // We need to look at the benefits the BP offers
if (theBenefits[i].name == BPlist[j].benefits[k]) { // We're looking at the i benefit in the list of possibles and the k benefit of BP j
var li = document.createElement('li'); // If there's a match, create the li with the hyperlink
var a = document.createElement('a');
a.href = '#' + BPlist[j].id;
var t = document.createTextNode(BPlist[j].title);
a.appendChild(t);
li.appendChild(a);
ul.appendChild(li); // Add this BP to the benefit div's list
}
}
}
}
r.appendChild(ul); // Add the ul with all its li elements to the div
document.getElementById('benefitsTables').appendChild(r); // Add the div to the doc
}
// Next we want to replace all text benefits with the relevant icon
var bList = document.getElementsByClassName('benefitsList'); // get the set of ul elements we need to process
for (var i = 0; i < bList.length; i++) {
var listElements = bList[i].getElementsByTagName('li'); // Get the li elements within this ul
for (var j = 0; j < listElements.length; j++) {
for (var k = 0; k < theBenefits.length; k++) { // Go through the benefits
if (listElements[j].textContent == theBenefits[k].name) { // The text in the current li element matches the current benefit, so we can make the swap
// bList[i].removeChild(listElements[j]); // This works but it destroys things as they're created. Should rearrange the loop but for now...
listElements[j].classList.add('hidden'); // Hide the original li
var l = document.createElement('li'); // Create a new li
l.classList.add('icon');
var img = document.createElement('img'); // This is repetitive but I tried to create an img element in theBenefits but
img.src= 'images/' + theBenefits[k].name.toLowerCase() + '.svg'; // For reasons I don't understand, it dowsn't work properly, this does.
img.alt= theBenefits[k].name;
img.classList.add('benefitIcon');
img.classList.add(theBenefits[k].id + 'Icon');
l.appendChild(img); // Add the img element from the current benefit
bList[i].appendChild(l); // Add the li back into the current ul
}
}
}
}
updateBenefitListReuse(); // replace ul>li of Benefits Reuse to text "All Best Practices"
// Separately, we need to set up the cross dom for the challenges SVG
initCrossDom();
}
</script>
<style type="text/css">
#bp-summary ul {
list-style-type: none;
padding-left: 0;
line-height:1.6em;
background-color: #FCFAEE;
}
.hidden {display:none}
ul.benefitsList li.icon {
display:inline;
list-style-type: none;
}
ul.benefitsList li.icon img {
padding:0;
margin-right:1em;
max-width:60px;
max-height: 70px;
}
ul.benefitsList li.icon img.comprehensionIcon, ul.benefitsList li.icon img.discoverabilityIcon, ul.benefitsList li.icon img.interoperabilityIcon, ul.benefitsList li.icon img.processabilityIcon {
max-width:80px;
}
ul.benefitsList li.icon img.discoverabilityIcon, ul.benefitsList li.icon img.interoperabilityIcon, ul.benefitsList li.icon img.processabilityIcon {
max-width:73px;
}
/* *************************************************************
These styles are for the lists of benefits
************************************************************** */
#benefitsTables {
width: 100%;
margin: 0 auto;
}
.benefit-list-panel {
border-radius: 1em; /*(padrão)*/
-moz-border-radius: 1em; /*(navegadores Flock e Firefox)*/
-webkit-border-radius: 1em; /*(navegadores Chrome e Safari)*/
padding: 0.2em 1em;
}
.benefit-list-panel ul {
list-style-type:none;
padding-left:0;
}
.benefit-list-panel ul li {
font-size:smaller;
line-height:1.4em;
}
.benefit-list-panel p.benefitsPanelTitle {
font-weight: bold;
text-transform: uppercase;
text-align: center;
}
#benefitListReuse {
background: #B0CC9B;
border: 1px solid #387F05;
}
#benefitListAccess {
background: #E8F1FA;
border: 1px solid #81B3E0;
}
#benefitListTrust {
background: #E6BE9F;
border: 1px solid #BF5B0E;
}
#benefitListDiscoverability {
background: #CCBEB5;
border: 1px solid #7F5C46;
}
#benefitListProcessability {
background: #C5B5DE;
border: 1px solid #6E46AD;
}
#benefitListInteroperability {
background: #F3E09A;
border: 1px solid #E0B200;
}
#benefitListLinkability {
background: #B9C1CC;
border: 1px solid #50637F;
}
#benefitListComprehension {
background: #B3B3B3;
border: 1px solid #404040;
}
/* *******************************************
We reuse the 2 column style (for screens > 600 wide) from the list of BPs
to create the columns for the lists of benefits
********************************************** */
@media screen and (min-width: 600px) {
#bp-summary ul, #benefitsTables {
column-count:2;
-moz-column-count:2;
-webkit-column-count:2;
column-gap: 1em;
}
/* We need to re-set the column number to 1 so that within each panel there is only 1 column */
#benefitsTables .benefit-list-panel {
column-count:1;
-moz-column-count:1;
-webkit-column-count:1;
margin:.1em;
display:inline-block; /* This prevents single lists spanning multiple columns, thank you http://stackoverflow.com/questions/6682501/css3-columns-widows-orphans */
width:90%; /* For somr reason some of the panels are wider than others, this stops that heppening */
}
}
/* And we can go to three columns for bigger screens */
@media screen and (min-width: 850px) {
#benefitsTables {
column-count:3;
-moz-column-count:3;
-webkit-column-count:3;
column-gap: 1em;
}
}
/* Styles for the BPs themsevles */
.practice, #tempPractice {
padding-left: 1em;
background-color: #FCFAEE;
border: thin solid #CCC;
/*border-radius: 10px;*/
margin-bottom: 1.5em;
}
#tempPractice .tempPracticelab {
background-color:#dfffff;
position: relative;
top: -1.5em;
font-weight:bold;
}
.practice p.practicedesc, #tempPractice p.tempPracticedesc {
font-style:italic;
border-bottom: thin solid black;
position:relative;
top:-1.5em;
margin: 0 2em -1em 1em;
}
.subhead{
font-weight:bold;
margin-top:1em;
}
.benefits .stamp {
height: 52px;
width: 52px;
margin-right: 4px;
margin-bottom: 4px;
}
.benefits .stamp-template {
height: 82px;
width: 82px;
margin-right: 4px;
margin-bottom: 4px;
}
.practice dl dt #tempPractice dl dt{
font-weight:normal;
}
figure {
text-align:center;
}
figure#contextDiagram {
width:60%;
margin:0 auto;
}
figure figcaption {
text-align:center;
font-style:italic;
}
table#uripatternstable,
table.bptable {
border-collapse: collapse;
caption-side:bottom;
}
table#uripatternstable th, table#uripatternstable td,
table.bptable th, table.bptable td {
border: 1px solid black;
padding:0.3em;
}
table#uripatternstable caption,
table.bptable caption {
margin:0.5em;
font-style:italic;
}
.stmt
{
padding: 3pt}
.stmt1
{
column-count:2;
-moz-column-count:2;
-webkit-column-count:2;
column-gap: 1em;
background-color: #FCFAEE;
}
.expand{
display:block;
cursor: pointer;
}
.expand:hover {
color: #3D3D3D;
}
.expand:before {
font-weight: bold;
content: "\25C6 Example (click to expand or collapse)";
}
.expand + input{
display:none;
}
.expand + input + *{
display:none;
}
.expand + input:checked + *{
display:block;
}
.benefits-itens {
width: 100%;
margin: 0 auto;
}
.benefits-itens .item {
border-radius: 22px; /*(padrão)*/
-moz-border-radius: 22px; /*(navegadores Flock e Firefox)*/
-webkit-border-radius: 22px; /*(navegadores Chrome e Safari)*/
width: 28%;
padding: 20px;
margin: 2px;
font-size: 13px;
line-height: 150%;
float: left;
}
.benefits-itens .item .title {
font-size: 16px;
font-weight: 800;
text-transform: uppercase;
text-align: center;
}
.benefits-itens .reuse {
background: #B0CC9B;
border: 1px solid #387F05;
}
.benefits-itens .access {
background: #E8F1FA;
border: 1px solid #81B3E0;
}
.benefits-itens .trust {
background: #E6BE9F;
border: 1px solid #BF5B0E;
float: right;
}
.benefits-itens .discoverability {
background: #CCBEB5;
border: 1px solid #7F5C46;
}
.benefits-itens .processability {
background: #C5B5DE;
border: 1px solid #6E46AD;
}
.benefits-itens .interoperability {
background: #F3E09A;
border: 1px solid #E0B200;
float: right;
}
.benefits-itens .linkability {
background: #B9C1CC;
border: 1px solid #50637F;
}
.benefits-itens .comprehension {
background: #B3B3B3;
border: 1px solid #404040;
float: right;
}
@media screen and (min-width: 1024px) {
.benefits-itens .item {
margin-left: 1.6%;
}
}
@media screen and (max-width: 900px) {
.benefits-itens .item {
clear: both;
display: inline-block;
float: left !important;
width: 90%;
}
}
</style>
</head>
<body>
<section id="abstract">
<p>This document provides Best Practices related to the
publication and usage of data on the Web designed to help support a
self-sustaining ecosystem. Data should be discoverable and
understandable by humans and machines. Where data is used in some way,
whether by the originator of the data or by an external party, such
usage should also be discoverable and the efforts of the data publisher
recognized. In short, following these Best Practices will facilitate
interaction between publishers and consumers.</p>
</section>
<section id="sotd">
<p>This version of the document shows its expected scope and future
direction. A template is used to show the "what", "why" and "how" of
each Best Practice. Comments are sought on the usefulness of this
approach and the expected scope of the final document.</p>
</section>
<section id="intro" class="informative">
<h2>Introduction</h2>
<p>The Best Practices described below have been developed to encourage and
enable the continued expansion of the Web as a medium for the exchange
of data. The growth in online sharing of open data by governments across the world
[[OKFN-INDEX]] [[ODB]], the increasing online publication of research data encouraged
by organizations like the Research Data Alliance [[RDA]], the harvesting,
analysis and online publishing of social media data, crowd-sourcing of information, the
increasing presence on the Web of important cultural heritage collections such as at the
Bibliothèque nationale de France [[BNF]] and the sustained growth in the
Linked Open Data Cloud [[LODC]], provide some examples of this growth in
the use of Web for publishing data.</p>
<p>However, this growth is not consistent in style and in many cases does not make use of the full potential of the Open Web Platform's ability to link one fact to another, to discover related resources and to create interactive visualizations.</p>
<p>In broad terms, data publishers aim to share data either openly or with
controlled access. Data consumers (who may also be producers themselves)
want to be able to find, use and link to the data, especially if it is accurate,
regularly updated and guaranteed to be available at all times. This
creates a fundamental need for a common understanding between data
publishers and data consumers. Without this agreement, data publishers'
efforts may be incompatible with data consumers' desires.</p>
<p>The openness and flexibility of the Web create new challenges for data
publishers and data consumers, such as how to
represent, describe and make data available in a way that it will be
easy to find and to understand. In contrast to conventional databases,
for example, where there is a single data model to represent the data
and a database management system (DBMS) to control data access, data on
the Web allows for the existence of multiple ways to represent and to
access data. For more details about the challenges see the section <a href="#challenges">Data on the Web Challenges</a>.</p>
<p>In this context, it becomes crucial to
provide guidance to publishers that will improve consistency in the way
data is managed. Such guidance will promote the reuse of data and foster
trust in the data among developers, whatever technology they choose to
use, increasing the potential for genuine innovation.</p>
<p>A general Best Practice to publish Data on the Web is to use standards. Different types of organizations specify standards that are specific to the publishing of datasets related to particular domains & applications, involving communities of users interested in that data. These standards define a common way of communicating information among the users of these communities. For example, there are two standards that can be used to publish transport timetables: the General Transit Feed Specification [[GTFS]] and the Service Interface for Real Time Information [[SIRI]]. These specify, in a mixed way, standardized terms, standardized data formats and standardized data access. The Best Practices set out in this document serve a general purpose of publishing and using Data on the Web and are domain & application independent. They can be extended or complemented by other Best Practices documents or standards that cover more specialized contexts.</p>
<!-- <p>Taking that into account, this document sets out a series of Best Practices that will help publishers and consumers face the new challenges and opportunities posed by data on the Web. They intend to serve a general purpose of publishing and using Data on the Web, but they may be specialized according to specific domains, such as Spatial Data on the Web Best Practices [[SDW-BP]].</p>-->
<p>Best Practices cover different aspects related to data publishing and
consumption, like data formats, data access, data identifiers and
metadata. In order to delimit the scope and elicit the required features
for Data on the Web Best Practices, the <abbr title="Data on the Web Best Practices">DWBP</abbr>
working group compiled a set of use cases [[DWBP-UCR]] that represent
scenarios of how data is commonly published on the Web and how it is
used. The set of requirements derived from these use cases were used to
guide the development of the Best Practices.</p>
<p>The Best Practices proposed in this document are intended to serve a
more general purpose than the practices suggested in, for example, Best Practices for
Publishing Linked Data [[LD-BP]] since DWBP is domain-independent. Whilst DWBP recommends the use of Linked Data, it also promotes best
practices for data on the Web in other open formats such as CSV. <!--The Best Practices related to the use of vocabularies
incorporate practices that stem from Best Practices for Publishing
Linked Data where appropriate.</p>-->
<p>In order to encourage data publishers to adopt the DWBP, benefits were set: comprehension; processability; discoverability; reuse; trust; linkability; access; and interoperability. They are described and related to the Best Practices in the section <a href="#BP_Benefits">Best Practices Benefits</a>.</p>
</section>
<section id="audience" class="informative">
<h2>Audience</h2>
<p>This document sets out Best Practices tailored primarily for those who publish data on the
Web. The Best Practices are designed to meet the needs of information
management staff, developers, and wider groups such as scientists
interested in sharing and reusing research data on the Web. While data
publishers are our primary audience, we encourage all those engaged in
related activities to become familiar with it. Every attempt has been
made to make the document as readable and usable as possible while still
retaining the accuracy and clarity needed in a technical specification.</p>
<p>Readers of this document are expected to be familiar with some
fundamental concepts of the architecture of the Web [[WEBARCH]], such as
resources and URIs, as well as a number of data formats. The normative
element of each Best Practice is the <em>intended outcome</em>.
Possible implementations are suggested and, where appropriate, these
recommend the use of a particular technology.
A basic knowledge of vocabularies and data models would be helpful to
better understand some aspects of this document. </p>
</section>
<section id="scope" class="informative">
<h2>Scope</h2>
<p>This document is concerned solely with Best Practices that:</p>
<ul>
<li>are specifically relevant to data published on the Web;</li>
<li>encourage publication or reuse of data on the Web;</li>
<li>can be tested by machines, humans or a combination of the two.</li>
</ul>
<p>As noted above, whether a Best Practice has or has not been followed
should be judged against the <em>intended outcome</em>, not the <em>possible
approach to implementation</em> which is offered as guidance. A best
practice is always subject to improvement as we learn and evolve the Web
together.</p>
</section>
<section id="context" class="informative">
<h2>Context</h2>
<p>The following diagram illustrates the context considered in this document. In general, the Best Practices proposed for publication and usage of
Data on the Web refer to <a href="#dataset">datasets</a> and <a href="#distribution">
distributions</a>. Data is published in different distributions, which are specific physical form of a dataset. By data, "we mean known facts
that can be recorded and that have implicit meaning" [[Navathe]]. These
distributions facilitate the sharing of data on a large scale, which
allows datasets to be used for several groups of <a href="#data_consumer">
data consumers </a>, without regard to purpose, audience, interest,
or license. Given this heterogeneity and the fact that data publishers
and data consumers may be unknown to each other, it is necessary to
provide some information about the datasets and distributions that may also contribute to
trustworthiness and reuse, such as: structural metadata, descriptive
metadata, access information, data quality information, provenance
information, license information and usage information. </p>
<p>An important aspect of publishing and sharing data on the Web
concerns the architectural basis of the Web [[WEBARCH]].
A relevant aspect of this is the identification principle that says that URIs
should be used to identify resources. In our context, a resource may be
a whole dataset or a specific item of given dataset. All resources
should be published with stable URIs, so that they can be referenced and
make links, via URIs, between two or more resources. Finally, to promote the interoperability among datasets it is important to adopt data vocabularies and standards. </p>
<!--<p>The following is a composite diagram illustrating the anatomy of a published and acessible Web dataset. Data values correspond to the data itself and may be available in one or more distributions, which should be defined by the publisher considering data consumer's expectations. The Metadata component corresponds to the additional information that describes the dataset and dataset distributions, helping consumers manipulate and reuse the data. In order to allow easy access to the dataset and its corresponding distributions, multiple dataset access mechanisms can be available. Finally, to promote the interoperability among datasets it is important to adopt data vocabularies and standards. </p>-->
<img src="images/context.png" alt="Our Context" height="280" width="680">
</section>
<section id="namespaces" class="informative">
<h2> Namespaces </h2>
<p> The following namespace prefixes are used throughout this document. </p>
<table id="uripatternstable">
<caption>Namespaces used in the document</caption>
<tbody>
<tr>
<th>Prefix</th>
<th>Namespace IRI</th>
</tr>
<tr>
<td>cnt</td>
<td>http://www.w3.org/2011/content#</td>
</tr>
<tr>
<td>dcat</td>
<td>http://www.w3.org/ns/dcat#</td>
</tr>
<tr>
<td>dct</td>
<td>http://purl.org/dc/terms/</td>
</tr>
<tr>
<td>dqv</td>
<td>http://www.w3.org/ns/dqv#</td>
</tr>
<tr>
<td>duv</td>
<td>http://www.w3.org/ns/duv#</td>
</tr>
<tr>
<td>foaf</td>
<td>http://xmlns.com/foaf/0.1/</td>
</tr>
<tr>
<td>oa</td>
<td>http://www.w3.org/ns/oa#</td>
</tr>
<tr>
<td>owl</td>
<td>http://www.w3.org/2002/07/owl#</td>
</tr>
<tr>
<td>pav</td>
<td>http://pav-ontology.github.io/pav/</td>
</tr>
<tr>
<td>prov</td>
<td>http://www.w3.org/ns/prov#</td>
</tr>
<tr>
<td>rdf</td>
<td>http://www.w3.org/1999/02/22-rdf-syntax-ns#</td>
</tr>
<tr>
<td>rdfs</td>
<td>http://www.w3.org/2000/01/rdf-schema#</td>
</tr>
<tr>
<td>skos</td>
<td>http://www.w3.org/2004/02/skos/core#</td>
</tr>
</tbody>
</table>
</section>
<section id="bp-template">
<h2>Best Practices Template</h2>
<p>This section presents the template used to describe Data on the Web
Best Practices.</p>
<section> <!-- This section exists simply to put the example at the same level in the doc outline as the actual BPs -->
<div id="tempPractice">
<p><span id="template" class="tempPracticelab">Best Practice Template</span></p>
<p class="tempPracticedesc">Short description of the BP</p>
<section class="axioms">
<h4 class="subhead">Why</h4>
<p>This section answers two crucial questions:</p>
<ul>
<li>Why this is unique to publishing or reusing data on the Web? </li>
<li>How does this encourages publication or reuse of data on the
Web? </li>
</ul>
<p>A full text description of the problem
addressed by the Best Practice may also be provided. It can be any
length but is likely to be no more than a few sentences. </section>
<section class="outcome">
<h4 class="subhead">Intended Outcome</h4>
<p>What it should be possible to do when a data publisher follows the
Best Practice. </p>
</section>
<section class="how">
<h4 class="subhead">Possible Approach to Implementation</h4>
<p>A description of a possible implementation strategy is provided.
This represents the best advice available at the time of writing but
specific circumstances and future developments may mean that
alternative implementation methods are more appropriate to achieve
the intended outcome.</p>
</section>
<section class="test">
<h4 class="subhead">How to Test</h4>
<p>Information on how to test the BP has been met. This might or might
not be machine testable.</p>
</section>
<section class="ucr">
<h4 class="subhead">Evidence</h4>
<p>Information about the relevance of the BP. It is described by one
or more relevant requirements as documented in the Data
on the Web Best Practices Use Cases & Requirements document [[DWBP-UCR]]</p>
</section>
<section class="benefits" typeof="bibo:Chapter" resource="" property="bibo:hasPart">
<h4 class="subhead">Benefits</h4>
A <a href="#BP_Benefits"> benefit </a> represents an improvement in the way how datasets are available on the Web. A Best Practice can have one or more benefits.
<ul class="benefitsList">
<!-- This text list is replaced by the icons by scripting -->
<li>Reuse</li>
<li>Comprehension</li>
<li>Linkability</li>
<li>Discoverability</li>
<li>Trust</li>
<li>Access</li>
<li>Interoperability</li>
<li>Processability</li>
</ul>
</section>
</div>
</section>
</section>
<section id="bp-summary"></section>
<section id="bestPractices">
<h2>The Best Practices</h2>
<p>This section contains the Best Practices to be used by data publishers in order to help them and data consumers to overcome the different challenges faced when publishing and consuming data on the Web. One or more Best Practices were proposed for each one of the challenges, which are described in the section <a href="#challenges">Data on the Web Challenges</a>.</p>
<p>Each BP is related to one or more requirements from the Data on the Web Best Practices Use Cases & Requirements document [[DWBP-UCR]] which guided their development. Each Best Practice has at least one of these requirements as evidence of its relevance.</p>
<section id="basicExample">
<h3>Running Example</h3>
<div class="example" style="counter-increment:none">John works for the Transport Agency of MyCity and is in charge of publishing data about public transport. John wants to publish this data for different types of data consumers such as developers interested on creating applications and also for software agents. It is important that both humans and software agents can easily understand and process the data which should be kept up to date and be easily discoverable on the Web. </div>
<p>RDF examples of the application of some Best Practices are shown using Turtle [[Turtle]].</p>
</section>
<section id="metadata">
<h3>Metadata</h3>
<p>The Web is an open information space, where the absence of a specific
context, such a company's internal information system, means that the
provision of metadata is a fundamental requirement. Data will not be
discoverable or reusable by anyone other than the publisher if
insufficient metadata is provided. Metadata provides additional
information that helps data consumers better understand the meaning of
data, its structure, and to clarify other issues, such as rights and
license terms, the organization that generated the data, data quality,
data access methods and the update schedule of datasets.</p>
<p>Metadata can be used to help tasks such as dataset discovery and reuse,
and can be assigned considering different levels of granularity from a
single property of a resource to a whole dataset, or all datasets from a
specific organization.</p>
<p>Metadata can be of different types. These types can be classified in
different taxonomies, with different grouping criteria. For example, a
specific taxonomy could define three metadata types according to
descriptive, structural and administrative features. A different taxonomy could define
metadata types with a scheme according to tasks where metadata are
used, for example, discovery and reuse.</p>
<!-- begin of Provide Metadata BP -->
<div class="practice">
<p><span id="ProvideMetadata" class="practicelab">Provide metadata</span></p>
<p class="practicedesc">Provide metadata for both human users and computer applications.</p>
<section class="axioms">
<h4 class="subhead">Why</h4>
<p>Providing metadata is a fundamental requirement when publishing
data on the Web because data publishers and data consumers may be
unknown to each other. Then, it is essential to provide information
that helps human users and computer applications to understand the
data as well as other important aspects that describes a dataset
or a distribution.</p>
</section>
<section class="outcome">
<h4 class="subhead">Intended Outcome</h4>
<p>Humans will be able to understand the metadata and computer applications, notably user agents, will be able to process it.</p>
</section>
<section class="how">
<h4 class="subhead">Possible Approach to Implementation</h4>
<p>Possible approaches to provide <em>human readable metadata:</em></p>
<ul>
<li>to provide metadata as part of an HTML Web page</li>
<li>to provide metadata as a separate text file</li>
</ul>
<p>Possible approaches to provide <em>machine-readable metadata:</em></p>
<ul>
<li> machine-readable metadata may be provided in a serialization
format such as Turtle and JSON, or it can be embedded in the
HTML page using [[HTML-RDFA]] or [[JSON-LD]]. If multiple formats are published separately, they should be served from the same URL using <a href="http://www.w3.org/Protocols/HTTP/Negotiation">content negotiation</a> and made available under separate URIs, distinguished by filename extension. Maintenance of multiple formats is best achieved by generating each available format on the fly based on a single source of the metadata.</li>
<li> when defining machine-readable metadata, reusing existing
standard terms and popular vocabularies are strongly
recommended. For example, Dublin Core Metadata (DCMI) terms
[[DC-TERMS]] and Data Catalog Vocabulary [[VOCAB-DCAT]] can
be used to provide descriptive metadata.</li>
</ul>
<aside class="example">
<h5 class="subhead">Human-readable</h5>
<p><a href="dwbp-example.html">Example page</a> with a
human-readable description of an available dataset.</p>
<h5 class="subhead">Machine-readable</h5>
<p><a href="dwbp-example.ttl">Example file</a> with a
machine-readable description of an available dataset.</p>
</aside>
</section>
<section class="test">
<h4 class="subhead">How to Test</h4>
<p>Check if human readable metadata is available.</p>
<p>Check if the metadata is available in a valid machine-readable format and without syntax error.</p>
</section>
<section class="ucr">
<h4 class="subhead">Evidence</h4>
<p><span>Relevant requirements</span>: <a href="http://www.w3.org/TR/dwbp-ucr/#R-MetadataAvailable">R-MetadataAvailable,
</a><a href="http://www.w3.org/TR/dwbp-ucr/#R-MetadataDocum">R-MetadataDocum,
</a><a href="http://www.w3.org/TR/dwbp-ucr/#R-MetadataMachineRead">R-MetadataMachineRead</a></p>
</section>
<section class="benefits">
<h4 class="subhead">Benefits</h4>
<ul class="benefitsList">
<li>Reuse</li>
<li>Comprehension</li>
<li>Discoverability</li>
<li>Processability</li>
</ul>
</section>
</div>
<!-- end of BP -->
<!-- begin Discovery Metadata BP -->
<div class="practice">
<p><span id="DescriptiveMetadata" class="practicelab">Provide
descriptive metadata</span></p>
<p class="practicedesc">Provide metadata that describes the overall features of datasets and distributions.</p>
<section class="axioms">
<h4 class="subhead">Why</h4>
<p>Explicitly providing dataset descriptive information allows user
agents to automatically discover datasets available on the Web and
it allows humans to understand the nature of the dataset and its
distributions. </p>
</section>
<section class="outcome">
<h4 class="subhead">Intended Outcome</h4>
<p>Humans will be able to interpret the nature of the dataset and its distributions, and software agents will be able to automatically discover datasets and distributions.</p>
</section>
<section class="how">
<h4 class="subhead">Possible Approach to Implementation</h4>
<p>Descriptive metadata can include the following overall features
of a dataset:</p>
<ul>
<li>The <strong>title</strong> and a <strong>description</strong>
of the dataset.</li>
<li>The <strong>keywords</strong> describing the dataset. </li>
<li>The <strong>date of publication</strong> of the dataset. </li>
<li> The <strong>entity responsible (publisher)</strong> for
making the dataset available.</li>
<li> The <strong> contact point </strong> for the dataset.</li>
<li> The <strong>spatial coverage </strong> of the dataset.</li>
<li> The <strong> temporal period </strong> that the dataset
covers.</li>
<li> The <strong> themes/categories </strong> covered by a
dataset. </li>
<!--<li>Any <strong>variants</strong> (e.g. different
human-language translations) of data.</li> <li><strong>Access mechanisms</strong> through which the data be accessed (see <a href="#access">Data Access</a>). </li> -->
</ul>
<!-- <p> The information above should be included both in the human
understandable and the machine understandable versions of the metadata. </p> -->
<p>Descriptive metadata can include the following overall features
of a distribution:</p>
<ul>
<li>The <strong>title</strong> and a <strong>description</strong>
of the distribution.</li>
<li>The <strong>date of publication</strong> of the distribution.
</li>
<li>The <strong>media type</strong> of the distribution. </li>
</ul>
<p>The machine-readable version of the descriptive metadata can be
provided using the vocabulary recommended by W3C to
describe datasets, i.e. the Data Catalog Vocabulary
[[VOCAB-DCAT]]. This provides a framework in which datasets can be
described as abstract entities. </p>
<!--<p>See also <a href="#AdministrativeMetadata">Provide
Administrative Metadata</a></p> -->
<aside class="example">
<h5 class="subhead">Machine-readable</h5>
<p>The example below shows how to use [[VOCAB-DCAT]] to provide
the machine-readable <strong> discovery </strong> metadata for
the bus stops dataset (<code>stops-2015-05-05</code>). The dataset has one CSV
distribution (<code>stops-2015-05-05.csv</code>) that is also described using
the [[VOCAB-DCAT]].
The dataset is classified under
the domain represented by the relative URI <code>mobility</code>. This
domain may be defined as part of a set of domains identified by
the URI <code>themes</code>.
To describe both concepts and schema
concepts, John used <a href="http://www.w3.org/TR/skos-primer/">SKOS </a>.
To express frequency of update an instance from the <a href="http://www.w3.org/TR/vocab-data-cube/#dsd-cog">Content-Oriented