GNU Hyperbole Manual
Total Page:16
File Type:pdf, Size:1020Kb
GNU Hyperbole Manual The Everyday Hypertextual Information Manager Bob Weiner This manual is for GNU Hyperbole (Edition 7.1.3, Published August, 2020). Copyright c 1989-2020 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation. GNU Hyperbole sofware is distributed under the terms of the GNU General Public License version 3 or later, as published by the Free Software Foundation, Inc. GNU Hyperbole is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABIL- ITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details in the file, \COPYING", within the Hyperbole package directory. Published by the Free Software Foundation, Inc. Author: Bob Weiner E-mail: <[email protected]> (This is a mail list). Web: www.gnu.org/software/hyperbole The body of the manual was written in Emacs and laid out using the GNU Texinfo markup language. i Short Contents GNU Hyperbole :::::::::::::::::::::::::::::::::::::::::: 1 1 Introduction :::::::::::::::::::::::::::::::::::::::::: 2 2 Smart Keys :::::::::::::::::::::::::::::::::::::::::: 7 3 Buttons :::::::::::::::::::::::::::::::::::::::::::: 18 4 Menus:::::::::::::::::::::::::::::::::::::::::::::: 38 5 HyControl :::::::::::::::::::::::::::::::::::::::::: 42 6 Koutliner ::::::::::::::::::::::::::::::::::::::::::: 47 7 HyRolo ::::::::::::::::::::::::::::::::::::::::::::: 59 8 Window Configurations :::::::::::::::::::::::::::::::: 66 9 Developing with Hyperbole ::::::::::::::::::::::::::::: 68 A Glossary :::::::::::::::::::::::::::::::::::::::::::: 74 B Setup :::::::::::::::::::::::::::::::::::::::::::::: 81 C Global Key Bindings :::::::::::::::::::::::::::::::::: 91 D Koutliner Keys::::::::::::::::::::::::::::::::::::::: 94 E Smart Key Reference ::::::::::::::::::::::::::::::::: 102 F Suggestion or Bug Reporting :::::::::::::::::::::::::: 128 G Questions and Answers ::::::::::::::::::::::::::::::: 129 H Future Work:::::::::::::::::::::::::::::::::::::::: 131 I References ::::::::::::::::::::::::::::::::::::::::: 133 Key Index ::::::::::::::::::::::::::::::::::::::::::::: 135 Function, Variable and File Index :::::::::::::::::::::::::: 139 Concept Index :::::::::::::::::::::::::::::::::::::::::: 143 ii Table of Contents GNU Hyperbole::::::::::::::::::::::::::::::::::::: 1 1 Introduction ::::::::::::::::::::::::::::::::::::: 2 1.1 Manual Overview ::::::::::::::::::::::::::::::::::::::::::::::: 2 1.2 Motivation ::::::::::::::::::::::::::::::::::::::::::::::::::::: 3 1.3 Hyperbole Overview :::::::::::::::::::::::::::::::::::::::::::: 3 1.4 Mail Lists :::::::::::::::::::::::::::::::::::::::::::::::::::::: 6 2 Smart Keys :::::::::::::::::::::::::::::::::::::: 7 2.1 Smart Key Bindings :::::::::::::::::::::::::::::::::::::::::::: 7 2.2 Smart Key Operations :::::::::::::::::::::::::::::::::::::::::: 7 2.3 Smart Key Argument Selection :::::::::::::::::::::::::::::::: 10 2.4 Smart Key Debugging ::::::::::::::::::::::::::::::::::::::::: 11 2.5 Smart Key Thing Selection :::::::::::::::::::::::::::::::::::: 11 2.6 Smart Mouse Key Modeline Clicks ::::::::::::::::::::::::::::: 12 2.7 Smart Mouse Key Drags::::::::::::::::::::::::::::::::::::::: 14 2.7.1 Creating and Deleting Windows::::::::::::::::::::::::::: 14 2.7.2 Saving and Restoring Window Configurations ::::::::::::: 14 2.7.3 Resizing Windows :::::::::::::::::::::::::::::::::::::::: 14 2.7.4 Moving Frames ::::::::::::::::::::::::::::::::::::::::::: 15 2.7.5 Dragging Buffers, Windows and Items::::::::::::::::::::: 15 2.7.5.1 Swapping Buffers :::::::::::::::::::::::::::::::::::: 15 2.7.5.2 Displaying Buffers ::::::::::::::::::::::::::::::::::: 15 2.7.5.3 Cloning Windows :::::::::::::::::::::::::::::::::::: 15 2.7.5.4 Displaying File and Buffer Items ::::::::::::::::::::: 15 2.7.5.5 Keyboard Drags ::::::::::::::::::::::::::::::::::::: 16 3 Buttons ::::::::::::::::::::::::::::::::::::::::: 18 3.1 Explicit Buttons::::::::::::::::::::::::::::::::::::::::::::::: 19 3.2 Global Buttons :::::::::::::::::::::::::::::::::::::::::::::::: 19 3.3 Implicit Buttons::::::::::::::::::::::::::::::::::::::::::::::: 20 3.3.1 Implicit Button Types :::::::::::::::::::::::::::::::::::: 21 3.3.2 Action Buttons ::::::::::::::::::::::::::::::::::::::::::: 28 3.4 Button Files::::::::::::::::::::::::::::::::::::::::::::::::::: 28 3.5 Action Types:::::::::::::::::::::::::::::::::::::::::::::::::: 29 3.6 Button Type Precedence::::::::::::::::::::::::::::::::::::::: 32 3.7 Utilizing Explicit Buttons ::::::::::::::::::::::::::::::::::::: 33 3.7.1 Creation:::::::::::::::::::::::::::::::::::::::::::::::::: 33 3.7.1.1 Creation Via Action Key Drags :::::::::::::::::::::: 33 3.7.1.2 Creation Via Menus ::::::::::::::::::::::::::::::::: 34 3.7.2 Renaming :::::::::::::::::::::::::::::::::::::::::::::::: 34 3.7.3 Deletion :::::::::::::::::::::::::::::::::::::::::::::::::: 35 iii 3.7.4 Modification :::::::::::::::::::::::::::::::::::::::::::::: 35 3.7.5 Searching and Summarizing::::::::::::::::::::::::::::::: 35 3.7.6 Buttons in Mail :::::::::::::::::::::::::::::::::::::::::: 36 3.7.7 Buttons in News:::::::::::::::::::::::::::::::::::::::::: 37 4 Menus ::::::::::::::::::::::::::::::::::::::::::: 38 5 HyControl :::::::::::::::::::::::::::::::::::::: 42 6 Koutliner ::::::::::::::::::::::::::::::::::::::: 47 6.1 Menu Commands:::::::::::::::::::::::::::::::::::::::::::::: 48 6.2 Creating Outlines ::::::::::::::::::::::::::::::::::::::::::::: 49 6.3 Autonumbering:::::::::::::::::::::::::::::::::::::::::::::::: 50 6.4 Idstamps :::::::::::::::::::::::::::::::::::::::::::::::::::::: 51 6.5 Editing:::::::::::::::::::::::::::::::::::::::::::::::::::::::: 51 6.5.1 Adding and Killing ::::::::::::::::::::::::::::::::::::::: 51 6.5.2 Relocating and Copying :::::::::::::::::::::::::::::::::: 51 6.5.3 Moving Around::::::::::::::::::::::::::::::::::::::::::: 53 6.5.4 Filling :::::::::::::::::::::::::::::::::::::::::::::::::::: 53 6.5.5 Transposing :::::::::::::::::::::::::::::::::::::::::::::: 53 6.5.6 Splitting and Appending :::::::::::::::::::::::::::::::::: 54 6.5.7 Inserting and Importing :::::::::::::::::::::::::::::::::: 54 6.5.8 Exporting :::::::::::::::::::::::::::::::::::::::::::::::: 55 6.6 Viewing ::::::::::::::::::::::::::::::::::::::::::::::::::::::: 55 6.6.1 Hiding and Showing :::::::::::::::::::::::::::::::::::::: 55 6.6.2 View Specs ::::::::::::::::::::::::::::::::::::::::::::::: 56 6.7 Links:::::::::::::::::::::::::::::::::::::::::::::::::::::::::: 56 6.8 Cell Attributes :::::::::::::::::::::::::::::::::::::::::::::::: 57 6.9 Koutliner History:::::::::::::::::::::::::::::::::::::::::::::: 58 7 HyRolo:::::::::::::::::::::::::::::::::::::::::: 59 7.1 HyRolo Concepts :::::::::::::::::::::::::::::::::::::::::::::: 59 7.2 Rolo Menu :::::::::::::::::::::::::::::::::::::::::::::::::::: 60 7.3 HyRolo Searching ::::::::::::::::::::::::::::::::::::::::::::: 61 7.4 HyRolo Keys :::::::::::::::::::::::::::::::::::::::::::::::::: 62 7.5 HyRolo Settings ::::::::::::::::::::::::::::::::::::::::::::::: 63 8 Window Configurations:::::::::::::::::::::::: 66 iv 9 Developing with Hyperbole ::::::::::::::::::: 68 9.1 Hook Variables :::::::::::::::::::::::::::::::::::::::::::::::: 68 9.2 Creating Types :::::::::::::::::::::::::::::::::::::::::::::::: 69 9.2.1 Action Type Creation :::::::::::::::::::::::::::::::::::: 70 9.2.2 Implicit Button Type Creation:::::::::::::::::::::::::::: 71 9.3 Explicit Button Technicalities:::::::::::::::::::::::::::::::::: 72 9.3.1 Button Label Normalization :::::::::::::::::::::::::::::: 72 9.3.2 Operational and Storage Formats ::::::::::::::::::::::::: 72 9.3.3 Programmatic Button Creation ::::::::::::::::::::::::::: 73 9.4 Encapsulating Systems :::::::::::::::::::::::::::::::::::::::: 73 9.5 Embedding Hyperbole ::::::::::::::::::::::::::::::::::::::::: 73 Appendix A Glossary :::::::::::::::::::::::::::: 74 Appendix B Setup:::::::::::::::::::::::::::::::: 81 B.1 Installation ::::::::::::::::::::::::::::::::::::::::::::::::::: 81 B.2 Invocation :::::::::::::::::::::::::::::::::::::::::::::::::::: 81 B.3 Customization :::::::::::::::::::::::::::::::::::::::::::::::: 83 B.3.1 Referent Display ::::::::::::::::::::::::::::::::::::::::: 84 B.3.2 Internal Viewers:::::::::::::::::::::::::::::::::::::::::: 84 B.3.3 External Viewers ::::::::::::::::::::::::::::::::::::::::: 86 B.3.4 Link Variable Substitution ::::::::::::::::::::::::::::::: 87 B.3.5 Web Search Engines:::::::::::::::::::::::::::::::::::::: 87 B.3.6 Using URLs with Find-File ::::::::::::::::::::::::::::::: 88 B.3.7 Invisible Text Searches ::::::::::::::::::::::::::::::::::: 89 B.3.8 Configuring Button Colors ::::::::::::::::::::::::::::::: 90 Appendix C Global Key Bindings :::::::::::::: 91 C.1 Binding Minibuffer Menu Items ::::::::::::::::::::::::::::::: 91 C.2 Default Global Bindings::::::::::::::::::::::::::::::::::::::: 91 Appendix D Koutliner Keys ::::::::::::::::::::: 94 Appendix E Smart Key Reference::::::::::::: 102 E.1 Smart Mouse Keys ::::::::::::::::::::::::::::::::::::::::::: 102 E.1.1 Minibuffer Menu Activation ::::::::::::::::::::::::::::: 102 E.1.2 Thing Selection ::::::::::::::::::::::::::::::::::::::::: 102 E.1.3 Side-by-Side Window Resizing::::::::::::::::::::::::::: 103 E.1.4 Modeline Clicks and Drags :::::::::::::::::::::::::::::: 104 E.1.5 Smart Mouse Drags between Windows::::::::::::::::::: 105 E.1.6 Smart Mouse Drags within a Window