On 13.06.05, [EMAIL PROTECTED] wrote:
> On Sun, 12 Jun 2005, Lars Gullik Bj�nnes wrote:
> > But we don't want that kind of documentation for lfuns, we want
> > documentation that is accesible from inside lyx.
IMHO, we need both, a short description for tooltips or the status line
and a full description with markup and links etc.
> Sure, but I was really wondering about what markup to use in the actual
> description. When you say emacs' "describe-function", are you referring to
> how a function is typically described, or the *markup* that's used...
The short description should be in the source (precisely, it should be
possible to generate it from the data in the source) so that something
like "describe-function" (which is what the old "apropos" function should
be called BTW) could give a short help.
IMHO, the short description doesnot need any markup. (And if a see-also
should be contained in the Synopsis (I would put See Also only in the
full doc), an extraction script could easily convert a lfun-name to a
link.)
The full description should use LyX markup (as we are all LyX users). It
could be a "revived" and improved References.lyx document or a separate
lyx file for every lfun. (see attachment for example).
I would like to see a html version of the Help Documents accessible from
the Help menu (maybe as "Html-Help" entry, opening a LyX index page in
the users default browser).
* The help would open in a separate browser window so I can work
with my document while looking at the help. (I suppose the average
LyX user has a browser available)
* Linking would become far more "natual" without much effort. (Of
course, every lfun entry needs a mark and every "See Also" should
contain References to these marks.)
G�nter
--
G.Milde web.de
#LyX 1.3 created this file. For more info see http://www.lyx.org/
\lyxformat 221
\textclass article
\language english
\inputencoding latin1
\fontscheme default
\graphics default
\paperfontsize 10
\spacing single
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\use_natbib 0
\use_numerical_citations 0
\paperorientation portrait
\leftmargin 2cm
\topmargin 2.9cm
\rightmargin 2cm
\bottommargin 2.9cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\quotes_language polish
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle empty
\layout Subsection
Decat
\begin_inset LatexCommand \label{Decat}
\end_inset
\layout Description
Synopsis: The decat function fixes
\begin_inset Quotes eld
\end_inset
additions
\begin_inset Quotes erd
\end_inset
made by overly-helpful paws.
\begin_inset Note
collapsed true
\layout Standard
To be extracted from the data in the source by some script
\end_inset
\layout Description
Arguments: None
\begin_inset Note
collapsed true
\layout Standard
To be extracted from the data in the source by some script
\end_inset
\layout Description
Bindings:
\begin_inset Note
collapsed true
\layout Standard
To be extracted from the data in the source by some script
\end_inset
\begin_deeper
\layout List
\labelwidthstring MMMMMMM
\series bold
Menu\SpecialChar ~
-
\series default
\family sans
\bar under
E
\bar default
dit\SpecialChar \menuseparator
\bar under
D
\bar default
ecat
\layout List
\labelwidthstring MMMMMMM
\series bold
Toolbar\SpecialChar ~
-
\series default
None
\layout List
\labelwidthstring MMMMMMM
\series bold
Keyboard\SpecialChar ~
-
\series default
\family sans
W-c W-a W-t
\end_deeper
\layout Description
Description: We all know how much cats
\emph on
love
\emph default
computers, especially the laps that sit in front of them.
However, a cat, being feline, must add its opinions to whatever you're
typing.
Or, your cat may simply decide to help you finish your work so you can
get to more important matters, such as brushing and petting.
The decat function is designed for just such moments.
\layout Description
Usage: Mark a section and call
\begin_inset Quotes pld
\end_inset
decat
\begin_inset Quotes prd
\end_inset
\layout Description
Examples: A particular black and white cat once added the following:
\begin_deeper
\layout Quote
sfd4rcxy45bb q43 tfd t43revcx
\layout Standard
\SpecialChar \ldots{}
to a document.
Run through decat, it became:
\layout Quote
Hey, bozo! Pay attention to me!
\end_deeper
\layout Description
See\SpecialChar ~
Also:
\begin_inset LatexCommand \ref{Template}
\end_inset
\layout Subsection
Template
\begin_inset LatexCommand \label{Template}
\end_inset
\layout Description
Synopsis:
\begin_inset Note
collapsed true
\layout Standard
To be extracted from the data in the source by some script
\end_inset
\layout Description
Arguments:
\begin_inset Note
collapsed true
\layout Standard
To be extracted from the data in the source by some script
\end_inset
\layout Description
Bindings:
\begin_inset Note
collapsed true
\layout Standard
To be extracted from the data in the source by some script
\end_inset
\layout Description
Description:
\begin_inset Note
collapsed true
\layout Standard
Purpose and details
\end_inset
\layout Description
Usage:
\begin_inset Note
collapsed true
\layout Standard
When to call (with a section marked, only in math mode, ...)
\layout Standard
What to give as arguments
\end_inset
\layout Description
Example:
\layout Description
See\SpecialChar ~
Also:
\begin_inset LatexCommand \ref{Decat}
\end_inset
\the_end
