add ReSpec template

kg-construct · Jun 15, 2021 · 3d9debd · 3d9debd
1 parent 6b404f3
commit 3d9debd
Show file tree

Hide file tree

Showing 14 changed files with 1,927 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+*.iml
+.idea/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Unreleased
+
+### Added
+
+- Respec template
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
-# rml-star-spec
+# RML star specification
+
 Specification of the RML star
+
+## Quickstart
+
+- edit dev.html
+  - Makes sure all your local assets are in the `resources` folder, and the links in your dev.html file are relative (important because the publishing script creates multiple nested paths)
+- run a HTTP server in this directory: `python3 -m http.server`
+- open `dev.html` with a browser as http://localhost:8000/dev.html
+- save as snapshot to `rendered.html` using the ReSpec's functionality: Button in the top right of the page "ReSpec" -> "Export..." -> "HTML"
+- run `node publish.js` to get the index.html + archived version in the `dist` folder
diff --git a/dev.html b/dev.html
@@ -0,0 +1,188 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>RML-star</title>
+    <meta charset='utf-8'>
+    <link rel="stylesheet" type="text/css" href="./resources/css/extras.css"/>
+    <script src="https://www.w3.org/Tools/respec/respec-w3c" class="remove" defer></script>
+    <style type="text/css">
+        /* Adapted from R2RML */
+        pre { 
+            word-wrap:normal
+        }
+        pre.ex-input,
+        pre.ex-mapping, 
+        pre.ex-output,
+        pre.ex-target,
+        pre.ex-access {
+            margin-top: 1.5em;
+            padding: 1em; 
+            font-size: 75%;
+        }
+        pre.ex-input:before,
+        pre.ex-mapping:before,
+        pre.ex-output:before, 
+        pre.ex-target:before,
+        pre.ex-access:before {
+            background: white;
+            display: block;
+            font-family: sans-serif;
+            font-size: 90%;
+            margin: -1.5em 0 0.5em 0;
+            padding: 0.4em 0.4em;
+            width: 18em;
+        }
+        /* Input data example */
+        pre.ex-input {
+            background: #cee;
+        }
+        pre.ex-input,
+        pre.ex-input:before {
+            border: 1px solid #acc;
+        }
+        pre.ex-input:before {
+            content: "Example input data";
+        }
+        /* RML mapping example */
+        pre.ex-mapping {
+            background: #eeb;
+        }
+        pre.ex-mapping,
+        pre.ex-mapping:before {
+            border: 1px solid #cc9;
+        }
+        pre.ex-mapping:before {
+            content: "Example RML-star mapping";
+        }
+        /* Output RDF example */
+        pre.ex-output {
+            background: #cfc;
+        }
+        pre.ex-output,
+        pre.ex-output:before {
+            border: 1px solid #aca;
+        }
+        pre.ex-output:before {
+            content: "Example output RDF-star";
+        }
+    </style>
+    <script class="remove">
+      var respecConfig = {
+        localBiblio: {
+          "RDF11-Concepts": {
+            title: "RDF 1.1 Concepts and Abstract Syntax",
+            href: "https://www.w3.org/TR/rdf11-concepts/",
+            status: "W3C Recommendation",
+            publisher: "W3C",
+            date: "25 February 2014",
+          },
+          "Turtle": {
+            title: "RDF 1.1 Turtle",
+            href: "https://www.w3.org/TR/turtle/",
+            status: "W3C Recommendation",
+            publisher: "W3C",
+            date: "25 February 2014",
+          }
+        },
+        // These may become useful if the document gets a more 'official' status
+        // postProcess : [ postProc ],
+        doRdfa: "true",
+        processVersion: 2021,
+        // specification status (e.g. WD, LCWD, WG-NOTE, etc.). If in doubt use ED.
+        specStatus: "unofficial",
+        // the specification's short name, as in http://www.w3.org/TR/short-name/
+        shortName: "rml-star",
+        // if your specification has a subtitle that goes below the main
+        // formal title, define it here
+        // subtitle   :  "White Paper",
+        // if you wish the publication date to be other than the last modification, set this
+        // publishDate:  "2015-06-30",
+        // if the specification's copyright date is a range of years, specify
+        // the start date here:
+        copyrightStart: "2021",
+        // if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
+        // and its maturity status
+        // previousPublishDate: "2015-10-15",
+        // previousMaturity: "FPWD",
+        // if there a publicly available Editor's Draft, this is the link
+        edDraftURI: "https://rml.io/specs/rml-star",
+        // if this is a LCWD, uncomment and set the end of its review period
+        // lcEnd: "2009-08-05",
+        // editors, add as many as you like
+        // only "name" is required
+        editors: [
+          {
+            name: "Anastasia Dimou"
+            , mailto: "anastasia.dimou@ugent.be"
+            , company: "Ghent University &ndash; imec &ndash; IDLab",
+            orcidid: "0000-0003-2138-7972",
+            companyURL: "http://idlab.technology/"
+          }
+        ],
+        // name of the WG
+        //wg: "Digital Publishing Interest Group",
+        // URI of the public WG page
+        //wgURI: "http://www.w3.org/dpub/IG/",
+        // name (without the @w3c.org) of the public mailing to which comments are due
+        //wgPublicList: "public-digipub-ig",
+        //issueBase: "https://github.com/w3c/dpub-pwp-loc/issues/",
+        //noRecTrack: "true",
+        otherLinks: [
+          {
+            key: "This Version",
+            data: [{
+              value: "https://rml.io/specs/rml-star/%thisDate%/",
+              href: "https://rml.io/specs/rml-star/%thisDate%/"
+            }]
+          },
+          {
+            key: "Previous Version",
+            data: [{
+              value: "https://rml.io/specs/rml-star/%prevDate%/",
+              href: "https://rml.io/specs/rml-star/%prevDate%/"
+            }]
+          },
+          {
+            key: "Website",
+            data: [{
+              value: "https://rml.io/",
+              href: "https://rml.io/"
+            }]
+          }
+        ],
+        // alternateFormats: [],
+        //charterDisclosureURI: "http://www.w3.org/2004/01/pp-impl/64149/status",
+        // URI of the patent status for this WG, for Rec-track documents
+        // !!!! IMPORTANT !!!!
+        // This is important for Rec-track documents, do not copy a patent URI from a random
+        // document unless you know what you're doing. If in doubt ask your friendly neighbourhood
+        // Team Contact.
+        //wgPatentURI: "http://www.w3.org/2004/01/pp-impl/64149/status",
+        // !!!! IMPORTANT !!!! MAKE THE ABOVE BLINK IN YOUR HEAD
+      };
+    </script>
+    //TODO register the rml-star goatcounter
+    <script data-goatcounter="https://rml-star.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
+    <noscript>
+        <img src="https://rml-star.goatcounter.com/count?p=/test-noscript">
+    </noscript>
+</head>
+<body>
+<section id='abstract' data-include="section/abstract.md" data-include-format="markdown"></section>
+
+<section id='sotd'>
+    <p data-format="markdown">
+        This is an early draft,
+        yet efforts are made to keep things stable.
+    </p>
+</section>
+
+<section id="conformance"></section>
+
+<section data-include="section/overview.md" data-include-format="markdown"></section>
+
+<section data-include="section/rml-star.md" data-include-format="markdown"></section>
+
+</body>
+</html>