File: hbdata.el.html
This module handles Hyperbole button data/attribute storage. In
general, it should not be extended by anyone other than Hyperbole
maintainers. If you alter the formats or accessors herein, you are
likely to make your buttons incompatible with future releases.
System developers should instead work with and extend the "hbut.el"
module which provides much of the Hyperbole application programming
interface and which hides the low level details handled by this
module.
Button data is typically stored within a file that holds the button
data for all files within that directory. The name of this file is
given by the variable 'hattr:filename,' usually it is ".hypb".
Here is a sample from a Hyperbole V2 button data file. Each button
data entry is a list of fields:
"TO-DO"
(Key Placeholders LinkType <arg-list> creator and modifier with times)
("alt.mouse.el" nil nil link-to-file ("./ell/alt-mouse.el") "zzz@gnu.org" "19991027:09:19:26" "zzz@gnu.org" "19991027:09:31:36")
which means: button \<(alt.mouse.el)> found in file "TO-DO" in the
current directory provides a link to the local file "./ell/alt-mouse.el".
It was created and last modified by zzz@gnu.org.
All link entries that originate from the same source file are stored
contiguously, one per line, in reverse order of creation.
Preceding all such entries is the source name (in the case of a file
used as a source, no directory information is included, since only
sources within the same directory as the button data file are used as
source files within it.