Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <info>
    <version>The version of the plugin</version>
    <authors>emails of the plugin authors, comma separated</authors>
    <site>if the plugin refer to a specific installation, list it here</site>
    <tags>a list of tags used to describe the plugin</tags>
    <shortdescription>A short description that will be used in the plugin interface</shortdescription>
    <description>A longer description that will be used in the plugin interface<description/>
    <example>This section may contain some code example for its use</example>
    <faq>A FAQ Url</faq>
    <installation>Installation instructions</installation>
    <requires>Version of the engine that is required for this plugin</requires>
    <services>
        This list the services that are offered by the plugin :

        # this is the pre 11.5.0 way of declaring services

        <PluginLifeCycleBusinessService>method included in the lib JARs</PluginLifeCycleBusinessService>
        <ObjectTriggerBusinessService>method included in the lib JARs</ObjectTriggerBusinessService>
         <WorkflowTriggerBusinessService>method included in the lib JARs</WorkflowTriggerBusinessService>


         # this is the current way of declaring services

         <service provides="interface name">implementation name</service>
         <service provides = "com.noheto.extensions.interfaces.services.IObjectTriggerBusinessService">method.name</service>
         <service provides = "com.noheto.extensions.interfaces.services.IWorkflowTriggerBusinessService">method.name</service>
         <service provides = "com.noheto.extensions.interfaces.services.IPluginLifeCycleBusinessService">method.name</service>
         <service provides = "com.noheto.extensions.interfaces.services.ISurferService">method.name</service>
    </services>
    <security>
        This list the path of pages that should be restricted to specific roles
        <paths>
            <path startsWith="/page/admin" roles="Administrators,Developer"/>
        </paths>
    </security>
  </info>
  <parameters>
    <parameter name="the name of the parameter : this will be a variable, so only ASCII and no spaces" type="text,string,integer or boolean" mandatory="false or true" default="default value" description="A legible description for the parameter"/>

    <parameter name="mynumber" type="int" mandatory="0" default="1" description="A value"></parameter>
    <parameter name="mystring" type="string" mandatory="0" default="" description="a string"></parameter>
    <parameter name="mytext" type="text" mandatory="0" default="" description="A big chuk of lorem ipsum"></parameter>
    <parameter name="mybool" type="boolean" mandatory="0" default="true" description="lorem ipsum"></parameter>
    <parameter name="email" type="mail" mandatory="1" default="" description="hello@test.com"></parameter>
    <parameter name="pass" type="password" mandatory="1" default="" description="Your password"></parameter>

  </parameters>
  <urls>

    If you need to create a clickable link to a specific page of the plugin
    or to a embedded or external doc, you ca declare paths that will appear
    in a special tab of the admin plugin interface

    <paths>
      <path bundleKey="url.index" url="/page/index.jspz"/>
      <path bundleKey="url.doc" url="/page/doc.jspz"/>
    </paths>
  </urls>
</root>

...

Localizing the Info descriptions

The "Info" section gives general information about the plugin and is likely to be localized in a multilingual environment

...