Beyond the question of the usefulness of an index in an online document (in my mind not very), implementing an index at this point would be an enormous amount of work (a good index always is).
I was not there when the doc was designed, but I suspect that the index tags that are there now were machine generated when the doc was moved from HTML to DocBook. No index tags have been added for at least the past few years. I certainly agree with your point in general. On Thu, Aug 5, 2010 at 10:52 AM, P T Withington <[email protected]> wrote: > I have just one question, (from something I learned when programming > robots: It is much easier to remember where you left something than to go > looking for it again): Should we use the "right" markup in hopes there will > someday be an index, rather than having to go look for indexable terms when > that day arrives? > > On 2010-08-05, at 10:18, Lou Iorio wrote: > > > I'm afraid the markup is wildly different throughout the doc. When I add > > anything > > new, I just use the <literal> tag: I've stopped using the <sgmltag> as > well. > > > > Tags like <indexterm> and <sgmltag> were part of the original design, but > > never implemented. > > > > On Thu, Aug 5, 2010 at 9:41 AM, André Bargull <[email protected]> > wrote: > > > >> Hmm, I've just copied and pasted the docbook markup from other places in > >> the same chapter, that's why there are the additional <indexterm> tags. > >> > >> I've made the following changes per your review comments and committed > the > >> change: > >> - removed all <indexterm>, but left <sgmltag> in the initial paragraph > >> (that way the attributes are rendered in the same font just like in the > rest > >> of the chapter) > >> - applied your proposal and simplified the list items, so the attribute > >> name is not repeated twice > >> > >> > >> > >> > >> > >> On 8/5/2010 2:26 PM, Lou Iorio wrote: > >> > >>> approved, but I'm not sure why you're using docbook "indexterm" tags: > >>> > >>> since we don't have an index, and probably never will. I just use > >>> "literal" tags > >>> for this kind of thing. It's really only a display issue: indexterms > >>> appear in the > >>> HTML as red text. > >>> > >>> I would simplify this: > >>> > >>> <literal>textalign</literal>: > >>> <indexterm><primary>textalign</primary></indexterm><sgmltag > >>> class="attribute">textalign</sgmltag> specifies > >>> how to align the text... > >>> > >>> to this: > >>> > >>> <literal>textalign</literal>: specifies > >>> how to align the text... > >>> > >>> Of course, you may know something I don't. > >>> > >>> Lou > >>> > >>> > >>> On Wed, Aug 4, 2010 at 8:13 PM, André Bargull <[email protected] > >>> <mailto:[email protected]>> wrote: > >>> > >>> Change 20100805-bargull-XZZ by barg...@bargull02 on 2010-08-05 > >>> 01:43:22 > >>> in /home/anba/src/svn/openlaszlo/trunk > >>> for http://svn.openlaszlo.org/openlaszlo/trunk > >>> > >>> Summary: add "letterspacing", "textalign", "textdecoration" and > >>> "textindent" to the text chapter of the Developer's Guide > >>> > >>> Bugs Fixed: LPP-8123 (lz.text - reference: improve description of > >>> "letterspacing", "textalign", "textdecoration" and "textindent") > >>> > >>> Doc Reviewer: lou > >>> > >>> Documentation: > >>> Added documentation for "letterspacing", "textalign", > >>> "textdecoration" and "textindent" with a simple example to show all > >>> attributes in action. > >>> And some other clean-up for the text chapter, see details section > >>> below. > >>> > >>> > >>> Details: > >>> - simple inline programlistings are no longer spanned over multiple > >>> lines > >>> - setXScroll() and setYScroll are deprecated, changed references to > >>> use xscroll resp. yscroll attribute > >>> - changed "scrollHeight" to proper lower case spelling "scrollheight" > >>> - removed a couple of notes about resize behaviour of text, they > >>> were totally out-dated > >>> > >>> > >>> Tests: > >>> build dguide, visual verify > >>> > >>> Files: > >>> M docs/src/developers/text.dbk > >>> A docs/src/developers/programs/text.advanced-styles.lzx > >>> > >>> Changeset: > >>> > http://svn.openlaszlo.org/openlaszlo/patches/20100805-bargull-XZZ.tar > >>> > >>> > >>> > >
