Fix typos in the comment in InsetInfo.h

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@20962 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Bo Peng 2007-10-14 01:37:02 +00:00
parent 4385c156e2
commit 366b902cdc

View File

@ -21,35 +21,36 @@
/* InsetInfo displays shortcuts, lyxrc, package and textclass /* InsetInfo displays shortcuts, lyxrc, package and textclass
availability and menu information in a non-editable boxed InsetText. availability and menu information in a non-editable boxed InsetText.
Output of such as inset may vary from system to system, depending Output of such an inset may vary from system to system, depending
on LyX and LaTeX configurations. Two LyX help files, LaTeXConfig.lyx on LyX and LaTeX configurations. Two LyX help files, LaTeXConfig.lyx
and Shortcuts.lyx make heavy use of this inset. The former uses it and Shortcuts.lyx make heavy use of this inset. The former uses it
to display the availability of packages and textclasses, the latter to display the availability of packages and textclasses, the latter
uses it to display currently used shortcuts. uses it to display currently used shortcuts.
This inset has two arguments: the type and argument of the information. This inset has two arguments: the type and argument of the information. The
The screen and latex output is the content of the information. An screen and latex output is the content of the information. An InsetInfo can
InsetInfo can have type "shortcut", "lyxrc", "package", "textclass", or have type "shortcut", "lyxrc", "package", "textclass", or "menu". Arguments
"menu". Arguments and outputs vary by type. and outputs vary by type.
shortcut: name of the LFUN such as "math-insert \alpha". The syntax shortcut: argument of this type of InsetInfo is the name of the LFUN such as
is the same as what is used in the bind and ui files. "math-insert \alpha". The syntax is the same as what is used in the bind
The output of this inset is all shortcuts separated by comma. and ui files. The output of this inset is all shortcuts for this LFUN
separated by comma.
lyxrc: name of the rc entry such as "bind_file". Look in src/LyXRC.h lyxrc: argument is the name of the rc entry such as "bind_file". Look in
for available entries. The output is the content of this RC src/LyXRC.h for available entries. The output is the content of this RC
entry. entry.
package: name of a latex package such as "listings". The output is package: argument is the name of a latex package such as "listings". The
"yes" or "no". output is "yes" or "no", indicating the availability of this package.
textclass: name of a textclass such as "article". The output is "yes" textclass: argument is the name a textclass such as "article". The output is
or "no". "yes" or "no", indicating the availability of this textclass.
menu: name of the LFUN such as "paste". The syntax is the same as menu: argument is the name of the LFUN such as "paste". The syntax is the same
what is used in the bind and ui files. The output is the as what is used in the bind and ui files. The output is the menu item that
menu item that trigger this LFUN. For example, "File > Paste". triggers this LFUN. For example, "File > Paste", where '>' is actually
'>' is actually \lyxarrow (an InsetSpecialChar). \lyxarrow (an InsetSpecialChar).
Because this inset is intended to be used only by document maintainers, Because this inset is intended to be used only by document maintainers,
@ -60,7 +61,7 @@ shortcut for "info-insert" (e.g. C-S-I), and
the work area. the work area.
2. select the text and run "info-insert" (e.g. press C-S-I). 2. select the text and run "info-insert" (e.g. press C-S-I).
An alternative method is to enter command "info-insert type args" in An alternative method is to enter command "info-insert type arg" in
the command buffer (view->Toolbar->Command Buffer). the command buffer (view->Toolbar->Command Buffer).
*/ */