pimpl not needed here

[lyx.git] / src / insets / InsetInfo.h

diff --git a/src/insets/InsetInfo.h b/src/insets/InsetInfo.h
index c3459bbea072a4c17e1eed3b3f82293993e4978a..c61b0e4985cb0df06503a8064f8703d861f44430 100644 (file)
--- a/src/insets/InsetInfo.h
+++ b/src/insets/InsetInfo.h
@@ -18,6 +18,54 @@
 #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 an 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: argument of this type of InsetInfo is the 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 for this LFUN
+    separated by comma.
+
+lyxrc: argument is the 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: argument is the name of a latex package such as "listings". The
+    output is "yes" or "no", indicating the availability of this package.
+
+textclass: argument is the name a textclass such as "article". The output is
+    "yes" or "no", indicating the availability of this textclass.
+
+menu: argument is the 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
+    triggers this LFUN. For example, "File > Paste", where '>' 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 can 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", in 
+   the work area.
+2. select the text and run "info-insert" (e.g. press C-S-I).
+
+An alternative method is to enter command "info-insert type arg" in 
+the command buffer (view->Toolbar->Command Buffer).
+
+*/
+
 namespace lyx {
 
 /** Used to insert index labels