-#LyX 1.6.5svn created this file. For more info see http://www.lyx.org/
-\lyxformat 345
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 444
\begin_document
\begin_header
\textclass article
+\begin_preamble
+\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
+\renewenvironment{description}{\list{}{%
+ \setlength{\itemsep}{-2pt}
+ \advance\leftmargini6\p@ \itemindent-12\p@
+ \labelwidth\z@ \let\makelabel\descriptionlabel}%
+}{
+ \endlist
+}
+\end_preamble
\use_default_options false
+\maintain_unincluded_children false
\language english
+\language_package default
\inputencoding auto
+\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
+\font_math auto
\font_default_family default
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
-
\graphics default
+\default_output_format default
+\output_sync 0
+\bibtex_command default
+\index_command default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry true
-\use_amsmath 1
-\use_esint 1
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package esint 1
+\use_package mathdots 0
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type numerical
+\biblio_style plain
\use_bibtopic false
+\use_indices false
\paperorientation portrait
+\suppress_date false
+\justification true
+\use_refstyle 0
+\index Index
+\shortcut idx
+\color #008000
+\end_index
\leftmargin 2.5cm
\topmargin 2cm
\rightmargin 3cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
-\defskip medskip
+\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
-\author ""
-\author ""
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict false
\end_header
\begin_body
\begin_layout Section*
-LFUNs documentation automatically generated 2009-10-07
+LFUNs documentation automatically generated 2012-09-29
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Subsection*
-LFUN_OPTIONAL_INSERT
+LFUN_ARGUMENT_INSERT
\end_layout
\begin_layout Description
-Action Inserts an optional-argument (short title) inset.
+Action Inserts an argument (short title) inset.
\end_layout
\begin_layout Description
-Syntax optional-insert
+Syntax argument-insert
\end_layout
\begin_layout Description
Origin vermeer, 12 Aug 2002
\end_layout
-\begin_layout Subsection*
-LFUN_LINE_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts a horizontal line.
-\end_layout
-
-\begin_layout Description
-Syntax line-insert
-\end_layout
-
-\begin_layout Description
-Origin Andre, Oct 27 2003
-\end_layout
-
\begin_layout Subsection*
LFUN_NEWPAGE_INSERT
\end_layout
Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
\end_layout
+\begin_layout Subsection*
+LFUN_PREVIEW_INSERT
+\end_layout
+
+\begin_layout Description
+Action Inserts a new preview inset.
+\end_layout
+
+\begin_layout Description
+Syntax preview-insert
+\end_layout
+
+\begin_layout Description
+Origin vfr, 28 Mar 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_TAB_INSERT
\end_layout
\end_layout
\begin_layout Description
-Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
+Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
\begin_inset Newline newline
\end_inset
lyxrc: name of rc_entry (e.g.
bind_file)
\begin_inset Newline newline
+\end_inset
+
+ lyxinfo: "version" - used version of LyX
+\begin_inset Newline newline
\end_inset
package: name of latex package (e.g.
\begin_inset Newline newline
\end_inset
- icon: name of lfun used in toolbar
+ icon: icon of lfun used in toolbar
\begin_inset Newline newline
\end_inset
- buffer: "name"|"path"|"class"
+ buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-a
+uthor"|"vcs-date"|"vcs-time"
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax flex-insert <TYPE:Name>
+Syntax flex-insert Name
\end_layout
\begin_layout Description
-Params TYPE: CharStyle|Custom|Element|Standard
-\begin_inset Newline newline
-\end_inset
-
-Identifies whether this is a Character Style, a Custom Inset or an XML Element,
- and which dynamical sub-menu this flex inset is in on the LyX menu tree.
- If Standard (currently unused): none of these.
-\begin_inset Newline newline
-\end_inset
-
-Name: This name must be defined either in your layout file or imported by
- some module.
- The definition is InsetLayout <TYPE:Name>
+Params Name: This name must be defined either in your layout file or imported
+ by some module.
+ The definition is InsetLayout Name or InsetLayout <Flex:Name>.
+ The Flex: prefix is optional.
\end_layout
\begin_layout Description
-Sample flex-insert CharStyle:Code
+Sample flex-insert Code
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
-ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
+Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip,
+ negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill,
+ hspace, hspace*
+\begin_inset Newline newline
+\end_inset
+
+Only in math mode: med and thick.
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Subsection*
-LFUN_TOC_INSERT
+LFUN_SCRIPT_INSERT
+\end_layout
+
+\begin_layout Description
+Action Inserts a subscript or superscript inset.
\end_layout
\begin_layout Description
-Action Inserts table of contents.
+Syntax script-insert <TYPE>
\end_layout
\begin_layout Description
-Syntax toc-insert
+Params <TYPE>: subscript|superscript
\end_layout
\begin_layout Description
-Origin Lgb, 27 May 97
+Origin Georg, 23 Nov 2010
\end_layout
\begin_layout Subsection*
\begin_layout Description
Params <TYPE:Name>: name of the index, if multiple indices are defined.
- with an empty argument, the default index is selected.
+ With an empty argument, the default index is selected.
\end_layout
\begin_layout Description
\begin_layout Description
Params <TYPE:Name>: name of the index, if multiple indices are defined.
- with an empty argument, the default index is selected.
+ With an empty argument, the default index is selected.
\end_layout
\begin_layout Description
Origin Lgb, 27 Feb 1997
\end_layout
+\begin_layout Subsection*
+LFUN_IPA_INSERT
+\end_layout
+
+\begin_layout Description
+Action Inserts an IPA inset.
+\end_layout
+
+\begin_layout Description
+Syntax ipa-insert
+\end_layout
+
+\begin_layout Description
+Origin spitz, 05 Mar 2012
+\end_layout
+
+\begin_layout Subsection*
+LFUN_IN_IPA
+\end_layout
+
+\begin_layout Description
+Action Only active in IPA inset.
+\end_layout
+
+\begin_layout Description
+Notion Dummy function which is only active in a IPA inset.
+ It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
+\end_layout
+
+\begin_layout Description
+Syntax in-ipa
+\end_layout
+
+\begin_layout Description
+Origin spitz, 20 May 2012
+\end_layout
+
+\begin_layout Subsection*
+LFUN_IPAMACRO_INSERT
+\end_layout
+
+\begin_layout Description
+Action Inserts special IPA macros into the document.
+\end_layout
+
+\begin_layout Description
+Syntax ipamacro-insert <CHAR>
+\end_layout
+
+\begin_layout Description
+Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
+ tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
+\end_layout
+
+\begin_layout Description
+Origin JSpitzm, 22 Aug 2012
+\end_layout
+
\begin_layout Subsection*
LFUN_NOMENCL_INSERT
\end_layout
\end_layout
\begin_layout Description
-Action Inserts Note on the current cursor postion, move selection inside
+Action Inserts Note on the current cursor position, move selection inside
the inset.
\end_layout
\end_layout
\begin_layout Description
-Action Moves the cursor to the begining of next Note inset.
+Action Moves the cursor to the beginning of next Note inset.
\end_layout
\begin_layout Description
Syntax note-next
\end_layout
-\begin_layout Subsection*
-LFUN_NOTES_MUTATE
-\end_layout
-
-\begin_layout Description
-Action Changes all Note insets of a particular type (source) to a different
- type (target) fot the current document.
-\end_layout
-
-\begin_layout Description
-Syntax notes-mutate <SOURCE> <TARGET>
-\end_layout
-
-\begin_layout Description
-Params <SOURCE/TARGET>: Note|Comment|Greyedout
-\end_layout
-
-\begin_layout Description
-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
+Action Inserts phantom on the current cursor position, move selection inside
the inset.
\end_layout
\begin_layout Description
Action Clears the selection.
If no text is selected call LFUN_FINISHED_FORWARD.
+ Inside math mode jumps out of the math inset.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Deletes characters to the begining of the word (usually the "C+BackSpace"
- key).
+Action Deletes characters to the beginning of the word (usually the "C+BackSpace
+" key).
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Search for next occurence of a string.
+Action Search for next occurrence of a string.
\end_layout
\begin_layout Description
\begin_inset Newline newline
\end_inset
-<casesensitive> <matchword> <all> <forward>"
+<casesensitive> <matchword> <all> <forward> <findnext>"
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Search for next occurence of a pattern.
+Action Search for next occurrence of a pattern.
\end_layout
\begin_layout Description
Syntax word-lowcase
\end_layout
+\begin_layout Subsection*
+LFUN_SPELLING_ADD
+\end_layout
+
+\begin_layout Description
+Action Add the word under the cursor to the respective spell checker dictionary.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-add [<STRING>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to add <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin JSpitzm, 18 Jan 2010
+\end_layout
+
+\begin_layout Subsection*
+LFUN_SPELLING_IGNORE
+\end_layout
+
+\begin_layout Description
+Action Let the spell checker ignore the word under the cursor in the current
+ session for the given language.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-ignore [<WORD>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to ignore <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin JSpitzm, 18 Jan 2010
+\end_layout
+
+\begin_layout Subsection*
+LFUN_SPELLING_REMOVE
+\end_layout
+
+\begin_layout Description
+Action Remove the word under the cursor from the respective spell checker
+ dictionary.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-remove [<STRING>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to remove <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin SWitt, 28 July 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_THESAURUS_ENTRY
\end_layout
Origin vfr, 22 Aug 2009
\end_layout
+\begin_layout Subsection*
+LFUN_SECTION_SELECT
+\end_layout
+
+\begin_layout Description
+Action Selects the whole section.
+\end_layout
+
+\begin_layout Description
+Notion The cursor should be in a section heading before calling this lfun.
+\end_layout
+
+\begin_layout Description
+Syntax section-select
+\end_layout
+
+\begin_layout Description
+Origin vfr, 05 May 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_LINE_BEGIN
\end_layout
\begin_layout Description
-Action Move the cursor to the begining of the (screen) line.
+Action Move the cursor to the beginning of the (screen) line.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Copies to the clipboard the last edit.
+Action Copies the current selection to the clipboard.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Origin baum, 10 Jul 2006
+Origin Georg, 10 Jul 2006
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Action Pastes the currently text selected text.
+Action Pastes the currently selected text.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Pastes the text in permanent selection.
+Action Pastes the internal selection text in permanent selection.
+\end_layout
+
+\begin_layout Description
+Notion Created in order to have middle mouse button pasting correct (bound
+ to command-alternatives selection-paste ; primary-selection-paste paragraph).
\end_layout
\begin_layout Description
Syntax selection-paste
\end_layout
+\begin_layout Description
+Origin lasgouttes, 14 Jan 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_CLIPBOARD_PASTE_SIMPLE
+\end_layout
+
+\begin_layout Description
+Action Pastes simple unformatted text from the active clipboard.
+\end_layout
+
+\begin_layout Description
+Syntax clipboard-paste-simple [<ARG>]
+\end_layout
+
+\begin_layout Description
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
+ "Join lines".
+\end_layout
+
\begin_layout Subsection*
LFUN_UNDO
\end_layout
\begin_layout Description
Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
- trigerred when using Text Style dialog.
+ triggered when using Text Style dialog.
\end_layout
\begin_layout Description
\begin_layout Description
Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
- bibliography) found from the cursor postion.
+ bibliography) found from the cursor position.
\end_layout
\begin_layout Description
\begin_layout Description
Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
-X bibliography) found from the cursor postion.
+X bibliography) found from the cursor position.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Enters subscript expression in math expression.
+Action Enters superscript expression in math expression.
\end_layout
\begin_layout Description
\begin_inset Newline newline
\end_inset
-where "script" stands fot the external script (normalized expression will
+where "script" stands for the external script (normalized expression will
be passed)
\end_layout
\end_layout
\begin_layout Description
-Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
-trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
+\begin_inset Newline newline
+\end_inset
+
+|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
\end_layout
\begin_layout Description
Action Moves the current paragraph upwards in the document.
\end_layout
+\begin_layout Description
+Notion Movement through the document will possibly break the paragraph-depth
+ (e.g.
+ itemize structure).
+\end_layout
+
\begin_layout Description
Syntax paragraph-move-up
\end_layout
\end_layout
\begin_layout Description
-Action Move the cursor to the next paragraph (or begining of the current
+Action Move the cursor to the next paragraph (or beginning of the current
one) in upward direction.
\end_layout
\end_layout
\begin_layout Description
-Action Move the cursor and select the text to the next paragraph (or begining
+Action Move the cursor and select the text to the next paragraph (or beginning
of the current one) in upward direction.
\end_layout
\end_layout
\begin_layout Description
-Action Move the cursor to the next paragraph (or begining of the current
+Action Move the cursor to the next paragraph (or beginning of the current
one) in downward direction.
\end_layout
\end_layout
\begin_layout Description
-Action Move the cursor and select the text to the next paragraph (or begining
+Action Move the cursor and select the text to the next paragraph (or beginning
of the current one) in downward direction.
\end_layout
\end_layout
\begin_layout Subsection*
-LFUN_BREAK_PARAGRAPH
+LFUN_PARAGRAPH_BREAK
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Syntax break-paragraph [<LAYOUT>]
+Syntax paragraph-break [<LAYOUT>]
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
Called internally by LFUN_DIALOG_UPDATE.
\end_layout
Origin Vermeer, 23 Mar 2006
\end_layout
-\begin_layout Subsection*
-LFUN_OUTLINE_DRAGMOVE
-\end_layout
-
-\begin_layout Description
-Action Moves the document section associated with the specified heading
- to a specified location.
- Both the heading and the target paragraph are specified by the paragraph
- ID numbers.
-\end_layout
-
-\begin_layout Description
-Notion The heading is a paragraph with style Part/Chapter/Section/ etc.
- Id number of the paragraph is not the sequential number seen on the screen,
- but an internal number that is unique for all opened buffers (documents).
-\end_layout
-
-\begin_layout Description
-Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
-\end_layout
-
-\begin_layout Description
-Params <PAR_ID_SECTION>: paragraph id of the section heading which is to
- be moved.
-\begin_inset Newline newline
-\end_inset
-
-<PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved
- to.
-\end_layout
-
-\begin_layout Description
-Origin Rob Oakes, 22 June 2009
-\end_layout
-
\begin_layout Subsection*
LFUN_INSET_EDIT
\end_layout
\end_layout
\begin_layout Description
-Syntax tabular-insert [<ROWS> <COLUMNS>]
-\end_layout
-
-\begin_layout Description
-Params In case no arguments are given show insert dialog.
-\end_layout
-
-\begin_layout Description
-Origin Jug, 12 Apr 2000
-\end_layout
-
-\begin_layout Subsection*
-LFUN_TABULAR_FEATURE
-\end_layout
-
-\begin_layout Description
-Action Sets various features to the table/cell on the current cursor position.
-\end_layout
-
-\begin_layout Description
-Notion Various math-environment features are handled here as well, e.g.
- add-vline-left/right for the Grid/Array environment
+Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
\end_layout
\begin_layout Description
-Syntax tabular-feature <FEATURE> [<ARG>]
+Syntax tabular-insert [<ROWS> <COLUMNS>]
\end_layout
\begin_layout Description
-Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
-y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
- align-left|align-right|align-center|align-block|valign-top|valign-bottom|
- valign-middle|longtabular-align-left|longtabular-align-center| longtabular-alig
-n-right|m-align-left|m-align-right|m-align-center| m-valign-top|m-valign-bottom|
-m-valign-middle|multicolumn|set-all-lines| unset-all-lines|set-longtabular|unset
--longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|tog
-gle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-use
-box|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| tabular-valign-top|tabul
-ar-valign-middle|tabular-valign-bottom
-\begin_inset Newline newline
-\end_inset
-
-<ARG>: additional argument for some commands, use debug mode to explore
- its values.
+Params In case no arguments are given show insert dialog.
\end_layout
\begin_layout Description
-Origin Jug, 28 Jul 2000
+Origin Jug, 12 Apr 2000
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Action Register the document as an file inside version control system (RCS,
- CVS).
+Action Register the document as an file inside version control system.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Checks-out the document for edit (and locks it for RCS).
-\end_layout
-
-\begin_layout Description
-Notion This is implemented only for RCS and SVN, not CVS.
+Action Checks-out the document for edit (and locks it in some cases).
\end_layout
\begin_layout Description
\end_inset
<COMMAND>: command to execute.
- $$i/$$p/$$m will be replaced by the current document/path/message.
+ $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/m
+essage.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_VC_REPO_SYNCHRO
+LFUN_VC_REPO_UPDATE
\end_layout
\begin_layout Description
-Action Synchronize the local archive directory in which resides the current
- document with the repository.
+Action Update the local archive directory in which resides the current document
+ with the remote repository.
\end_layout
\begin_layout Description
-Notion This is currently implemented only for SVN as revert + update operation.
-\end_layout
-
-\begin_layout Description
-Syntax vc-repo-synchro
+Syntax vc-repo-update
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CHANGES_TRACK
+LFUN_VC_COMPARE
\end_layout
\begin_layout Description
-Action Toggles change tracking to on/off.
+Action Compares two revisions of the same file under version control.
\end_layout
\begin_layout Description
-Syntax changes-track
+Syntax vc-compare [<REV1>] [<REV2>]
\end_layout
\begin_layout Description
-Origin levon, 1 Oct 2002
-\end_layout
+Params Revision number either points directly to commit in history or if
+ negative number -x it points to (last commit - x).
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_CHANGES_OUTPUT
-\end_layout
+ In RCS we subtract only in the last number of revision specification.
+ Special case "0" is reserved for the last committed revision.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+<REV1>: Older file.
+\begin_inset Newline newline
+\end_inset
+
+ <REV2>: Newer file.
+ Used only if REV1 > 0.
+\begin_inset Newline newline
+\end_inset
+
+If no parameter is given, interactive dialog will be shown.
+\end_layout
+
+\begin_layout Description
+Sample Compare current document against last commit
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare 0
+\begin_inset Newline newline
+\end_inset
+
+Compare current document against current revision - 5 commits
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare -5
+\begin_inset Newline newline
+\end_inset
+
+Compare revisions 120 and 155
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare 120 155
+\end_layout
+
+\begin_layout Description
+Origin sanda, 12 Feb 2010
+\end_layout
+
+\begin_layout Subsection*
+LFUN_CHANGES_TRACK
+\end_layout
+
+\begin_layout Description
+Action Toggles change tracking to on/off.
+\end_layout
+
+\begin_layout Description
+Syntax changes-track
+\end_layout
+
+\begin_layout Description
+Origin levon, 1 Oct 2002
+\end_layout
+
+\begin_layout Subsection*
+LFUN_CHANGES_OUTPUT
+\end_layout
+
+\begin_layout Description
Action Toggles showing of change tracking in typesetted output.
\end_layout
\end_layout
\begin_layout Description
-Syntax change-accept
+Syntax change-reject
\end_layout
\begin_layout Description
\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|citation|ert|listings|external|graphics|tabular|
+\begin_inset Newline newline
+\end_inset
+
+ hyperlink|include|index|label|line|nomencl|vspace|ref|toc|scri
+pt>
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
-prettyref -- Formatted reference
+formatted -- Formatted reference
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Action Modify existing inset.
+Action Modify some properties of an inset.
\end_layout
\begin_layout Description
Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
- graphics, include, label, listings, note, phantom, ref, space, tabular,
- vspace, wrap insets.
+ graphics, include, index, info, label, listings, newline, newpage, nomencl,
+ note, phantom, ref, space, tabular, vspace, wrap insets.
\end_layout
\begin_layout Description
-Syntax inset-modify <INSET> <ARGS>
+Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify
+ tabular <FEATURE> [<ARG>]
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-\end_layout
-
-\begin_layout Subsection*
-LFUN_NEXT_INSET_MODIFY
-\end_layout
+Params Generally see LFUN_INSET_INSERT for further details.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Modify the inset at cursor position, if there is one.
-\end_layout
+In case that <INSET> is "tabular" various math-environment features are
+ handled as well, e.g.
+ add-vline-left/right for the Grid/Array environment.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-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
+<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-colum
+n| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
+ align-left|align-right|align-center|align-block|align-decimal|set-decimal-point
+| valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-ali
+gn-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-v
+align-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-l
+ines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabula
+r|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|
+toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltf
+irsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|
+toggle-ltcaption| set-special-column|set-special-multicolumn|set-special-multiro
+w| set-booktabs|unset-booktabs|set-top-space|set-bottom-space| set-interline-spa
+ce|set-border-lines|tabular-valign-top| tabular-valign-middle|tabular-valign-bot
+tom|set-tabular-width
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
+<ARG>: additional argument for some commands, use debug mode to explore
+ its values.
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-\end_layout
+Sample inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin JSpitzm, 23 Mar 2008
+ inset-modify changetype Ovalbox
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
Called internally by LFUN_DIALOG_UPDATE
\end_layout
\begin_layout Description
Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
- graphics, href, include, index, index_print, label, listings, note, phantom,
- ref, space, tabular, vspace, wrap insets.
+ graphics, href, include, index, index_print, label, line, listings, note,
+ phantom, ref, space, tabular, vspace, wrap insets.
\end_layout
\begin_layout Description
\begin_layout Description
Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
- graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|
-tabular|vspace|wrap>.
+\begin_inset Newline newline
+\end_inset
+
+graphics|href|include|index|index_print|label|line|
+\begin_inset Newline newline
+\end_inset
+
+listings|note|phantom|ref|space|tabular|vspace|wrap>.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Action Toggles the collapsable inset at cursor position, or the inset we
+Action Toggles the collapsible inset at cursor position, or the inset we
are currently in.
\end_layout
\begin_inset Newline newline
\end_inset
-open/close/toggle are for collapsable insets.
+open/close/toggle are for collapsible insets.
toggle is used when no argument is given.
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Subsection*
-LFUN_ALL_INSETS_TOGGLE
+LFUN_INSET_FORALL
\end_layout
\begin_layout Description
-Action Toggles (open/closes) all collapsable insets (of a given type) in
- the document.
+Action Apply the given commands on insets of a given name.
\end_layout
\begin_layout Description
-Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
+Notion WARNING: use at your own risks; this function gives you too many
+ ways of shooting yourself in the foot.
+ A typical example is inset-forall Note note-insert which starts an infinite
+ loop.
+ This is mitigated by the fact that the number of actions is arbitrarily
+ limited to 100000.
+ Note also that inset-forall does not update metrics between iterations,
+ which can lead to bugs.
+ This has to be eventually fixed.
\end_layout
\begin_layout Description
-Syntax all-insets-toggle [<STATE>] [<INSET>]
+Syntax inset-forall <NAME> <LFUN-COMMAND>
+\begin_inset Newline newline
+\end_inset
+
+<NAME>: Type of Inset.
+ If <NAME> is *, all insets are matched.
+ The name is used like for InsetLayout in layout files: "Note" matches all
+ note insets, while "Note:Note" only matches LyX yellow note insets.
\end_layout
\begin_layout Description
-Params <STATE>: <toggle|open|close|assign> default: toggle
+Sample Remove all index insets:
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Index delete-char-forward
+\begin_inset Newline newline
+\end_inset
+
+Close all Notes (also works for a particular branch, for example):
\begin_inset Newline newline
\end_inset
-<INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
- insets
+ inset-forall Note inset-toggle close
+\begin_inset Newline newline
+\end_inset
+
+Transform all yellow notes to comments
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Note:Note inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+Try to put LyX in an infinite loop if there is at least a Note:
+\begin_inset Newline newline
+\end_inset
+
+ inset-forall Note char-backward
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin lasgouttes, 27 Nov 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_GRAPHICS_RELOAD
+\end_layout
+
+\begin_layout Description
+Action Reloads the image if necessary.
+\end_layout
+
+\begin_layout Description
+Syntax graphics-reload
+\end_layout
+
+\begin_layout Description
+Origin vfr, 10 Aug 2009
\end_layout
\begin_layout Subsection*
\begin_layout Description
Action Moves the cursor to the numbered bookmark, opening the file if necessary.
- Note that bookmarsk are saved per-session, not per file.
+ Note that bookmarks are saved per-session, not per file.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion Skiping "auto" when allowauto is false.
+Notion Skipping "auto" when allowauto is false.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
-ew/update|math_panels|vcs
+Params <NAME>: standard|extra|table|math|mathmacrotemplate|
+\begin_inset Newline newline
+\end_inset
+
+minibuffer|review|view/update|math_panels|vcs| view-others|update-others
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_SPLIT_VIEW
+LFUN_VIEW_SPLIT
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion All split views act in the same way indpendently.
+Notion All split views act in the same way independently.
\end_layout
\begin_layout Description
-Syntax split-view <vertical|horizontal>
+Syntax view-split <vertical|horizontal>
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_CLOSE_TAB_GROUP
+LFUN_VIEW_CLOSE
+\end_layout
+
+\begin_layout Description
+Action Close the current document work area.
+\end_layout
+
+\begin_layout Description
+Notion Close the current work area.
+ If no other work areas are showing the buffer, then close the associated
+ buffer as well.
+\end_layout
+
+\begin_layout Description
+Syntax view-close
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, 15 Sep 2012
+\end_layout
+
+\begin_layout Subsection*
+LFUN_TAB_GROUP_CLOSE
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This only closes the work areas, not the buffer themselves.
+Notion This only closes the work areas, not the buffers themselves.
The still opened buffers can be visualized in another tab group.
\end_layout
\begin_layout Description
-Syntax close-tab-group
+Syntax tab-group-close
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Shows hidden dialog or create new one for a given function/inset
+Action Shows hidden dialog or creates new one for a given function/inset
settings etc.
\end_layout
\begin_inset Newline newline
\end_inset
-document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
+compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
\begin_inset Newline newline
\end_inset
-href|include|index|index_print|info|label|listings|log|mathdelimiter|
+graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit
+er|
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
+Notion This is an internal LFUN, not to be used by users.
\end_layout
\begin_layout Description
Notion Maps were widely used in past, when X-windows didn't have nowadays
keyboard support.
They can be still used to maintain uniform keyboard layout across the various
- plaforms.
+ platforms.
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Description
-Action Sets the cursor position based on the row number of generated TeX
- file.
+Action Sets the cursor position in LyX based on the row number of generated
+ TeX file.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Params <FILE>: the filename.
+Params <FILE>: the path and filename.
Environment variables are expanded in the path.
In case this LFUN does not work make sure you are giving correct path to
the file.
If the file is located inside LyX temporary directory it will be mapped
back into the appropriate opened buffer (e.g.
for the case of generated .tex file).
- .ext: extensions will be automatically replaced by .lyx.
- <ROW_NUMBER> The row number of the LaTeX file to which to go.
+\begin_inset Newline newline
+\end_inset
+
+.ext: extensions will be automatically replaced by .lyx.
+\begin_inset Newline newline
+\end_inset
+
+<ROW_NUMBER> The row number of the LaTeX file to which to go.
+\end_layout
+
+\begin_layout Description
+Sample server-goto-file-row /home/user/example.lyx 41
+\begin_inset Newline newline
+\end_inset
+
+server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
\end_layout
\begin_layout Description
Origin Edmar, 23 Dec 1998
\end_layout
+\begin_layout Subsection*
+LFUN_FORWARD_SEARCH
+\end_layout
+
+\begin_layout Description
+Action Sets the cursor position in the previewed (dvi/pdf) file based on
+ the row number in LyX window.
+\end_layout
+
+\begin_layout Description
+Notion The external program used for forward search call can be specified
+ in LyX Output preferences.
+ See Additional manual for details of these settings.
+\end_layout
+
+\begin_layout Description
+Syntax forward-search
+\end_layout
+
+\begin_layout Description
+Origin sanda, 14 Apr 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_SERVER_NOTIFY
\end_layout
\begin_layout Description
Action Sets the cursor position based on the editing area coordinates (similar
- as clicking on that point with left mouse button).
+ to clicking on that point with left mouse button).
\end_layout
\begin_layout Description
literate_extension is generated.
Then LyX invokes
\backslash
-build_command (with a default of``make'') to generate the code and
+build_command (with a default of ``make'') to generate the code and
\backslash
build_error_filter to process the compilation error messages.
\begin_inset Newline newline
Origin bpeng, 27 Apr 2006
\end_layout
+\begin_layout Subsection*
+LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
+\end_layout
+
+\begin_layout Description
+Action Toggles including of resources for forward/reverse search of the
+ given document.
+\end_layout
+
+\begin_layout Description
+Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package
+ is used for DVI.
+ Custom LaTeX macro can be defined in preferences.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-toggle-output-sync
+\end_layout
+
+\begin_layout Description
+Origin sanda, 25 May 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_BUFFER_CLOSE
\end_layout
\end_layout
\begin_layout Description
-Syntax buffer-export <FORMAT>
+Syntax buffer-export <FORMAT> [<DEST>]
\end_layout
\begin_layout Description
In case of "custom" you will be asked for a format you want to start from
and for the command that you want to apply to this format.
Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
+ <DEST> If present, this argument provides the export destination filename.
+ Its containing folder will also be the destination folder, where all
+ the needed external files will be copied.
\end_layout
\begin_layout Description
Origin leeming, 27 Mar 2004
\end_layout
+\begin_layout Subsection*
+LFUN_BUFFER_EXPORT_AS
+\end_layout
+
+\begin_layout Description
+Action Pops up a dialog for exporting the current buffer.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-export-as
+\end_layout
+
+\begin_layout Description
+Origin tommaso, 6 Oct 2011
+\end_layout
+
\begin_layout Subsection*
LFUN_BUFFER_PRINT
\end_layout
\begin_layout Description
Notion File can be imported iff lyx file format is (transitively) reachable
- via defined convertors in preferences.
- Look into File->Import menu to get an idea of the currently active import
+ via defined converters in preferences.
+ Look in the File->Import menu to get an idea of the currently active import
formats.
\end_layout
\end_layout
\begin_layout Description
-Action Creates a new buffer (that is, document).
+Action Creates a new buffer (that is, document) and switches to it.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-Action Switch to the given buffer.
-\end_layout
-
-\begin_layout Description
-Notion This is useful also in case you need simultaneously more views of
- the edited document in different LyX windows.
+Action Display and switch to the given buffer.
\end_layout
\begin_layout Description
-Syntax buffer-new-template <BUFFER>
+Syntax buffer-switch <BUFFER>
\end_layout
\begin_layout Description
-Params <BUFFER>: already opened document which is to be shown.
+Params <BUFFER>: path and filename of already opened (but possibly hidden)
+ document which is to be shown.
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Description
-Notion In the ->Readonly mode checks-in/commits the data if the file is
- under version control.
- In the Readonly-> mode checkouts the data from repository.
-\begin_inset Newline newline
-\end_inset
-
-If these operations fail, buffer won't be toggled.
+Notion This function is not allowed if the file is under version control,
+ since read-only flag is often used in version control file locking.
\end_layout
\begin_layout Description
\begin_layout Description
Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
-EW) the output will be rewriten - updated.
+EW) the output will be rewritten - updated.
This is useful in case your viewer is able to detect such changes (e.g.
ghostview for postscript).
\end_layout
A relative path is with respect to the original location of the buffer/file.
\end_layout
+\begin_layout Subsection*
+LFUN_BUFFER_FORALL
+\end_layout
+
+\begin_layout Description
+Action Applies a command to all visible, hidden, or both types of buffers
+ in the active window.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
+\end_layout
+
+\begin_layout Description
+Params <BUFFER-TYPE>: <visible|hidden|both default:> default: visible <LFUN-COMM
+AND>: The command that is to be applied to the buffers.
+\end_layout
+
+\begin_layout Description
+Sample Close all Notes in all visible documents:
+\begin_inset Newline newline
+\end_inset
+
+ buffer-forall inset-forall Note inset-toggle close
+\begin_inset Newline newline
+\end_inset
+
+Toggle change tracking on all documents:
+\begin_inset Newline newline
+\end_inset
+
+ buffer-forall both changes-track
+\begin_inset Newline newline
+\end_inset
+
+Toggle read-only for all visible documents:
+\begin_inset Newline newline
+\end_inset
+
+ buffer-forall buffer-toggle-read-only
+\begin_inset Newline newline
+\end_inset
+
+Show statistics for each document:
+\begin_inset Newline newline
+\end_inset
+
+ buffer-forall both statistics
+\begin_inset Newline newline
+\end_inset
+
+Activate the branch named "Solutions" in all visible documents:
+\begin_inset Newline newline
+\end_inset
+
+ buffer-forall branch-activate Solutions
+\begin_inset Newline newline
+\end_inset
+
+Export all visible documents to PDF (pdflatex):
+\begin_inset Newline newline
+\end_inset
+
+ buffer-forall buffer-export pdf2
+\begin_inset Newline newline
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Origin scottkostyshak, 20 Jul 2012
+\end_layout
+
\begin_layout Subsection*
LFUN_BUFFER_WRITE_ALL
\end_layout
\end_layout
\begin_layout Description
-Action Opens the minibuffer toolbar so that the user can type in there.
+Action Switches the focus to the minibuffer so that the user can type in
+ there.
+ If necessary, it opens the minibuffer toolbar.
\end_layout
\begin_layout Description
Origin Lgb, 8 Apr 2001
\end_layout
+\begin_layout Subsection*
+LFUN_DEBUG_LEVEL_SET
+\end_layout
+
+\begin_layout Description
+Action Set debug output level.
+\end_layout
+
+\begin_layout Description
+Syntax debug-level-set <LEVEL>
+\end_layout
+
+\begin_layout Description
+Params <LEVEL>: comma separated list of levels or the correspondent number
+ of their combination.
+ 0 is equivalent to disabling all debug events.
+ See lyx -dbg for the current list of debug levels and their numbers.
+\end_layout
+
+\begin_layout Description
+Origin sanda, 28 Dec 2009
+\end_layout
+
\begin_layout Subsection*
LFUN_PREFERENCES_SAVE
\end_layout
\end_layout
\begin_layout Description
-Action Determine whether keep cursor inside the editing window regardless
- the scrollbar movement.
+Action Determine whether to keep cursor inside the editing window regardless
+ of the scrollbar movement.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Subsection*
-LFUN_SECTION_SELECT
-\end_layout
-
-\begin_layout Description
-Action Selects the whole section.
-\end_layout
-
-\begin_layout Description
-Notion The cursor should be in a section heading before calling this lfun.
-\end_layout
-
-\begin_layout Description
-Syntax section-select
+LFUN_INSET_COPY_AS
\end_layout
\begin_layout Description
-Origin vfr, 05 May 2009
-\end_layout
-
-\begin_layout Subsection*
-LFUN_GRAPHICS_RELOAD
+Action Copies the inset to the clipboard as a certain type.
\end_layout
\begin_layout Description
-Action Reloads the image if necessary.
+Notion Currently used only for InsetInfo where its content is copied as
+ a text.
\end_layout
\begin_layout Description
-Syntax graphics-reload
+Syntax inset-copy-as
\end_layout
\begin_layout Description
-Origin vfr, 10 Aug 2009
+Origin vfr, 18 Apr 2010
\end_layout
\end_body
projects / lyx.git / blobdiff