Racket Scribble Emacs Mode

0.3

Racket Scribble Emacs Mode

Neil Van Dyke

License: LGPL 3 Web: http://www.neilvandyke.org/scribble-emacs/

1 Introduction

This package provides an Emacs editing mode for Racket Scribble.

1.1 Features

The current version of this package provides a few features: it

Syntax coloring/fontification. Currently supported syntax is scribble/base, scribble/bnf, and some of scribble/manual. (Note: This feature is currenty implemented using regular expressions derived from a detailed grammar of various Scribble procedures and special syntax. This might change in the future, since regular expressions are not very appropriate.)
Syntax quick-reference help in the echo area, when clicking on a name in at-sign syntax. This is implemented using the encoded grammar and ElDoc.
Completion of Scribble functions, special syntax, and keywords, using M-TAB.
Various hints to Emacs about the syntax of Scribble.
Menu-based navigation to particular section headings, using Imenu.

Some additional features are planned.

1.2 Requirements

This package is being developed with GNU Emacs 23.2 on GNU/Linux. There is an intention to have it portable to GNU Emacs 23 and 22 on all popular host OS platforms those Emacs versions support, so please let me know if you find compatibility problems.

This package currently uses the “DejaVu” fonts explicitly.

2 Installation

This package is currently distributed through PLaneT. There are two alternatives for installation:

Evaluate the following Racket code to install the PLaneT package and to modify your personal Emacs initialization file (usually ~/.emacs) to load the scribble.el file when you start Emacs.
(require (planet neil/scribble-emacs:1:2/install-in-my-emacs))
You can safely evaluate this code many times, such as to install new versions, and the configuration in your Emacs initialization file will be updated appropriately.
Evaluate the following Racket code to install the PLaneT package without modifying your Emacs setup.
(require (planet neil/scribble-emacs:1:2))

3 History

Version 0.4 — 2013-09-28 - PLaneT (1 3)
Added code and codeblock. (Thanks to Rommel M. Martinez.)
Version 0.3 — 2011-01-10 - PLaneT (1 2)
Added M-TAB completion of Scribble functions, syntax, and keywords.
Version 0.2 — 2011-01-09 - PLaneT (1 1)
Documentation fix.
Version 0.1 — 2011-01-09 - PLaneT (1 0)
Initial release.

4 Legal

Copyright © 2011 Neil Van Dyke. This program is Free Software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License (LGPL 3), or (at your option) any later version. This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See http://www.gnu.org/licenses/ for details. For other licenses and consulting, please contact the author.