Home
Marcos Cáceres edited this page Jun 14, 2016
·
8 revisions
Pages 73
- Home
- Acknowledgments
- additionalCopyrightHolders
- addPatentNote
- alternateFormats
- appendix
- authors
- charterDisclosureURI
- Configuration (respecConfig)
- copyrightStart
- crEnd
- data include
- data include format
- data include replace
- data merge
- data number
- data oninclude
- data transform (Deprecated)
- diffTool
- dir
- doRDFa
- edDraftURI
- editors
- ednote
- errata
- example
- figure
- format
- implementationReportURI
- includePermalinks
- informative
- introductory
- lang
- lcEnd
- localBiblio
- logos
- maxTocLevel
- nohighlight
- noLegacyStyle
- nolinks
- noRecTrack
- note
- noTOC
- otherLinks
- Person objects
- postProcess
- practice
- practicedesc
- practicelab
- preProcess
- prevED
- previousDiffURI
- previousMaturity
- previousPublishDate
- previousURI
- prevRecShortname
- prevRecURI
- processVersion
- publishDate
- refNote
- remove
- section
- shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- title
- tocIntroductory
- wg
- wgPatentURI
- wgPublicList
- wgURI
- Show 58 more pages…
Configuring ReSpec
configuration options
- additionalCopyrightHolders
- addPatentNote
- alternateFormats
- authors
- charterDisclosureURI
- copyrightStart
- crEnd
- diffTool
- doRDFa
- edDraftURI
- editors
- errata
- format (markdown)
- implementationReportURI
- includePermalinks
- lcEnd
- localBiblio
- logos
- maxTocLevel
- noLegacyStyle
- noRecTrack
- noTOC
- otherLinks
- postProcess
- preProcess
- prevED
- previousDiffURI
- previousMaturity
- previousPublishDate
- previousURI
- prevRecShortname
- prevRecURI
- processVersion
- publishDate
- refNote
- shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- tocIntroductory
- wg
- wgPatentURI
- wgPublicList
- wgURI
HTML elements
HTML attributes
- data-include
- data-include-format
- data-include-replace
- data-merge
- data-number
- data-oninclude
- data-transform (Deprecated)
- dir
- lang
CSS Classes
Clone this wiki locally
ReSpec is a tool that makes writing specifications easier. ReSpec handles things like styling, referential integrity, bibliographical data, and other mundane tasks.
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='//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",
}],
processVersion: 2015,
edDraftURI: "http://some.github.repo",
shortName: "dahut"
};
</script>
</head>
<body>
<section id='abstract'>
<p>
This is required.
</p>
</section>
<section id='sotd'>
<p>
This is required.
</p>
</section>
<section>
<h2>Start your spec!</h2>
<pre class="idl">
interface Foo{
attribute Bar bar;
void doTheFoo();
};
</pre>
</section>
</body>
</html>Getting Support
The official support channel for ReSpec is [email protected]. The mailing list archives are available. You can subscribe by sending email to [email protected] with "subscribe" as the subject line.