-#LyX 1.6.0 created this file. For more info see http://www.lyx.org/
+#LyX 1.6.1 created this file. For more info see http://www.lyx.org/
\lyxformat 345
\begin_document
\begin_header
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
+
\graphics default
\paperfontsize default
\use_hyperref false
\paperpagestyle default
\tracking_changes false
\output_changes false
-\author ""
-\author ""
+\author ""
+\author ""
\end_header
\begin_body
\begin_layout Section*
-LFUNs documentation automatically generated 23.10.2008.
+LFUNs documentation automatically generated 06.02.2009.
\end_layout
\begin_layout Standard
\end_inset
1.
- input the type and argument of this inset, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+ input the type and argument of this inset, e.g.
"menu paste", in the work area.
\begin_inset Newline newline
\end_layout
+\begin_layout Description
+Sample command-sequence info-insert buffer path; info-insert buffer name
+
+\end_layout
+
\begin_layout Description
Origin bpeng, 7 Oct 2007
\end_layout
Origin sanda, 18 Jun 2008
\end_layout
+\begin_layout Subsection*
+LFUN_PHANTOM_INSERT
+\end_layout
+
+\begin_layout Description
+Action Inserts phantom on the current cursor postion, move selection inside
+ the inset.
+
+\end_layout
+
+\begin_layout Description
+Syntax phantom-insert [<TYPE>]
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
+\end_layout
+
+\begin_layout Description
+Origin uwestoehr, 30 Jan 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_NEWLINE_INSERT
\end_layout
\begin_layout Description
Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
If no parameter is given, search with last find-dialog data is used for
- search (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+ search (i.e.
find-next).
\end_layout
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FORWARD
+LFUN_WORD_FINDADV
+\end_layout
+
+\begin_layout Description
+Action Search for next occurence of a pattern.
+
+\end_layout
+
+\begin_layout Description
+Syntax word-findadv [<DATA>]
+\end_layout
+
+\begin_layout Description
+Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
+ If no parameter is given, search with last find-dialog data is used for
+ search (i.e.
+ find-next).
+
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, Nov 15 2007
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This is the action which should be taken when the (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g., ctrl-) "left" key is pressed.
+Notion This is the action which should be taken when the (e.g., ctrl-) "left"
+ key is pressed.
Generally, it moves the cursor to the next beginning of a word on the left.
However, in Bidi text this become slightly more complicated, and there
are different modes of cursor movement.
\end_layout
\begin_layout Description
-Notion This is the action which should be taken when the (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g., ctrl-) "right" key is pressed.
+Notion This is the action which should be taken when the (e.g., ctrl-) "right"
+ key is pressed.
Generally, it moves the cursor to the next beginning of a word on the right.
However, in Bidi text this become slightly more complicated, and there
are different modes of cursor movement.
\end_layout
\begin_layout Description
-Action Capitalizes the words in the selection (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Action Capitalizes the words in the selection (i.e.
the first letters) or the letter on the cursor position.
\end_layout
\end_layout
\begin_layout Description
-Syntax thesaurus-entry
+Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <STRING>: word to look up <LANG>: language (see file languages)
+
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Params <ARG>: "paragraph" will cause pasting as one paragraph, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
"Join lines".
\end_layout
\end_layout
\begin_layout Description
-Params <ARG>: "paragraph" will cause pasting as one paragraph, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
"Join lines".
\end_layout
+\begin_layout Subsection*
+LFUN_SELECTION_PASTE
+\end_layout
+
+\begin_layout Description
+Action Pastes the text in permanent selection.
+
+\end_layout
+
+\begin_layout Description
+Syntax selection-paste
+\end_layout
+
\begin_layout Subsection*
LFUN_UNDO
\end_layout
\end_layout
\begin_layout Description
-Params <FONT_INFO>: specifies font atributes, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Params <FONT_INFO>: specifies font atributes, e.g.
family, series, shape, size, emph, noun, underbar, number, color, language,
toggleall.
\end_layout
\begin_layout Description
-Action Inserts math delimiters (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Action Inserts math delimiters (e.g.
parentheses, brackets) enclosing expression.
\end_layout
\end_layout
\begin_layout Description
-Action Inserts math fixed size delimiters (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Action Inserts math fixed size delimiters (e.g.
parentheses, brackets) enclosing expression.
\end_layout
\end_layout
\begin_layout Description
-Params <NAME>: The name of the macro, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Params <NAME>: The name of the macro, e.g.
"mymacro".
<NARGS>: The number of parameters of the macro.
Default is 0.
\end_layout
\begin_layout Description
-Syntax math-space [<TYPE>]
+Syntax math-space [<TYPE>] [<LEN>]
\end_layout
\begin_layout Description
-Params <TYPE>: negative spaces: !|negmedspace|negthickspace
+Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
+
\begin_inset Newline newline
\end_inset
- positive spaces: ,|:|;|quad|qquad
+ positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
+
+\begin_inset Newline newline
+\end_inset
+
+ custom space: hspace
\begin_inset Newline newline
\end_inset
"," used by default.
-
+ Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
+ and ; = thickspace.
+ <LEN>: length for custom spaces (hspace)
\end_layout
\begin_layout Description
\begin_layout Description
Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
- c or t) (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
- 1 char) and the horizontal alignments (l, c or r) (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+ c or t) (i.e.
+ 1 char) and the horizontal alignments (l, c or r) (i.e.
<COL> chars).
\end_layout
\end_layout
\begin_layout Description
-Action In text mode enters math mode (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Action In text mode enters math mode (i.e.
puts math insets on the current cursor position), in math mode enters text
mode inside math expression.
Origin Alejandro, 4 Jun 1996
\end_layout
+\begin_layout Subsection*
+LFUN_REGEXP_MODE
+\end_layout
+
+\begin_layout Description
+Action Enters regexp mode (i.e., puts regexp insets on the current cursor
+ position).
+ Used by the advanced search dialog.
+
+\end_layout
+
+\begin_layout Description
+Notion If there is any selected text, then it is moved inside the created
+ regexp inset.
+
+\end_layout
+
+\begin_layout Description
+Syntax regexp-mode [<ARG>]
+\end_layout
+
+\begin_layout Description
+Params <ARG>: eventual argument (regular expression).
+
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, 4 Oct 2008
+\end_layout
+
\begin_layout Subsection*
LFUN_MATH_NUMBER_LINE_TOGGLE
\end_layout
Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
\end_layout
+\begin_layout Subsection*
+LFUN_MATH_FONT_STYLE
+\end_layout
+
+\begin_layout Description
+Action Changes the text style used in math.
+
+\end_layout
+
+\begin_layout Description
+Syntax math-font-style <STYLE>
+\end_layout
+
+\begin_layout Description
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
+trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
+\end_layout
+
+\begin_layout Description
+Origin vfr, 9 jan 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_MATH_MACRO_UNFOLD
\end_layout
\end_layout
\begin_layout Description
-Notion Unfold the Math Macro the cursor is in, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Notion Unfold the Math Macro the cursor is in, i.e.
display it as foo.
\end_layout
\end_layout
\begin_layout Description
-Notion Fold the Math Macro the cursor is in if it was unfolded, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
displayed as foo before.
\end_layout
\begin_layout Description
Params <NUM>: The number of the parameter behind which the new one will
- be added (1 for the first, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+ be added (1 for the first, i.e.
use 0 for add a parameter at the left), defaults to the last one.
\end_layout
\end_layout
\begin_layout Description
-Notion Various math-environment features are handled here as well, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Notion Various math-environment features are handled here as well, e.g.
add-vline-left/right for Grid/Cases environment
\end_layout
set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
-|set-bottom-space|set-interline-space|set-border-lines
+|set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
+ar-valign-middle|tabular-valign-bottom
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
- See LyX Extended Manual (Version Control Chapter) for additional information.
+ See LyX Additional Features Manual (Version Control Chapter) for additional
+ information.
\end_layout
Origin Lgb, 1 Jul 1997
\end_layout
+\begin_layout Subsection*
+LFUN_VC_COMMAND
+\end_layout
+
+\begin_layout Description
+Action Executes external command.
+ This command is intended to support additional VCS commands.
+
+\end_layout
+
+\begin_layout Description
+Syntax vc-command <FLAG> <PATH> <COMMAND>
+\end_layout
+
+\begin_layout Description
+Params <FLAG>: Flags for the command can be combined together.
+
+\begin_inset Newline newline
+\end_inset
+
+ U - dUmmy - no flags
+\begin_inset Newline newline
+\end_inset
+
+ D - Doc - need document loaded to proceed
+\begin_inset Newline newline
+\end_inset
+
+ I - dIrty - mark document dirty
+\begin_inset Newline newline
+\end_inset
+
+ R - Reload - ensure that the document is saved and reload it after command
+ execution
+\begin_inset Newline newline
+\end_inset
+
+ M - Message - ask for input string (commit message)
+\begin_inset Newline newline
+\end_inset
+
+ <PATH>: path where to start.
+ $$p will be replaced by the current document path.
+
+\begin_inset Newline newline
+\end_inset
+
+ <COMMAND>: command to execute.
+ $$i/$$p/$$m will be replaced by the current document/path/message.
+
+\end_layout
+
+\begin_layout Description
+Sample vc-command DR $$p "svn up"
+\end_layout
+
+\begin_layout Description
+Origin sanda, 13 Jan 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_CHANGES_TRACK
\end_layout
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
-nclude|index|label|nomencl|vspace|ref|toc>
+Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
+\begin_inset Newline newline
+\end_inset
+
+ hyperlink|include|index|label|nomencl|vspace|ref|toc>
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
- ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
- ref insets.
+Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
+ graphics, include, label, listings, note, phantom, ref, space, tabular,
+ vspace, wrap insets.
\end_layout
\end_layout
\begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
- ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
- ref insets.
+Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
+ graphics, include, label, listings, note, phantom, ref, space, tabular,
+ vspace, wrap insets.
\end_layout
\end_layout
\begin_layout Description
-Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
+Params <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
+
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
- ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
- ref insets.
+Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
+ graphics, include, label, listings, note, phantom, ref, space, tabular,
+ vspace, wrap insets.
\end_layout
\end_layout
\begin_layout Description
-Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
+Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
\end_layout
\begin_layout Description
\begin_inset Newline newline
\end_inset
- include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
+ include|index|info|nomenclature|label|listings|log|mathdelimiter|
\begin_inset Newline newline
\end_inset
- note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
+ mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|
\begin_inset Newline newline
\end_inset
- tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
+ spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|
+
\begin_inset Newline newline
\end_inset
- wrap|listings|<SPECIAL>
+ view-source|vspace|wrap|<SPECIAL>
\begin_inset Newline newline
\end_inset
\begin_layout Description
Notion This can be used to grab last key-sequence used inside the LyX window.
- See also Debug extensions section in Extended features manual.
+ See also Debug extensions section in Additional features manual.
\end_layout
\begin_layout Description
Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
EW) the output will be rewriten - updated.
- This is useful in case your viewer is able to detect such changes (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+ This is useful in case your viewer is able to detect such changes (e.g.
ghostview for postscript).
\end_layout
\end_layout
\begin_layout Description
-Action Inserts plain text file as paragraph (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+Action Inserts plain text file as paragraph (i.e.
join lines).
\end_layout
A .def file allows to define a command with
\backslash
define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
- <LFUN> is the lfun code to be executed (see e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
+ <LFUN> is the lfun code to be executed (see e.g.
LFUN_COMMAND_SEQUENCE).
\backslash
Origin rgh, 27 May 2008
\end_layout
+\begin_layout Subsection*
+LFUN_COPY_LABEL_AS_REF
+\end_layout
+
+\begin_layout Description
+Action Copies the label at the cursor as a cross-reference to be pasted
+ elsewhere.
+
+\end_layout
+
+\begin_layout Description
+Syntax copy-label-as-reference
+\end_layout
+
+\begin_layout Description
+Origin sts, 16 Nov 2008
+\end_layout
+
\end_body
\end_document
projects / lyx.git / blobdiff