Re: documentation format and html output --

[Karl-Friedrich R. <ra...@un...>]

Am 20.08.2015 um 00:01 schrieb Hans-Bernhard Bröker:
> Am 19.08.2015 um 01:34 schrieb Karl-Friedrich Ratzsch:
> 
>> Trying to link to them using
>>
>> ^ <a href="#positive">positivelink</a>
>>
>> was not possible, pdflatex complains about runaway arguments and
>> unfound references. Hm. I'll look into this.
> 
> Well, maybe there's a reason all the existing links are spelled like
> this instead:
> 
> ^ <a href="#positive">
>  positivelink
> ^ </a>
> 
> ;-)

Ah! Still it never used, can't be, because there is a bug in
doc2tex, the link gets two closing brackets too many. I uploaded a fix:
https://sourceforge.net/p/gnuplot/patches/719/#646e


>> I wanted to add an empty lines before section heading, two for
>> levels 2,3, to make navigation in the source a bit easier. Any
>> objection to changing that style rule?
> 
> Why make such a major change, when every self-respecting
> programmers' text editor can regex-search for, e.g., /^3/ ?

Oh, I don't have so much respect for myself as a programmer.
And you said nobody had an editor with syntax highlighting for the
gnuplot docs. ;-)
I noticed the diff format is rather similar, and i might perhaps dig
myself into finally learning regular expressions and adjusting
gedits highlighting scheme to the gnuplot.doc format. Let's see.

Still, i see no harm in adding an empty line before every heading.
Similar looking source code still works, but gets frowned upon.

> 
>> There is one comment in docs/README, saying
>>
>>     Tables must have a space in column 2.
>>
>> Any idea what this means? It is never done.
> 
> Ah, but it is! For _plain_text_ tables, that is.

Which are indented much further. Ah! So the rule might better be
"Plaintext tables get indented so as to at least leave a space in
column 2."

But plaintext always has fixed line feed anyway. Does that rule make
any difference? (Of course it makes a lot of sense to indent tables.)

  Karl