Skip to content

Commit db658b4

Browse files
committed
Add "List of Requirements" tool using ReSpec hooks
This adds a "List of Requirements" as an additional navigation section, after the table of contents. This list is populated by scraping the specification document's HTML markup. Each list item is an occurrence of a "MUST" or "SHOULD" RFC 2119 keyword, along with some context. List item headers link back to the respective section containing the keyword. The item elements themselves are clickable, and scroll to the reference location in the document. A "shortcut" button appears next to the ReSpec UI button, to allow for jumping to the list. This also has a secondary purpose, as it signals the existence of this feature.
1 parent 41b0957 commit db658b4

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

index.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,20 @@
77
<script src="common/js/biblio.js" class="remove"></script>
88
<script src="common/js/pub.js" class="remove"></script>
99
<script src="common/js/idllink.js" class="remove"></script>
10+
<script src="https://unpkg.com/reqlist/lib/reqlist.js" class="remove"></script>
11+
<link href="https://unpkg.com/reqlist/lib/reqlist.css" class="remove" rel="stylesheet" type="text/css" />
1012
<link href="common/css/common.css" rel="stylesheet" type="text/css" />
1113
<script class="remove">
1214
// <![CDATA[
1315
var respecConfig = {
14-
postProcess: [create_manifest, convert_dfn_to_link],
16+
preProcess: [
17+
prepare_reqlist
18+
],
19+
postProcess: [
20+
create_manifest,
21+
convert_dfn_to_link,
22+
add_reqlist_button
23+
],
1524
wg: "Publishing Working Group",
1625
specStatus: "ED",
1726
shortName: "pub-manifest",

0 commit comments

Comments
 (0)