LinkedDataHub-Apps/docs/ttl-to-html.xsl at master · AtomGraph/LinkedDataHub-Apps · GitHub

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
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="3.0"
    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:dct="http://purl.org/dc/terms/"
    xmlns:dh="https://www.w3.org/ns/ldt/document-hierarchy#"
    xmlns:ldh="https://w3id.org/atomgraph/linkeddatahub#"
    xmlns:xhtml="http://www.w3.org/1999/xhtml"
    xmlns:json="http://www.w3.org/2005/xpath-functions"
    xmlns:local="urn:local:functions"
    xmlns="http://www.w3.org/1999/xhtml"
    exclude-result-prefixes="#all">

    <!-- primary output is suppressed; all pages are written via xsl:result-document -->
    <xsl:output method="text"/>

    <xsl:param name="docs-dir" as="xs:string" select="'/docs'"/>
    <xsl:param name="rdf-dir" as="xs:string" select="'/rdf'"/>
    <xsl:param name="output-folder" as="xs:string" select="'/output'"/>
    <xsl:param name="site-base-url" as="xs:string" select="'https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/'"/>

    <!-- all RDF/XML documents — sidecar for nav and child discovery only -->
    <xsl:variable name="all-docs" select="collection('file://' || $rdf-dir || '?select=*.rdf;recurse=yes;content-type=application/xml')"/>

    <!-- sha1 hash → filename mapping for uploads/ references -->
    <xsl:variable name="files-xml" select="document('file://' || $docs-dir || '/files.xml')"/>

    <xsl:key name="file-by-sha1"
        match="json:map/json:array[@key='files']/json:map"
        use="json:string[@key='sha1']"/>

    <!-- doc path → source .ttl modification time -->
    <xsl:variable name="timestamps-xml" select="document('file://' || $docs-dir || '/timestamps.xml')"/>

    <xsl:key name="timestamp-by-path" match="json:string" use="@key"/>

    <!--
        Derive the logical resource URI from a node's document base URI.
        riot outputs the main resource as rdf:about="" (relative to base), so we cannot
        rely on @rdf:about for identity. Instead we reconstruct from the file path:
          file:/docs/user-guide/search-data.rdf  →  file:/user-guide/search-data/
    -->
    <xsl:function name="local:resource-uri" as="xs:string">
        <xsl:param name="node" as="node()"/>
        <!-- Saxon may emit file:/path or file:///path; normalize to absolute path first -->
        <xsl:variable name="abs-path" select="replace(base-uri($node), '^file:/*', '/')"/>
        <xsl:variable name="rel" select="substring-after($abs-path, $rdf-dir)"/>
        <xsl:sequence select="'file:' || replace($rel, '\.rdf$', '/')"/>
    </xsl:function>

    <!-- ==================== INITIAL TEMPLATE ==================== -->

    <xsl:template name="main">
        <xsl:apply-templates select="$all-docs/rdf:RDF"/>

        <!-- synthetic root index.html — no TTL source exists for the docs root -->
        <xsl:variable name="root-base-path" as="xs:string" select="'/'"/>
        <xsl:variable name="top-level-docs" select="$all-docs/rdf:RDF[resolve-uri('../', local:resource-uri(.)) = 'file:/']"/>
        <xsl:result-document href="{$output-folder}/index.html" method="xhtml" html-version="5">
            <html>
                <xsl:call-template name="html-head">
                    <xsl:with-param name="title" select="'Documentation'"/>
                </xsl:call-template>
                <body>
                    <xsl:call-template name="navbar">
                        <xsl:with-param name="brand-href" select="''"/>
                    </xsl:call-template>
                    <div class="container-fluid">
                        <div class="row-fluid">
                            <nav class="span2">
                                <ul class="nav nav-list">
                                    <!-- current-uri = 'file:/' — none of the nav items match, so no active class -->
                                    <xsl:apply-templates select="$top-level-docs" mode="nav">
                                        <xsl:sort select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]/dct:title"/>
                                        <xsl:with-param name="current-uri" select="'file:/'" tunnel="yes"/>
                                        <xsl:with-param name="base-path" select="$root-base-path" tunnel="yes"/>
                                    </xsl:apply-templates>
                                </ul>
                            </nav>
                            <main class="span7">
                                <xsl:apply-templates select="$top-level-docs" mode="child-item">
                                    <xsl:sort select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]/dct:title"/>
                                    <xsl:with-param name="base-path" select="$root-base-path" tunnel="yes"/>
                                </xsl:apply-templates>
                            </main>
                        </div>
                    </div>
                    <xsl:call-template name="footer"/>
                </body>
            </html>
        </xsl:result-document>

        <!-- sitemap.xml -->
        <xsl:result-document href="{$output-folder}/sitemap.xml" method="xml" indent="yes">
            <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
                <url>
                    <loc><xsl:value-of select="$site-base-url"/></loc>
                </url>
                <xsl:for-each select="$timestamps-xml/json:map/json:string">
                    <xsl:sort select="@key"/>
                    <url>
                        <loc><xsl:value-of select="$site-base-url || substring-after(@key, '/')"/></loc>
                        <lastmod><xsl:value-of select="."/></lastmod>
                    </url>
                </xsl:for-each>
            </urlset>
        </xsl:result-document>
    </xsl:template>

    <!-- ==================== ONE PAGE PER RDF DOCUMENT ==================== -->

    <xsl:template match="/rdf:RDF">
        <xsl:variable name="resource" select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]"/>
        <xsl:variable name="resource-uri" select="local:resource-uri(.)"/>
        <xsl:variable name="base-path" select="replace($resource-uri, '^file:', '')"/>

        <xsl:result-document href="{$output-folder}{$base-path}index.html" method="xhtml" html-version="5">
            <html>
                <xsl:call-template name="html-head">
                    <xsl:with-param name="title" select="$resource/dct:title"/>
                    <xsl:with-param name="description" select="$resource/dct:description"/>
                    <xsl:with-param name="doc-path" select="$base-path"/>
                </xsl:call-template>
                <body>
                    <xsl:call-template name="navbar">
                        <xsl:with-param name="brand-href" select="local:relativize('/', $base-path)"/>
                    </xsl:call-template>
                    <div class="container-fluid">
                        <div class="row-fluid">
                            <nav class="span2">
                                <ul class="nav nav-list">
                                    <xsl:apply-templates
                                        select="$all-docs/rdf:RDF[resolve-uri('../', local:resource-uri(.)) = 'file:/']"
                                        mode="nav">
                                        <xsl:sort select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]/dct:title"/>
                                        <xsl:with-param name="current-uri" select="$resource-uri" tunnel="yes"/>
                                        <xsl:with-param name="base-path" select="$base-path" tunnel="yes"/>
                                    </xsl:apply-templates>
                                </ul>
                            </nav>
                            <main class="span7">
                                <xsl:apply-templates select="$resource">
                                    <xsl:with-param name="base-path" select="$base-path" tunnel="yes"/>
                                </xsl:apply-templates>
                            </main>
                        </div>
                    </div>
                    <xsl:call-template name="footer"/>
                </body>
            </html>
        </xsl:result-document>
    </xsl:template>

    <!-- ==================== CONTAINER ==================== -->

    <xsl:template match="rdf:Description[rdf:type/@rdf:resource = 'https://www.w3.org/ns/ldt/document-hierarchy#Container']">
        <xsl:param name="base-path" tunnel="yes"/>
        <xsl:variable name="resource-uri" select="local:resource-uri(.)"/>

        <header>
            <h1><xsl:value-of select="dct:title"/></h1>
        </header>
        <xsl:apply-templates select="*[namespace-uri() = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'][starts-with(local-name(), '_')]">
            <xsl:sort select="xs:integer(substring-after(local-name(), '_'))" data-type="number"/>
        </xsl:apply-templates>
        <nav>
            <xsl:apply-templates
                select="$all-docs/rdf:RDF[resolve-uri('../', local:resource-uri(.)) = $resource-uri]"
                mode="child-item">
                <xsl:sort select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]/dct:title"/>
            </xsl:apply-templates>
        </nav>
    </xsl:template>

    <!-- ==================== ITEM ==================== -->

    <xsl:template match="rdf:Description[rdf:type/@rdf:resource = 'https://www.w3.org/ns/ldt/document-hierarchy#Item']">
        <header>
            <h1><xsl:value-of select="dct:title"/></h1>
        </header>
        <xsl:apply-templates select="*[namespace-uri() = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'][starts-with(local-name(), '_')]">
            <xsl:sort select="xs:integer(substring-after(local-name(), '_'))" data-type="number"/>
        </xsl:apply-templates>
    </xsl:template>

    <!-- ==================== rdf:_N — dereference to target description (or suppress if no @rdf:resource) ==================== -->

    <xsl:template match="rdf:Description/*[namespace-uri() = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'][starts-with(local-name(), '_')]">
        <xsl:if test="@rdf:resource">
            <xsl:apply-templates select="../../rdf:Description[@rdf:about = current()/@rdf:resource]"/>
        </xsl:if>
    </xsl:template>

    <!-- ==================== XHTML CONTENT BLOCK ==================== -->

    <xsl:template match="rdf:Description[rdf:type/@rdf:resource = 'https://w3id.org/atomgraph/linkeddatahub#XHTML']">
        <xsl:apply-templates select="rdf:value/node()" mode="xhtml"/>
    </xsl:template>

    <!-- ==================== OBJECT BLOCK (ldh:ChildrenView etc.) — suppress ==================== -->

    <xsl:template match="rdf:Description[rdf:type/@rdf:resource = 'https://w3id.org/atomgraph/linkeddatahub#Object']"/>

    <!-- ==================== NAV MODE ==================== -->

    <xsl:mode name="nav"/>

    <xsl:template match="/rdf:RDF" mode="nav">
        <xsl:param name="current-uri" tunnel="yes"/>
        <xsl:param name="base-path" tunnel="yes"/>

        <xsl:variable name="resource" select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]"/>
        <xsl:variable name="resource-uri" select="local:resource-uri(.)"/>
        <xsl:variable name="resource-path" select="replace($resource-uri, '^file:', '')"/>
        <xsl:variable name="children" select="$all-docs/rdf:RDF[resolve-uri('../', local:resource-uri(.)) = $resource-uri]"/>

        <li>
            <xsl:if test="$resource-uri = $current-uri">
                <xsl:attribute name="class">active</xsl:attribute>
            </xsl:if>
            <a href="{local:relativize($resource-path, $base-path)}">
                <xsl:value-of select="$resource/dct:title"/>
            </a>
            <xsl:if test="$children">
                <ul class="nav nav-list">
                    <xsl:apply-templates select="$children" mode="nav">
                        <xsl:sort select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]/dct:title"/>
                    </xsl:apply-templates>
                </ul>
            </xsl:if>
        </li>
    </xsl:template>

    <!-- ==================== CHILD-ITEM MODE ==================== -->

    <xsl:mode name="child-item"/>

    <xsl:template match="/rdf:RDF" mode="child-item">
        <xsl:param name="base-path" tunnel="yes"/>

        <xsl:variable name="resource" select="rdf:Description[rdf:type/@rdf:resource = ('https://www.w3.org/ns/ldt/document-hierarchy#Item', 'https://www.w3.org/ns/ldt/document-hierarchy#Container')]"/>
        <xsl:variable name="resource-path" select="replace(local:resource-uri(.), '^file:', '')"/>

        <div class="well">
            <h2>
                <a href="{local:relativize($resource-path, $base-path)}">
                    <xsl:if test="$resource/dct:description">
                        <xsl:attribute name="title" select="$resource/dct:description"/>
                    </xsl:if>
                    <xsl:value-of select="$resource/dct:title"/>
                </a>
            </h2>
            <xsl:if test="$resource/dct:description">
                <p><xsl:value-of select="$resource/dct:description"/></p>
            </xsl:if>
        </div>
    </xsl:template>

    <!-- ==================== XHTML MODE ==================== -->

    <xsl:mode name="xhtml" on-no-match="shallow-copy"/>

    <!-- resolve uploads/<hash> to files/<name> in img src and object data -->
    <xsl:template match="xhtml:img/@src[contains(., 'uploads/')] | xhtml:object/@data[contains(., 'uploads/')]" mode="xhtml">
        <xsl:variable name="hash" select="substring-after(., 'uploads/')"/>
        <xsl:variable name="match" select="key('file-by-sha1', $hash, $files-xml)"/>
        <xsl:choose>
            <xsl:when test="$match">
                <xsl:attribute name="{local-name()}" select="substring-before(., 'uploads/') || 'files/' || $match/json:string[@key='name']"/>
            </xsl:when>
            <xsl:otherwise>
                <xsl:message terminate="yes">Could not find file for hash '<xsl:value-of select="$hash"/>'</xsl:message>
            </xsl:otherwise>
        </xsl:choose>
    </xsl:template>

    <!-- strip "LinkedDataHub Cloud" tabs, keep only the active tab content -->
    <xsl:template match="xhtml:div[@class = 'tabbable'][xhtml:ul/xhtml:li/xhtml:a = 'LinkedDataHub Cloud']" mode="xhtml">
        <xsl:apply-templates select="xhtml:div[@class = 'tab-content']/xhtml:div[contains-token(@class, 'active')]/*" mode="xhtml"/>
    </xsl:template>

    <!-- ==================== HTML BOILERPLATE NAMED TEMPLATES ==================== -->

    <xsl:template name="html-head">
        <xsl:param name="title" as="xs:string"/>
        <xsl:param name="description" as="xs:string?"/>
        <xsl:param name="doc-path" as="xs:string?"/>
        <head>
            <title>LinkedDataHub v5 — <xsl:value-of select="$title"/></title>
            <xsl:if test="$description">
                <meta name="description" content="{$description}"/>
            </xsl:if>
            <xsl:variable name="modified" select="key('timestamp-by-path', $doc-path, $timestamps-xml)"/>
            <xsl:if test="$modified">
                <meta name="last-modified" content="{$modified}"/>
            </xsl:if>
            <link href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/files/css/bootstrap.css" rel="stylesheet" type="text/css"/>
            <link href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/files/css/bootstrap-responsive.css" rel="stylesheet" type="text/css"/>
            <link href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/files/css/linkeddatahub-bootstrap.css" rel="stylesheet" type="text/css"/>
            <style type="text/css">
                body { padding-top: 60px; }
                object { width: 100%; min-height: 640px; }
            </style>
            <script type="text/javascript" src="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/files/js/jquery.min.js"/>
            <script type="text/javascript" src="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/files/js/bootstrap.min.js"/>
            <script type="text/javascript">
                <xsl:text><![CDATA[
                    $(document).ready(function() {
                        $("ul.nav-tabs a").on("click", function() {
                            $(this).closest("ul").children().toggleClass("active", false);
                            $(this).closest("li").toggleClass("active", true);
                            $(this).closest("ul").next().children().toggleClass("active", false);
                            $(this).closest("ul").next().children().eq($(this).closest("li").index()).toggleClass("active", true);
                        });
                    });
                ]]></xsl:text>
            </script>
            <script async="async" src="https://www.googletagmanager.com/gtag/js?id=UA-38402002-6"/>
            <script>
                <xsl:text><![CDATA[
                    window.dataLayer = window.dataLayer || [];
                    function gtag(){dataLayer.push(arguments);}
                    gtag('js', new Date());
                    gtag('config', 'UA-38402002-6');
                ]]></xsl:text>
            </script>
        </head>
    </xsl:template>

    <xsl:template name="navbar">
        <xsl:param name="brand-href" as="xs:string"/>
        <div class="navbar navbar-fixed-top">
            <div class="navbar-inner">
                <div class="container-fluid">
                    <a class="brand" href="{$brand-href}">LinkedDataHub</a>
                    <div class="nav-collapse collapse">
                        <ul class="nav">
                            <li class="active">
                                <div class="btn-group">
                                    <a class="btn" href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/">Documentation v5</a>
                                    <button class="btn dropdown-toggle" data-toggle="dropdown">
                                        <span class="caret"/>
                                    </button>
                                    <ul class="dropdown-menu">
                                        <li><a href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/v3/">Documentation v3</a></li>
                                        <li><a href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/v2/">Documentation v2</a></li>
                                    </ul>
                                </div>
                            </li>
                            <li><a href="https://github.com/AtomGraph/LinkedDataHub" target="_blank">Code</a></li>
                        </ul>
                    </div>
                </div>
            </div>
        </div>
    </xsl:template>

    <xsl:template name="footer">
        <div class="footer container-fluid">
            <div class="row-fluid">
                <div class="offset2 span8">
                    <div class="span3">
                        <h2 class="nav-header">About</h2>
                        <ul class="nav nav-list">
                            <li><a href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/about/" target="_blank">LinkedDataHub</a></li>
                            <li><a href="https://atomgraph.com" target="_blank">AtomGraph</a></li>
                        </ul>
                    </div>
                    <div class="span3">
                        <h2 class="nav-header">Resources</h2>
                        <ul class="nav nav-list">
                            <li><a href="https://atomgraph.github.io/LinkedDataHub/linkeddatahub/docs/" target="_blank">Documentation</a></li>
                            <li><a href="https://www.youtube.com/channel/UCtrdvnVjM99u9hrjESwfCeg" target="_blank">Screencasts</a></li>
                        </ul>
                    </div>
                    <div class="span3">
                        <h2 class="nav-header">Support</h2>
                        <ul class="nav nav-list">
                            <li><a href="https://groups.io/g/linkeddatahub" target="_blank">Mailing list</a></li>
                            <li><a href="https://github.com/AtomGraph/LinkedDataHub/issues" target="_blank">Report issues</a></li>
                            <li><a href="mailto:support@linkeddatahub.com">Contact support</a></li>
                        </ul>
                    </div>
                    <div class="span3">
                        <h2 class="nav-header">Follow us</h2>
                        <ul class="nav nav-list">
                            <li><a href="https://twitter.com/atomgraphhq" target="_blank">@atomgraphhq</a></li>
                            <li><a href="https://github.com/AtomGraph" target="_blank">github.com/AtomGraph</a></li>
                        </ul>
                    </div>
                </div>
            </div>
        </div>
    </xsl:template>

    <!-- ==================== HELPER FUNCTIONS ==================== -->

    <!-- make $target path relative to $base path (both root-relative, e.g. /get-started/) -->
    <xsl:function name="local:relativize" as="xs:string">
        <xsl:param name="target" as="xs:string"/>
        <xsl:param name="base" as="xs:string"/>
        <xsl:sequence select="local:relativize-segs(tail(tokenize($target, '/')), tail(tokenize($base, '/')))"/>
    </xsl:function>

    <xsl:function name="local:relativize-segs" as="xs:string">
        <xsl:param name="t" as="xs:string*"/>
        <xsl:param name="b" as="xs:string*"/>
        <xsl:choose>
            <xsl:when test="exists($t) and exists($b) and head($t) = head($b)">
                <xsl:sequence select="local:relativize-segs(tail($t), tail($b))"/>
            </xsl:when>
            <xsl:otherwise>
                <!-- for each remaining base segment (except first), go up one level; then append target -->
                <xsl:sequence select="string-join((for $s in tail($b) return '..', $t), '/')"/>
            </xsl:otherwise>
        </xsl:choose>
    </xsl:function>

</xsl:stylesheet>