Remove hardcoded values

[lyx.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index a5b89fb4831115412a36ba5e7acb07fc72714b21..27b87391e6a78cf14c237f2933cb00a1dbee0cd0 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -401,18 +401,28 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
  * \li Action: Inserts quotes according to the type and quote-language preference.
- * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
-               are distinguished.
- * \li Syntax: quote-insert [<TYPE>] [<SIDE>] [<LANG>]
- * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
- *             <SIDE>: 'left' for opening quotes, 'right' for closing quotes, otherwise
- *                     the side will be guessed from the context.
- *             <STYLE>: 'english' for ``English'' quote style
- *                      'swedish' for ''Swedish'' quote style
- *                      'german' for ,,German`` quote style
- *                      'polish' for ,,Polish'' quote style
- *                      'french' for <<French>> quote style
- *                      'danish' for >>Danish<< quote style
+ * \li Notion: Currently 15 different quote styles are distinguished (see params).
+ * \li Syntax: quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
+ * \li Params: <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise
+ *                       outer (i.e., primary, usually double) quotes will be used.\n
+ *             <SIDE>:  'opening' for opening quotes, 'closing' for closing quotes,
+ *                       otherwise the side will be guessed from the context.\n
+ *             <STYLE>: 'british' for `British' quote style (with ``inner quotation'')\n
+ *                      'cjk' for Chinese/Japanese/Korean corner bracket quotation marks\n
+ *                      'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks\n
+ *                      'danish' for >>Danish<< quote style (with >inner quotation<)\n
+ *                      'english' for ``English'' quote style (with `inner quotation')\n
+ *                      'french' for <<french>> quote style (with ``inner quotation'')\n
+ *                      'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]\n
+ *                      'german' for ,,German`` quote style (with ,inner quotation`)\n
+ *                      'plain' for "Plain" quote style (with 'inner quotation')\n
+ *                      'polish' for ,,Polish'' quote style (with ,inner quotation')\n
+ *                      'swedish' for ''Swedish'' quote style (with 'inner quotation')\n
+ *                      'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]\n
+ *                      'swiss' for <<Swiss>> quote style (with <inner quotation>)\n
+ *                      'russian' for <<Russian>> quote style (with ,,inner quotation``)\n
+ *                      'dynamic' for Dynamic quotation marks which inherit the global
+ *                                document style\n
  *                      If no quote style is specified, the document-wide will be used.
  * \endvar
  */
@@ -2470,17 +2480,18 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
  * \li Action: Modify some properties of an inset.
- * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
-                        floats, graphics, include, index, info, label,
-                        listings, newline, newpage, nomencl, note, phantom,
-                        quote, ref, space, tabular, vspace, wrap insets.
+ * \li Notion: Used for argument, bibitem, bibtex, box, branch, caption, citation,
+                        command, ert, external, float, graphics, include, index,
+                        info, label, line, listings, newline, newpage, nomencl,
+                        note, phantom, quotes, ref, script, separator, space,
+                        tabular, vspace and wrap insets.
  * \li Syntax: inset-modify <INSET> <ARGS> \n
                inset-modify changetype <TYPE>
  * \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
+               Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \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