/usr/share/doc/nedit/html/calltips.html is in nedit 1:5.6a-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | <HTML>
<HEAD>
<TITLE> Features for Programming </TITLE>
</HEAD>
<BODY>
<A NAME="Calltips"></A>
<H2> Calltips </H2>
<P>
Calltips are little yellow boxes that pop up to remind you what the arguments
and return type of a function are. More generally, they're a UI mechanism to
present a small amount of crucial information in a prominent location. To
display a calltip, select some text and choose "Show Calltip" from the Search
menu. To kill a displayed calltip, hit Esc.
</P><P>
Calltips get their information from one of two places -- either a tags file (see
"<A HREF="tags.html#Finding_Declarations_(ctags)">Finding Declarations (ctags)</A>") or a calltips file. First, any loaded calltips
files are searched for a definition, and if nothing is found then the tags
database is searched. If a tag is found that matches the highlighted text then
a calltip is displayed with the first few lines of the definition -- usually
enough to show you what the arguments of a function are.
</P><P>
You can load a calltips file by using choosing "Load Calltips File" from the
File menu. You can unload a calltips file by selecting it from the
"Unload Calltips File" submenu of the File menu. You can also choose one or
more default calltips files to be loaded for each language mode using the
"Default calltips file(s)" field of the Language Modes dialog.
</P><P>
The calltips file format is very simple. calltips files are organized in blocks
separated by blank lines. The first line of the block is the key, which is the
word that is matched when a calltip is requested. The rest of the block is
displayed as the calltip.
</P><P>
Almost any text at all can appear in a calltip key or a calltip. There are no
special characters that need to be escaped. The only issues to note are that
trailing whitespace is ignored, and you cannot have a blank line inside a
calltip. (Use a single period instead -- it'll be nearly invisible.) You should
also avoid calltip keys that begin and end with '*' characters, since those are
used to mark special blocks.
</P><P>
There are five special block types--comment, include, language, alias, and
version--which are distinguished by their first lines, "* comment *",
"* include *", "* language *", "* alias *", and "* version *" respectively
(without quotes).
</P><P>
Comment blocks are ignored when reading calltips files.
</P><P>
Include blocks specify additional calltips files to load, one per line. The ~
character can be used for your $HOME directory, but other shell shortcuts like
* and ? can't be used. Include blocks allow you to make a calltips file for your
project that includes, say, the calltips files for C, Motif, and Xt.
</P><P>
Language blocks specify which language mode the calltips should be used with.
When a calltip is requested it won't match tips from languages other than the
current language mode. Language blocks only affect the tips listed after the
block.
</P><P>
Alias blocks allow a calltip to have multiple keys. The first line of the block
is the key for the calltip to be displayed, and the rest of the lines are
additional keys, one per line, that should also show the calltip.
</P><P>
Version blocks are ignored for the time being.
</P><P>
You can use calltips in your own macros using the calltip() and kill_calltip()
macro subroutines and the $calltip_ID macro variable. See the
<A HREF="macro_subrs.html#Macro_Subroutines">Macro Subroutines</A> section for details.
<P><HR>
</P><P>
</P><P>
</P>
</BODY>
</HTML>
|