home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #27 / NN_1992_27.iso / spool / gnu / emacs / sources / 800 < prev    next >
Encoding:
Text File  |  1992-11-17  |  19.5 KB  |  525 lines
  1. Newsgroups: gnu.emacs.sources
  2. Path: sparky!uunet!think.com!paperboy.osf.org!paperboy!nick
  3. From: nick@osf.org (Nick Dokos)
  4. Subject: Re: visit the file at point pickf.el
  5. In-Reply-To: barryn@world.std.com's message of Thu, 12 Nov 1992 16:04:58 GMT
  6. Message-ID: <NICK.92Nov16221033@alphaville.osf.org>
  7. Sender: news@osf.org (USENET News System)
  8. Organization: Open Software Foundation
  9. References: <BARRYN.92Nov12110458@world.std.com>
  10. Date: 17 Nov 92 03:10:33 GMT
  11. Lines: 512
  12.  
  13. You might want to investigate Hyperbole which does this and much, much
  14. more. The README file is appended.
  15.  
  16. #
  17. # FILE:        README
  18. # SUMMARY:      Intro information on Hyperbole.  
  19. #
  20. # AUTHOR:       Bob Weiner
  21. # ORG:          Brown U.
  22. #
  23. # ORIG-DATE:    19-Oct-91 at 03:27:47
  24. # LAST-MOD:     10-Apr-92 at 16:32:32 by Bob Weiner
  25.  
  26. The author's work on this project has been sponsored by Motorola Inc.
  27. under the Distinguished Student-Employee program.
  28.  
  29. We hope you enjoy using and developing with Hyperbole.  Suggestions and bug
  30. reports are welcome, as described later in this document.  Feel free to
  31. mail or post news containing this file wherever it may be of use.
  32.  
  33.  
  34.            Outline
  35. ================================
  36. * Hyperbole Overview
  37. * What's New?
  38. * How to Obtain
  39. * Installation / Configuration
  40. * Quick Reference
  41. * Mail Lists
  42. * Beta Tester Quotes
  43. * Why was Hyperbole developed?
  44. * Copyright
  45. ================================
  46.  
  47.  
  48. * Hyperbole Overview
  49.  
  50. Hyperbole is an open, efficient information browsing and management
  51. system based around a hypertext model.  It is intended for everyday work
  52. on any UNIX platform supported by GNU Emacs (or Epoch from the
  53. University of Illinois).  Hyperbole allows hypertext buttons to be
  54. embedded within unstructured and structured files, mail messages and
  55. news articles.  It also provides point-and-click access to ftp archives,
  56. Wide-Area Information Servers (WAIS), and the World-Wide Web (WWW)
  57. hypertext system through encapsulations of software that support these
  58. protocols.
  59.  
  60. Hyperbole consists of three parts:
  61.  
  62.    1.  an interactive information management interface which anyone can use;
  63.  
  64.    2.  a set of programming library classes for system developers who
  65.        want to integrate Hyperbole with another user interface or as a
  66.        back-end to a distinct system.  (All of Hyperbole is written in
  67.        Lisp for ease of modification.  Although Hyperbole is a
  68.        prototype, it has been engineered for real-world usage and is
  69.        well structured.)
  70.  
  71.    3.  A set of hyper-button-action types that provides core hypertext
  72.        and other behaviors.  Users can make simple changes to button
  73.        types and those familiar with Emacs Lisp can quickly prototype
  74.        and deliver new types.
  75.  
  76. A Hyperbole user works with hypertext buttons; he may create, modify,
  77. move or delete buttons.  Each button performs a specific action, such as
  78. linking to a file or executing a UNIX shell command.
  79.  
  80. Presently, there are two distinct categories of Hyperbole buttons:
  81. explicit buttons (the ones that Hyperbole creates) and implicit buttons
  82. (buttons created and managed by other programs or embedded within the
  83. structure of a document and recognized contextually by Hyperbole).
  84. Explicit Hyperbole buttons may be embedded within any type of text file.
  85.  
  86. Hyperbole buttons may be clicked upon with a mouse to activate them or
  87. to describe their actions.  Thus, a user can always check how a button
  88. will act before activating it.  Buttons may also be activated from a
  89. keyboard.  (In fact, all Hyperbole operations, including menu usage, may
  90. be performed from any standard character terminal interface, so one need
  91. not be anchored to a workstation all day).
  92.  
  93. Hyperbole does not enforce any particular hypertext or information
  94. management model, but instead allows you to organize your information in
  95. large or small chunks as you see fit.  Some of its most important
  96. features include:
  97.  
  98.     Buttons may link to information or may execute procedures, such as
  99.     starting or communicating with external programs;
  100.  
  101.     Buttons may be embedded within electronic mail messages;
  102.  
  103.     Other hypertext and information retrieval systems may be
  104.     encapsulated under a Hyperbole user interface (a number of samples
  105.     are provided).
  106.  
  107. Typical Hyperbole applications include:
  108.  
  109.     personal information management
  110.        Overlapping link paths provide a variety of views into an
  111.        information space.
  112.  
  113.        A search facility locates buttons in context and permits quick
  114.        selection.
  115.  
  116.     documentation browsing
  117.        Embed cross-references in your favorite documentation format.
  118.  
  119.        Add a point-and-click interface to existing documentation.
  120.  
  121.        Link code and design documents.  Jump to the definition of an
  122.        identifier from its use within code or its reference within
  123.        documentation.
  124.  
  125.     help/training systems
  126.        Create tutorials with embedded buttons that show students how
  127.        things work while explaining the concepts, e.g. an introduction
  128.        to UNIX commands.  This technique can be much more effective than
  129.        descriptions alone.
  130.  
  131.     archive managers
  132.        Supplement programs that manage archives from incoming
  133.        information streams by having them add topic-based buttons that
  134.        link to the archive holdings.  Users can then search and create
  135.        their own links to archive entries.
  136.  
  137.  
  138. * What's New?
  139.  
  140.   Changes between V2 and V3.
  141.  
  142.   BUTTONS
  143.  
  144.     - Global buttons that can be created, deleted or activated by name.
  145.  
  146.     - Ange-ftp pathnames whether quoted or not are recognized as implicit
  147.       buttons in any context, just click to view.
  148.  
  149.     - Internet RFC document random-access browsing via table of contents
  150.       ibtype.
  151.  
  152.     - Implicit button type, grep-msg, which jumps to source of grep and
  153.       error msg lines.
  154.  
  155.     - Multi-line button labels preceded by common fill prefixes are
  156.       recognized properly, e.g. in source code with comment characters as
  157.       the fill prefix.
  158.  
  159.   SMART KEY
  160.  
  161.     - C and Lisp jump to definition of tag at point.
  162.  
  163.     - Calendar scrolling and appointment viewing.
  164.  
  165.     - Man page apropos viewing and reference following.
  166.  
  167.     - Outline expanding and collapsing.
  168.  
  169.     - Rmail and GNUS browsing.
  170.  
  171.     - Dired and Buffer Menu selecting and deleting.
  172.  
  173.     - Wrolo entry source editing and entry narrowing to focus.
  174.  
  175.   MESSAGING
  176.  
  177.     - Automatic support for buttons in RMAIL, VM, MH-e, and GNUS messages.
  178.       Support is loaded only if the particular tool is invoked.
  179.  
  180.     - Mail and news comments automatically inserted to alert others that you
  181.       can utilize Hyperbole buttons in messages.
  182.  
  183.     - Msg/ menu for sending messages to the Hyperbole mail list and for
  184.       sending in an add/remove/change request for your entry on one of
  185.       the Hyperbole mail lists.  (The hyperbole mail list is now
  186.       accessible via WAIS clients, if you know what that means.  The
  187.       source entry for this WAIS server appears in the Mail Lists
  188.       section of this file.) 
  189.  
  190.     - Automatic insertion of Hyperbole configuration info when click on
  191.       hyperbole mail list address in outgoing messages.
  192.  
  193.   HELP
  194.  
  195.     - A documentation quick access menu.
  196.  
  197.   USER INTERFACE
  198.  
  199.     - Working SunView support.
  200.  
  201.     - Built in rolodex (wrolo) support.
  202.  
  203.     - Mouse keys may be toggled between Hyperbole Smart Key bindings and any
  204.       set of prior bindings.
  205.  
  206.     - Support for Epoch V4 Beta.
  207.  
  208.   DEVELOPMENT/PROGRAMMING
  209.  
  210.     - New implicit button type format the same as defuns.
  211.       It permits one ibtype to perform any number of actions, so for
  212.       example, one ibtype could handle all the kinds of buttons found in a
  213.       particular document format.  Ibtypes can send any number of needed
  214.       arguments to actions.  Ibtypes can be evaluated without triggering any
  215.       actions to test their return values.
  216.  
  217.     - Any Lisp function may now be used to create a Hyperbole action, not
  218.       just defacts.
  219.  
  220.     - Non-nil action return values are now accessible to callers.
  221.  
  222.  
  223. * How to Obtain
  224.  
  225. Hyperbole is available across the Internet via anonymous ftp.  Do not send
  226. requests to have it mailed to you since it won't be.  Instead have another
  227. party who has Internet access obtain it for the both of you.
  228.  
  229. A server which sends the Hyperbole distribution in response to mail
  230. requests may be put into service sometime in the first quarter of 1992.
  231. The Free Software Foundation has expressed interest in distributing
  232. Hyperbole as a separate add-on to GNU Emacs, once Hyperbole reaches a
  233. stable point of maturation, so you may eventually be able to get it from
  234. them.  Here is how to obtain it from the Brown software archive:
  235.  
  236. Move to a directory below which you want the 'hyperbole' directory to
  237. be created.  Unpacking the Hyperbole archive will create this
  238. directory and place all of the files below it.
  239.  
  240.    cd <LOCAL-LISP-DIR>
  241.  
  242. Ftp to wilma.cs.brown.edu  (Internet Host ID = 128.148.31.66):
  243.  
  244.    prompt> ftp wilma.cs.brown.edu
  245.  
  246. Login as 'anonymous' with your own <user-id>@<site-name> as a password.
  247.    
  248.    Name (wilma.cs.brown.edu:rsw): anonymous
  249.    331 Guest login ok, send EMAIL address (e.g. user@host.domain) as password.
  250.    Password:
  251.    230 Guest login ok, access restrictions apply.
  252.  
  253. Move to the Hyperbole directory:
  254.  
  255.    ftp> cd pub/hyperbole
  256.  
  257. Set your transfer mode to binary:
  258.  
  259.    ftp> bin
  260.    200 Type set to I.
  261.  
  262. Turn off prompting:
  263.  
  264.    ftp> prompt
  265.    Interactive mode off.
  266.  
  267. Either retrieve just the Hyperbole archive and any diff-based patches:
  268.  
  269.    ftp> mget h*tar.Z
  270.    ftp> mget diff*
  271.  
  272. or retrieve all of the files (the individual, non-tar files, are also
  273. included in the above archive, so they are not strictly necessary):
  274.  
  275.    ftp> mget *
  276.  
  277. Close the ftp connection:
  278.  
  279.    ftp> quit
  280.    221 Goodbye.
  281.  
  282. Unpack the tar archive with:
  283.  
  284.    zcat h*tar.Z | tar xvf -
  285. or
  286.    uncompress h*tar.Z; tar xvf h*tar
  287.  
  288.  
  289. * Installation / Configuration
  290.  
  291. The Hyperbole Manual is included in three forms:
  292.     "hypb.info"       - online version
  293.      hypb.ps          - Postscript form
  294.     "hypb.texinfo"    - source form
  295.  
  296. If you have just retrieved Hyperbole, see "hsite-ex.el" for installation
  297. and setup instructions.  If Hyperbole has already been installed for
  298. use at your site, you can manually invoke it from within GNU Emacs or Epoch by
  299. loading the "hsite.el" code library file:  {M-x load-lib RTN hsite RTN}.  See
  300. the section on 'Initializing' in the Hyperbole Manual for information on how to
  301. set up for permanent Hyperbole use.
  302.  
  303. To add a pointer to the Info version of the Hyperbole manual within your Info
  304. directory file, add the following two lines (the '*' should be in the first
  305. column) to the menu within that file, substituting for <HYP-DIR>:
  306.  
  307.     * Hyperbole: (<HYP-DIR>/hypb.info).
  308.         GNU Emacs-based extensible hypertext management system.
  309.  
  310. When used with a mouse, Hyperbole uses your middle and right mouse buttons by
  311. default.  The bindings are set in "hmouse-key.el".  What the mouse
  312. buttons do is set in the 'smart-key-alist' variable in "hui-mouse.el"
  313. and is summarized in "hmouse-doc".
  314.  
  315.  
  316. * Quick Reference
  317.  
  318. "MANIFEST" summarizes most of the files in the distribution.
  319.  
  320. See "DEMO" for a demonstration of standard Hyperbole button
  321. capabilities.
  322.  
  323. Naming conventions:
  324.   All Hyperbole-specific code files begin with an 'h'.
  325.   Hyperbole user-interface files begin with 'hui-' or 'hmous'.
  326.   Files that define implicit button types begin with 'hib'.
  327.   Encapsulations of foreign systems begin with 'hsys-'.
  328.  
  329. Most of the standard Emacs user interface for Hyperbole is located in
  330. "hui.el".  Most of the Hyperbole application programming interface can be
  331. found in "hbut.el".  "hbdata.el" encapsulates the button attribute storage
  332. handling presently implemented by Hyperbole.  "hmail.el" provides a basic
  333. abstract interface for folding mail readers other than Rmail into Hyperbole.
  334.  
  335.  
  336. * Mail Lists
  337.  
  338. There are several Hyperbole-related mail addresses.  Learn what each is
  339. for before you contemplate mailing to any of them.
  340.  
  341.  
  342. hyperbole-request@cs.brown.edu
  343.  
  344.    ALL mail concerning administration of the Hyperbole mailing lists
  345.    should be sent here.  That includes addition, change, or deletion
  346.    requests.  Don't EVER consider sending such a request to a Hyperbole
  347.    mail list or people will think you can't read.  ONLY FULLY
  348.    DOMAIN-BASED ADDRESSES WILL BE ACCEPTED (no UUCP '!' characters nor
  349.    .UUCP pseudo-domain).  If you don't have such an address by now, you
  350.    should get one.  Anyone else who wants to handle these other
  351.    addresses is free to forward the contents of the lists to them.
  352.  
  353.    Use the following formats on your subject line to execute requests,
  354.    where you substitute your own values for the <> delimited items.
  355.  
  356.    Subject: Add <your name> '<' <user@domain> '>' to <mail-list-sans-domain>.
  357.    Subject: Remove '<' <user@domain> '>' from <mail-list-sans-domain>.
  358.    Subject: Change '<' <user@domain> '>' to '<' <newuser>@<newdomain> '>' in <mail-list-sans-domain>.
  359.  
  360.    For example:
  361.      Subject: Add Joe Williams <joe@cs.brown.edu> to hyperbole.
  362.      Subject: Remove <joe@cs.brown.edu> from hyperbole.
  363.      Subject: Change <joe@cs.brown.edu> to <joe@mot.com> in hyperbole.
  364.  
  365.  
  366. hyperbole@cs.brown.edu
  367.  
  368.    Mail list for discussion of all Hyperbole issues.  Bug reports and
  369.    suggestions may also be sent here.
  370.  
  371.    Always use your Subject and/or Summary: lines to state the position
  372.    that your message takes on the topic that it addresses, e.g. send
  373.    "Subject: Basic bug in top-level Hyperbole menu." rather than
  374.    "Subject: Hyperbole bug".  Statements end with periods, questions
  375.    with question marks (typically), and high energy, high impact
  376.    declarations with exclamation points.  This simple rule makes all
  377.    e-mail communication much easier for recipients to handle
  378.    appropriately.
  379.  
  380.    If you ask a question, your subject line should include the word
  381.    'question' or 'query' or should end with a '?', e.g. "Subject: How
  382.    can man page SEE ALSOs be made implicit buttons?"  A "Subject: Re:
  383.    How can ..." then indicates an answer to the question.  Question
  384.    messages should normally include your Hyperbole and Emacs version
  385.    numbers and clearly explain your problem and surrounding issues.
  386.    Otherwise, you will simply waste the time of those who may want to
  387.    help you.  (Your top-level Hyperbole menu shows its version number
  388.    and {M-x emacs-version RTN} gives the other.)
  389.  
  390.    If you ask questions, you should consider adding to the discussion by
  391.    telling people the kinds of work you are doing or contemplating doing
  392.    with Hyperbole.  In this way, the list will not be overwhelmed by
  393.    messages that ask for but provide no information.
  394.  
  395.    This list is now archived as a WAIS server.  Ask <wais-talk@think.com>
  396.    if you have questions about what WAIS is.  The source entry for this
  397.    server is:
  398.  
  399. (:source 
  400.    :version  3 
  401.    :ip-address "128.148.31.66"
  402.    :ip-name "wilma.cs.brown.edu"
  403.    :tcp-port 8000
  404.    :database-name "hyperbole"
  405.    :cost 0.00 
  406.    :cost-unit :free 
  407.    :maintainer "mlm@cs.brown.edu"
  408.    :description "This WAIS server contains all messages sent to the Hyperbole mailing list.
  409. Hyperbole is a flexible, information manager built on top of GNU Emacs.
  410. It is available for anonymous ftp from /wilma.cs.brown.edu:pub/hyperbole.
  411. See the README file there for details.
  412. Server created with WAIS release 8 b3.1 on Feb 20 14:40:09 1992 by wais@wilma"
  413. )
  414.  
  415.  
  416. hyperbole-announce@cs.brown.edu
  417.  
  418.    Those who don't want to participate in the discussion but want to
  419.    hear about bug fixes and new releases of Hyperbole should subscribe
  420.    to this list.  Anyone on the 'hyperbole' list is automatically on
  421.    this one too, so there is no need to subscribe to this one in that
  422.    case.  This list is for official fixes and announcements so don't send
  423.    your own fixes here.  Send them to 'hyperbole' instead.
  424.  
  425.  
  426. * V2 Beta Tester Quotes
  427.  
  428.  "In general, Hyperbole is an embeddable, highly extensible hypertext
  429.   tool.  As such, I find it very useful. As it stands now, Hyperbole is
  430.   particularly helpful for organizing ill-structured or loosely coupled
  431.   information, in part because there are few tools geared for this purpose.
  432.   Hyperbole also possesses a lot of potentials in supporting a wider
  433.   spectrum of structuredness, ranging from unstructured to highly
  434.   structured environments, as well as structural changes over time.
  435.  
  436.   Major Uses:
  437.  
  438.   * Menu interface to our own Epoch-based collaborative support environment
  439.     called CoReView: This interface brings together all top-level user
  440.     commands into a single partitioned screen, and allows the end user to
  441.     interact with the system using simple mouse-clicking instead of the
  442.     meta-x key.
  443.  
  444.   * Gateway to internet resources: this includes links to major Internet
  445.     archive sites of various types of information. Links are made at both
  446.     directory and file levels.
  447.  
  448.   * Alternative directory organizer: The hierarchical nature of the Unix
  449.     file system sometimes makes it difficult to find things quickly and
  450.     easily using directory navigational tools such as dired. Hyperbole
  451.     enables me to create various "profile" views of my directory tree, with
  452.     entries in these views referring to files anywhere in the hierarchy.
  453.  
  454.   * Organizing and viewing online documentation: using Hyperbole along with
  455.     Hyper-man and Info makes it truly easy to look up online documentation.
  456.       
  457.   * Other desktop organization tasks: including links to various mail
  458.     folders, saved newsgroup conversation threads, online note-taker,
  459.     emacs-command invocations, etc."
  460.  
  461.                         -- Dadong Wan
  462.  
  463. -------
  464.  
  465.  "Hyperbole is the first hyper-link system I've run across that is
  466.   actually part of the environment I use regularly, namely Emacs. The
  467.   complete flexibility of the links is both impressive and expected -- the
  468.   idea of making the link itself programmable is clever, and given that one
  469.   assumes the full power of emacs.  Being able to send email with buttons
  470.   in it is a very powerful capability.  Using ange-ftp mode, one can make
  471.   file references "across the world" as easily as normal file references."
  472.  
  473.                         -- Mark Eichin
  474.  
  475. -------
  476.  
  477.  "The Hyperbole system provides a nice interface to exploring corners of
  478.   Unix that I didn't know existed before."
  479.  
  480.                     -- Craig Smith
  481.  
  482. -------
  483.  
  484.  
  485. * Why was Hyperbole developed?
  486.  
  487. Hyperbole has been designed to aid in research aimed at Personalized
  488. Information production/retrieval Environments (PIEs).  Hyperbole is a
  489. backend manager to be used in prototyping an initial PIE.
  490.  
  491. An examination of many hypertext environments as background research did
  492. not turn up any that seemed suitable for the research envisioned, mainly
  493. due to the lack of rich, portable programmer and user environments.  We also
  494. tired of trying to manage our own distributed information pools with standard
  495. UNIX tools.  And so Hyperbole was conceived and raved about until it
  496. got its name.
  497.  
  498.  
  499. * Copyright
  500.  
  501. The following copyright applies to the Hyperbole system as a whole.
  502. Each file also bears its own copyright, e.g. the files based upon GNU
  503. copyrighted code bear the same copyright as GNU Emacs.
  504.  
  505. Copyright (C) 1991, Brown University, Providence, RI
  506.  
  507. Permission to use, modify and redistribute this software and its
  508. documentation for any purpose other than its incorporation into a
  509. commercial product is hereby granted without fee.  A distribution fee
  510. may be charged with any redistribution.  Any distribution requires
  511. that the above copyright notice appear in all copies, that both that
  512. copyright notice and this permission notice appear in supporting
  513. documentation, and that neither the name of Brown University nor the
  514. author's name be used in advertising or publicity pertaining to
  515. distribution of the software without specific, written prior permission.
  516.  
  517. Brown University makes no representations about the suitability of this
  518. software for any purpose.  It is provided "as is" without express or
  519. implied warranty.
  520. --
  521. Nick Dokos    nick@osf.org    
  522. OSF Systems Engineering
  523.  
  524. Member of the League for Programming Freedom - write to lpf@uunet.uu.net
  525.