RSS

 
WinEdt Macro Library  | macro previous macro  | next macro

dynamicKeywords

This macro package is only useful in combination with a mode.
If you don't want to install a mode that requires this package, and you are not a mode writer, you don't need it.

Currently, the following modes use this package:

Description

This macro package provides mode writers with the possibility to dynamically load keywords for highlighting and for word completion.

Apart from many others, WinEdt has two features: It will highlight keywords (e.g. \bibliography), so that you can easily distinguish them from other -- possibly misspelled -- words (e.g. \bibiography). Secondly, WinEdt provides word completion for pre-defined keywords. On WinEdt.org, you can find configuration components, which will extend WinEdt's knowledge about those built-in keywords.

However, with most (computer) languages it is possible to define your own keywords. For instance in TEX, PHP or Bibliography styles, you will want to make up your own functions, or you are using local registers in WinEdt's macro language. Nobody can know in advance which name you choose for these, so that they cannot be highlighted nor can they be available for word completion1. This is where this package steps in. If keywords can be gathered using some regular expression, they can be collected, highlighted and made available for word completion by using this package.

To get a better idea, you can have a look at this comparison. You'll see a bibliography style in which only the static keywords are highlighted (on the left-hand side), and the same file highlighted using dynamicKeywords (on the right). Here, all highlighted words (that is, all words in that file!) are also available for command completion.

Usage

Mode writers can find comprehensive instructions on how to use this package in the file dynamicKeywords.README in the zip file.

Installation

Extract the zip file in %b\Macros\macro (preferably) or %B\Macros\macro\.
That is all you should be having to do. The rest will be taken care of by the mode you are installing.

Download

macro/dynamicKeywords.zip (version 1.4)

Package contributed by Robert <w.m.lgmx.net>


1 ... unless you are using macros like complete.edt or completeWord.edt.

WinEdt Macro Library  | macro previous macro  | next macro