Basic Zimlet Definition Tags: Difference between revisions
mNo edit summary |
No edit summary |
||
| (16 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{BC|Community Sandbox}} | |||
__FORCETOC__ | |||
<div class="col-md-12 ibox-content"> | |||
=Basic Zimlet Definition Tags= | |||
{{KB|{{Unsupported}}|{{ZCS 8.0}}|{{ZCS 7.0}}|}} | |||
{{Archive}}{{WIP}} | |||
{{warning|1=You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to: https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide.}} | |||
==zimlet== | |||
<zimlet> tag is the top level element for Zimlet definition file. | <zimlet> tag is the top level element for Zimlet definition file. | ||
| Line 6: | Line 14: | ||
* version | * version | ||
* description | * description | ||
* target | |||
*: Space-separated list of targets. Valid values include "main" (default), "compose-window", and "view-window". | |||
May contain following elements: | May contain following elements: | ||
| Line 58: | Line 68: | ||
==userProperties== | ==userProperties== | ||
Lists per-user properties used by the Zimlet. | Lists per-user properties used by the Zimlet. | ||
=== property === | |||
{{Article Footer|Zimbra Collaboration 8.0, 7.0|04/16/2014}} | |||
[[Category:Zimlets]] | |||
Latest revision as of 06:00, 17 July 2021
Basic Zimlet Definition Tags
- This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
- This article is a Work in Progress, and may be unfinished or missing sections.
|
You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to: https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide. |
zimlet
<zimlet> tag is the top level element for Zimlet definition file.
Supported attributes:
- name - must match the name of Zimlet definition XML file.
- version
- description
- target
- Space-separated list of targets. Valid values include "main" (default), "compose-window", and "view-window".
May contain following elements:
- include
- includeCSS
- resource
- handlerObject
- zimletPanelItem
- contentObject
- serverExtension
- userProperties
include
Indicates Javascript files used by the Zimlet. The listed Javascript files are automatically loaded by the Zimlet framework in the order specified in the definition file.
includeCSS
Indicates CSS style sheet files used by the Zimlet. The listed CSS files are automatically loaded by the Zimlet framework in the order specified in the definition file.
resource
Indicates additional resource files, such as XSL, GIF, or JPEG images.
handlerObject
Name of the top level Javascript object. The object must declare ZimletBase as the prototype. The object is automatically instantiated by Zimlet framework.
zimletPanelItem
Creates an entry in the Zimlet panel area.
Supported attributes:
- label
- icon
May contain following elements:
- toolTipText
- dragSource
- contextMenu
contentObject
Specify the behavior of content object in the document that Zimlet matches.
May contain following elements:
- matchOn
- toolTip
serverExtension
Specify the rules for server side indexing.
Supported attributes:
- hasKeyword
- extensionClass
- regex
userProperties
Lists per-user properties used by the Zimlet.
property
