From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me X-Spam-Level: X-Spam-Status: No, score=0.7 required=5.0 tests=BAYES_00,LOTS_OF_MONEY, MSGID_RANDY autolearn=no autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: 103376,e61c8636ef35379d X-Google-Attributes: gid103376,public X-Google-ArrivalTime: 2001-01-18 09:02:02 PST Path: supernews.google.com!sn-xit-03!supernews.com!logbridge.uoregon.edu!news.maxwell.syr.edu!nntp2.deja.com!nnrp1.deja.com!not-for-mail From: mark_lundquist@my-deja.com Newsgroups: comp.lang.ada Subject: Re: Examples in Docs Date: Thu, 18 Jan 2001 16:46:21 GMT Organization: Deja.com Message-ID: <9476kq$d5i$1@nnrp1.deja.com> References: <942eet$das$1@nnrp1.deja.com> NNTP-Posting-Host: 130.213.201.109 X-Article-Creation-Date: Thu Jan 18 16:46:21 2001 GMT X-Http-User-Agent: Mozilla/4.0 (compatible; MSIE 5.0; Windows NT; DigExt) X-Http-Proxy: 1.1 x64.deja.com:80 (Squid/1.1.22) for client 130.213.201.109 X-MyDeja-Info: XMYDJUIDmark_lundquist Xref: supernews.google.com comp.lang.ada:4174 Date: 2001-01-18T16:46:21+00:00 List-Id: In article , "Randy Brukardt" wrote: > mark_lundquist@my-deja.com wrote in message > <942eet$das$1@nnrp1.deja.com>... > > >I've been thinking about how more thorough self-reference could make a > >HT version of the RM a really powerful tool, even without additional > >material such as examples (not to discount your idea, which I think is > >a good one). > > > >What I would like to have: > > > >1) every cross-reference anchor a hyperlink to the referenced text > >2) every use of a defined term (e.g. "protected action", "nominal > >subtype", "master", etc.) anchor a HL to the definition of the term > >3) the instance of every term in its definition anchor a HL to the > >index entry for the term > >4) HLs in the syntax summary/cross-reference > > > >My RM of choice :-) is the annotated version w/ Technical Corrigenda on > >the ACAA web site; the annotations help me understand why things are > >what they are, and I feel like I'm getting the "full meal deal". A HT > >version of that that allowed the user to expand/elide the annotations > >would be great. > > Humm, the HTML version of the RM on the ACAA website in fact includes > items 1 So it does... and I'm sure I've used it many times without even noticing it, so I just didn't remember it without having it up in a browswer in front of me! :-) > and 3 on your list above. (Try clicking on any index entry, and > you will be taken directly to the item referenced.) Yes of course, but what I'm wanting is a link in the opposite direction, from the defining instance of the term into the index, at the family of index entries for that term. The combination of (2) and (3) is the real point... Let's say you were reading along and you came to the term 'discrete range', and you say "I want to see where that's defined, so you just click on it and (2) go to the definition. Then you say "I wonder where else this term is used", so you click again and (3) you're in the index looking at all the index entries for 'discrete range'. So if you can see a term in your browser you are only 3 clicks away from any other instances of use of the term. > > Item 2 would be wonderful, but it would be very expensive to do (as the > source of the RM does not mark uses of terms in any special way). > Usefully picking them out with any automated method is bound to be very > incomplete. Undoubtedly... > > Item 4 is partially accomplished by the HTML RM -- the section numbers > are hot links (so you can get to the section where the production is > defined). But not the individual items. > So I guess my wish-list would include finer-grained cross-references... > [...] > I put a lot of thought into what could be accomplished with the time I > had available, and I'm glad that people appreciate that work I sure do appreciate it! BTW, I'm not suggesting that my ideas above are anything that I think should have to do with ACAA or ARG editorial activities. It seems like you've gone "above and beyond the call of duty" as it is! :-) I guess I was imagining that someone else would produce it, maybe a student project or something. But now that you bring it up, there are two modest improvements that I think could be made to the ACAA version even with limited time :-) 1) 'A'..'Z' links into the index (it's a pretty big index to scroll through) 2) Chapter links into the TOC (again, to reduce scrolling) In fact those are so easy, maybe I'll just make my own index page and TOC and bookmark those... Best Regards, Mark Sent via Deja.com http://www.deja.com/