Changes between Version 5 and Version 6 of PluginDevelopmentGuide


Ignore:
Timestamp:
07.04.2013 18:31:17 (7 years ago)
Author:
jri
Comment:

Try out the plugin

Legend:

Unmodified
Added
Removed
Modified
  • PluginDevelopmentGuide

    v5 v6  
    4141This section illustrates how to begin a plugin project, how to build and how to deploy a plugin, and how to re-deploy the plugin once you made changes in its source code. In other words, this section illustrates the plugin development turn-around cycle. 
    4242 
    43 Let's start with a very simple plugin called //DeepaMehta 4 Tagging//. This plugin will just create a new topic type called `Tag`. Once the plugin is activated the topic type will appear in the DeepaMehta webclient's //Create// menu, so you can create tag topics and associate them with arbitrary topics. And you will be able to fulltext search for tags. 
     43Let's start with a very simple plugin called //DeepaMehta 4 Tagging//. This plugin will just create a new topic type called `Tag`. Once the plugin is activated the topic type will appear in the DeepaMehta Webclient's //Create// menu, so you can create tag topics and associate them with arbitrary topics. And you will be able to fulltext search for tags. 
    4444 
    4545Developing a plugin whose only purpose is to provide new topic type definitions requires no Java or JavaScript coding. All is declarative, mainly in JSON format. 
    4646 
    47 Of course the topic type could be created interactively as well, by using the DeepaMehta webclient's type editor. However, being packaged as a plugin means you can distribute it. When other DeepaMehta users install your plugin they can use your type definitions. 
     47Of course the topic type could be created interactively as well, by using the DeepaMehta Webclient's type editor. However, being packaged as a plugin means you can distribute it. When other DeepaMehta users install your plugin they can use your type definitions. 
    4848 
    4949=== Begin a plugin project === 
     
    163163}}} 
    164164 
    165 Then a browser windows opens automatically and displays the typical DeepaMehta webclient. 
     165Then a browser windows opens automatically and displays the DeepaMehta Webclient. 
    166166 
    167167The terminal is now occupied by the //Gogo// shell. Press the return key some times and you'll see its `g!` prompt. 
     
    282282}}} 
    283283 
    284 When you type again `lb` in the DeepaMehta terminal you'll see the plugin in the list of activated bundles: 
     284When you type again `lb` in the DeepaMehta terminal you'll see the //DeepaMehta 4 Tagging// plugin now appears in the list of activated bundles: 
    285285 
    286286{{{ 
     
    294294   32|Active     |    5|DeepaMehta 4 Tagging (0.1.0.SNAPSHOT) 
    295295}}} 
     296 
     297=== Try out the plugin === 
     298 
     299Now you can try out the plugin. In the DeepaMehta Webclient login as user "admin" and leave the password field empty. The //Create// menu appears and when you open it you'll see the new type //Tag// listed. Thus, you can create tags now. Additionally you can associate tags to your content topics, search for tags, and navigate along the tag associations, just as you do with other topics. 
     300 
     301The result so far: the //DeepaMehta 4 Tagging// plugin provides a new topic type definition or, in other words: a data model. All the active operations on the other hand like create, edit, search, delete, associate, and navigate are provided by the DeepaMehta Webclient at a generic level, and are applicable to your new topic type as well. 
     302