Mercurial > hg > xemacs-beta
diff lisp/hyperbole/DEMO @ 24:4103f0995bd7 r19-15b95
Import from CVS: tag r19-15b95
author | cvs |
---|---|
date | Mon, 13 Aug 2007 08:51:03 +0200 |
parents | 376386a54a3c |
children | 131b0175ea99 |
line wrap: on
line diff
--- a/lisp/hyperbole/DEMO Mon Aug 13 08:50:31 2007 +0200 +++ b/lisp/hyperbole/DEMO Mon Aug 13 08:51:03 2007 +0200 @@ -1,5 +1,13 @@ * Overview +InfoDock Associates, the developer of Hyperbole and InfoDock (an industrial +quality turn-key version of XEmacs), sells high quality commercial support, +training, books and custom package development for InfoDock, XEmacs or GNU +Emacs on a variety of platforms. Contact us at <info@infodock.com> or visit +our web site at http://www.infodock.com. + + ------------------ + This file demonstrates simple usage of the basic Hyperbole button-action types and shows how Hyperbole can support a style of self-documenting, interactive files. See the glossary in the Hyperbole Manual, @@ -23,7 +31,7 @@ with the Action Key. (Once you have Hyperbole installed, just press the Action Key on the word, <(factorial)>.) If you instead press the Assist Key, you get help for the preceding button. The help provides a summary report of -the button. You will see that it utilizes the 'eval-elisp' action type. You +the button. You will see that it utilizes the `eval-elisp' action type. You can also see who created it. Try it. Note that the create-time and mod-time are displayed using your own @@ -125,7 +133,7 @@ this file. While such commands are executing, you can perform other operations. If you create a button that runs a shell command which displays its own window system window, i.e. a window outside of Emacs, use -'exec-window-cmd' rather than 'exec-shell-cmd' as its action type. +`exec-window-cmd' rather than `exec-shell-cmd' as its action type. You can link to files such as your <(.login)> file. Or directories, like the <(tmp directory)>. When creating file links, if the file you @@ -136,11 +144,11 @@ when you activate file link buttons. Most basic Hyperbole action types display their results in this manner. -You can make a button an alias for another by using the 'link-to-ebut' +You can make a button an alias for another by using the `link-to-ebut' action type. This <(factorial alias)> button does whatever the earlier <(factorial)> button does. -The 'link-to-mail' action type allows you to reference mail messages +The `link-to-mail' action type allows you to reference mail messages that you have stored away. We can't demonstrate it here since we don't have the mail messages that you do. @@ -169,26 +177,26 @@ Any doubly quoted pathname acts as an implicit button that either displays the referenced path within a buffer, passes it to an external viewer program, or -runs a function that operates upon the path. These are 'pathname' implicit +runs a function that operates upon the path. These are `pathname' implicit buttons. For example, activate "README". Most pathnames simply link to the files that they name and so are simply -displayed for editing. The variable 'hpath:suffixes' is a list of filename +displayed for editing. The variable `hpath:suffixes' is a list of filename suffix strings that are added to or removed from pathnames when searching for a match. "So if "README.gz" existed, the pathname button "README" would display it. If you use the Emacs "crypt.el" package, then compressed files will be uncompressed before they are displayed. Activate "README.gz" and you'll see that the README file is displayed as desired. -The variable 'hpath:display-alist' contains pairs of pathname expressions and +The variable `hpath:display-alist' contains pairs of pathname expressions and edit functions. When a pathname matches an expression, the associated edit function is invoked upon the pathname. -The variable 'hpath:find-alist' determines the file suffixes which should be +The variable `hpath:find-alist' determines the file suffixes which should be viewed with external programs. It also specifies the associated viewer program for each different window system under which Hyperbole may be run. See its documentation for more details. Under the X window system, for -example, if you have the 'xv' program, all of the following file formats may +example, if you have the `xv' program, all of the following file formats may be displayed as images: gif, tiff, xbm, pm, pbm, and jpeg. Several prefix characters may be attached to pathnames to indicate that @@ -205,10 +213,10 @@ via anonymous ftp to: "/anonymous@alpha.gnu.ai.mit.edu:ange-ftp/ange-ftp.tar.gz"). -Once you have *loaded* the ange-ftp or the efs package (or you use a -version of Emacs 19 which autoloads ange-ftp), if you are on the -Internet, you can click on any of the following to browse the contents -of the Hyperbole distribution at the XEmacs Archive (limit the amount +Once you have *loaded* the ange-ftp or the efs package (or you use a version +of Emacs 19 which autoloads ange-ftp), if you are on the Internet, you can +click on any of the following to browse the contents of the Hyperbole +distribution at the University of Illinois at Urbana (limit the amount you do this so as not to deny others access to the archive): "/anonymous@ftp.xemacs.org:pub/infodock/" @@ -225,7 +233,7 @@ GNU Info (filename)node references such as "(hyperbole.info)Glossary" or -"(emacs)Glossary", work similarly, thanks to the 'Info-node' button type. +"(emacs)Glossary", work similarly, thanks to the `Info-node' button type. Try one of the Glossary buttons above. If you want to quickly learn how to create explicit buttons, see @@ -250,7 +258,7 @@ Hyperbole distribution. You could use the Emacs dired subsystem, "(emacs)Dired", but a faster way is to note that files named MANIFEST and DIR are used to summarize the files in a directory, so we can use -each of their entries as an implicit button (of 'dir-summary' type) to +each of their entries as an implicit button (of `dir-summary' type) to take us to the file. Let's look at "MANIFEST". Now click anywhere within a line in the MANIFEST @@ -270,19 +278,19 @@ First you must ensure that you load the Hyperbole library that supports URL viewing. Either your "hsite.el" file should require hsys-w3 as part of -'hibtypes:begin-load-hook' or you should move point after the following line +`hibtypes:begin-load-hook' or you should move point after the following line and hit {C-x C-e} to evaluate it. (progn (require 'w3) (require 'hsys-w3)) Now try using the Action Key on: - "http://www.ncsa.uiuc.edu" + "http://www.infodock.com" ** Grep, Occurrence, Debugger and Compiler Error Buttons, and Cscope Analyzer Lines -The output of 'grep -n', the UNIX line pattern matcher, can be +The output of `grep -n', the UNIX line pattern matcher, can be activated as buttons that jump to each matched line within its source file; use {M-x grep RET}. @@ -331,20 +339,20 @@ If you click on the buffer name, the buffer will be displayed just as a file buffer would. This type of implicit button is called a -'hyp-source' button. +`hyp-source' button. You can also activate any explicit buttons shown in a help buffer. ** UNIX Man Apropos Buttons -Below are some lines output by the UNIX 'apropos' command (with a little +Below are some lines output by the UNIX `apropos' command (with a little touchup for display purposes). A button activation anywhere within such a line recognizes the line as an apropos entry and tries to display the -man page for the entry. Try it. (If you happen to use the 'superman' +man page for the entry. Try it. (If you happen to use the `superman' package which fetches man pages in the background, you'll have to wait for the next version of superman which removes incompatibilities with the standard man page fetch command before you can use these -'man-apropos' implicit buttons.) +`man-apropos' implicit buttons.) grep, egrep, fgrep (1V) - search a file for a string or regular expression rm, rmdir (1) - remove (unlink) files or directories @@ -357,18 +365,18 @@ handling package for GNU Emacs, you can retrieve and browse RFC documents used in Internet standard-making. Simply use the Action Key on an RFC document identifier, like RFC-822. Rfc822 and rfc 822 work as well. The -'rfc' implicit button type provides this service. The 'hpath:rfc' variable +`rfc' implicit button type provides this service. The `hpath:rfc' variable specifies the location from which to retrieve RFCs. Once you have retrieved an RFC, an Action Key press most anywhere within a line typically will produce a table of contents summary of the RFC (via the -'rfc-toc' implicit button type). An Action Key press on any of the table of +`rfc-toc' implicit button type). An Action Key press on any of the table of contents lines then displays that section, for easy random access browsing. ** Site-specific Online Library Document IDs Hyperbole offers a powerful, yet easy to use facility for building online -libraries through the use of the 'doc-id' implicit button type. A document id +libraries through the use of the `doc-id' implicit button type. A document id is used just like a reference citation in traditional publications but it actually links to the document that it references and the card catalog (index) entry for the document. One can easily pass around doc ids to point @@ -414,7 +422,7 @@ and while holding it down, depress the Assist Key. Then release the keys in any order and the help display will pop up. It explains that there was no particular matching Smart Key context, so a default operation is performed -(the value of the variable 'action-key-default-function' determines the +(the value of the variable `action-key-default-function' determines the operation performed). ** Scrolling to the Beginning and End of Buffers