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