IBM
Contents Index Previous Next



Overview


Introduction

The implementation works with GNU Emacs version 19.31 or later, and only on UNIX systems. It does not work with any Emacs for Windows.

It is assumed that you are familiar with Emacs terminology and how to use Emacs. Some experience with installing Emacs Lisp packages is also required when setting up the integrated environment.

Text Document Handling

By setting preferences to use Emacs as text editor in SDL Suite and TTCN Suite, text editing support in Emacs is offered both from the Organizer and editors. Text document handling is implemented in the Lisp package "sdtemacs".

In the Organizer, text documents are identified by the document type "Text Plain" when you add new or existing documents. A new Emacs instance will always be started, even though there may exist one already (started from outside SDL Suite and TTCN Suite).

Link Handling

The Lisp package "sdtlinks" defines the minor mode SDTlinks which supports SOMT implementation links in text documents. This gives the possibility to handle link endpoints and follow the links defined for these endpoints. The support for link handling is optional.

When the SDTlinks mode is active, endpoints are displayed with a typeface differing from the plain text. Type faces for endpoints with and without links are configurable, see Type Faces for Endpoints.

To be able to represent endpoints in text files, the file contents differ from what is seen in the Emacs buffer containing a file with endpoints. The file format for endpoints look like this:

<SDT_LINK_ENDPOINT_BEGIN anchor >text<SDT_LINK_ENDPOINT_END>

where anchor is an integer uniquely identifying the endpoint and text is the endpoint text. If the SDTlinks mode is inactive, this raw file contents is displayed in the Emacs buffer.

Caution!

When the SDTlinks mode is inactive:

Do not alter any text representing endpoints (described in Link Handling).

Do not duplicate text containing endpoints since this will yield unpredictable results as each endpoint is uniquely identified in a file.

As a general principle, Undo is not available for the link handling commands.w


http://www.ibm.com/rational
Contents Index Previous Next