|
DataMuseum.dkPresents historical artifacts from the history of: DKUUG/EUUG Conference tapes |
This is an automatic "excavation" of a thematic subset of
See our Wiki for more about DKUUG/EUUG Conference tapes Excavated with: AutoArchaeologist - Free & Open Source Software. |
top - metrics - downloadIndex: T h
Length: 1799 (0x707) Types: TextFile Names: »helpfile«
└─⟦52210d11f⟧ Bits:30007239 EUUGD2: TeX 3 1992-12 └─⟦c319c2751⟧ »unix3.0/TeX3.0.tar.Z« └─⟦036c765ac⟧ └─⟦this⟧ »TeX3.0/TeXcontrib/gnutex/Help/helpfile«
?topic This line is printed when the user wants help on "topic". ? ?? Help is available on: alias keyword subject topic last-subject spaces work space Since there is a null keyword for this line, this section is printed when the user wants general help (when a help keyword isn't given). A command summary is usually here. Notice that the null keyword is equivalent to a "?" keyword here, because of the '?' and '??' keyword lines above. ?keyword ?Keyword ?KEYWORD These lines will be printed on the screen if the user wanted help on "keyword", "Keyword", or "KEYWORD". No casefolding is done on the keywords. ?subject ?alias This line is printed for help on "subject" and "alias". ?spaces work ?spaces ?work Note that spaces are okay in keywords. This allows you to set up an entry for, say, "open usage". Then when someone types an unrecognized argument to the `open' command, you can make a call like: help("open usage", helpfilename); so it looks like you have a usage message in your program, whereas you really are still using the help file. ? ? That previous line was just a space, like this line is a comment. ?space You can even get help on just a space, although keywording invisible characters could prove confusing to your users. Note that "comments" are really just very long keyword entries, above. It's unlikely that anyone would ask for help on " That previous line was just a space, like this line is a comment." ?revision @(#) 1.1 87/07/23 ?last-subject Note that help sections are terminated by the start of the next '?' entry or by EOF. So you can't have a leading '?' on a line of any help section. You can re-define the magic character to recognize in column 1, though, if '?' is too useful. (I suggest ^A in such extreme cases.)