The RTextDoc LaTeX editor put to the test

Those daring to use LaTeX for the first time might want to start off with an editor – a program such as RTextDoc [1]. Such a program promises a lot of additional comfort functions beyond checking syntax that allow correct document formatting with minimal mouse clicks.

The fact that GPL app RTextDoc is written in Java, which means you need the corresponding runtime environment (see the "Installation" box), but it also means it runs just as well on Linux as Mac OS X and Windows. Additional plugins add flexibility extending the base editor. Technically, the software is based on the RText [2] editor also implemented in Java.

$ java -jar /RTextDoc_path/rtextdoc.jar

java --version<C>

A glance at the list of features shows why it's worthwhile giving this program a try. The software supports more than 20 languages, including spell-checking and a built-in grammar checker through LanguageTool [3]. You can also add simple drawings, with the software highlighting the LaTeX syntax and other markup languages directly in the source code. RTextDoc handles bookmarks and grouping of sections, as well as line numbering and bracket pairing testing. Finally, it supports syntax highlighting for programming languages, along with references and BibTeX checking. A WYSIWYG mode is available for math formulas, and additional functions can be added to menus and macros.

GPL at Cost

There is a catch, however. Many of the options are available in a fee-activated version (see Table 1). Unlocking them costs $20 for private users. This approach is something, in fact, that the GPL allows, as long as the source code is freely accessible.

The fee-based nature also applies to the detailed documentation, which only activated versions have access to (Figure 1). Fortunately, online help is available for each menu item (Figure 2), which you can find as HTML files in the doc/ directory of your installation. The help can clarify some details but is primarily aimed at Java programmers, for which RText was originally developed.

Figure 1: The comprehensive documentation is available only for paying RTextDoc customers.

Figure 2: The sparse online help for menus is available even without activation.

Activation was not without some problems in my test. Even though the administrators set up the account within a day to enable access to the documentation, enabling the additional editor functions required deleting the ~/.rtextdoc/ directory after installation.

LaTeX Skills

The developers tout RTextDoc as a specialized LaTeX editor. As a compiler, it's based on the now obsolete pdfLaTeX and Dvips, which is not being developed anymore. Native support for XeLaTeX, currently the most used variant, is nowhere to be found. In principle, however, other TeX compilers can be used. You can add them in Macros or use them as a basis for your own. In this context, macros have nothing to do with those used in LaTeX but are more related to JavaScript and Groovy routines callable from the editor.

An example of how this works is shown in Figure 3. The example shows the Run pdfLaTeX.groovy script. By replacing the // do not modify line with it, you can call XeLaTeX instead of pdfLaTeX. However, saving the script as xelatex.groovy so that the editor can find it, won't work. The documentation suggests dropping it in macros/ in the ~/.rtextdoc directory.

Figure 3: Integrating modern compilers in the software requires some effort, without much support from developers.

The program actually supports linguistic adjustments for menus and dialogs, which worked fine in the Java-written predecessor. In the current version of RTextDoc, you can also find a comprehensive dialog in Edit | Options that allows language settings, although it didn't work for me in either the free or the activated version of the software.

Another special feature the program provides is an environment for creating drawings for LaTeX documents. This currently works much better with graphics programs such as Inkscape, MyPaint, or GIMP instead, including exporting in a supported bitmap format. These applications are optimized for graphics creation and allow special effects, such as filling selected regions with gradients or the like. RTextDoc instead bases its drawing function on the Java-developed LaTeXDraw (Figure 4).

Figure 4: LaTeXDraw lets you create drawings, but with little chance of modifying them.

This not-so-powerful program doesn't allow moving, adding, or removing set points in most tools. It also relies on the PSTricks package developed for PostScript output that is mostly no longer used – for good reason. The drawing module also doesn't support the much more powerful PGF/TikZ for PDF output.