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

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): ______________________________________.

= Appendix =

Glossary
Application  – A OpenOffice.org "module" for different document types. There are the following   applications: Writer for text documents, Calc for spreadsheets, Impress for presentations, Draw for drawings, Math for formulas, Basic for Macros.

Active Help  - A synonym for an extended tip.

Anchor  – A location inside a help file which serves as a bookmark to which the help viewer   jumps, displaying the help for a certain context.

Attribute  – Component of an XML element carrying information that specifies the element in   greater detail, for example, the attribute in the element.

Bookmark  – 1. A help function that allows you to set user-defined bookmarks to help topics to   make them easier to access. 2. An element of a help XML file that is used to define anchor points for help ids or keywords.

Build List  – The file     controls the build process of a module by defining module   directories to be built and application dependencies between them.

Cascading Style Sheet  – The style sheet used to define the layout of a help page displayed in   the help viewer.

Context-Sensitive Help  – When called from within the OpenOffice.org application, the help   receives information about the user interface context,such as active dialog, or selected element. This information is used by the help to display information related to that context, provided this relation is defined in the help files. Help IDs are used to define this relation.

CVS  – Concurrent Versioning System, a widespread version control system that is also used by   OpenOffice.org. See.

CVS Module  – A part of the CVS that contains code for a section of the OpenOffice.org   product.

Dependency Files  – When a module is re-compiled, only changed files and files that depend   on them need to be compiled again. Dependency files describe these dependencies. These files are used by the utility.

DTD  – Document Type Definition, a file that describes the document syntax for an XML   document. The DTD is needed to validate an XML file.

Embedding  – In OpenOffice.org help files can contain references to parts of other help files   that are dynamically inserted when the help is displayed.

Extended Tip  – Yellow "bubble" on the application user interface that contains information   about the element under the mouse cursor. Extended tips appear when the mouse

cursor rests over a user interface element. In OpenOffice.org 1.1.x they are enabled/disabled using.

Full-Text Search  – A help function that allows you to search through the text of the set of help   files. The function uses a search index that is created when the help files are compiled and built. Help files can be excluded from this search index using the value in the attribute of the element.

Help Authoring Template  – The help authoring filter contains XSLT import/export filters and a   help authoring template that specifies the layout of the help documents inside OpenOffice.org.

Help Compiler  – A program that compiles the help files into an intermediate "object" format   that is used by the help linker to assemble the final help files that are installed with OpenOffice.org.

Help Content Provider  – A service inside OpenOffice.org that provides the Help to the help   viewer.

Help IDs  – Numerical or symbolic identifiers that are defined for user interface elements in the   application code. Help IDs can be used to identify the context in which the help is called and to define a relation between an application context and the help topic that is displayed.

Help Module  – Each OpenOffice.org application has a help module associated:   Writer,   Calc, Draw, Impress, Math, Basic.

Help Section  – A subdirectory of  . Each help module contains   the help files of one or more help sections.

Help Topic  – The contents of a help file. Usually, a help topic describes one task or a logical   group of reference information.

Help Viewer  - OpenOffice.org component that displays the help files and provides help   functionality.

Icon  – An image that is taken from the resource repository of the application itself. Icons are   stored in different CVS modules and after installation are available in the file.

Image  – Graphical content that is specific to the help files. All images are stored in the   directory of the CVS module and after installation are available in the file.

Block Image  – An image that is on a paragraph of its own. Block images can have captions.

Inline Image  – An image that is part of another paragraph and surrounded by text content.   Inline images cannot have captions.

Import/Export Filter  – XSLT files that control the conversion of the help files from     to OpenOffice.org and vice versa. Using a template they also control the appearance of the files in OpenOffice.org.

Index of Keywords  – A two-level list of keywords associated with help topics. Keywords are   explicitly defined in the help files.

Instructional Information  – Information in OpenOffice.org help that provides instructions on   how to fulfill tasks.

makefile  – File that describes the processes for "making" (compiling/linking) files inside a directory. Used by the utility.

Meta Data  – Help file data that describe the help file, like file name, topic title, creation date.   These are stored inside the element of the help file.

Nested Sections  – Sections containing other subsections. Nested sections are supported in   the help files.

Nested Tables  – Tables containing other tables. Nested tables are   unsupported   in the help   files.

Node  – A node is a part of the help content tree that is used to group help topics. See   Contents   Branch on page 25.

Output Tree  – A directory tree (aka   solver) that takes all files that are produced on "making"   (compiling/linking) source files. See.

Platform  – Operating System, such as Linux, Solaris x86, Solaris SPARC, or Windows.

Reference Information  – Information in OpenOffice.org help that explains the effect or function   of a user interface element.

Role  – In the help files that type of a paragraph is specified by its     attribute.

Section Delimiter Line  – A section inside OpenOffice.org is delimited by two gray lines.

Solver  – see   Output Tree.

Style Sheet  – A document containing commands for transforming an XML file (transformation   style sheet) or for displaying an XML or HTML file (cascading style sheet).

Symbolic Name  – The help IDs used in the applications can be transformed to symbolic   names that are defined in the list of help ids,. They are symbolic identifiers that give the number a somewhat descriptive name.

Tool Tip  – A synonym for an extended tip.

Topic ID  – Each help file (aka topic) has a unique topic   ID   to be identified. It usually is created   from the help file name.

Transformation Style Sheet  – The style sheet used for transformation.

Transformation  – In this context, the process of converting the XML format of the help   document. The major transformation takes place when the help is displayed. The transformation style sheet is used for that.

UNO Command Name  – One type of help ID that is used in the applications. Other than   "normal" help ids which are numerical, these command names are symbolic identifiers and don't need to be converted.

Validation  – The process of checking the validity of a help file. See   Validating   on   page 103.

XML Help Document Type Definition
<!ELEMENT ahelp (#PCDATA | embedvar | br | comment | emph | item | link | switchinline | variable)*> <!ATTLIST ahelp hid CDATA #REQUIRED visibility (hidden | visible) #IMPLIED > <!ELEMENT alt (#PCDATA)> <!ATTLIST alt xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED > <!ELEMENT body (section | paragraph | table | comment | bookmark | switch | embed | list | sort)*> <!ELEMENT bookmark (bookmark_value)*> <!ATTLIST bookmark branch CDATA #REQUIRED xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED > <!ELEMENT bookmark_value (#PCDATA | embedvar)*> <!ELEMENT br EMPTY> <!ELEMENT caption (#PCDATA | embedvar | br | emph | item | link | switchinline | variable)*> <!ATTLIST caption xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED > <!ELEMENT case (paragraph | table | comment | bookmark | embed | link | list | switch | section | sort)*> <!ATTLIST case select CDATA #REQUIRED > <!ELEMENT caseinline (#PCDATA | image | embedvar | br | emph | item | link | switchinline | variable | ahelp | object)*> <!ATTLIST caseinline select CDATA #REQUIRED > <!ELEMENT comment (#PCDATA)> <!ELEMENT created (#PCDATA)> <!ATTLIST created date CDATA #REQUIRED > <!ELEMENT default (paragraph | table | comment | bookmark | embed | link | list | switch | section | sort)*> <!ELEMENT defaultinline (#PCDATA | image | embedvar | br | emph | item | link | switchinline | variable | ahelp | object)*> <!ELEMENT embed EMPTY> <!ATTLIST embed href CDATA #REQUIRED role CDATA #IMPLIED level CDATA #IMPLIED > <!ELEMENT embedvar EMPTY> <!ATTLIST embedvar href CDATA #REQUIRED markup (keep | ignore) #IMPLIED > <!ELEMENT emph (#PCDATA | item | comment | help-id-missing)* > <!ELEMENT filename (#PCDATA)> <!ELEMENT helpdocument (meta, body)> <!ATTLIST helpdocument version CDATA #REQUIRED > <!ELEMENT history (created, lastedited)> <!ELEMENT image (caption* | alt+)?> <!ATTLIST image src CDATA #REQUIRED width CDATA #IMPLIED height CDATA #IMPLIED id CDATA #REQUIRED localize CDATA #IMPLIED > <!ELEMENT item (#PCDATA)> <!ATTLIST item type CDATA #REQUIRED > <!ELEMENT lastedited (#PCDATA)> <!ATTLIST lastedited date CDATA #REQUIRED > <!ELEMENT link (#PCDATA | embedvar | emph | item | variable | switchinline)*> <!ATTLIST link href CDATA #REQUIRED name CDATA #IMPLIED type CDATA #IMPLIED target CDATA #IMPLIED > <!ELEMENT list (listitem | (comment)*)+> <!ATTLIST list type CDATA #REQUIRED startwith CDATA #IMPLIED format (1 | i | I | a | A) #IMPLIED bullet (disc | circle | square) #IMPLIED sorted (asc | desc) #IMPLIED > <!ELEMENT listitem (comment | section | paragraph | table | switch | embed | bookmark)*> <!ATTLIST listitem format (1 | i | I | a | A) #IMPLIED bullet (disc | circle | square) #IMPLIED class CDATA #IMPLIED > <!ELEMENT meta (topic, history?)> <!ELEMENT object EMPTY> <!ATTLIST object type CDATA #REQUIRED id CDATA #REQUIRED data CDATA #REQUIRED height CDATA #IMPLIED width CDATA #IMPLIED > <!ELEMENT paragraph (#PCDATA | image | comment | embedvar | br | emph | item | link | switchinline | variable | ahelp | object | bookmark | help-id-missing)*> <!ATTLIST paragraph role CDATA #REQUIRED level CDATA #IMPLIED id CDATA #REQUIRED l10n CDATA #IMPLIED xml-lang CDATA #REQUIRED oldref CDATA #IMPLIED localize CDATA #IMPLIED > <!ELEMENT section (section | paragraph | table | list | comment | bookmark | embed | switch | sort )*> <!ATTLIST section id CDATA #REQUIRED > <!ELEMENT sort (section+)> <!ATTLIST sort order (asc | desc) #IMPLIED > <!ELEMENT switch ((case | comment)* | default?)*> <!ATTLIST switch select (sys | appl | distrib | target | lang | ver) #REQUIRED > <!ELEMENT switchinline ((caseinline)+, (defaultinline?)?)> <!ATTLIST switchinline select (sys | appl | distrib | target | ver | lang) #REQUIRED > <!ELEMENT table (caption*, tablerow+)> <!ATTLIST table name CDATA #IMPLIED width CDATA #IMPLIED height CDATA #IMPLIED unit CDATA #IMPLIED class CDATA #IMPLIED id CDATA #REQUIRED > <!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 > <!ELEMENT tablerow (tablecell+)> <!ATTLIST tablerow height CDATA #IMPLIED class CDATA #IMPLIED unit CDATA #IMPLIED > <!ELEMENT title (#PCDATA)> <!ATTLIST title xml-lang CDATA #REQUIRED id CDATA #REQUIRED localize CDATA #IMPLIED > <!ELEMENT topic (title+, filename, bookmark*)> <!ATTLIST topic id CDATA #REQUIRED indexer (exclude | include) #IMPLIED status (DRAFT | FINAL | PUBLISH | STALLED | DEPRECATED) #IMPLIED > <!ELEMENT variable (#PCDATA | ahelp | embedvar | br | emph | item | link | variable | image | object | switchinline)*> <!ATTLIST variable id CDATA #REQUIRED visibility (hidden | visible) #IMPLIED > <!ELEMENT help-id-missing EMPTY>