File: hib-doc-id.el.html
This library defines the doc-id implicit button type which lets
you create archives of reference documents by topic and then
reference them within any Hyperbole readable file by use of simple
identifiers, like [-Emacs-001-]. It functions like a rapid access
card catalog with easy to embed document identifiers.
TO USE:
Pressing the Action Key on a doc id such as, [-Emacs-001-],
displays the online version of the document, if any. Pressing the
Assist Key on it displays its document index entry.
TO CONFIGURE:
Set the value of doc-id-indices before using the doc-id
implicit button type defined herein or you will get an error telling you
to do so. See the documentation for doc-id-indices.
You must explicitly load this library in order to use it, since
Hyperbole does not load it by default.
The default setup uses doc ids of the form, [- Emacs-001 -], delimited
by minus signs inside square brackets, the id starting with a topic name,
followed by a minus sign and a multi-digit numeric identifier.
Typically an index entry should have links to all available forms of its
document, e.g. online, printed, source. Below is a sample index entry form
to use. The default variable settings herein work with this format. If
you prefer a different one, you must change all of the variable values.
--------------------------------------------------------------------------
Title: ID: [- -]
Email-To:
Distribution:
Abstract:
References:
Author:
Copyright:
Keywords: hypertext
Online-Format:
Online-Loc: ""
Printed-Format:
Printed-Loc: Local Library
Printable-Loc: ""
Source-Format:
Source-Loc: ""
Date:
Version-Changes:
--------------------------------------------------------------------------
Defined variables (7)
doc-id-end | String which delimits end of a site-specific document id. |
doc-id-index-entry-regexp | Regexp which matches start of a site-specific document index entry. |
doc-id-indices | List of pathnames in which to search for site-specific document index entries. |
doc-id-match | Single arg function returning regexp matching within DOC-ID’s index entry only. |
doc-id-online-regexp | Regexp with 1st grouping matching a double quoted index entry implicit button. |
doc-id-p | Value is a function with a boolean result that tests whether ‘str’ is a doc id. |
doc-id-start | String which delimits start of a site-specific document id. |
Defined functions (2)
actypes::link-to-doc | (DOC-ID) |
doc-id:help | (BUT) |