Marcos Cáceres edited this page Feb 13, 2018 · 20 revisions

ReSpec is a tool that makes writing specifications easier. ReSpec handles things like styling, referential integrity, bibliographical data, and other mundane tasks.

User's guide

A detailed user's guide is available.

If you want to hack on ReSpec, we also have a Developers Guide.

Getting up and running

All you need is a HTML Document and to set some configuration options. Each configuration option is documented in this Wiki.

<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <title>Replace me with a real title</title>
    <script 
     src='https://www.w3.org/Tools/respec/respec-w3c-common' 
     class='remove'></script>
    <script class='remove'>
      var respecConfig = {
        specStatus: "ED",
        editors: [{
          name: "Your Name",
          url: "http://your-site.com",
        }],
        github: "http://github.com/w3c/some-spec",
        shortName: "dahut"
      };
    </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>

Getting Support

The official support channel for ReSpec is spec-prod@w3.org. The mailing list archives are available. You can subscribe by sending email to spec-prod-request@w3.org with "subscribe" as the subject line.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.