File: hyrolo.el.html

This is Hyperbole's advanced rolo system, HyRolo, for convenient
 management of hierarchical, record-oriented information. Most
 often this is used for contact management but it can quickly be
 adapted to most any record-oriented lookup task, for fast, full-text
 retrieval.

 See all the autoloaded functions herein for interactive commands.
 See the Info manual entry "(hyperbole)HyRolo" for usage information.

 Note that for Markdown files, HyRolo supports only the modern standard
 of headlines that start with '#' characters, not the older, setext
 style of underlining headers with '=' or '-' characters.

Defined variables (56)

hyrolo--cache-index-to-major-mode-hashtHash table with integer major-mode index keys and ‘major-mode’ values.
hyrolo--cache-loc-match-boundsOrdered list of the bounds of each matched buffer in Hyrolo display buffer.
hyrolo--cache-major-mode-indexNext index value to use when caching buffer-local values.
hyrolo--cache-major-mode-indexesOrdered keys to select major modes in ‘hyrolo--cache-major-mode-indexes’.
hyrolo--cache-major-mode-to-index-hashtHash table with ‘major-mode’ name keys and integer major-mode index values.
hyrolo--expanded-file-listList of hyrolo files after directory and file wildcard expansions.
hyrolo--wconfigSaves frame’s window configuration prior to a hyrolo search.
hyrolo-add-hookHook run when a HyRolo item is added.
hyrolo-auto-mode-alistEntries to prepend to ‘auto-mode-alist’ to invoke file modes used by HyRolo.
hyrolo-boolean-only-flagSet to prevent HyRolo from displaying an error buffer when running tests.
hyrolo-date-formatFormat of date string used in HyRolo automatic date stamps.
hyrolo-display-bufferBuffer used to display set of last matching rolo entries.
hyrolo-display-format-functionFunction of 2 args, start and end, that formats the region for display.
hyrolo-edit-hookHook run when a HyRolo item is edited.
hyrolo-email-formatFormat string to use when adding an entry with e-mail addr from a mail msg.
hyrolo-entry-group-numberGroup number whose length represents the level of any entry matched.
hyrolo-entry-name-regexpRegexp matching a hyrolo entry name.
hyrolo-entry-regexpRegular expression to match the beginning of a HyRolo entry.
hyrolo-entry-trailing-space-group-numberGroup number within ‘hyrolo-hdr-and-entry-regexp’ containing trailing space.
hyrolo-file-listList of files containing hyrolo entries.
hyrolo-file-suffix-regexpFile suffix regexp used to select files to search with HyRolo.
hyrolo-find-file-functionFunction to interactively display a ‘hyrolo-file-list’ file for editing.
hyrolo-find-file-noselect-functionFunction used by HyRolo to read ‘hyrolo-file-list’ files into Emacs.
hyrolo-google-contacts-flagNon-nil means search Google Contacts on each hyrolo query.
hyrolo-hdr-and-entry-regexpRegular expression to match the beginning of a HyRolo file header or entry.
hyrolo-hdr-formatHeader to insert before a file’s first entry match when file has no header.
hyrolo-hdr-prefix-regexpRegexp to prefix to ‘hyrolo-hdr-and-entry-regexp’ and ‘outline-regexp’.
hyrolo-hdr-regexpRegular expression to match the first and last lines of hyrolo file headers.
hyrolo-highlight-faceFace used to highlight rolo search matches.
hyrolo-kill-buffers-after-useNon-nil means kill rolo file buffers after searching them for entries.
hyrolo-logical-regexpRegexp matching the beginning of a HyRolo logical search string.
hyrolo-markdown-mode-abbrev-tableAbbrev table for ‘hyrolo-markdown-mode’.
hyrolo-markdown-mode-hookHook run after entering ‘hyrolo-markdown-mode’.
hyrolo-markdown-mode-mapKeymap for ‘hyrolo-markdown-mode’.
hyrolo-markdown-mode-syntax-tableSyntax table for ‘hyrolo-markdown-mode’.
hyrolo-markdown-suffix-regexpRegexp matching Markdown file suffixes.
hyrolo-match-regexpLast regular expression used to search the hyrolo.
hyrolo-mode-mapKeymap for the hyrolo display match buffer.
hyrolo-mode-prefix-mapKeymap for hyrolo display match buffer bindings with a prefix, typically C-c.
hyrolo-mode-syntax-tableSyntax table used while in hyrolo match mode.
hyrolo-next-match-functionValue is the function to find next match within a HyRolo file.
hyrolo-org-mode-abbrev-tableAbbrev table for ‘hyrolo-org-mode’.
hyrolo-org-mode-hookHook run after entering ‘hyrolo-org-mode’.
hyrolo-org-mode-mapKeymap for ‘hyrolo-org-mode’.
hyrolo-org-mode-syntax-tableSyntax table for ‘hyrolo-org-mode’.
hyrolo-outline-minor-modeNon-nil if Hyrolo-Outline minor mode is enabled.
hyrolo-outline-minor-mode-hookHook run after entering or leaving ‘hyrolo-outline-minor-mode’.
hyrolo-outline-mode-abbrev-tableAbbrev table for ‘hyrolo-outline-mode’.
hyrolo-outline-mode-hookHook run after entering ‘hyrolo-outline-mode’.
hyrolo-outline-mode-mapKeymap for ‘hyrolo-outline-mode’.
hyrolo-outline-mode-syntax-tableSyntax table for ‘hyrolo-outline-mode’.
hyrolo-reveal-ignore-this-commandSet this non-nil in any command that should ignore ‘hyrolo-reveal-mode’.
hyrolo-reveal-modeNon-nil if Hyrolo-Reveal mode is enabled.
hyrolo-reveal-mode-hookHook run after entering or leaving ‘hyrolo-reveal-mode’.
hyrolo-save-buffers-after-useNon-nil means save rolo file after an entry is killed.
hyrolo-yank-reformat-functionA function of two arguments, START and END, invoked after a ‘hyrolo-yank’.

Defined functions (142)

hyrolo--cache-get-major-mode-from-index(MAJOR-MODE-INDEX)
hyrolo--cache-initialize()
hyrolo--cache-major-mode(SRC-BUF)
hyrolo--funcall-with-outline-regexp(FUNC)
hyrolo--post-display-buffer()
hyrolo--pre-display-buffer(&optional SRC-BUF)
hyrolo-add(NAME &optional FILE)
hyrolo-add-match(REGEXP START END HEADLINE-ONLY)
hyrolo-any-file-type-problem-p()
hyrolo-at-tags-p(&optional AT-TAG-FLAG)
hyrolo-bbdb-entry-format(START END)
hyrolo-bbdb-fgrep(&optional ARG)
hyrolo-bbdb-grep(&optional ARG)
hyrolo-bbdb-grep-file(HYROLO-FILE-OR-BUF REGEXP &optional MAX-MATCHES COUNT-ONLY)
hyrolo-buffer-exists-p(HYROLO-BUF)
hyrolo-cache-get-major-mode-from-pos(POS)
hyrolo-cache-location-start-and-end()
hyrolo-consult-fgrep(&optional STRING MAX-MATCHES PATH-LIST PROMPT)
hyrolo-consult-grep(&optional REGEXP MAX-MATCHES PATH-LIST PROMPT)
hyrolo-current-date()
hyrolo-display-format(START END)
hyrolo-display-matches(&optional DISPLAY-BUF RETURN-TO-BUFFER)
hyrolo-display-to-entry-end()
hyrolo-edit(&optional NAME FILE-OR-BUF)
hyrolo-edit-date()
hyrolo-edit-entry()
hyrolo-expand-path-list(PATHS)
hyrolo-fgrep(STRING &optional MAX-MATCHES HYROLO-FILES-OR-BUFS COUNT-ONLY HEADLINE-ONLY NO-DISPLAY)
hyrolo-fgrep-directories(FILE-REGEXP &rest DIRS)
hyrolo-fgrep-file(HYROLO-FILE-OR-BUF STRING &optional MAX-MATCHES COUNT-ONLY HEADLINE-ONLY)
hyrolo-file-list-changed(SYMBOL SET-TO-VALUE OPERATION WHERE)
hyrolo-find-file(&optional FILE FIND-FUNCTION &rest ARGS)
hyrolo-find-file-noselect(&optional FILE)
hyrolo-format-name(NAME-STR FIRST LAST)
hyrolo-forward-visible-line(&optional ARG)
hyrolo-funcall-match(FUNC &optional NARROW-FLAG BACKWARD-FLAG)
hyrolo-get-file-list()
hyrolo-google-contacts-fgrep(&optional ARG)
hyrolo-google-contacts-grep(&optional ARG)
hyrolo-google-contacts-grep-file(HYROLO-FILE-OR-BUF REGEXP &optional MAX-MATCHES COUNT-ONLY)
hyrolo-google-contacts-insert-data(CONTACTS TOKEN CONTACT-PREFIX-STRING)
hyrolo-google-contacts-insert-generic-list(ITEMS TITLE &optional GET-VALUE)
hyrolo-google-contacts-p()
hyrolo-grep(REGEXP &optional MAX-MATCHES HYROLO-FILES-OR-BUFS COUNT-ONLY HEADLINE-ONLY NO-DISPLAY)
hyrolo-grep-directories(FILE-REGEXP &rest DIRS)
hyrolo-grep-file(HYROLO-FILE-OR-BUF PATTERN &optional MAX-MATCHES COUNT-ONLY HEADLINE-ONLY)
hyrolo-grep-input(READ-FUNCTION PROMPT &optional PATH-LIST)
hyrolo-grep-or-fgrep(&optional ARG)
hyrolo-hdr-in-p()
hyrolo-hdr-move-after-p()
hyrolo-hdr-to-first-line-p()
hyrolo-hdr-to-last-line-p()
hyrolo-highlight-matches(REGEXP START END)
hyrolo-install-markdown-mode()
hyrolo-isearch(&optional ARG)
hyrolo-isearch-for-regexp(REGEXP FOLD-SEARCH-FLAG)
hyrolo-isearch-regexp(&optional ARG)
hyrolo-kill(NAME &optional FILE)
hyrolo-kill-buffer(&optional HYROLO-BUF)
hyrolo-let-file-list(SYMBOL VALUE)
hyrolo-locate()
hyrolo-mail-to()
hyrolo-major-mode-from-file-name(NAME)
hyrolo-map-level(FUNC LEVEL-REGEXP &optional MAX-GROUPINGS)
hyrolo-map-matches(FUNC &optional NARROW-FLAG)
hyrolo-map-single-subtree(FUNC EXACT-LEVEL-REGEXP LEVEL-LEN READ-ONLY-FLAG)
hyrolo-markdown-mode()
hyrolo-min-matched-level()
hyrolo-mode()
hyrolo-move-forward(FUNC &rest ARGS)
hyrolo-move-to-entry-end(INCLUDE-SUB-ENTRIES)
hyrolo-name-and-email()
hyrolo-name-at-p()
hyrolo-next-match()
hyrolo-next-regexp-match(REGEXP)
hyrolo-normalize-mode-function(FRAME)
hyrolo-org(STRING &optional MAX-MATCHES ORG-FILES)
hyrolo-org-mode()
hyrolo-org-roam(STRING &optional MAX-MATCHES ORG-ROAM-FILES)
hyrolo-outline-back-to-heading(&optional INVISIBLE-OK)
hyrolo-outline-demote(&optional WHICH)
hyrolo-outline-forward-same-level(ARG)
hyrolo-outline-get-last-sibling()
hyrolo-outline-get-level(BACKWARD-FLAG)
hyrolo-outline-get-next-sibling()
hyrolo-outline-hide-body()
hyrolo-outline-hide-entry()
hyrolo-outline-hide-leaves()
hyrolo-outline-hide-other()
hyrolo-outline-hide-sublevels(LEVELS)
hyrolo-outline-hide-subtree()
hyrolo-outline-insert-heading()
hyrolo-outline-level()
hyrolo-outline-mark-subtree()
hyrolo-outline-minor-mode(&optional ARG)
hyrolo-outline-move-subtree-down(&optional ARG)
hyrolo-outline-move-subtree-up(&optional ARG)
hyrolo-outline-next-visible-heading(ARG)
hyrolo-outline-previous-heading()
hyrolo-outline-previous-visible-heading(ARG)
hyrolo-outline-promote(&optional WHICH)
hyrolo-outline-show-all()
hyrolo-outline-show-branches()
hyrolo-outline-show-children(&optional LEVEL)
hyrolo-outline-show-entry()
hyrolo-outline-show-subtree()
hyrolo-outline-up-heading(ARG &optional INVISIBLE-OK)
hyrolo-overview(LEVELS-TO-SHOW)
hyrolo-previous-match()
hyrolo-prompt(KEYBOARD-FUNCTION PROMPT)
hyrolo-quit()
hyrolo-refresh-file-list()
hyrolo-rename(OLD-FILE NEW-FILE)
hyrolo-retrieve-google-contacts(&optional QUERY-STRING FORCE-REFRESH)
hyrolo-reveal-close-old-overlays(OLD-OLS)
hyrolo-reveal-mode(&optional ARG)
hyrolo-reveal-open-new-overlays(OLD-OLS)
hyrolo-save-buffer(&optional HYROLO-BUF)
hyrolo-search-directories(SEARCH-CMD FILE-REGEXP &rest DIRS)
hyrolo-set-date(&optional EDIT-ONLY-FLAG)
hyrolo-set-display-buffer()
hyrolo-set-display-buffer-mode()
hyrolo-set-file-list(SYMBOL VALUE)
hyrolo-show-levels(LEVELS-TO-SHOW)
hyrolo-sort(&optional HYROLO-FILE)
hyrolo-sort-level(LEVEL-REGEXP &optional MAX-GROUPINGS)
hyrolo-sort-lines(REVERSE BEG END)
hyrolo-tags-view(&optional TODO-ONLY MATCH VIEW-BUFFER-NAME)
hyrolo-to(NAME &optional FILE-OR-BUF-LIST)
hyrolo-to-buffer(BUFFER &optional OTHER-WINDOW-FLAG FRAME)
hyrolo-to-entry-beginning(&optional INCLUDE-SUB-ENTRIES)
hyrolo-to-entry-end(&optional INCLUDE-SUB-ENTRIES)
hyrolo-to-next-loc()
hyrolo-to-previous-loc()
hyrolo-toggle-datestamps(&optional ARG)
hyrolo-toggle-narrow-to-entry()
hyrolo-top-level()
hyrolo-update-file-list(&optional PATH-LIST)
hyrolo-verify()
hyrolo-widen()
hyrolo-word(STRING &optional MAX-MATCHES HYROLO-FILES-OR-BUFS COUNT-ONLY HEADLINE-ONLY NO-DISPLAY)
hyrolo-yank(NAME &optional REGEXP-FLAG)

Defined faces (0)