Upcoming TocPlugin changes
"Anton van Straaten" <[email protected]>
| Newsgroups | gmane.lisp.scheme.plt.schematics |
|---|---|
| Message-ID | <[email protected]> |
For everyone's information, in a little while I'm going to start changing the existing topics to use the TocPlugin. This will be a test; if we're not happy with it, I'll change it all back. The TocPlugin seems as though it should solve the problem I ran into. Afaict, using it seems to have two consequences (these aren't intended as instructions yet, just informative): * Instead of using the TWiki ---+ notation for headings that should appear in the TOC, we'll use %SECTION0%, %SECTION1%, etc. instead. We may only want to use these tags for chapter, section and recipe headings - the rest can be ordinary headings which won't go into the TOC. * For inclusion in the cookbook, any new topic has to be added to a list in a topic called WebOrder. Then instead of %TOC%, we'll use %CONTENTS% to get a top-level table of contents. This automatically builds the TOC from the %SECTIONn% headings in all of the topics listed in WebOrder. This means that the hierarchy of topic inclusion doesn't matter; headings will be pulled from topics no matter how deeply they're nested. This is the bit that solves the problem I ran into. With instructions and the examples provided by the existing topics, I don't think this'll be too complicated. The main extra thing it imposes is the need to add the topic to an additional list, other than the point it is included in the book. If a contributor forgets to do that, it's easy to find and fix. It'll also be obvious: if there are any %SECTION% tags in the new topic, they'll display an error message. Anton ------------------------------------------------------- This SF.Net email is sponsored by: IBM Linux Tutorials Free Linux tutorial presented by Daniel Robbins, President and CEO of GenToo technologies. Learn everything from fundamentals to system administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click