![]() ![]() The branch attribute takes the value contents. For examples of using embedded fragments inside bookmark values, refer to the next sections.Ĭontent entries are displayed on the Content tab page of the help viewer. The only child element that is allowed inside the bookmark_value is embedvar to allow embedding of commonly used titles for content nodes or index entries. ![]() The branch attribute specifies the type of bookmark to be defined (a content entry, an index entry, or a help ID), while the sub-element bookmark_value contains the visible bookmark text, if applicable. To define an anchor for a bookmark inside a help document, the element has to be positioned at the place the bookmark will point to. Currently there are three branches defined: contents, index, and hid. A bookmark has a branch attribute representing the purpose of the bookmark. The main element is the bookmark element. ![]() The help uses one unified bookmarking system to set anchors inside the help files which are used by the Index tab, the Contents tab and for context-sensitive help. If you use other roles, you must ensure that they are taken into account by the CSS files that define the help file display format.ĭefining Index, Contents, and Context Sensitivity More roles can be defined as required (see also Paragraph Formatting on page 86):Ī heading If this role is assigned to a paragraph, the heading level has to be specified using the level attribute of the paragraph element. The following roles are currently suggested and defined in the help authoring template. The values for the role attribute are not defined in the DTD.ĭuring the conversion process (XML→HTML) the role attribute is mapped to a class attribute of the corresponding HTML element allowing to influence the layout of the corresponding paragraph using cascading style sheets. The role attribute defines the role of a paragraph with the paragraph role being the standard. There is no heading element, instead all headings are treated as paragraphs with a heading role. The main element for help content is a paragraph. The corresponding information is taken from the application's configuration information and passed to the style sheet (see The Main Transformation Style Sheet on page 16). ![]() %PRODUCTVERSION designates the current version of the product, for exampleīoth variables are replaced by the main transformation style sheet main_transform.xsl (see page 16) when the help is displayed.%PRODUCTNAME designates the name of the product, for example.You must never use the literal name of the product but instead one of the following variables : This is to allow for correct branding of the product (for example, vs. In the help files the following variables are used to designate the name and the version of the product. The minimum information is a topic title and the filename inside the elements The basic structure of a valid help file for consists of a helpdocument root element with one meta and one body sub-element containing the content ( body) and meta information ( meta). Help File XML format Basics Basic Document Structure Original document stored at Apache OpenOffice Website The Initial Writer of the Original Documentation is Sun Microsystems Inc. Use this Documentation if you comply with the terms of this License. The contents of this Documentation are subject to the Public Documentation License Version 1.0 (the "License") you may only Content on this page is licensed under the Public Documentation License (PDL).Īuthor: Frank Peters, Sun Microsystems 2.0_16 ![]()
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |