Documentation/Understanding, Authoring and Editing Openoffice.org Help/3

Author: Frank Peters, Sun Microsystems (fpe@openoffice.org) Version: 2.0_16 Date: Feb 3, 2006

Public Documentation License Notice The contents of this Documentation are subject to the Public Documentation License Version 1.0 (the "License"); you may only use this Documentation if you comply with the terms of this License. A copy of the License is available at https://www.openoffice.org/licenses/PDL.html. The Initial Writer of the Original Documentation is Sun Microsystems Inc. Copyright (C) 2005. All Rights Reserved. (Initial Writer contact(s): fpe@sun.com). Contributor(s): ______________________________________.

This chapter lists all elements of the XML help file DTD in alphabetical order as presented in the Document Type Definition in the Appendix.

The element sections presented here all share a common structure. The name of the element serves as a heading and is followed by element details:


 * Element Description and Purpose
 * Attributes
 * Parent Elements
 * Child Elements
 * Element Definition
 * Element Example

Examples for elements can show an element within its parent or child context.

Common Attributes
The following attributes are common to several elements.

xml-lang
The  attribute designates elements that need localization. The localization process identifies elements to be localized by this attribute. It contains the language of the element it belongs to as a combination of language ISO code (ISO 639-1) and country ISO code (ISO 3166), separated by a dash.

xml-lang="en-US"

All elements containing text to be translated have an  attribute: ,  ,  ,  , and.

You can use the  element to insert comments into the help file. But if they are outside an element that will be localized they will not be recognized by the localizers.

localize
The  attribute can only take the value   and designates elements that are excluded from the localization process. If an element contains the localize attribute set to, its contents and the contents of all child elements should not be translated. If the attribute contains any other value than  it will be ignored. The attribute is optional.

localize="false"

All elements containing text to be translated or subelements with text to be translated have an optional  attribute: ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  , and.

id
The id element contains a unique string used to identify the element for localization and referencing purposes. The ID must be unique within a help file so that referencing across files and relocating sections and paragraphs across files is possible.

id="some_unique_value"

All elements that can be embedded or have to be translated contain a mandatory  attribute: ,  ,  ,  ,  ,  ,  , and.

Valid characters for the  value are capital or small letters from a-z, numbers from 0-9, and the underscore, in any combination. Other characters are not allowed.

ahelp
This element designates text that is to be used as extended tips (for instance, tool tips or active help). It can contain text and child elements. It can only be used as a child of a paragraph.

Attributes

Table 1: Attributes of the ahelp Element

Parent Elements

,,  ,

Child Elements

,,  ,  ,  ,  ,

Element Definition

<!ELEMENT ahelp (#PCDATA | embedvar | br | comment | emph | menuitem | keycode | widget | input | literal | sup | sub| item | link | switchinline | variable)*> <!ATTLIST ahelp hid CDATA #REQUIRED visibility (hidden | visible) #IMPLIED >

Example

 You will only see this text in the extended tips for the ui control with the help id HID_SOME_HID.

alt
This element is used to specify an alternative text for an image. It corresponds to the HTML attribute of the same name and can only contain PCDATA that is localized (no markup).

Attributes

Table 2: Attributes of the alt element

Parent Elements

Child Elements

none

Element Definition

<!ELEMENT alt (#PCDATA)> <!ATTLIST alt xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED >

Example

 Dialog File Open

bascode
This element starts a Basic code syntax highlight

Attributes

None

Element Definition

<!ELEMENT bascode (paragraph+)>

Example

Sub Dialog1Show    BasicLibraries.LoadLibrary("Tools")    oDialog1 = LoadDialog("Standard", "Dialog1")    oDialog1.Execute End Sub

body
This element contains all help content information. It cannot itself contain any PCDATA, but rather only child elements.

Attributes

Table 3: Attributes of the body element

Parent Elements

Child Elements

,,  ,  ,  ,  , ,  ,

Element Definition

<!ELEMENT body (section | paragraph | table | comment | bookmark | switch | embed | list | sort)*> <!ATTLIST body localize CDATA #IMPLIED >

Example

This is the content of a help file

bookmark
This element contains information about a bookmark used in the help files. The bookmark type is specified inside the branch attribute of the  element while the bookmark value is defined in the child element. For more information about the bookmarking system in the help please refer to Defining Index, Contents, and Context Sensitivity on page 25.

Attributes

Table 4: Attributes of the bookmark element

Parent Elements

,, , , , ,

Child Elements

Element Definition

<!ELEMENT bookmark (bookmark_value)*> <!ATTLIST bookmark branch CDATA #REQUIRED xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED >

Example

  StarOffice Writer Help/Working with Fields/Editing Field Contents    Formulas/Exporting  

bookmark_value
This element contains the value of a bookmark. See Defining Index, Contents, and Context Sensitivity on page |25 for details.

Parent Elements

Child Elements

Element Definition

<!ELEMENT bookmark_value (#PCDATA | embedvar)*>

Example

  StarOffice Writer Help/Working with Fields/Editing Field Contents </bookmark_value> <bookmark branch="index/scalc" xml-lang="en-US" id="bm_543">  Formulas/Exporting </bookmark_value> <bookmark branch="index/scalc" xml-lang="de-DE" id="bm_543">  Formeln/Exportieren </bookmark_value>

br
This element can be used to place a manual line break. It works like the corresponding HTML  element. The element itself is empty.

Parent Elements

,,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT br EMPTY>

Example

This line must have a  manual  line break.

caption
This element specifies the (optional) caption of an image or a table.

Attributes

Table 5: Attributes of the caption element

Parent Elements

,

Child Elements

,, , , , ,

Element Definition

<!ELEMENT caption (#PCDATA | embedvar | br | emph | item | link | switchinline | variable)*> <!ATTLIST caption xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED >

Example

case
This elements holds the cases of a  statement.

Attributes

Table 6: Attributes of the case element

Parent Elements

Child Elements

,,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT case (paragraph | table | comment | bookmark | embed | link | list | switch | section)*> <!ATTLIST case select CDATA #REQUIRED >

Example

<case select="WIN"> This appears in Windows. <case select="UNIX"> This appears in Unix. This appears in all other cases

caseinline
This element holds the cases for a  statement.

Attributes

Table 7: Attributes of the caseinline element

Parent Elements

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT caseinline (#PCDATA | image | embedvar | br | emph | item | link | switchinline | variable | ahelp | object)*> <!ATTLIST caseinline select CDATA #REQUIRED >

Example

Press the <caseinline select="WIN">Ctrl <caseinline select="MAC">Apple any key to start.

comment
This element is used for inserting comments into the help files used by the author/editor/translator. They are to be removed when the help files are compiled.

Attributes

none

Parent Elements

,,  ,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT comment (#PCDATA)>

Example

FPE: This section is in a draft state!

created
This element holds the date of document creation and additional information (author or comment).

Attributes

Table 8: Attributes of the created element

Parent Elements

Child Elements

none

Element Definition

<!ELEMENT created (#PCDATA)> <!ATTLIST created date CDATA #REQUIRED >

Example

<created date="2002-05-20T15:15:00">New topic created  <lastedited date="2002-06-20T15:15:00">Made changes

default
This elements holds the default values for a. It is evaluated if all  elements of a   element evaluate to false.

Attributes

none

Parent Elements

Child Elements

,,  ,  ,  ,  ,

Element Definition

<!ELEMENT default (paragraph | table | comment | bookmark | embed | link | list | switch | section)*>

Example

<case select="WIN"> This appears in Windows. <case select="UNIX"> This appears in Unix.    This appears in all other cases 

defaultinline
This elements holds the default values for an inline switch. It is evaluated if all  elements of a   element evaluate to false.

Attributes

none

Parent Elements

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT defaultinline (#PCDATA | image | embedvar | br | emph | item | link | switchinline | variable | ahelp | object)*>

Example

Press the <caseinline select="WIN">Ctrl <caseinline select="MAC">Apple  any  key to start.

embed
This element is used to embed content from a different source at the current position. The only elements that can be embedded from somewhere else are  or , which are identified by their URL. For smaller text fragments, can be used. See Embedding Content.

The optional  attribute can override the role of a paragraph. For embedded sections, the  attribute has no effect.

Attributes

Table 9: Attributes of the embed element

Parent Elements

,,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT embed EMPTY> <!ATTLIST embed href CDATA #REQUIRED role CDATA #IMPLIED level CDATA #IMPLIED >

Example

<embed href="text/swriter/guide/editing#4711"/> <embed href="text/scalc/01/0123456#9876" role="warning"/>

embedvar
This element is used to embed smaller text fragments with and without markup, which were previously declared as being. See also Embedding Content.

Attributes

Table 10: Attributes of the embedvar element

Parent Elements

,,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT embedvar EMPTY> <!ATTLIST embedvar href CDATA #REQUIRED markup (keep | ignore) #IMPLIED >

Example

This element can be found on the <embedvar href="text/swriter/01/dialogs#fileopen" markup="ignore"/> dialog.

emph
This element is used to mark emphasized content. It can only contain PCDATA.

Attributes

none

Parent Elements

,,  ,  ,  ,  ,

Child Elements

, ,

Element Definition

<!ELEMENT emph (#PCDATA | item | comment)*>

Example

 Never  delete the paragraph

filename
This element contains the path and name of the help topic file as included in the jar file, for example,.

Attributes

none

Parent Elements

Child Elements

none

Element Definition

<!ELEMENT filename (#PCDATA)>

Example

text/swriter/01/08154711.xhp

h1
This element is the top heading element holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT h1 (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST h1 id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;h1 id="par4711_001" xml_lang="en-US"&gt; Italic characters &lt;/h1&gt; <paragraph role="paragraph" id="par4711_002" xml_lang="en-US"> Proceed as follows to write an italic character  

h2
This element is a heading element holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT h2 (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST h2 id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;h2 id="par4711_001" xml_lang="en-US"&gt; Italic characters &lt;/h2&gt; <paragraph role="paragraph" id="par4711_002" xml_lang="en-US"> Proceed as follows to write an italic character  

h3
This element is a heading element holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT h3 (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST h3 id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;h3 id="par4711_001" xml_lang="en-US"&gt; Italic characters &lt;/h3&gt; <paragraph role="paragraph" id="par4711_002" xml_lang="en-US"> Proceed as follows to write an italic character  

h4
This element is a heading element holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT h4 (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST h4 id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;h4 id="par4711_001" xml_lang="en-US"&gt; Italic characters &lt;/h4&gt; <paragraph role="paragraph" id="par4711_002" xml_lang="en-US"> Proceed as follows to write an italic character  

h5
This element is a heading element holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT h5 (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST h5 id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;h5 id="par4711_001" xml_lang="en-US"&gt; Italic characters &lt;/h5&gt; <paragraph role="paragraph" id="par4711_002" xml_lang="en-US"> Proceed as follows to write an italic character  

h6
This element is a heading element holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT h6 (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST h6 id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;h6 id="par4711_001" xml_lang="en-US"&gt; Italic characters &lt;/h6&gt; <paragraph role="paragraph" id="par4711_002" xml_lang="en-US"> Proceed as follows to write an italic character  

helpdocument
This is the root element of a help document and contains the  and   part of the help topic.

Attributes

Table 11: Attributes of the helpdocument element

Parent Elements

none

Child Elements

,

Element Definition

<!ELEMENT helpdocument (meta, body)> <!ATTLIST helpdocument version CDATA #REQUIRED >

Example

<helpdocument version="1.0">  

help-id-missing
This element is only used to display the help ID for a help file that cannot be found. It is only used in the help error page and replaced by the missing help ID.

Parent Elements

Child Elements

None

Element Definition

<!ELEMENT help-id-missing EMPTY>

history
This element contains information about the author and the date of creation, as well as the same information about the last editing cycle.

Attributes

none

Parent Elements

Child Elements

,

Element Definition

<!ELEMENT history (created, lastedited)>

Example

  <created date="2002-05-20T15:15:00">New topic created <lastedited date="2002-06-20T15:15:00">Made changes  

image
This element carries information about images in the document.

Attributes

Table 12: Attributes of the image element

Parent Elements

,,  ,  ,

Child Elements

,

Element Definition

<!ELEMENT image (caption* | alt+)?> <!ATTLIST image src CDATA #REQUIRED width CDATA #IMPLIED height CDATA #IMPLIED id CDATA #REQUIRED >

Example

<image src="picture/win/common/writermainwin.xhp" id="img4711" width="75" height="75"> <caption xml-lang="en-US" id="cp4711"> The main writer windows showing all writer toolbars. <alt xml-lang="en-US" id="alt4711">Main program window  

input
This element is used to mark up a input text in a document.

Attributes None

Parent Elements

,,  ,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT input (#PCDATA)> > Example

&lt;input&gt;=SUM(A1:A100)&lt;/input&gt; returns the sum of cells in range A1 to A100

item
This generic element is used to mark up objects that are to be formatted in a unique way. The attribute  is used to specify the item type (a keystroke, a menu item, a dialog title etc). This element resembles the

Attributes

Table 13: Attributes of the item element

Parent Elements

,,  ,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT item (#PCDATA)> <!ATTLIST item type CDATA #REQUIRED >

Example

You see the  File Open  dialog.

lastedited
This element contains the date when the document was last edited inside the  attribute. Additional information can be specified as PCDATA.

Attributes

Table 14: Attributes of the lastedited element

Parent Elements

Child Elements

none

Element Definition

<!ELEMENT lastedited (#PCDATA)> <!ATTLIST lastedited date CDATA #REQUIRED >

Example

<created date="2002-05-20T15:15:00">New topic created <lastedited date="2002-06-20T15:15:00">Made changes 

keycode
This element is used to mark up a keystroke.

Attributes None

Parent Elements

,,  ,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT keycode (#PCDATA)> > Example

Press &lt;keycode&gt;Ctrl + Shift + V&lt;/keycode&gt; to open paste special dialog box.

link
This element contains a link to another document inside or outside the help system. For links to other help files, the URL syntax is

with



Path and name of the help file as contained in the help jar archive, for instance.



Anchor target to jump to (optional). These can be the IDs of bookmarks, sections, or paragraphs.

Attributes

Table 15: Attributes of the link element

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,

Element Definition

<!ELEMENT link (#PCDATA | embedvar | emph | item | variable | switchinline)*> <!ATTLIST link href CDATA #REQUIRED name CDATA #REQUIRED type CDATA #IMPLIED target CDATA #IMPLIED >

Example

Please refer to <link href="https://www.openoffice.org" name="Link to the OpenOffice.org Website">the OpenOffice.org website for further details. More details can be found in <link href="text/common/guide/overview.xhp" name="Link to the overview">the overview .

list
This element represents ordered (numbered) and unordered (bulleted) lists. The element itself does not contain any PCDATA, but only child elements that carry the content or comments.

Attributes

Table 16: Attributes of the list element

Parent Elements

,,  ,  ,

Child Elements

,

Element Definition

<!ELEMENT list (listitem | (comment)*)+> <!ATTLIST list type CDATA #REQUIRED startwith CDATA #IMPLIED format (1 | i | I | a | A) #IMPLIED bullet (disc | circle | square) #IMPLIED localize CDATA #IMPLIED sorted (asc | desc) #IMPLIED >

Example

<list type="ordered" startwith="5" format="a"> ...  

listitem
This element holds the contents of a  in child elements.

Attributes

Table 17: Attributes of the listitem element

Parent Elements

Child Elements

,,  ,  ,  ,  ,

Element Definition

<!ELEMENT listitem (comment | section | paragraph | table | switch | embed | bookmark)*> <!ATTLIST listitem format (1 | i | I | a | A) #IMPLIED bullet (disc | circle | square) #IMPLIED localize CDATA #IMPLIED class CDATA #IMPLIED >

Example

  Insert the CD.  

menuitem
This element is used to mark up a menu item.

Attributes None

Parent Elements

,,  ,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT menuitem (#PCDATA)> > Example

Choose &lt;menuitem&gt;File - New&lt;/menuitem&gt; to create a new file.

meta
This element contains sub-elements with data used to organize the help.

Attributes

None

Parent Elements

Child Elements

,

Element Definition

<!ELEMENT meta (topic, history?)>

Example

  ...  

note
This element adds a note paragraph holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT note (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST note id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;note id="par4711_001"&gt; You can paste contents with &lt;keycode&gt;Ctrl + Ins&lt;/keycode&gt; &lt;/note&gt;

object
This generic element contains information about objects to be embedded into the help page like audio or video files. It is reserved for future use.

Attributes

Table 18: Attributes of the object element

Parent Elements

,,  ,

Child Elements

none

Element Definition

<!ELEMENT object EMPTY> <!ATTLIST object type CDATA #REQUIRED id CDATA #REQUIRED data CDATA #REQUIRED height CDATA #IMPLIED width CDATA #IMPLIED >

Example

<object data="clock.svg" id="objClock" type="image/svg+xml" width="200" height="200">

paragraph
This element is the standard element holding content. The  attribute defines its context in greater detail. See also Paragraph Roles on page 24.

Attributes

Table 19: Attributes of the paragraph element

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT paragraph (#PCDATA | image | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | object | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST paragraph role CDATA #REQUIRED level CDATA #IMPLIED id CDATA #REQUIRED l10n CDATA #REQUIRED xml-lang CDATA #REQUIRED oldref CDATA #IMPLIED localize CDATA #IMPLIED >

Example

<paragraph role="heading" level="1" id="par4711_001" xml_lang="en-US"> Italic characters   <paragraph role="paragraph" id="par4711_002" xml_lang="en-US">' Proceed as follows to write an italic character  

pycode
This element starts a Python code syntax highlight

Attributes

None

Element Definition

<!ELEMENT pycode (paragraph+)>

Example

<paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false"># -*- coding: utf-8 -*- <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false">from __future__ import unicode_literals <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false"> <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false">import uno, os, subprocess <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false"> <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false">def interpreter_console: <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false">   ctx = XSCRIPTCONTEXT.getComponentContext <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false">   smgr = ctx.getServiceManager <paragraph role="pycode" id="par_id3156443" xml-lang="en-US" localize="false">   install_path = uno.fileUrlToSystemPath(ps.Module) <paragraph role="pycode" id="par_id3156443" xml-lang="en-US"                >    pgm = install_path + os.sep + "python"  # Python shell/console path <paragraph role="pycode" id="par_id3156443" xml-lang="en-US"                >    subprocess.Popen(pgm)  # Start Python interactive Shell

section
This element serves as a generic container for multiple elements to make them able to be embedded in other documents. Each  takes a unique ID which is used to identify it when embedded in other documents. Subsections are allowed. A  can only contain sub-elements.

Attributes

Table 20: Attributes of the section element

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT section (section | paragraph | table | list | comment | bookmark | embed | switch | sort )*> <!ATTLIST section id CDATA #REQUIRED localize CDATA #IMPLIED >

Example

  This applies to multiple applications  

sort
This element is used to mark up a set of sections that are to be sorted. The sequence of the sections inside the sort element plays no role for the display sequence.

Attributes

Table 27: Attributes of the sort element''

Parent Elements

,

Child Elements

Element Definition

<!ELEMENT sort (section+)> <!ATTLIST sort order (asc | desc) #IMPLIED descendant (h1 | h2 | h3 | h4 | h5 | h6 | paragraph) #IMPLIED >

Example

  ... ...   

sqlcode
This element starts a SQL code syntax highlight

Attributes

None

Element Definition

<!ELEMENT sqlcode (paragraph+)>

Example

<paragraph role="sqlcode" id="par_id3156443" xml-lang="en-US" localize="false">SELECT * FROM "Media" <paragraph role="sqlcode" id="par_id3148575" xml-lang="en-US" localize="false">WHERE "Title" = IFNULL( ( SELECT "Filter_1" FROM "Filter" ), "Title" )

sub
This element is used to mark subscripts content. It can only contain PCDATA.

Attributes

none

Parent Elements

,,  ,  ,  ,  ,

Child Elements

, ,

Element Definition

<!ELEMENT sub (#PCDATA | item | comment)*>

Example

H&lt;sub&gt;2&lt;/sub&gt;O is the water molecule

sup
This element is used to mark superscripts content. It can only contain PCDATA.

Attributes

none

Parent Elements

,,  ,  ,  ,  ,

Child Elements

, ,

Element Definition

<!ELEMENT sup (#PCDATA | item | comment)*>

Example

6.5 x 10&lt;sup&gt;5&lt;/sup&gt; is 65000 in scientific notation

switch
This element is used to switch  or   for different platform, application, distribution, target medium or language context. For switching content inside paragraphs,  must be used.

Attributes

Table 21: Attributes of the switch element

Parent Elements

, ,

Child Elements

, ,

Element Definition

<!ELEMENT switch ((case | comment)* | default?)*> <!ATTLIST switch select (sys | appl | distrib | target | lang | ver) #REQUIRED localize CDATA #IMPLIED >

Example

  <case select="WIN"> This appears in Windows. <case select="UNIX"> This appears in Unix. This appears in all other cases  

switchinline
This element is used to switch parts of  for different platform, application, distribution, target medium or language context. For switching complete paragraphs or sections  must be used.

Attributes

Table 22: Attributes of the switchinline element

Parent Elements

,,  ,  ,  ,

Child Elements

,

Element Definition

<!ELEMENT switchinline ((caseinline)+, (defaultinline?)?)> <!ATTLIST switchinline select (sys | appl | distrib | target | ver | lang) #REQUIRED >

Example

Press the   <caseinline select="WIN">Ctrl <caseinline select="MAC">Apple any  key to start.

table
This element defines a table containing one or more. The table element itself only contains child elements.

Attributes

Table 23: Attributes of the table element

Parent Elements

,,  ,  ,

Child Elements

,

Element Definition

<!ELEMENT table (caption*, tablehead*, tablerow+)> <!ATTLIST table name CDATA #IMPLIED width CDATA #IMPLIED height CDATA #IMPLIED unit CDATA #IMPLIED class CDATA #IMPLIED id CDATA #REQUIRED localize CDATA #IMPLIED >

Example

 

tablehead
This element defines a table head containing one or more. The table head element itself only contains child elements.

Attributes

Table 23a: Attributes of the table head element

Parent Elements

Child Elements

Element Definition

<!ELEMENT tablehead (tablerow+)> <!ATTLIST tablehead class CDATA #IMPLIED>

Example

tablecell
This element contains child elements taking the cell content. Complex tables can be created using the  and   attributes of.

Attributes

Table 24: Attributes of the tablecell element

Parent Elements 

Child Elements

,,  ,  ,  ,  ,

Element Definition

<!ELEMENT tablecell (section | paragraph | comment | embed | bookmark | image | list)*> <!ATTLIST tablecell colspan CDATA #IMPLIED rowspan CDATA #IMPLIED width CDATA #IMPLIED class CDATA #IMPLIED unit CDATA #IMPLIED localize CDATA #IMPLIED >

Example

tablerow
This element contains table rows, which themselves only contain table cells.

Attributes

Table 25: Attributes of the tablerow element

Parent Elements

Child Elements

Element Definition

<!ELEMENT tablerow (tablecell+)> <!ATTLIST tablerow height CDATA #IMPLIED class CDATA #IMPLIED unit CDATA #IMPLIED localize CDATA #IMPLIED >

Example

tip
This element adds a tip paragraph holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT tip (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST tip id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;tip id="par4711_001"&gt; You can paste content with &lt;keycode&gt;Ctrl + Ins&lt;/keycode&gt; &lt;/tip&gt;

title
This is the title of the help page as displayed in the list on the Contents tab page, the Index list and the search results. The title content can not contain HTML entities like

or.

Attributes

Table 26: Attributes of the title element

Parent Elements

Child Elements

none

Element Definition

<!ELEMENT title (#PCDATA)> <!ATTLIST title xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED >

Example

<title xml_lang="en-US" id="tit1233">Opening a text document 

topic
This element contains child elements with information about the current help topic.

Attributes

Table 27: Attributes of the topic element

Parent Elements

Child Elements

, ,

Element Definition

<!ELEMENT topic (title+, filename, bookmark*)> <!ATTLIST topic id CDATA #REQUIRED indexer (exclude | include) #IMPLIED >

Example

<topic id="4711" indexer="exclude"> <title xml_lang="en-US">Invisible help file text/swriter/01/08154711  

variable
This element is used to define reusable text fragments. The fragments can be embedded in other contexts by means of the  element.

Attributes

Table 28: Attributes of the variable element

Parent Elements

,,  ,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT variable (#PCDATA | ahelp | embedvar | br | emph | item | link | variable | image | object | switchinline)*> <!ATTLIST variable id CDATA #REQUIRED visibility (hidden | visible) #IMPLIED >

Example

You may use the <variable id="dlg_FileOpen"> Open a file   to open a file. List of menu names to be embedded <paragraph xml_lang="en-US"> <variable id="menu_File" visibility="hidden">File Menu <variable id="menu_Edit" visibility="hidden">Edit Menu <variable id="menu_View" visibility="hidden">View Menu 

warning
This element adds a warning paragraph holding content.

Attributes

Parent Elements

,,  ,  ,  ,

Child Elements

,,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,

Element Definition

<!ELEMENT warning (#PCDATA | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | bookmark | keycode | menuitem | input | literal | widget)*> <!ATTLIST warning id CDATA #REQUIRED xml-lang CDATA #IMPLIED localize CDATA #IMPLIED >

Example

&lt;warning id="par4711_001"&gt; You cannot paste contents in read-only sections &lt;/warning&gt;

widget
This element is used to mark up a UI widget in the text.

Attributes None

Parent Elements

,,  ,  ,  ,  ,  ,

Child Elements

none

Element Definition

<!ELEMENT widget (#PCDATA)> > Example

Click the &lt;widget&gt;Apply&lt;/widget&gt; button to commit your changes.

Contents File (*.tree) Elements
The contents files are used to specify the hierarchy displayed on the '''Contents tab page of the help viewer (see also Hierarchical List of Contents on page 10).

tree_view
This is the root element for a contents file.

Attributes

Table 29: Attributes of the tree_view element

Parent Elements

none

Child Elements

Element Definition

<!ELEMENT tree_view (help_section)+> <!ATTLIST tree_view version CDATA #REQUIRED >

Example

<tree_view version="24-Aug-2004"> <help_section application="swriter" id="01" title="Installation"> ... </help_section> </tree_view>

help_section
The  are the top-most elements in the table of contents as displayed by the help viewer.

Attributes

Table 30: Attributes of the help_section element

Parent Elements

Child Elements

,

Element Definition

<!ELEMENT help_section (node|topic)*> <!ATTLIST help_section application CDATA #REQUIRED id CDATA #REQUIRED title CDATA #REQUIRED >

Example

<tree_view version="24-Aug-2004"> <help_section application="swriter" id="01" title="Installation"> ... </help_section> </tree_view>

node
Nodes are the hierarchical elements that represent topic groups and contain help topics. In the help viewer, they are represented by book icons. Nodes can have subnodes.

Attributes

Table 31: Attributes of the node element

Parent Elements

Child Elements

,

Element Definition

<!ELEMENT node (topic)*> <!ATTLIST node id CDATA #REQUIRED title CDATA #REQUIRED >

Example

<tree_view version="24-Aug-2004"> <help_section application="swriter" id="10" title="Common Topics"> <node id="1001" title="General Information"> <topic id="shared/text/shared/main0400.xhp">Shortcut Keys ...   </help_section> </tree_view>

topic
Topics are links that point to help files. The  attribute contains the URL of the file to be loaded. The element contains the file title.

When the script  from the   directory in the   module is used to update the tree files, the element content is automatically updated based on the file titles. This also applies to localized languages.

Attributes

Table 32: Attributes of the topic element

Parent Elements

,

Child Elements

none

Element Definition

<!ELEMENT topic (#PCDATA)> <!ATTLIST topic id CDATA #REQUIRED >

Example

<tree_view version="24-Aug-2004"> <help_section application="swriter" id="10" title="Common Topics"> <node id="1001" title="General Information"> <topic id="shared/text/shared/main0400.xhp">Shortcut Keys  ... </help_section> </tree_view>