-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
516 lines (463 loc) · 17.9 KB
/
index.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="pandoc">
<meta name="author" content="Jakob Voß (VZG)">
<meta name="dcterms.date" content="2022-06-09">
<title>Data Validation made easy</title>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
<link rel="stylesheet" href="https://unpkg.com/reveal.js@^4//dist/reset.css">
<link rel="stylesheet" href="https://unpkg.com/reveal.js@^4//dist/reveal.css">
<style>
.reveal .sourceCode { /* see #7635 */
overflow: visible;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
<link rel="stylesheet" href="https://unpkg.com/reveal.js@^4//dist/theme/white.css" id="theme">
<link rel="stylesheet" href="style.css"/>
</head>
<body>
<div class="reveal">
<div class="slides">
<section id="title-slide">
<h1 class="title">Data Validation made easy</h1>
<p class="author">Jakob Voß (VZG)</p>
<p class="institute">ELAG 2022 Conference, Riga</p>
<p class="date">2022-06-09</p>
</section>
<section id="outline" class="slide level2">
<h2>Outline</h2>
<ul>
<li><p><strong>What</strong> is data validation?</p></li>
<li><p><strong>Why</strong> is data validation difficult?</p></li>
<li><p><strong>How</strong> can data validation be made easy?</p></li>
<li><p><strong>Where</strong> can I use it?</p></li>
</ul>
</section>
<section>
<section id="what-is-data-validation" class="title-slide slide level1">
<h1>What is data validation?</h1>
</section>
<section id="detect-bad-data" class="slide level2">
<h2>Detect bad data</h2>
<div>
<ul>
<li class="fragment"><p>Eventually all data is sequences of
bits</p></li>
<li class="fragment"><p>Data must conform to expected shapes</p></li>
<li class="fragment"><p><strong>Data validation</strong> <span
class="math inline">=</span> check expectations</p></li>
</ul>
</div>
</section>
<section id="expectations" class="slide level2">
<h2>Expectations</h2>
<div>
<ul>
<li class="fragment"><p><strong>completeness</strong><br />
e.g. all records have year</p></li>
<li class="fragment"><p><strong>constraints</strong><br />
e.g. year < 2022</p></li>
<li class="fragment"><p><strong>consistency</strong><br />
e.g. birth < death (except time-travellers)</p></li>
</ul>
</div>
</section>
<section id="data-neq-information" class="slide level2">
<h2>Data <span class="math inline">≠</span> Information</h2>
<ul>
<li><p><strong>completeness</strong></p>
<ul>
<li><p><em>internal</em>: e.g. all authors have names</p></li>
<li><p><em>external</em>: e.g. all authors are listed</p></li>
</ul></li>
</ul>
</section>
<section id="data-quality" class="slide level2">
<h2>Data quality</h2>
<ul>
<li><p>code: <strong>unit tests</strong><br />
against software rot</p></li>
<li><p>data: <strong>data validation</strong><br />
against propagation of errors</p></li>
</ul>
</section></section>
<section>
<section id="why-is-data-validation-difficult"
class="title-slide slide level1">
<h1>Why is data validation difficult?</h1>
</section>
<section id="challenges" class="slide level2">
<h2>Challenges</h2>
<div>
<ul>
<li class="fragment"><p><strong>Big data</strong> & <strong>data
integration</strong><br />
e.g. bibliographic data + knowledge graphs</p></li>
<li class="fragment"><p><strong>Many formats</strong> & different
expectations</p></li>
<li class="fragment"><p>Diverse <strong>validation
technologies</strong></p></li>
</ul>
</div>
</section>
<section id="technologies" class="slide level2">
<h2>Technologies</h2>
<div>
<ul>
<li class="fragment"><p>Custom <strong>parser/rules</strong> (<em>if …
then …</em>)</p></li>
<li class="fragment"><p><strong>Schema languages</strong></p>
<table>
<tbody>
<tr class="odd">
<td style="text-align: left;">JSON</td>
<td style="text-align: left;">JSON Schema</td>
</tr>
<tr class="even">
<td style="text-align: left;">XML</td>
<td style="text-align: left;">XSD, DTD, Schematron</td>
</tr>
<tr class="odd">
<td style="text-align: left;">RDF</td>
<td style="text-align: left;">SHACL/ShEx</td>
</tr>
<tr class="even">
<td style="text-align: left;">String</td>
<td style="text-align: left;">RegEx, EBNF</td>
</tr>
<tr class="odd">
<td style="text-align: left;">MARC</td>
<td style="text-align: left;">Avram</td>
</tr>
</tbody>
</table></li>
</ul>
</div>
</section>
<section id="levels-of-description" class="slide level2">
<h2>Levels of description</h2>
<p><img data-src="./levels.svg" /></p>
</section></section>
<section>
<section id="how-to-make-data-validation-easy"
class="title-slide slide level1">
<h1>How to make data validation easy</h1>
</section>
<section id="abstraction" class="slide level2">
<h2>Abstraction</h2>
<p><img data-src="./abstraction.svg" style="width:200.0%" /></p>
</section>
<section id="api" class="slide level2">
<h2>API</h2>
<dl>
<dt>Request</dt>
<dd>
<code>data</code> (file, URL, file or stream) and<br />
<code>format</code> identifier (+ optional version)
</dd>
<dt>Response</dt>
<dd>
list of errors
</dd>
<dt>Error</dt>
<dd>
<code>message</code> (+ optional positions)
</dd>
</dl>
</section></section>
<section>
<section id="where-can-i-use-it" class="title-slide slide level1">
<h1>Where can I use it?</h1>
</section>
<section id="validation-server" class="slide level2">
<h2>Validation Server</h2>
<ul>
<li><p><strong>Web service</strong> to validate data</p></li>
<li><p>Configured with formats and schemas</p></li>
<li><p><a
href="https://github.com/gbv/validation-server">github.com/gbv/validation-server</a>
(Node)</p></li>
<li><p><a
href="https://format.gbv.de/validate/">format.gbv.de/validate</a></p></li>
</ul>
</section>
<section id="request-api" class="slide level2">
<h2>Request API</h2>
<div>
<ul>
<li class="fragment"><p>HTTP GET & POST</p>
<ul>
<li class="fragment">raw data or web form file upload</li>
<li class="fragment">Use in any web application (CORS)</li>
</ul></li>
<li class="fragment"><p>Web interface</p></li>
<li class="fragment"><p>Command line (requires configuration)</p></li>
</ul>
</div>
</section>
<section id="demo" class="slide level2">
<h2>Demo</h2>
<p><a href="https://format.gbv.de/validate"
class="uri">https://format.gbv.de/validate</a></p>
</section>
<section id="example" class="slide level2">
<h2>Example</h2>
<pre class="shell"><code>curl https://format.gbv.de/validate/vzg-article \
--data-binary @article.json</code></pre>
<div class="sourceCode" id="cb2"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span> </span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"message"</span><span class="fu">:</span> <span class="st">"must be array"</span><span class="fu">,</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">"position"</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">"jsonpointer"</span><span class="fu">:</span> <span class="st">"/authors"</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
</section>
<section id="benefits" class="slide level2">
<h2>Benefits</h2>
<ul>
<li><p>Registry of known formats and schemas</p></li>
<li><p>No local installation required</p></li>
<li><p>Unified API</p></li>
</ul>
</section></section>
<section>
<section id="summary-outlook" class="title-slide slide level1">
<h1>Summary & Outlook</h1>
</section>
<section id="data-quality-paradigms" class="slide level2">
<h2>Data quality paradigms</h2>
<div>
<ul>
<li class="fragment"><p><strong>Authority based</strong><br />
done by experts is good by definition</p></li>
<li class="fragment"><p><strong>Evidence based</strong><br />
continuous measuring & improving</p></li>
</ul>
</div>
</section>
<section id="abstraction-1" class="slide level2">
<h2>Abstraction</h2>
<p><img data-src="./summary.svg" style="width:200.0%" /></p>
</section>
<section id="implementation" class="slide level2">
<h2>Implementation</h2>
<ul>
<li><p>Validation Server</p></li>
<li><p>Configure formats with schemas</p></li>
<li><p>Public instance <a
href="https://format.gbv.de/validate/">format.gbv.de/validate</a></p></li>
</ul>
</section>
<section id="planned-features" class="slide level2">
<h2>Planned features</h2>
<ul>
<li><p>Support more schema languages<br />
(Avram, EBNF, Schematron SHACL/ShEx…)</p></li>
<li><p>Support validating MARC21</p></li>
<li><p>Show error context</p></li>
</ul>
</section>
<section id="alternatives" class="slide level2">
<h2>Alternatives</h2>
<ul>
<li><p>Build-in rules of black-box library system 😕</p></li>
<li><p>Validator engines for each schema language
(e.g. <code>xmllint</code>) 😐</p></li>
<li><p>Metadata Quality Assurance Framework 😀</p></li>
</ul>
</section></section>
</div>
</div>
<script src="https://unpkg.com/reveal.js@^4//dist/reveal.js"></script>
<!-- reveal.js plugins -->
<script src="https://unpkg.com/reveal.js@^4//plugin/notes/notes.js"></script>
<script src="https://unpkg.com/reveal.js@^4//plugin/search/search.js"></script>
<script src="https://unpkg.com/reveal.js@^4//plugin/zoom/zoom.js"></script>
<script>
// Full list of configuration options available at:
// https://revealjs.com/config/
Reveal.initialize({
// Display controls in the bottom right corner
controls: true,
// Help the user learn the controls by providing hints, for example by
// bouncing the down arrow when they first encounter a vertical slide
controlsTutorial: true,
// Determines where controls appear, "edges" or "bottom-right"
controlsLayout: 'bottom-right',
// Visibility rule for backwards navigation arrows; "faded", "hidden"
// or "visible"
controlsBackArrows: 'faded',
// Display a presentation progress bar
progress: true,
// Display the page number of the current slide
slideNumber: false,
// 'all', 'print', or 'speaker'
showSlideNumber: 'all',
// Add the current slide number to the URL hash so that reloading the
// page/copying the URL will return you to the same slide
hash: true,
// Start with 1 for the hash rather than 0
hashOneBasedIndex: false,
// Flags if we should monitor the hash and change slides accordingly
respondToHashChanges: true,
// Push each slide change to the browser history
history: false,
// Enable keyboard shortcuts for navigation
keyboard: true,
// Enable the slide overview mode
overview: true,
// Disables the default reveal.js slide layout (scaling and centering)
// so that you can use custom CSS layout
disableLayout: false,
// Vertical centering of slides
center: true,
// Enables touch navigation on devices with touch input
touch: true,
// Loop the presentation
loop: false,
// Change the presentation direction to be RTL
rtl: false,
// see https://revealjs.com/vertical-slides/#navigation-mode
navigationMode: 'default',
// Randomizes the order of slides each time the presentation loads
shuffle: false,
// Turns fragments on and off globally
fragments: true,
// Flags whether to include the current fragment in the URL,
// so that reloading brings you to the same fragment position
fragmentInURL: true,
// Flags if the presentation is running in an embedded mode,
// i.e. contained within a limited portion of the screen
embedded: false,
// Flags if we should show a help overlay when the questionmark
// key is pressed
help: true,
// Flags if it should be possible to pause the presentation (blackout)
pause: true,
// Flags if speaker notes should be visible to all viewers
showNotes: false,
// Global override for autoplaying embedded media (null/true/false)
autoPlayMedia: null,
// Global override for preloading lazy-loaded iframes (null/true/false)
preloadIframes: null,
// Number of milliseconds between automatically proceeding to the
// next slide, disabled when set to 0, this value can be overwritten
// by using a data-autoslide attribute on your slides
autoSlide: 0,
// Stop auto-sliding after user input
autoSlideStoppable: true,
// Use this method for navigation when auto-sliding
autoSlideMethod: null,
// Specify the average time in seconds that you think you will spend
// presenting each slide. This is used to show a pacing timer in the
// speaker view
defaultTiming: null,
// Enable slide navigation via mouse wheel
mouseWheel: false,
// The display mode that will be used to show slides
display: 'block',
// Hide cursor if inactive
hideInactiveCursor: true,
// Time before the cursor is hidden (in ms)
hideCursorTime: 5000,
// Opens links in an iframe preview overlay
previewLinks: false,
// Transition style (none/fade/slide/convex/concave/zoom)
transition: 'fade',
// Transition speed (default/fast/slow)
transitionSpeed: 'default',
// Transition style for full page slide backgrounds
// (none/fade/slide/convex/concave/zoom)
backgroundTransition: 'fade',
// Number of slides away from the current that are visible
viewDistance: 3,
// Number of slides away from the current that are visible on mobile
// devices. It is advisable to set this to a lower number than
// viewDistance in order to save resources.
mobileViewDistance: 2,
// reveal.js plugins
plugins: [
RevealNotes,
RevealSearch,
RevealZoom
]
});
</script>
</body>
</html>