|Starting with Apache OpenOffice 2.4 extensions can contain help content and extend the OpenOffice.org's installed help content. Add-on Help Integration is now legacy. See instead chapter Help Content.|
OpenOffice.org supports the integration of add-ons into its Help menu. The add-on help menu items are inserted below the Registration menu item, guarded by separators. This guarantees that users have quick access to the add-on help. The OfficeHelp set uses the same MenuItem node-type as the AddonMenu set, but there are some special treatments of the properties.
|Properties of template MenuItem|
||string. The name of the configuration node. It must be unique inside the configuration branch. Therefore it is mandatory to use a schema such as |
||string. Specifies the help command URL that should be dispatched when the user activates the menu entry.Separators defined by the special command URL "|
||string. Contains the title of a top-level menu item. This property supports localization: The default string, which is used when OpenOffice.org cannot find a string definition for its current language, uses the value element without an attribute. You define a string for a certain language with the |
string. Defines an optional image URL that could address an internal OpenOffice.org image or an external user-defined image. The syntax of an internal image URL is: private:image/<number> where number specifies the image.
External user-defined images are supported using the placeholder variable %origin%, representing the folder where the component will be installed. The term %origin% will be exchanged with another placeholder, which is substituted during runtime by OpenOffice.org to the real installation folder. Since OpenOffice.org supports two different configuration folders ( user and share ), this mechanism is necessary to determine the installation folder of a component.
For example the URL %origin%/image is substituted with something like
The placeholder vnd.sun.star.expand:$UNO_USER_PACKAGES_CACHE is then substituted during runtime by the real path.
OpenOffice.org supports bitmaps with 1, 4, 8, 16, 24 bit color depth. Magenta (color value red=0xffff, green=0x0000, blue=0xffff) is used as the transparent color, which means that the background color of the display is used instead of the image pixel color when the image is drawn.
For optimal results the size of small images should be 16x16 pixel and for big images 26x26 pixel. Other image sizes will be scaled automatically by OpenOffice.org.If no high contrast image is provided, OpenOffice.org uses the normal image for high contrast environments. Images that are not valid are ignored.This property has a higher priority than the Images set when OpenOffice.org searches for images.
||string. Specifies the target frame for the command URL. Normally an add-on will use one of the predefined target names:
||string. A list of service names, separated by a comma, that specifies in which context the add-on menu should be visible. An empty context means that the function is visible in all contexts. The OpenOffice.org application modules use the following services names:
The context service name for add-ons is determined by the service name of the model that is bound to the frame, which is associated with an UI element (toolbar, menu bar, ...). Thus the service name of the Writer model is
||A set of <code>MenuItem entries. Not used for |
The following example shows the single help menu item for the add-on example.
<?xml version='1.0' encoding='UTF-8'?> <oor:component-data xmlns:oor="http://openoffice.org/2001/registry" xmlns:xs="http://www.w3.org/2001/XMLSchema" oor:name="Addons" oor:package="org.openoffice.Office"> <node oor:name="AddonUI"> <node oor:name="OfficeHelp"> <node oor:name="com.sun.star.comp.framework.addon" oor:op="replace"> <prop oor:name="URL" oor:type="xs:string" <value>org.openoffice.Office.addon.example:Help</value> </prop> <prop oor:name="ImageIdentifier" oor:type="xs:string"> <value/> </prop> <prop oor:name="Title" oor:type="xs:string"> <value xml:lang="de">Über Add-On Beispiel</value> <value xml:lang="en-US">About Add-On Example</value> </prop> <prop oor:name="Target" oor:type="xs:string"> <value>_self</value> </prop> </node> </node> </node> </oor:component-data>
|Content on this page is licensed under the Public Documentation License (PDL).|