Bill Allombert on Sat, 06 Aug 2016 15:13:53 +0200


[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]

Re: online HTML docs


On Mon, Aug 01, 2016 at 10:30:51AM +0200, Karim Belabas wrote:
> * Bill Allombert [2016-07-30 23:25]:
> > On Mon, Jul 25, 2016 at 12:08:13PM +0200, Karim Belabas wrote:
> > > P.S. Thanks to everybody who commented and submitted bug reports !
> > > 
> > > The /html/ version uses frames which are scheduled to be replaced by a css
> > > equivalent. The /ref/ version should pass a HTML5 validator (and
> > > currently misses a few sections like "GP operators" and the introduction
> > > to "readline").
> > 
> > What would be nice would be an single URL scheme that gives a link to the
> > documentation of any GP function.
> 
> 2) I kind of like the current grouping by "help section" and I'd prefer
> to keep it way. Would something like
> 
>     html/9.html#bnfinit
> 
> be suitable ? You need to know the help section number for this
> (9 for bnfinit) but inside gp it's not a problem ( ep->menu ). Of course
> 
>   General_number_fields.html#bnfinit
> 
> already works but you need to know the section name as normalized by gphtml,
> which is less convenient; whereas gphtml can trivially soft link
> 
>   General_number_fields.html -> 6.html
> 
> while dumping the HTML pages since it knows the correspondance.

Done, except that I added the symlinks by hand for testing:
Try
??bnfinit 
in the online GP

Probably we should add the chapter number:
html/chapt3/6.html#bnfinit
instead of
html/6.html#bnfinit

Cheers,
Bill.