Carlo de Falco wrote:
> On 12 Feb 2010, at 23:13, Søren Hauberg wrote:
>
>
>> I don't think an elegant solution to this problem is feasibly. What I
>> have written is quite a hack, but it works most of the time. We
>> could in
>> principle introduce a new texinfo macro that marks the first sentence,
>> i.e. something like
>>
>> @first_sentence{Rotate an image around the center by a given angle.}
>>
>> This would also allow us to apply a different style to the first
>> sentence (not sure if we would actually want to do that, though).
>>
>> This approach, however, requires changes to core Octave, and to be
>> honest I'm not so sure it's actually a good idea...
>>
>> Søren
>>
>>
>
> Is that first sentence used anywhere else than in the html docs for
> packages?
> If that is the only use, one solution would be to add the short
> description to
> the INDEX file syntax rather than change the Octave help system.
> e.g. one could do:
>
> OCS >> Octave Circuit Simulator
> Matrix Assembly Functions
> asm_initialize_system {build the system matrices for the linear and
> time-invariant part of the system.}
> ....
>
> If the INDEX has no short description we could then fall back to the
> current approach of extracting from
> the docstring.
>
> c.
I believe the "lookfor" function can either search for matches in the
first sentence or the whole body of the help text. So yes there is
another use for the first sentence function.
D.
------------------------------------------------------------------------------
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
Octave-dev@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/octave-dev
