JinnIde - Creation of Jinni Prolog Entities

JinnIde is the Jinni Prolog IDE Plugin for JEdit. From the Cassandra release onwards, Jinni Prolog code development is supported by automated creation of Jinni Prolog entities such as classes and modules. The following explains how to create a Jinni Prolog class or module automatically.

To generate a Jinni Prolog class or a module JinnIde offers a GUI dialogue that allows creating a JinniDoc-based template. This might sound complicated but - with JinnIde - it's a trivial and simple thing to accomplish:

  1. Create a new Jinni Prolog file by selecting File/New or pressing CTRL-N.
  2. Open up the template viewer or pull down the templates menu and click on Create object
  3. The GUI dialogue comes up:

  1. Fill out the entries:
  1. After pressing OK all these indications are written out to the buffer you just created in step (1) and you may correct anything now at any time. Anyway, the result is something like

So one can see that, apart from the above developer's descriptions (objective, name and details), JinnIde also produces

Internally all this is accomplished by applying the velocity template engine which comes along with the templates plugin available for JEdit (which is thus one of the required plugins for JinnIde). There are a couple of sub templates used to get the author name and the license which one may easily modify to include another license description and author name. See the templates 'Do copyright contents' and 'Set author'. You may modify them by right-clicking on the corresponding entry in the templates viewer and selecting 'Edit template'. Take a look at the documentation of the templates plugin for the details.


© 2001-2014 Chico Töpfer