Remarks

Description

Known Problems

Download

Version history

Description

Add remarks or other data to files -- even non-writable ones. These remarks are saved as file properties. Overriding the default edit "method", remarks can also be links to other files. Also see CompEmacsTextcoding for a more elaborated example for other possible uses.

Usage

Installation: Put (require 'remarks) (remarks-install) into your startup/user init file.

Select a region and execute `remarks-make'. Remarks are saved and restored via properties.el.

• Exit the note editing buffer by pressing C-c C-c -- if you kill the temporary buffer otherwise, the editing modes could get messed up.
• Make the first line a meaningful title.
• Inserting a null-text results in the deletion of the note.
• When notes overlap, the user will be asked to select one note by its title.
• Usually remarks will be saved when killing the buffer. You can nevertheless force saving notes by calling `properties-write'.
• When closing a buffer, opened remarks will be saved automatically.

Commands

`remarks-make'

Make a note covering the region from BEG to END.

`remarks-edit'

Edit the note at point.

`remarks-summarise'

Summarise the current buffer's remarks.

`remarks-make-link'

Mark a region as a link to another file.

Variables

`remarks-mouse-button'

Pressing this mouse button over an annotated region (button-3 by default) pops up a small menu.

`remarks-marker'

Prefix annotated regions with this string (default: "[REM%%]", %% being the note number).

`remarks-find-link-function'

Function used for opening links.

Faces

`remarks-face'

Face for marking excerpts.

`remarks-link-face'

Face for marking excerpts.

Mouse & key bindings (local to overlay/extent)

Known Problems

Download

Requirements: tellib, file properties

0.2: remarks.el.gz

Version history

v0.2

Improvements for use with CompEmacsTextcoding

v0.1

Initial release (tested with XEmacs)

(c) 2003 Thomas Link (last updated Mar 20 2003)	home	top