Home - Geonovum/respec GitHub Wiki

ReSpec is a tool that makes writing specifications easier. It handles things like styling, referential integrity and bibliographical data. ReSpec has been built by W3C and their ReSpec-wiki is available.

Getting Started

All you need is an HTML Document and to set some configuration options. Styling options are available on W3C Sample Specification.

<!DOCTYPE html>
<html lang='nl'>

<head>
  <meta charset='utf-8' />
  <title>Replace me with a real title</title>
  <script src='https://tools.geostandaarden.nl/respec/builds/respec-geonovum.js'
  class='remove' async></script>
  <script class='remove'>
    var respecConfig = {
      specStatus: 'GN-WV',
      specType: 'IM',
      editors: [{
        name: 'Your Name',
        company: 'You company',
        url: 'http://your-site.com',
      }],
      shortName: 'profile-iso21xxx',
      github: 'https://some.github.repo',
    };
  </script>
</head>

<body>
  <section id='abstract'>
    <p> This is required. </p>
  </section>
  <section id='sotd'>
    <p> This is required. </p>
  </section>
  <section data-dfn-for='Foo'>
    <h2><dfn>Foo</dfn> interface</h2>
    <pre class='idl'>
      interface Foo {
          attribute Bar bar;
          void doTheFoo();
      };
      </pre>
    <p>The <a>Foo</a> interface is nice. Lets you do stuff.</p>
    <p>The <dfn>bar</dfn> attribute, returns 🍺.
    </p>
    <p>The <dfn>doTheFoo()</dfn> method, returns nothing.
    </p>
  </section>
</body>

</html>

Preview the document

For most Geonovum documents the Github repository is configured to publish pages on github.io. If you are looking for other ways to preview the document, or like to preview while making changes, see Preview a Respec document

Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️