Hi Søren:
Søren Hauberg wrote:
> fre, 12 02 2010 kl. 17:46 +0100, skrev Philip Nienhuis:
>> these descriptions have been truncated.
>> Evidently somewhere during publishing/upload to the site the truncation
>> happens again.
>
> I'm guessing here... When 'generate_html' displays lists of functions,
> it shows the first line of the help text. The first line is extracted by
> looking for the first period ('.') on the help text. I guess this is
> what's causing your help texts to be truncated. I consider this a bug in
> 'generate_html'; it should ensure the the character following the period
> is a blank character.
... or a "\n".
Anyway that's what I also found, but I figured that solution might still
be fragile - there are cases where it might fail, like otherwise useful
abbreviations, viz. e.g. etc. (pun intended.)
The situation would improve if stricter requirements would be imposed on
that first sentence, like:
- Max 80 characters incl. the last dot ;-) (BTW isn't this a bit too
short?)
- MUST end with one or two newline(s) (or space + newline(s))
- May contain only a concise & general description of what the function
file does
(Hmmm I did trespass these requirements myself)
- Other requirements?
Perhaps such requirements do exist already but I haven't found them in
the docs.
BTW it is function file get_first_help_sentence.m, plaintext subfunction
(written by you BTW) in the core octave Help package where this logic is
implemented. I've already looked at how to mend it but an elegant fix is
not as straightforward (for me) as I figured it would be (ugly hacks are
easier).
Philip
------------------------------------------------------------------------------
SOLARIS 10 is the OS for Data Centers - provides features such as DTrace,
Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW
http://p.sf.net/sfu/solaris-dev2dev
_______________________________________________
Octave-dev mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/octave-dev
