xemacs-beta: lisp/hyperbole/DEMO comparison

comparison lisp/hyperbole/DEMO @ 100:4be1180a9e89 r20-1b2

Import from CVS: tag r20-1b2

author	cvs
date	Mon, 13 Aug 2007 09:15:11 +0200
parents	131b0175ea99
children

comparison

equal deleted inserted replaced

-:2d83cbd90d8d
+:4be1180a9e89
 * 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,
 "(hyperbole.info)Glossary", if terms used here are unfamiliar to you.
 This button prints the <(factorial)> of 5 in the minibuffer when activated
 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
 timezone but they are stored as universal times.  So if you work with
 people at other sites, you can mix their buttons with your own within
 A <(shell command)> button can do many things, such as display the length of
 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
 are linking to is loaded in a buffer, you are prompted as to whether you
 want the link to jump to the present point in that buffer.  If so, the
 link will always jump there, so position point within the referent file
 to take advantage of this feature.  Note how a separate window is used
 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.
 Hyperbole buttons may also be embedded within mail messages.  Even
 buttons copied into mail replies can work:
 ** Implicit Path Links
 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
 a different action should be taken when the button is activated.
 An exclamation point prefix indicates that the full pathname should be run
 If you use the ange-ftp or efs add-on to GNU Emacs, such remote pathnames
 will work as well.  (The latest version of ange-ftp may always be obtained
 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
+Once you have *loaded* the ange-ftp or the efs package (or you use a version
-version of Emacs 19 which autoloads ange-ftp), if you are on the
+of Emacs 19 which autoloads ange-ftp), if you are on the Internet, you can
-Internet, you can click on any of the following to browse the contents
+click on any of the following to browse the contents of the Hyperbole
-of the Hyperbole distribution at the XEmacs Archive (limit the amount
+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/"
 /anonymous@128.174.252.16:/pub/infodock/
 	  /ftp.xemacs.org:pub/infodock/
 	 "ftp://ftp.xemacs.org/pub/infodock/
 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
 "(hyperbole.info)Drags" and "(hyperbole.info)Menus".
 Now suppose you want to browse through a number of files within the
 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
 file and you see that it is displayed as expected.  (Remember to use the
 Hyperbole history command to return here.)  You can get help on these buttons
 URLs (universal resource locators) from within any buffer just as you would
 any other implicit button, once you do some initial setup.
 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}.
 Compiler error messages also serve as implicit buttons that jump to
 associated source lines; use {M-x compile RET}.  GDB, DBX or XDB stack frames
 @loc> #<buffer *scratch*>
 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
 touch (1V)              - update the access and modification times of a file
 cat (1V)                - concatenate and display
 If you are on the Internet and you have the ange-ftp or efs remote file
 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
 people to appropriate documents.  For example, a mail message in response to
 a question might say, "See [Emacs-001] for examples of what Emacs can do."
 Here is an example.  Depress the Action Key somewhere within this paragraph
 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
 A left to right horizontal drag of the Action Key of 5 or more characters

Mercurial > hg > xemacs-beta

comparison lisp/hyperbole/DEMO @ 100:4be1180a9e89 r20-1b2