Next: , Previous: <tasks> tag, Up: Task Reports and Overviews


6.3 planner-registry

The planner-registry module provides a way to keep track of all the URLs in your projects, and to list them depending on the current buffer. The URLs are defined in muse-url-protocols module from Muse.

If a URL has been created by planner-create-task-from-buffer, going to that buffer and calling planner-registry-show will show you where Planner put the URL.

Getting started

To begin using planner-registry, add the following to your Planner configuration file.

     (require 'planner-registry)
     (planner-registry-initialize)

You must put it after the place where Planner has been loaded in your configuration file.

If you want the registry to be updated each time you save a Planner file, add the following to your Planner configuration.

     (planner-registry-insinuate)

If you don't want to update the registry each time a file is written, you can do it manually with planner-registry-update: it will update the registry for saved Planner/Muse buffers only.

planner-registry does not define any keybindings by default. Its most useful interactive function is planner-registry-show.

Example usage

Say for example that you created a task from an e-mail. Go to that e-mail and call planner-registry-show: it will open a new buffer displaying the files (in a muse links format) where a link to this e-mail has been added.

Options

planner-registry defines the following options.

— User Option: planner-registry-file

The file where planner-registry stores its URL registry.

— User Option: planner-registry-min-keyword-size

The minimum size for keywords.

— User Option: planner-registry-max-keyword-size

The maximum size for keywords.

— User Option: planner-registry-max-number-of-keywords

The maximum number of keywords.

— User Option: planner-registry-ignore-keywords

A list of keywords to ignore.

— User Option: planner-registry-show-level

Level used by the planner-registry-show function. 0 means that this function shows only exact matches. 1 means that this function also shows descriptive matches. 2 (or more) means that this function also shows fuzzy matches.