Major mode for editing Stata files in Emacs
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs4github
lisp
scripts
setup_aids
syntax_testers
templates
INSTALL.md
README.md
changes.md
changes.txt
font_highlighting_example.ado
readme.txt

README.md

The ado-mode for Emacs

The ado-mode is a major [editing] mode for Emacs which allows truly good editing of Stata, namely do, ado, sthlp, smcl, and mata files. Here is a screenshot to see what the highlighting does. The mode also handles indentation, date stamps, and includes templates for writing help files, project do-files and the like.

Emacs versions 25, 24, and 23 are supported.

Here is the change log which says what is new.

The current version is 1.15.1.3, which is made for Stata 15.1. It works just fine with earlier versions of Stata, but it will highlight commands as though you were using Stata 15.1.

Here are the things which make life easier when using the ado-mode. Features include

  • Sending code directly from Emacs to Stata for evaluation.

  • Opening any file on the default ado-path, even automagically opening the ado-file for the current command.

  • Opening Stata help files (in Stata, of course) from Emacs.

  • Context-sensitive highlighting for keeping typos to a minimum.

    • Stata's commands and keywords are highlighted even if abbreviated.
    • Commands which need subcommands are highlighted differently, so that you know a subcommand is needed.
    • Downloaded and personal user-written commands can be automatically highlighted once Emacs knows where they are kept.
    • smcl directive highlighting (a big help for help files)
  • Templates for common files, such as do-files which keep their own logs, ado-files, do-files made for testing and debugging ado-files, and (most importantly, perhaps) Stata help files.

  • Automatic indentation so that long if, foreach, forvalues, and while blocks get closed. Many types of indentation styles are supported.

  • Making the name of the ado file match the name of the program defined, even if you change the program's name.

  • Automatic refreshing of a header time stamp which can be formatted in a variety of ways.

  • Typical Emacs things: Parentheses, braces and double-quotes are balanced.

Installation is not as simple as it could be, so there (will be) installation instructions on the wiki. For now, the installation instructions are back on the old webpage.)

Please let me know if there are any troubles with the installations, since there are little quirks with cross-platform Emacs stuff.

ado-mode is on Twitter: @ado-mode. The real reason for this is to have an easy RSS feed for finding out about updates: https://twitter.com/adomode