Skip to content

Commit

Permalink
gitdocumentatie (#3)
Browse files Browse the repository at this point in the history 
* gitdocumentatie

* new config

* Recover `conformance` and `tof`

---------

Co-authored-by: Alexander Green <alexander.green@logius.nl>
  • Loading branch information
@logius-standaardenbeheer @sanderke
logius-standaardenbeheer and sanderke committed Apr 25, 2023
1 parent c566c7d commit 814fe4e
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 228 deletions.
83 changes: 37 additions & 46 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -1,49 +1,40 @@
<!DOCTYPE html>
<html lang="nl">

<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>Digikoppeling Koppelvlakstandaard WUS</title>
<script src="js/config.js" class="remove"></script>
<link rel="shortcut icon" type="image/x-icon"
href="https://publicatie.centrumvoorstandaarden.nl/respec/style/logos/logius.ico" />
<script src="https://publicatie.centrumvoorstandaarden.nl/respec/builds/respec-logius.js" class="remove" async>
<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type"/>
<meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport"/>
<title>
Digikoppeling Koppelvlakstandaard WUS
</title>
<script class="remove" src="https://gitdocumentatie.logius.nl/publicatie/respec/organisation-config.js">
</script>
</head>

<body>
<section id='abstract' data-include="01_abstract.html"></section>
<section id='sotd'></section>
<section class="introductory" data-include-format="markdown" data-include="02_documentbeheer.md"></section>
<section class="introductory" data-include-format="markdown" data-include="03_colofon.md"></section>

<section data-include-format="markdown" data-include="ch01_Inleiding.md"></section>
<section data-include-format="markdown" data-include="ch02_Koppelvlakstandaard WUS.md"></section>
<section data-include-format="markdown" data-include="ch03_Digikoppeling profielen WUS.md"></section>
<!-- De rest van het document kun je in Markdown schrijven. -->
<!-- <section id="tof" class="informative appendix"></section> -->
<section id='conformance'>
<!-- This section is filled automatically by ReSpec. -->
</section>

<section id="tof">
<!-- This section is filled with figures automatically by ReSpec. -->
</section>

<!-- <section id="toc"> -->
<!-- This section is filled with content automatically by ReSpec. -->
<!-- </section> -->

<!-- <section id="index"> -->
<!-- This section is filled with content automatically by ReSpec. -->
<!-- </section> -->

<!-- This p is filled with content automatically by ReSpec. -->
<!-- <section id="github-contributors">
<h1>Contributors</h1>
<p id="gh-contributors"></p>
</section> -->
</body>

</html>
<script class="remove" src="js/config.js">
</script>
<script>
respecConfig = {...organisationConfig, ...respecConfig}; if (respecConfig.specStatus.toUpperCase() == "WV") {respecConfig.thisVersion = respecConfig.edDraftURI;}
</script>
<link href="https://gitdocumentatie.logius.nl/publicatie/respec/style/logos/logius.ico" rel="shortcut icon" type="image/x-icon"/>
<script async="" class="remove" src="https://gitdocumentatie.logius.nl/publicatie/respec/builds/respec-nlgov.js">
</script>
</head>
<body>
<section data-include="01_abstract.html" id="abstract">
</section>
<section id="sotd">
</section>
<section class="introductory" data-include="02_documentbeheer.md" data-include-format="markdown">
</section>
<section class="introductory" data-include="03_colofon.md" data-include-format="markdown">
</section>
<section data-include="ch01_Inleiding.md" data-include-format="markdown">
</section>
<section data-include="ch02_Koppelvlakstandaard WUS.md" data-include-format="markdown">
</section>
<section data-include="ch03_Digikoppeling profielen WUS.md" data-include-format="markdown">
</section>
<section id='conformance'>
</section>
<section id="tof">
</section>
</body>
</html>
206 changes: 24 additions & 182 deletions js/config.js
View file
Original file line number Diff line number Diff line change
@@ -1,187 +1,29 @@
var respecConfig = {
// this template doesn't use all possible config parameters
// see https://respec.org/docs/ for alle

// specStatus currently supported
// WW, GN-WV: Werkversie
// CV, GN-CV: Consultatie versie
// VV, GN-VV: Vastgestelde versie (of Versie ter vaststelling)
// DEF, GN-DEF: Definitieve versie
// EO: Einde ondersteuning, verouderde versie, vervangen door nieuwe versie
// TG: Versie teruggetrokken
// BASIS, GN-BASIS: 'geen status'

specStatus: "DEF",
// SpecType currently supported
// NO: "Norm"
// ST: "Standaard"
// IM: "Informatiemodel"
// PR: "Praktijkrichtlijn"
// HR: "Handreiking"
// WA: "Werkafspraak"
// AL: "Algemeen"
// BD: "Beheerdocumentatie"
// BP: "Best Practice"
specType: "ST",

// subtitle will be shown below title, can be omitted
//subtitle: "Hier komt een subtitle",

// The specification's publish domain, which is used to publish the specification
// the url in the header thisVersion is generated like `<conf.nl_organisationPublishURL>/<conf.pubDomain>/<specStatus>-<specType.toLowerCase()>-<conf.shortName>}-conf.publishDate>/`
alternateFormats: [ {
"label" : "pdf",
"uri" : "Digikoppeling-Koppelvlakstandaard-WUS.pdf"
} ],
authors: [ {
"mailto" : "digikoppeling@logius.nl",
"name" : "Logius"
} ],
editors: [
{
"name" : "Peter Haasnoot",
"url" : "https://logius.nl/standaarden"
},
{
"name" : "Pieter Hering",
"url" : "https://logius.nl/standaarden"
}
],
github: "https://github.com/Logius-standaarden/Digikoppeling-Koppelvlakstandaard-WUS",
previousPublishDate: "2020-10-06",
previousPublishVersion: "3.8",
pubDomain: "dk",
// The specification's "short name", which is the name used in NL_Respec URLs
shortName: "wus",

// A YYYY-MM-DD date. The publication date of the present document.
// Als er geen publishDate is opgegeven, genereert ReSpec de dataum o.b.v. de laatste wijzigingen
// Belangrijk: als publishDate niet opgegeven is, wordt bij de link "Laatst gepubliceerde versie" "geen" gezet. Anders wordt een link opgebouwd voor de laatste versie, met het formaat:
publishDate: "2022-04-11",

// A YYYY-MM-DD date. When there is a previous release of a given specification, (W3C)
previousPublishDate: "2020-10-06",

publishVersion: "3.8.1",
previousPublishVersion: "3.8",

// Zie https://github.com/w3c/respec/wiki/previousMaturity. Dit moet een
// A YYYY-MM-DD date. When a previousPublishDate is specified, this is typically required as well in order to generate the "Previous Version"
//previousMaturity: "WV",

// license can be one of the following: cc0, cc-by or cc-by-nd((default)) (see https://github.com/Geonovum/respec/wiki/license )
license: 'cc-by-nd',

// Overrides the standard logo with one or more other logos. (see https://respec.org/docs/#logos)
// Geef een lege array op als er geen <default> logo moet staan
// logos: [],

//Adds a JSON-LD script element containing schema.org information, which can be useful for search engines.
doJsonLd: true,

// An array of person objects describing the editors of the document
// this can be simple or more elaborated
editors: [{
name: "Peter Haasnoot",
url: "https://logius.nl/standaarden",
},
{
name: "Pieter Hering",
url: "https://logius.nl/standaarden",
}
],
// An array of person objects describing the authors of the document
// this can be simple or more elaborated
authors: [{
name: "Logius",
mailto: "digikoppeling@logius.nl",
}
],
// The github option allows you associate your specification with a repository on GitHub.
github: "https://github.com/Logius-standaarden/Digikoppeling-Koppelvlakstandaard-WUS",

// The URL of your test suite, gets included in the specification's headers.
// testSuiteURI: "https://portaal.digikoppeling.nl/CV/home.html",

// With long algorithms in a specification, it can be useful to allow readers to click on variables marked up with <var> (e.g., Let <var>elem</var> be ...).
// highlightVars: true,

// Controls if linked "§" section markers are added to a document
addSectionLinks: true,

// Lints for accessibility issues using axe-core
a11y: false,

// A number indicating the maximum depth of the table of contents. Defaults to 0 which includes all levels.
// maxTocLevel: 3,

// Shows links to alternate formats (such as PDF, ePub) in the document header.
// alternateFormats: [{
// label: "html",
// uri: "https://publicatie.centrumvoorstandaarden.nl/api/oauth/static.html",
// },
// {
// label: "pdf",
// uri: "https://publicatie.centrumvoorstandaarden.nl/api/oauth/static.pdf",
// },
// ],

alternateFormats: [
{
label: "pdf",
uri: "Digikoppeling-Koppelvlakstandaard-WUS.pdf",
},
],
// For Consultatieversies (specStatus="GN-CV") there is a default text in the section "Status of this document" that contains an emailaddress for feedback and comments on the document.
nl_emailComments: "digikoppeling@logius.nl",
// this parameter will add the tag_name of the latest release to the document Title
// only set this parameter when a release has been set

nl_addReleaseTagTitle: true,
// if you use a single document for your spec, which uses more than one markdown H1 header, e.g. '# inleiding'
// this configuration can be set to make sure that the alle H1 headers and navigation bars are preserved

nl_markdownSplitH1sections: false,

// nl_organisationName is used for some company specific values in the header (and Sotd)
// currently supported: Logius and Geonovum (default)
nl_organisationName: "Logius",

// prefix for the names of company specific css, svg and ico prefixes
// defaults to "GN-"
nl_organisationPrefix: "LS-",

// if nl_markdownEmbedImageInFigure is set to true images in markdown generated content will be surrounded with <figures> element
// so that figures can be linked are be a part of table of figures
nl_markdownEmbedImageInFigure: true,

// this url points to the folder where organsation specific css files are stored
// defaults to https://tools.geostandaarden.nl/respec/style/ if not set
nl_organisationStylesURL: "https://publicatie.centrumvoorstandaarden.nl/respec/style/",
// nl_organisationStylesURL: "http://localhost:8081/respec/style/",

// nl_organisationPublishURL points to organisation specifica publication page, used in header
// defaults to https://docs.geostandaarden.nl/"
nl_organisationPublishURL: "https://publicatie.centrumvoorstandaarden.nl/",

// nl_logo refers to company logo
// defaults to https://tools.geostandaarden.nl/respec/style/logos/Geonovum.svg
nl_logo: {
src: "https://publicatie.centrumvoorstandaarden.nl/respec/style/logos/figure-logius.svg",
alt: "Logius",
id: "Logius",
height: 77,
width: 44,
url: "https://www.logius.nl/standaarden",
},

// If you need to include a one-off reference that isn't in the SpecRef database or
// if you need to override an existing reference with specific content, then you can use this configuration option.
localBiblio: {
Beveiligingsdocument: {
href: "https://publicatie.centrumvoorstandaarden.nl/dk/beveilig/",
title: "Digikoppeling Beveiligingsstandaarden en voorschriften",
publisher: "Logius",
},
Certificaten: {
href: "https://cert.pkioverheid.nl/",
title: "PkIoverheid certificaten",
publisher: "Logius"
},
Logius: {
href: "https://logius.nl/digikoppeling",
title: "Logius Digikoppeling",
publisher: "Logius",
},
Compliance: {
href: "https://portaal.digikoppeling.nl",
title: "Digikoppeling Compliance Voorziening",
publisher: "Logius",
},
Voorbeelden: {
href: "https://www.logius.nl/sites/default/files/public/bestanden/diensten/DigiKoppeling/Overig/Digikoppeling-Koppelvlakstandaard-WUS-Voorbeeldberichten.zip",
title: "Digikoppeling WUS voorbeelden (zip)",
publisher: "Logius",
}

}
shortName: "wus",
specStatus: "DEF",
specType: "ST"
};

0 comments on commit 814fe4e

Please sign in to comment.