mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-10 20:04:46 +00:00
Document InsetInfo in insets/InsetInfo.h
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@20956 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
parent
d8aacb8df2
commit
07fcacfd8b
@ -18,6 +18,49 @@
|
||||
#include "Cursor.h"
|
||||
#include "support/Translator.h"
|
||||
|
||||
/* InsetInfo displays shortcuts, lyxrc, package and textclass
|
||||
availability and menu information in a non-editable boxed InsetText.
|
||||
|
||||
Output of such as inset may vary from system to system, depending
|
||||
on LyX and LaTeX configurations. Two LyX help files, LaTeXConfig.lyx
|
||||
and Shortcuts.lyx make heavy use of this inset. The former uses it
|
||||
to display the availability of packages and textclasses, the latter
|
||||
uses it to display currently used shortcuts.
|
||||
|
||||
This inset has two arguments: the type and argument of the information.
|
||||
The screen and latex output is the content of the information. An
|
||||
InsetInfo can have type "shortcut", "lyxrc", "package", "textclass", or
|
||||
"menu". Arguments and outputs vary by type.
|
||||
|
||||
shortcut: name of the LFUN such as "math-insert \alpha". The syntax
|
||||
is the same as what is used in the bind and ui files.
|
||||
The output of this inset is all shortcuts separated by comma.
|
||||
|
||||
lyxrc: name of the rc entry such as "bind_file". Look in src/LyXRC.h
|
||||
for available entries. The output is the content of this RC
|
||||
entry.
|
||||
|
||||
package: name of a latex package such as "listings". The output is
|
||||
"yes" or "no".
|
||||
|
||||
textclass: name of a textclass such as "article". The output is "yes"
|
||||
or "no".
|
||||
|
||||
menu: name of the LFUN such as "paste". The syntax is the same as
|
||||
what is used in the bind and ui files. The output is the
|
||||
menu item that trigger this LFUN. For example, "File > Paste".
|
||||
'>' is actually \lyxarrow (an InsetSpecialChar).
|
||||
|
||||
|
||||
Because this inset is intended to be used only by document maintainers,
|
||||
there is no GUI, no menu entry for this inset. A user would have to
|
||||
define a shortcut for "info-insert" (e.g. C-S-I), and
|
||||
|
||||
1. input the type and argument of this inset. E.g. "menu paste".
|
||||
2. select the text and run "info-insert" (e.g. press C-S-I).
|
||||
|
||||
*/
|
||||
|
||||
namespace lyx {
|
||||
|
||||
/** Used to insert index labels
|
||||
|
Loading…
Reference in New Issue
Block a user