On Fri, Aug 24, 2012 at 11:14:34AM -0400, Dan Scott wrote: > On Fri, Aug 24, 2012 at 11:02:29AM -0400, Bill Erickson wrote: > > > > Speaking of release notes, I remembered something I wanted to bring up back > > when cutting beta1. > > <snip> > > > ... then the files in docs/RELEASE_NOTES_NEXT/ should look like this: > > > > > > Feature Name > > ^^^^^^^^^^^^ > > > > We built this city on rock and roll > > > > Feature Sub-Heading > > +++++++++++++++++++ > > > > * Marconi plays the mamba > > * listen to the radio > > > > > > In other words, start each file in docs/RELEASE_NOTES_NEXT/ at the "^^^" > > heading level. > > > > Asciidoc will warn when compiling such a file: > > > > WARNING: foo.txt: line 2: section title out of sequence: expected level 1, > > got level 3) > > > > but it will still compile, so you are able to verify the syntax. > > > > Sound sane? > > Sane, but completely unnecessary. > > Asciidoc lets you offset the levels of included files, idea being that > you might want to recombine individual topics at different levels in > different publications. So what I've been doing in the DIG docs when I > add a topic is add a normal top-level Asciidoc file, then offset it when > I include it.
[...] > You can include as many files as you like within a given offset section, > so we would only need to put one pair of offset directives in the > release notes container file, and just include the entries there. Very cool. So the release notes building process would look more like this? mkdir RELEASE_NOTES_X_Y/ mv RELEASE_NOTES_NEXT/* RELEASE_NOTES_X_Y/ create RELEASE_NOTES_X_Y.txt, which include::'s the contents of RELEASE_NOTES_X_Y/ -b -- Bill Erickson | Senior Software Developer | phone: 877-OPEN-ILS (673-6457) | email: [email protected] | web: http://esilibrary.com | Equinox Software, Inc. / Your Library's Guide to Open Source
