Re: lynx-dev extending the syntax of 'include' command in lynx.cfg

[Vlad Harchev]

On Sun, 18 Apr 1999, Leonid Pauzner wrote:

> 15-Apr-99 00:51 Vlad Harchev wrote:
> >   Here is a patch that implements this functionality (except brave 
> > approach).
> >  It works as described. Features:
> ...
> 
> > PS: It will be good if someone documented the 'include' command. As I
> > remember, even the description of the plain 'include' is absent in the docs.
> 
> An INCLUDE behaviour mentioned breafly in Lynx Users Guide (near the bottom)
> with a pointer to LYNXCFG:/ page.  But I think the real documentation
> should belong to lynx.cfg file itself.  Probably few words of comments
> from you really welcome.

  If TD confirm that this patch will be integrated I'l try, but I afraid of my
English.

  Also I have the following idea:
 We can write the documentation for the lynx.cfg in html (and each option will
have an anchor consisting of it's name). When adding new options/changing
behaviour of the options, we will modify that html file. And we can write the
script that will regenerate the comments in lynx.cfg automatically: (by
cutting the html piece corresponding to each option (with sed), rendering that
piece to text with lynx) and prefixing the rendered text with '#'. I think the
script will be easy to write. 
  After having moved all docs to some html file( say it will be lynxcfg.html),
we can do even more:
  when generating the contents of LYNXCFG:// in read_cfg, we can make each
option name 'X' used to be a hyperlink with href 'lynxcfg.html#X' - so user
can quickly explore documentation for each option s/he used.
  More explanation:
if the was a following line in lynx.cfg:
        STARTFILE:http://lynx.browser.org
current code in LYReadCFG.c:read_cfg will generate the following piece of code
        STARTFILE:http://lynx.browser.org 
(ie copy it). After moving all option description to lynxcfg.html, we can
generate the following entry:
        <a href="/whatever/path/lyxncfg.html#STARTFILE>
                STARTFILE</a>:http://lynx.browser.org
ie user will be able to activate this hyperlink and get the description of
the 'STARTFILE' option. 

 Best regards,
  -Vlad