Some documentation of quote's inset-modify

This commit is contained in:
Juergen Spitzmueller 2016-12-18 13:38:41 +01:00
parent 5583186393
commit 092bbcede5
2 changed files with 28 additions and 3 deletions

View File

@ -45,6 +45,25 @@
the side (left, right, auto) and quotation mark style (english, swedish,
german, polish, french, danish).
* inset-modify
This function now also applies to quote insets. It takes a three-character
string as an argument, refering (1.) to the style (e = ``english'',
s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
(2.) to the side (l = left, r = right) and (3.) to the quotation level
(s = single, d = double). So "eld" means "English left double quotation mark".
A dot in the string means: take the current value. So "inset-modify changetype e.."
will only change the style to English, while letting side and level as is,
"inset-modify changetype f.s" will change the style to French and the level to
single, leaving the side value.
This function is most useful when combined with inset-forall. E.g.,
"inset-forall Quotes inset-modify changetype f.."
=> change all quote insets to French style, maintaining current side and level
"inset-forall Quotes inset-modify changetype ..s"
=> change all quote insets to single quotes, keeping style and level
"inset-forall Quotes inset-modify changetype g.s"
=> change all quote insets to German single quotes, keeping left/right setting
!!!The following LyX documents have been moved in 2.3:

View File

@ -2473,11 +2473,17 @@ void LyXAction::init()
* \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
floats, graphics, include, index, info, label,
listings, newline, newpage, nomencl, note, phantom,
ref, space, tabular, vspace, wrap insets.
quote, ref, space, tabular, vspace, wrap insets.
* \li Syntax: inset-modify <INSET> <ARGS> \n
inset-modify changetype <TYPE>
* \li Sample: inset-modify note Note Comment \n
inset-modify changetype Ovalbox
* \li Sample: Change a Note inset into a Comment inset: \n
inset-modify note Note Comment \n
Change a Box into an Ovalbox: \n
inset-modify changetype Ovalbox \n
Change a quotation mark to e[nglish style], l[eft side], s[ingle] \n
inset-modify changetype els \n
Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \n
inset-modify changetype e.. \n
* \endvar
*/
{ LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },