W3C home > Mailing lists > Public > spec-prod@w3.org > July to September 2011

Re: Placing Abstract and Sotd in table of contents

From: Robin Berjon <robin@berjon.com>
Date: Wed, 7 Sep 2011 21:11:19 +0200
Cc: "spec-prod@w3.org Prod" <spec-prod@w3.org>
Message-Id: <A5F2F41F-D6E5-4A98-B4F7-F968A94610E0@berjon.com>
To: Shane McCarron <shane@aptest.com>
On Sep 7, 2011, at 19:15 , Shane McCarron wrote:
> I was recently asked by the PFWG to ensure the Abstract and Sotd are in the ToC.  This doesn't seem like it is normal W3C house style, so I certainly wouldn't do it as a default.  However, would anyone object to my adding this as an option?  Otherwise I am going to have to mark up the ReSpec-based PFWG documents by hand!

Since I had my hands still in there when I got this email, I made a change that supports this.

TL;DR: You can set tocIntroductory to true in your spec's configuration and it should DTRT.

What happens under the hood is that sections with class=introductory, which are ignored for the ToC by default (that class is automatically added to SotD and Abstract), now get included (but not numbered, because it seemed weird). This means that documents which had added other such front material using class=introductory will now show up in the ToC too when this option is enabled. Hopefully that's not an issue (people not using this won't see any difference).

Robin Berjon - http://berjon.com/ - @robinberjon
Received on Wednesday, 7 September 2011 19:11:45 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:55:16 UTC