You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by bu...@apache.org on 2014/03/26 17:39:02 UTC
svn commit: r903778 [2/2] - in /websites/staging/ooo-site/trunk: cgi-bin/
content/
content/documentation/online_help/helpauthoring/HelpAuthorings-passthru.html
Added: websites/staging/ooo-site/trunk/content/documentation/online_help/helpauthoring/HelpAuthorings-passthru.html
==============================================================================
--- websites/staging/ooo-site/trunk/content/documentation/online_help/helpauthoring/HelpAuthorings-passthru.html (added)
+++ websites/staging/ooo-site/trunk/content/documentation/online_help/helpauthoring/HelpAuthorings-passthru.html Wed Mar 26 16:39:02 2014
@@ -0,0 +1,5750 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><HTML>
+<HEAD>
+<TITLE>OpenOffice Help Authoring Body</TITLE>
+
+<style>
+h3 {text-decoration: underline; font-style: italic;}
+table { border-collapse: collapse; }
+table,th, td { border: 1px solid black; }
+th {font-style: bold; background-color: #66CCff;}
+ </style>
+</HEAD>
+
+<BODY>
+<A name=1></a><IMG src="HelpAuthoring-1_1.jpg"><br>
+<b>OpenOffice.org 2.0</b><br>
+Understanding, Authoring and Editing<br>
+<b>OPENOFFICE.ORG HELP</b><br>
+Author:<br>
+Frank Peters, Sun Microsystems (fpe@openoffice.org)<br>
+Version:<br>
+2.0_16<br>
+Date:<br>
+Feb 3, 2006<br>
+<hr>
+<A name=2></a><hr>
+<A name=3></a><b>Public Documentation License Notice </b><br>
+The contents of this Documentation are subject to the Public Documentation License Version 1.0 (the "License"); you may only <br>
+use this Documentation if you comply with the terms of this License. A copy of the License is available at <br>
+<A href="http://www.openoffice.org/licenses/PDL.html">http://www.openoffice.org/licenses/PDL.html.</a> <br>
+The Initial Writer of the Original Documentation is Sun Microsystems Inc. Copyright (C) 2005. All Rights Reserved. (Initial Writer <br>
+contact(s): <A href="mailto:fpe@sun.com">fpe@sun.com</a>).<br>
+Contributor(s): ______________________________________. <br>
+<hr>
+<A name=4></a><hr>
+<A name=5></a>Contents<br>
+<b>1 How OpenOffice Help Works..........9</b><br>
+Help Ingredients..........9<br>
+Extended Tips...........9<br>
+Context-Sensitive Help..........9<br>
+Hierarchical List of Contents..........10<br>
+Index of Keywords..........10<br>
+Full-Text Search..........10<br>
+Bookmarks..........11<br>
+Help Agent..........11<br>
+Installed Help Files..........13<br>
+Help Modules and Help Sections..........13<br>
+Help Module Configuration Files..........14<br>
+Help Module Contents Files (Section Archives)..........15<br>
+Help Module Lookup Tables (Databases)..........15<br>
+Help Module Extended Tip Files..........15<br>
+Help Module Index Files..........16<br>
+The Main Transformation Style Sheet..........16<br>
+The Cascading Style Sheets..........16<br>
+Application Help Calls..........16<br>
+Structure of the CVS Help Module..........18<br>
+Building the Help Set..........19<br>
+Setting Up a Build Environment..........19<br>
+Makefiles for the Help..........19<br>
+Help Build Process..........21<br>
+Adding a help file to or Removing a help file from the set of help files..........22<br>
+Help Images..........22<br>
+<b>2 Help File XML Format Basics..........23</b><br>
+Basic Document Structure..........23<br>
+Using Variables..........23<br>
+Paragraph Roles..........24<br>
+Defining Index, Contents, and Context Sensitivity..........25<br>
+Contents Branch..........25<br>
+Index Branch..........26<br>
+"hid" Branch..........26<br>
+Switching Content..........27<br>
+Switching Complete Paragraphs or Sections..........27<br>
+Switching Text Fragments Inside Paragraphs..........28<br>
+Embedding Content..........28<br>
+Embedding Complete Sections..........29<br>
+Embedding text fragments..........29<br>
+Images and Icons..........30<br>
+Localization Information..........31<br>
+Auxiliary Files..........31<br>
+Files used for building the help..........31<br>
+Main transformation stylesheet..........32<br>
+Contents definition files *..........tree..........32<br>
+<b>3 Help File XML Reference..........35</b><br>
+Common Attributes..........35<br>
+xml-Lang..........35<br>
+localize..........36<br>
+id..........36<br>
+Help File (*..........xhp) Elements..........37<br>
+ahelp..........37<br>
+alt..........38<br>
+body..........38<br>
+bookmark..........39<br>
+bookmark_value..........40<br>
+br..........41<br>
+caption..........41<br>
+<A name=6></a>case..........42<br>
+caseinline..........43<br>
+comment..........43<br>
+created..........44<br>
+default..........45<br>
+defaultinline..........45<br>
+embed..........46<br>
+embedvar..........47<br>
+emph..........48<br>
+filename..........48<br>
+helpdocument..........49<br>
+help-id-missing..........49<br>
+History..........50<br>
+image..........50<br>
+item..........51<br>
+lastedited..........52<br>
+link..........53<br>
+list..........54<br>
+listitem..........55<br>
+meta..........56<br>
+object..........57<br>
+paragraph..........58<br>
+section..........59<br>
+sort..........60<br>
+switch..........61<br>
+switchinline..........62<br>
+table..........63<br>
+tablecell..........64<br>
+tablerow..........66<br>
+title..........67<br>
+topic..........68<br>
+variable..........69<br>
+Contents File (*..........tree) Elements..........70<br>
+Tree_view..........70<br>
+help_section..........71<br>
+Node..........72<br>
+Topic..........72<br>
+<b>4 Authoring Help With OpenOffic.org ..........75</b><br>
+Setting Up the Environment ..........75<br>
+Directory Hierarchy..........75<br>
+Installing the Import/Export Filters..........76<br>
+Installing the Supporting Macros..........76<br>
+Installing the Help Authoring Menu..........77<br>
+Editing Help Files - Basics..........78<br>
+Paragraphs and Paragraph Formatting..........78<br>
+Sections..........79<br>
+Tables..........79<br>
+Images..........79<br>
+Lists..........79<br>
+Embedding..........79<br>
+Character Formatting..........80<br>
+Working With the Help Files..........80<br>
+Creating a Help File..........80<br>
+Opening a Help File..........81<br>
+Removing a Help File..........81<br>
+Moving a Help File..........82<br>
+Sections and Paragraphs..........82<br>
+Where are the Sections?..........82<br>
+Adding a Section..........83<br>
+Adding a Subsection..........84<br>
+Removing a Section..........84<br>
+Linking to a Section..........84<br>
+Embedding a Section..........84<br>
+Adding a Paragraph..........84<br>
+Editing a Paragraph..........85<br>
+Paragraph Formatting..........86<br>
+Creating New Styles..........87<br>
+Changing a Paragraph Style..........87<br>
+Changing a Character Style..........87<br>
+Moving a Paragraph Inside a Help File..........87<br>
+Moving a Paragraph to a Different Help File..........87<br>
+Excluding a Paragraph from Localization..........88<br>
+Tables ..........89<br>
+
+<A name=7></A><hr>
+Adding a Table...89<br>
+Modifying the Table Layout...89<br>
+Deleting a Table...90<br>
+Using a Table for Formatting Purposes...90<br>
+Adding a caption to an existing table...90<br>
+Lists...90<br>
+Inserting, removing, modifying lists...90<br>
+Interrupting a List...90<br>
+Working with Images...91<br>
+Help Image Repository...91<br>
+Inserting a block image...92<br>
+Inserting an inline image...92<br>
+Adding an image caption...93<br>
+Embedding Content ...93<br>
+Embedding a Section or Variable...93<br>
+Linking...94<br>
+Linking to another Help file...94<br>
+Linking to the WWW...94<br>
+Meta Data...94<br>
+Setting the topic title...95<br>
+Setting the topic ID...95<br>
+Excluding a file from the search index...95<br>
+Changing the initial file creation comment...95<br>
+Changing the Last Edited comment...95<br>
+Bookmarks...95<br>
+Adding a new bookmark set with Index Entries...95<br>
+Adding Index Entries to an existing bookmark set...96<br>
+Modifying Index Entries in an existing bookmark set...97<br>
+Adding a new bookmark set with TOC Entries[]...97<br>
+Adding TOC Entries to an existing bookmark set...97<br>
+Determining A Help ID...98<br>
+Adding a Help ID...98<br>
+Switching Content...99<br>
+Inline switching...99<br>
+Switching complete sections or paragraphs...100<br>
+Miscellaneous...103<br>
+Extended Tips...103<br>
+Sorting...103<br>
+Validating...103<br>
+Troubleshooting...104<br>
+A help file cannot be opened...104<br>
+A help file cannot be saved...104<br>
+No Help file can be opened or saved...104<br>
+Paragraph content has vanished on Reload...104<br>
+<b>5 Appendix...105</b><br>
+Glossary...105<br>
+XML Help Document Type Definition...108<br>
+<hr>
+<!--Page 8 -->
+<A name=8></a><hr>
+<!--Page 9 -->
+<A name=9></a><h2>1 How OpenOffice.org Help Works</h2>
+This chapter gives an overview of the OpenOffice.org 2.0 help system. It describes <br>
+the different features of the help system, how it is organized, and how it is built from <br>
+the source files.<br>
+<h3>Help Ingredients</h3><br>
+The OpenOffice.org help system comprises different help features, which are <br>
+explained in detail in the following sections.<br>
+<h4>Extended Tips</h4>
+Extended Tips are yellow pop-up windows that appear on the application user <br>
+interface (UI), and display a short reference text for an element. An extended tip for a <br>
+particular UI element is triggered by resting the mouse over that element for a short <br>
+amount of time (approx. 1 second). On moving the mouse, the extended tip <br>
+disappears.<br>
+Display of extended tips is enabled by choosing <b>HelpTools -> Options -> </b><br>
+<b>OpenOffice.org -> General -> Tips -> Extended Tips,</b> or by pressing <br>
+<b>Shift+F1</b>.<br>
+When the extended tips are enabled by pressing <b>Shift+F1,</b> the tips are displayed <br>
+without any delay. This mode is exited when a mouse button is clicked.<br>
+Extended tips use <i>Help Ids,</i> which are assigned to UI elements to find the correct text <br>
+for that UI element. The text itself is defined in the help files inside the ahelp element. <br>
+For more information about the structure of the help files, please refer to chapter <A href="HelpAuthorings.html#23">2:</a> <br>
+"<i><A href="HelpAuthorings.html#23">Help File XML format Basics</i></a>" on page<A href="HelpAuthorings.html#23"> 23.</a><br>
+<h4>Context-Sensitive Help</h4>
+OpenOffice.org Help is context-sensitive, which means that the help viewer displays <br>
+reference information or instructions for the current application context when the help <br>
+is called from within the application. <br>
+<b>9</b><br>
+<hr>
+<!--Page 10-->
+<A name=10></a>Context-sensitive help is invoked by pressing <b>F1</b> or clicking the <b>Help</b> button in a <br>
+dialog.<br>
+<i>Help IDs</i> are used to identify the context. A lookup table is used to find the correct <br>
+anchor inside the help file set (see also<A href="HelpAuthorings.html#16"> <i>Application Help Calls</i></a> on page <A href="HelpAuthorings.html#16">16)</a>. <br>
+ Not all contexts are actually mapped to help topics. In that case, the start page of the corresponding <br>
+help section is shown.<br>
+<h4>Hierarchical List Of Contents</h4><br>
+There is a hierarchical list of help contents available from the <b>Contents</b> tab page of <br>
+the help viewer. This should not be considered a complete table of contents, like in a <br>
+book, but a selection of help topics sorted by different application/document types and <br>
+task groups (see<A href="HelpAuthorings.html#12"> Fig. 1 </a>on page<A href="HelpAuthorings.html#12"> 12)</a>.<br>
+Help topics can appear more than once if they fit into multiple application/task groups. <br>
+Currently, these contents trees are manually compiled and saved in *.tree files.<br>
+In the future, these contents lists will be able to be defined within the help files <br>
+themselves. The *.tree files will then be created when the help is compiled in the <br>
+software build cycle.<br>
+ Note that, although the corresponding elements are included in the help format, these are <i>not yet </i><br>
+evaluated by the help compiler. The tree files must still be generated <i>manually</i>.<br>
+<h4>Index Of Keywords</h4><br>
+The <b>Index</b> tab page of the help viewer contains a two-level keyword index. These <br>
+two levels allow for a basic grouping of keywords. The index is displayed per help <br>
+module (see <A href="HelpAuthorings.html#12">Fig. 2</a> on page <A href="HelpAuthorings.html#12">12)</a>.<br>
+After selecting an OpenOffice.org help module from the dropdown list at the top left of <br>
+the help viewer, the corresponding list of keywords is loaded.<br>
+ Typing a search term directly causes a jump to the next suitable first-level entry in the <br>
+index list.<br>
+The keywords are defined inside the help files as bookmarks. See also section <br>
+<A href="HelpAuthorings.html#95"><i>Bookmarks</i></a> on page <A href="HelpAuthorings.html#95">95</a>.<br>
+<h4>Full-Text Search</h4><br>
+The <b>Find</b> tab page allows you to search through the help content. You can only <br>
+search through one help module at a time (see<A href="HelpAuthorings.html#12"> Fig. 3 </a>on page<A href="HelpAuthorings.html#12"> 12</a>).<br>
+<b>10</b><br>
+<hr>
+<!-- Page 11 -->
+<A name=11></a>By default, the search engine searches for case-insensitive substrings that appear <br>
+anywhere in a help file. You can restrict the search scope by specifying a search for <br>
+complete words only, and to only search headings in help files.<br>
+The results are displayed sorted by search rank, showing the best matches at the top <br>
+of the list.<br>
+<h4>Bookmarks</h4><br>
+The <b>Bookmarks</b> tab page lists user-defined bookmarks that correspond to help <br>
+pages. User-defined bookmarks from al help modules can belong to this list. The icon <br>
+next to a bookmark indicates the help module to which the bookmark belongs (see <br>
+<A href="HelpAuthorings.html#12">Fig. 4</a> on page <A href="HelpAuthorings.html#12">12)</a>.<br>
+Double-clicking the bookmark takes you back to the corresponding help page.<br>
+Bookmarks can be named individual y.<br>
+ Don't confuse these bookmarks with the bookmark element in the help XML format.<br>
+<h4>Help Agent</h4><br>
+The <i>Help Agent</i> is a smal notification window that appears when the user is in a <br>
+certain context, for example, when the AutoCorrect function has automatical y <br>
+modified the text. Clicking the window opens the help at the location that is assigned <br>
+to that context. <br>
+As with the extended tips and the context sensitive help, the context for the Help <br>
+Agent is specified using Help IDs. The IDs that trigger the display of the Help Agent <br>
+are defined in the file SFX.xcu in the directory --
+share/registry/data/org/openoffice/Office. <br>
+This file is not part of the helpcontent2 svn project.<br>
+
+<b>11</b><br>
+<hr>
+<!-- Page 12 -->
+<A name=12></a>
+<p>
+<i>Fig. 1: List of contents</i><br><br>
+<img src="Fig1.png" alt="Figure 1: List of Contents" />
+<p>
+<i>Fig. 2: Keyword Index</i><br><br>
+<img src="Fig2.png" alt="Figure 2:Keyword Index" />
+<p>
+<i>Fig. 3: Full Text Search</i><br><br>
+<img src="Fig3.png" alt="Figure 3: Text Search" />
+<p>
+<i>Fig. 4: Bookmarks</i><br><br>
+<img src="Fig4.png" alt="Figure 4: Bookmarks" />
+<p>
+<b>12</b><br>
+<hr>
+<!-- Page 13 -->
+<A name=13></a>
+<h3>Installed Help Files</h3><br>
+On installation, a help directory is created as child of the main OpenOffice.org <br>
+directory. It contains al global files (currently only main_transform.xsl), and one or <br>
+more subdirectories with language-dependent files. The language directories are <br>
+designated by ISO codes, for example, en-US for US-English. The contents of this <br>
+language directory are as follows:<br>
+<table border="1">
+<caption><b>Table 1: Help files that are installed.</b></caption>
+<tr>
+<th>Directory/File</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>help/</td>
+<td>The main help directory</td>
+</tr>
+<tr>
+<td>
+help/main_transform.xsl</td>
+<td>The main transformation style sheet (<A href="HelpAuthorings.html#16">see <i>The Main</i></a>
+<A href="HelpAuthorings.html#16"><i>Transformation Style Sheet</i> below)</a></td>
+</tr>
+<tr>
+<td>
+help/{lang}<br></td>
+<td>The language dependent help files</td>
+</tr>
+<tr>
+<td>help/{lang}/*.css</td>
+<td>The cascading style sheets for displaying the help in the help
+viewer (<A href="HelpAuthorings.html#16">see <i>The Cascading Style Sheets</i> below)</a></td>
+</tr>
+<tr>
+<td>help/{lang}/err.html<br></td>
+<td>The error file. This file is called whenever a help page can not be
+found.</td>
+</tr>
+<tr>
+<td>help/{lang}/shared.jar</td>
+<td>The help file archive for shared help files</td>
+</tr>
+<tr>
+<td>help/{lang}/shared.tree</td>
+<td>The contents file for shared help files (see <i><A href="HelpAuthorings.html#15">Help Module Contents</i></a>
+<A href="HelpAuthorings.html#15"><i>Files (Section Archives)</i>)</a></td>
+</tr>
+<tr>
+<td>help/{lang}/schart.jar</td>
+<td>The help file archive for help files dealing with charts <A href="HelpAuthorings.html#13">[1</a>]</td>
+</tr>
+<tr>
+<td>help/{lang}/schart.tree</td>
+<td>The contents file for help files dealing with charts (see <i><A href="HelpAuthorings.html#15">Help</i></a>
+<A href="HelpAuthorings.html#15"><i>Module Contents Files (Section Archives)</i> </a>)<A href="HelpAuthorings.html#13">[1</a>]</td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.cfg</td>
+<td>The configuration files for a help module (<A href="HelpAuthorings.html#14">see <i>Help Module</i></a>
+<A href="HelpAuthorings.html#14"><i>Configuration Files</i> </a>)</td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.db</td>
+<td>The lookup tables for a help module (<A href="HelpAuthorings.html#15">see <i>Help Module Lookup</i></a><br>
+<A href="HelpAuthorings.html#15"><i>Tables (Databases)</i></a> )</td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.ht</td>
+<td>The extended tips for a help module (<A href="HelpAuthorings.html#15">see <i>Help Module Extended</i></a>
+<A href="HelpAuthorings.html#15"><i>Tip Files</i> </a>)</td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.idx/</td>
+<td>The full text search index for a help module<br></td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.jar</td>
+<td>The help file archive for a help module<br></td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.key</td>
+<td>The index file for a help module (<A href="HelpAuthorings.html#16">see <i>Help Module Index Files </i></a>)</td>
+</tr>
+<tr>
+<td>help/{lang}/{module}.tree<br></td>
+<td>The contents file for a help module (see <i><A href="HelpAuthorings.html#15">Help Module Contents</i></a></td>
+</tr>
+</table>
+
+
+<A href="HelpAuthorings.html#15"><i>Files (Section Archives)</i> </a>)<br>
+
+
+<h4>Help Modules And Help Sections</h4><br>
+The help is divided into different help modules that can be selected using the drop <br>
+down list at the top left of the help viewer. These correspond to the applications or <br>
+modules of OpenOffice.org.<br>
+1<br>
+This is a legacy remainder of an older StarOffice help structure.<br>
+<b>13</b><br>
+<hr>
+<A name=14></a>Each help file (*.xhp) has a scope that consists of one or more <i>help sections</i> and <br>
+includes the corresponding help file archives *.jar. These archives contain al help <br>
+files of a help section. A help section <i>does not</i> correspond to an application of <br>
+OpenOffice.org. <br>
+In the help file viewer, the index and the full text search work within this scope only.<br>
+ The distinction between help <i>module</i> and help <i>section</i> is confusing and will be eradicated in the <br>
+future. Basically, a help <i>section</i> contains all files that are found inside the text/{section} path <br>
+of the help source directory (see<A href="HelpAuthorings.html#18"> <i>Structure of the CVS Help Module</i></a> on page <A href="HelpAuthorings.html#18">18</a> for the structure of <br>
+the help source module). Each help section produces a *.jar archive containing all help files in <br>
+that path. A help <i>module</i> takes one or more sections and combines them to form the scope of a <br>
+module.<br>
+<table border ="1">
+<caption><b>Table 2:OpenOffice.org help modules and scope</b><caption
+<tr>
+<th><b>Help module</b><br></th>
+<th><b>Help Sections (Scope)</b><br></th>
+</tr>
+<tr>
+<td>BASIC<br></td>
+<td>sbasic + shared<br></td>
+</tr>
+<tr>
+<td>Calc<br></td>
+<td>scalc + shared + schart<br></td>
+</tr>
+<tr>
+<td>Draw<br></td>
+<td>sdraw + simpress + shared + schart<br></td>
+</tr>
+<tr>
+<td>Impress<br></td>
+<td>sdraw + simpress + shared + schart<br></td>
+</tr>
+<tr>
+<td>Math<br></td>
+<td>smath + shared<br>/td>
+</tr>
+<tr>
+<td>Writer<br></td>
+<td>swriter + shared + schart<br></td>
+</tr>
+<tr>
+<td>Base[<A href="HelpAuthorings.html#14">2</a>]<br></td>
+<td>shared/explorer/database<br></td>
+</tr>
+</table>
+<p>
+From the table above, it follows that the scope for the Writer help module includes al <br>
+help files from swriter.jar, shared.jar and schart.jar. Each help module has a <br>
+set of six files (cfg, db, ht, jar, key, tree) and an *.idx directory associated with it <br>
+except for Draw and Base, which have no *.tree file.<A href="HelpAuthorings.html#14">[3]</a><br>
+
+<h4>Help Module Configuration Files</h4><br>
+The *.cfg configuration files are ASCII files containing parameter=value pairs with <br>
+configuration information. They are created and maintained manually:<br>
+<br><code>
+Title=%PRODUCTNAME Writer<br>
+Copyright=Copyright 2004, Sun Microsystems, Inc.<br>
+Language=en-US<br>
+Order=2<br>
+Start=text%2Fswriter%2Fmain0000.xhp<br>
+Heading=headingheading<br>
+Program=WRITER<br>
+07.07.04 00:00:00<br>
+</code>
+<br>
+<!--footnotes --><hr>
+
+* For historical reasons, the contents for Draw are included in the simpress.tree file and the contents for Base (database) are included in <br>
+the shared.tree file.<br>
+<b>14</b><br>
+<hr>
+<!--Page 15-->
+<A name=15></a><br>
+Title specifies the help module title as displayed in the drop down list at the top <br>
+left of the help viewer.<br>
+<br>
+Copyright is a copyright string.<br>
+<br>
+Language specifies the help language for the help module.<br>
+<br>
+Order was used in an earlier implementation and is deprecated.<br>
+<br>
+Start defines the start page for a help module. The slashes in the path name are <br>
+encoded as %2F. The start page <i>must </i>be contained in the archive that has the <br>
+same name as the configuration file (swriter.jar for swriter.cfg)<br>
+<br>
+Heading defines an internal value that is used by the ful text search engine.<br>
+<br>
+Program specifies the application name that will be used for switching content <br>
+(see <A href="HelpAuthorings.html#99"><i>Switching Content</i> </a>on page<A href="HelpAuthorings.html#99"> 99</a>)<br>
+<br>
+The last line contains the creation date. Use of this is deprecated. It is not <br>
+evaluated anywhere.<br>
+<hr>
+
+<h4>Help Module Contents Files (Section Archives)</h4><br>
+The *.jar contents files contain the help topic files for a help section (see <i><A href="HelpAuthorings.html#13">Help</i></a><br>
+<A href="HelpAuthorings.html#13"><i>Modules and Help Sections</i> </a>). It is an archive file with a subdirectory structure that <br>
+contains all help xhp files. There is one archive per help <i>section</i> (sbasic, shared, <br>
+sdraw, simpress, scalc, schart, swriter, smath). Each help <i>module</i> comprises more <br>
+than one help section (see <i><A href="HelpAuthorings.html#13">Help Modules and Help Sections</i></a> ).<br>
+<h3>Help Module Lookup Tables (Databases)</h3><br>
+The lookup tables *.db are Berkeley databases that contain a lookup table used by <br>
+the help application to find a help page to display for a given help ID. The tables are <br>
+used for referencing context sensitive help pages when help is cal ed from the <br>
+application. They are not used for cal ing help files from within other help files. This is <br>
+designated by the parameter UseDB=no in the help file URL (see <i><A href="HelpAuthorings.html#16">Application Help</i></a><br>
+<A href="HelpAuthorings.html#16"><i>Cal s</i> </a>on page<A href="HelpAuthorings.html#16"> 16</a>). The data for that table come from the bookmark elements in the <br>
+help files (see<A href="HelpAuthorings.html#95"> <i>Bookmarks</i></a> on page <A href="HelpAuthorings.html#95">95)</a>.<br>
+
+<h4>Help Module Extended Tip Files</h4><br>
+The files *.ht are Berkeley databases that contain the extended help tip text for al <br>
+Help IDs. The application uses these files to fetch the text for an extended tip for a <br>
+given Help ID.<br>
+The data for that table come from the bookmark elements in conjunction with the <br>
+ahelp elements in the help files (see<A href="HelpAuthorings.html#95"> <i>Bookmarks</i></a> on page <A href="HelpAuthorings.html#95">95</a>). It is extracted from the <br>
+help files at compile time.<br>
+
+<b>15</b><br>
+<hr>
+<!-- Page 16-->
+<A name=16></a>
+<h4>Help Module Index Files</h4><br>
+The files *.key are Berkeley databases that contain the index entries for the help <br>
+modules.<br>
+The data for that table come from the bookmark elements in the help files (see <br>
+<A href="HelpAuthorings.html#95"><i>Bookmarks</i></a> on page <A href="HelpAuthorings.html#95">95</a>). It is extracted from the help files at compile time.<br>
+<h3>The Main Transformation Style Sheet</h3><br>
+The file main_transform.xsl is global for al languages and help files and is used for <br>
+final transformation of the xhp help file to yield an html file that is displayed by the help <br>
+viewer component.<br>
+This style sheet is responsible for converting XML help elements and classes into <br>
+HTML elements and classes. The overal layout of the help file is specified using this <br>
+style sheet. The graphical appearance is control ed by the cascading style sheets (see <br>
+<A href="HelpAuthorings.html#16">The Cascading Style Sheets</a>).<br>
+
+<h4>The Cascading Style Sheets</h4><br>
+The cascading style sheets *.css describe the formatting style for the help page. <br>
+Since different locales require different fonts and font effects, the cascading style <br>
+sheets are language dependent. There is one set of style sheets per language. <br>
+The OpenOffice.org help viewer only recognizes some basic CSS2 commands. There <br>
+are five style sheets available, four of which account for special accessibility issues. <br>
+They are selected in the application using <b>Tools -> Options -> OpenOffice.org -> General -> Help Formatting</b>.<br>
+<hr>
+
+<h3>Application Help Calls</h3><br>
+This section briefly describes what happens when a help file is called from the <br>
+application or from within the help itself (links or embeddings).<br>
+
+
+<dl>
+ <dt>(F1 or Help Button)</dt>
+<dd>1. When <b>F1</b> or a <b>help</b> button is pressed in an OpenOffice.org application, a help <br>
+ request is sent as an URL to the help content provider.<br></dd>
+<dt>$module.db </dt>
+<dd>2. The help ID is resolved to a help file using the help lookup table for the
+ application ($module.db).<br>
+ 3. When a help file is called from within the help, the URL sent to the help <br>
+content provider contains the file path. There is no need for resolving the ID.<br></dd>
+<dt>$module.jar</dt>
+
+<dd>4. The help file is extracted from the corresponding help file archive <br>
+ ($module.jar).<br></dd>
+<dt>main_transform.xsl</dt>
+<dd>5. The extracted help file is transformed into HTML using the <br>
+main_transform.xsl style sheet and sent to the help viewer for display. The <br>
+stylesheet main_transform.xsl controls all conversion from xhp to html, and <br>
+must be adjusted whenever new elements, attributes, or attribute values must <br>
+be taken into account.<br></dd>
+<dt>Viewer</dt>
+<dd>6. Displays the help</dd>
+</dl>
+<b>16</b><br>
+<hr>
+<!--Page 17-->
+<A name=17></a>
+
+The URLs sent to the help content provider have two forms:<br>
+<dl>
+ <dt>URLs from the application<br></dt>
+ <dd>vnd.sun.star.help://swriter/12345?Language=en-US&System=UNIX<br></dd>
+<dt>URLs send within the help:<br></dt>
+<dd>vnd.sun.star.help://swriter/text/swriter/main0100.xhp?Language=en-<br>
+ US&System=UNIX&UseDB=no&DbPAR=swriter<br></dd>
+<br>
+</dl>
+The protocol identifier vnd.sun.star.help:<br>
+<br>
+The help archive jar file to use: swriter<br>
+<br>
+The help ID to look up, or the name of the file to extract: 12345 or <br>
+swriter/text/swriter/main0100.xhp<br>
+<br>
+A parameter for the current language: Language=en-US<br>
+<br>
+A parameter for the current operating system: System=UNIX<br>
+<br>
+A parameter to disable help ID lookup (only for help internal URLs): UseDB=no<br>
+<br>
+A parameter to describe the current help context (module): DbPAR=swriter <br>
+This can differ from the help archive jar file used (see also <i><A href="HelpAuthorings.html#13">Help Modules and</i></a><br>
+<A href="HelpAuthorings.html#13"><i>Help Sections</i></a> on page <A href="HelpAuthorings.html#13">13)</a>.<br>
+
+<b>17</b><br>
+<hr>
+<!--Page 18 -->
+<A name=18></a>
+<h3>Structure of the Help Source Module</h3><br>
+The help source files and all helper files are located in the CVS module <br>
+helpcontent2. The directory layout is as follows:<br>
+<table border="1">
+<caption><b>Table 3: Structure of the Help source module</b><caption
+<tr>
+<th><b>Directory</b></th>
+<th><b>Content</b></th>
+</tr>
+<tr>
+<td>helpcontent2/<br></td>
+<td>The module's main directory<br>
+</tr>
+<tr>
+<td>helpcontent2/helpers<br>
+<td>Files that are not used by the help content itself, like <br>
+the DTD for the XML help format.<br>
+</tr>
+<tr>
+<td>helpcontent2/helpers/helpauthoring<br>
+<td>The help authoring environment for OpenOffice.org, <br>
+<A href="HelpAuthorings.html#75">see Authoring Help With OpenOffice.org </a>on <A href="HelpAuthorings.html#75">page 75</a>.<br>
+</tr>
+<tr>
+<td>helpcontent2/source<br>
+<td>The help source files that are used to build the help.<br>
+</tr>
+<tr>
+<td>helpcontent2/source/auxiliary<br>
+<td>Auxiliary files that do not contain help content but are <br>
+still needed for building the help, style sheets, <br>
+configuration files (<A href="HelpAuthorings.html#31">see Auxiliary Files</a> on <A href="HelpAuthorings.html#31">page 31)</a><br>
+</tr>
+<tr>
+<td>helpcontent2/source/text<br>
+<td>The help content source files, the makefiles for the <br>
+help compiler, and the localized content. Every <br>
+subdirectory contains its own makefile and a file with <br>
+all localized content.<br>
+</tr>
+<tr>
+<td>helpcontent2/source/text/sbasic<br></td>
+<td>Help files specific to BASIC (and the IDE).<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/scalc<br></td>
+<td>Help files specific to the Calc module.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/schart<br></td>
+<td>Help files specific to charts.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/sdraw<br></td>
+<td>Help files specific to the Draw module.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/shared<br></td>
+<td>Help files common to two or more modules.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/simpress<br></td>
+<td>Help files specific to the Impress module.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/smath<br></td>
+<td>Help files specific to the Math module.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/source/text/swriter<br></td>
+<td>Help files specific to the Writer module.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/prj<br></td>
+<td>The build lists.<br></td>
+</tr>
+<tr>
+<td>helpcontent2/util<br></td>
+<td>The makefiles for the help linker (see <i><A href="HelpAuthorings.html#20">Makefiles for</i></a><br>
+<A href="HelpAuthorings.html#20"><i>linking the compiled files</i> </a>on page <A href="HelpAuthorings.html#20">20</a>).<br></td>
+</tr>
+</table>
+
+ Note that the help images are no longer part of the CVS module. Starting with OpenOffice.org 2.0, <br>
+application icons are directly taken from the images.zip repository in the share/config <br>
+directory.<br>
+ Images specific to the help need to be added to the CVS default_images module in the <br>
+helpimg subdirectory. These willthen also be included in the images.zip archive.<br>
+
+<b>18</b><br>
+<hr>
+<A name=19></a>
+
+<h3>Building the Help Set</h3><br>
+<h4>Setting Up A Build Environment</h4>
+This is described on <a href="http://tools.openoffice.org">tools.openoffice.org</a>.<br>
+<h4>Makefiles For The Help</h4>
+The helpcontent2 module contains three types of makefiles:<br>
+
+<b>1. Makefiles for compiling the help source files</b><br>
+These makefiles are found in the <code>helpcontent2/source/text</code> directories. <br>
+Every subdirectory that contains help files to be compiled has a <br>
+corresponding makefile, for example (<i>shortened for clarity</i>):<br><br>
+<code>
+#***************************************************************<br>
+#***************************************************************<br>
+ <br>
+# edit to match directory level<br>
+PRJ = ..$/..$/..$/..<br>
+# same for all makefiles in "helpcontent2"<br>
+PRJNAME = helpcontent2<br>
+# edit to match the current package<br>
+PACKAGE = text/sbasic/guide<br>
+# uniqe name (module wide);<br>
+# using a modified forme of package should do here<br>
+TARGET = text_sbasic_guide<br>
+# edit to match the current module<br>
+MODULE = sbasic<br>
+ <br>
+# --- Settings ------------------------------------------------<br>
+ <br>
+.INCLUDE : settings.mk<br>
+.INCLUDE : $(PRJ)$/settings.pmk<br>
+ <br>
+# this list matches the *.xhp files to process<br>
+HZIPFILES = \<br>
+ control_properties.hzip \<br>
+ create_dialog.hzip \<br>
+ insert_control.hzip \<br>
+ sample_code.hzip \<br>
+ show_dialog.hzip<br>
+ <br>
+# --- Targets -------------------------------------------------<br>
+ <br>
+.INCLUDE : target.mk<br>
+.INCLUDE : $(PRJ)$/makefile.pmk<br><br>
+</code>
+<p>
+
+You find a template for this makefile in helpcontent2/helpers. This <br>
+template is used when the makefiles are created using the <br>
+createmakefile.pl script in helpcontent2/helpers. Use this script for <br>
+makefile creation and don't modify the makefiles manually.<br>
+<b>19</b><br>
+<hr>
+<!--Page 20 -->
+<A name=20></a>
+<b>2. Makefiles for linking the compiled files.</b><br>
+These makefiles are found in the subdirectories of <code>helpcontent2/util</code> (the <br>
+directory itself contains the third type of makefile), for example (<i>shortened for </i><br>
+<i>clarity</i>):<br><br>
+<code>
+#**************************************************************<br>
+#**************************************************************<br>
+ <br>
+# edit to match directory level<br>
+PRJ = ..$/..<br>
+# same for all makefiles in "helpcontent2"<br>
+PRJNAME = helpcontent2<br>
+# uniqe name (module wide);<br>
+# using a modified forme of package should do here<br>
+TARGET = util_sbasic<br>
+ <br>
+# --- Settings ------------------------------------------------<br>
+ <br>
+.INCLUDE : settings.mk<br>
+.INCLUDE : $(PRJ)$/settings.pmk<br>
+.IF "$(SOLAR_JAVA)"!=""<br>
+common_build_zip:=<br>
+zip1generatedlangs=TRUE<br>
+zip1langdirs=$(aux_alllangiso)<br>
+ZIP1TARGET=xhp_sbasic<br>
+ZIP1FLAGS= -u -r<br>
+ZIP1DIR=$(MISC)$/$(LANGDIR)<br>
+ZIP1LIST=$(LANGDIR)$/text$/sbasic$/* -x "*.dphh*" \<br>
+-x "*.hzip" -x "*.created"<br>
+.ENDIF<br>
+# "$(SOLAR_JAVA)"!=""<br>
+ <br>
+LINKNAME=sbasic<br>
+LINKADDEDFILES= \<br>
+ -add sbasic.cfg <br>
+$(PRJ)$/source$/auxiliary$/LANGUAGE$/sbasic.cfg \<br>
+ -add sbasic.tree <br>
+$(PRJ)$/source$/auxiliary$/LANGUAGE$/sbasic.tree \<br>
+ -add sbasic.jar $(BIN)$/xhp_sbasic_LANGUAGE.zip<br>
+ <br>
+ <br>
+LINKADDEDDEPS= \<br>
+ $(PRJ)$/source$/auxiliary$/LANGUAGE$/sbasic.cfg \<br>
+ $(PRJ)$/source$/auxiliary$/LANGUAGE$/sbasic.tree \<br>
+ $(BIN)$/xhp_sbasic_LANGUAGE.zip<br>
+ <br>
+LINKLINKFILES= \<br>
+ text$/sbasic$/guide$/control_properties.hzip \<br>
+ text$/sbasic$/guide$/create_dialog.hzip \<br>
+ text$/sbasic$/guide$/insert_control.hzip \<br>
+ text$/sbasic$/guide$/sample_code.hzip \<br>
+ text$/sbasic$/guide$/show_dialog.hzip \<br>
+ <br>
+</code>
+
+<b>20</b><br>
+<hr>
+<!-- Page 21 -->
+<A name=21></a> <br>
+<br><code>
+# --- Targets -------------------------------------------------<br>
+.INCLUDE : target.mk<br>
+.INCLUDE : $(PRJ)$/util$/target.pmk<br>
+</code>
+
+You find a template for this makefile in helpcontent2/helpers. This <br>
+template is used when the makefiles are created using the <br>
+createmakefile.pl script in helpcontent2/helpers. Use this script for <br>
+makefile creation and not to modify the makefiles manual y.<br>
+
+<b>3. A makefile for creating the stylesheet archive in <code>helpcontent2/util</code></b> <br>
+(shortened for clarity):<br><br>
+
+<code>
+#**************************************************************<br>
+#**************************************************************<br>
+ <br>
+# edit to match directory level<br>
+PRJ = ..<br>
+# same for all makefiles in "helpcontent2"<br>
+PRJNAME = helpcontent2<br>
+# uniqe name (module wide);<br>
+# using a modified forme of package should do here<br>
+TARGET = plain_util<br>
+ <br>
+# --- Settings ------------------------------------------------<br>
+.INCLUDE : settings.mk <br>
+.INCLUDE : $(PRJ)$/settings.pmk<br>
+ <br>
+ZIP1TARGET=helpxsl<br>
+ZIP1FLAGS= -u -r<br>
+ZIP1DIR=$(PRJ)$/source$/auxiliary<br>
+ZIP1LIST=main_transform*.xsl<br>
+# --- Targets -------------------------------------------------<br>
+ <br>
+.INCLUDE : target.mk<br>
+ <br>
+ALLTAR : $(COMMONBIN)$/helpimg.ilst<br>
+ <br>
+$(COMMONBIN)$/helpimg.ilst: helpimg.ilst<br>
+ $(COPY) $< $@<br>
+</code>
+
+<H4>Help Build Process</h4><br>
+The file <code>helpconten2/prj/build.lst</code> defines which directories are built using a <br>
+directory's makefile. Dependencies (which directories need to be built first) are also <br>
+defined here.More information about the build process for OpenOffice.org in general can be found on<A href="http://tools.openoffice.org/"> http://tools.openoffice.org</a>, <br>
+<A href="http://ooo.ximian.com/hackers-guide.html">http://ooo.ximian.com/hackers-guide.html</a>, or on <A href="http://go-oo.org/wiki/index.php/Main_Page">http://go-oo.org/wiki/index.php/Main_Page.</a><br>
+Initiate a help build by issuing the command <b><code>build</code></b> while in the helpcontent2 <br>
+directory.<br>
+
+
+<b>21</b>
+
+<hr>
+<!--Page 22-->
+<A name=22></a>
+<oll>
+<li> The help files from helpcontent2/source/text are compiled and written to the <br>
+misc subdirectory of the platform directory of the output tree. This step produces <br>
+a set of *.hzip files and dependency files *.dphh. These files are the particles <br>
+that are used to create the help modules in the next the linking step.<br></li>
+<li>The compiled help files are taken from the misc directory and linked into a zip <br>
+archive. Other files are added from the helpcontent2/source/auxiliary <br>
+directory to that archive as defined in the makefiles of the subdirectories in <br>
+helpcontent2/util. This results in one zip archive per help module and <br>
+language in the bin subdirectory of the platform directory of the output tree.<br></li>
+<li>The helpxsl.zip archive is built according to the makefile in <br>
+helpcontent2/util.<br></li>
+<li>All archive files are delivered according to the d.lst file in helpcontent2/prj.<br></li>
+</ol>
+
+<h4>Adding A Help File To Or Removing A Help File From The Set Of Help Files</h4>
+
+The makefiles need to be adjusted to reflect the changes you made to the set of files. <br>
+If you added a new file, add this to the makefile of its directory and to the link makefile <br>
+(in helpcontent2/util/*) of any module that wil contain the file. If you deleted a <br>
+help file, remove it from the makefile of its directory and from the link makefile (in <br>
+helpcontent2/util/*) of any module that contains the file.<br>
+ The safest way is to run the create_makefiles.pl script from helpcontent2/helpers to update the <br>
+makefiles.<br><br>
+If you rebuild the help after help files have been deleted, or after dependencies <br>
+(references) between the files have been changed, you need to remove al <br>
+dependency files from the misc directory that are no longer valid. To be perfectly safe, <br>
+you can remove the complete output tree for the platform of the helpcontent2 <br>
+module.<br>
+<h4>Help Images</h4><br>
+Images that are used inside the help are stored in different modules and accessed by <br>
+the help viewer using the images.zip archive on runtime. Therefore, you need to add <br>
+help images, such as screenshots, to the helpimg directory of the default_images <br>
+module. Including the help images to the images.zip repository is control ed by the <br>
+helpimg.ilst file that is found in the util directory of helpcontent2.<br>
+The helpimg.ilst file contains all image files to be included for helpcontent2, one <br>
+file per line. The variable <code>%GLOBALRES%</code> is used to designate the default image <br>
+directory:<br><br>
+%GLOBALRES%/helpimg/calcein.png<br><br>
+
+ Don't forget the localized files in the subdirectories.<br>
+<b>22</b><br>
+<hr>
+<!--Page 23 -->
+<A name=23></a>
+<h2>2 Help File XML Format Basics</h2>
+<h3>Basic Document Structure</h3>
+The basic structure of a valid help file for OpenOffice.org consists of a helpdocument <br>
+root element with one meta and one body sub-element containing the content (body) <br>
+and meta information (meta). The minimum information is a topic title and the filename <br>
+inside the elements <br>
+<br>
+<code>/helpdocument/meta/topic/title</code> <br>
+and<br>
+<br>
+<code>/helpdocument/meta/topic/filename</code><br><br>
+<code>
+<?xml version="1.0" encoding="UTF-8"?><br>
+<helpdocument version="1.0"><br>
+ <meta><br>
+ <topic id="someid" indexer="include" status="PUBLISH"><br>
+ <title xml-lang="en-US" id="tit">Topic Title</title><br>
+ <filename>text/swriter/01/012345.xhp</filename><br>
+ </topic><br>
+ </meta><br>
+ <body><br>
+ </body><br>
+</helpdocument><br>
+</code>
+
+ The help file extension is xhp.<br>
+<h3>Using Variables</h3>
+In the help files the following variables are used to designate the name and the <br>
+version of the product. This is to allow for correct branding of the product (for <br>
+example, OpenOffice.org vs. StarOffice). You must never use the literal name of the <br>
+product but instead one of the following variables (In addition to these variables, the following two variables are still used in the help files for legacy reasons but deprecated: $[officename] <br>
+and $[officeversion].):<br>
+
+<b>23</b><br>
+<hr>
+<!--Page 24 -->
+<A name=24></a><br>
+<code>%PRODUCTNAME</code> designates the name of the product, for example <br>
+<b>OpenOffice.org</b>.<br>
+<br>
+<br><code>%PRODUCTVERSION</code> designates the current version of the product, for example <br>
+<b>2.0</b>.<br><br>
+
+Both variables are replaced by the main transformation style sheet <br>
+main_transform.xsl (see page <A href="HelpAuthorings.html#16">16)</a> when the help is displayed. The corresponding <br>
+information is taken from the application's configuration information and passed to the <br>
+style sheet (see<A href="HelpAuthorings.html#16"> <i>The Main Transformation Style Sheet</i> </a>on page<A href="HelpAuthorings.html#16"> 16</a>).<br>
+<h3>Paragraph Roles</h3><br>
+The main element for help content is a paragraph. There is no heading element, <br>
+instead al headings are treated as paragraphs with a heading <i>role</i>. The role attribute <br>
+defines the role of a paragraph with the paragraph role being the standard. The <br>
+values for the role attribute are not defined in the DTD. <br>
+During the conversion process (XMLHTML) the role attribute is mapped to a class <br>
+attribute of the corresponding HTML element allowing to influence the layout of the <br>
+corresponding paragraph using cascading style sheets.[<A href="HelpAuthorings.html#24">7</a>]<br>
+The following roles are currently suggested and defined in the help authoring <br>
+template. More roles can be defined as required (see also <i><A href="HelpAuthorings.html#86">Paragraph Formatting</i></a> on <br>
+page <A href="HelpAuthorings.html#86">86</a>):<br>
+<br>
+<table border ="1">
+ <caption><b>Table 4: Paragraph Roles<br></b><caption
+ <tr>
+<th>Role</th><br>
+<th>Description</th><br>
+<th>Converts to...</th><br>
+</tr>
+<tr>
+ <td>paragraph<br></td>
+<td>A standard paragraph<br></td>
+<td><p class="paragraph">...<br>
+</p><br></td>
+</tr>
+<tr>
+<td>heading<br></td>
+<td>A heading <br></td>
+<td><h1>...</h1><br>
+If this role is assigned to a paragraph, the to<br>
+heading level has to be specified using <br>
+<h6>...</h6><br>
+the level attribute of the paragraph <br>
+element.<br></td>
+</tr>
+<tr>
+<td>note<br></td>
+<td>A note<br></td>
+<td><p class="note">...</p><br></td>
+</tr>
+<tr>
+<td>warning<br></td>
+<td>A warning<br></td>
+<td><p class="warning">...</p><br></td>
+</tr>
+<tr>
+<td>tip<br></td>
+<td>A tip<br></td>
+<td><p class="tip">...</p><br></td>
+</tr>
+<tr>
+<td>code<br></td>
+<td>A code fragment<br></td>
+<td><p class="code">...</p><br></td>
+<tr>
+<td>example<br></td>
+<td>An example<br></td>
+<td><p class="example"> ...</p><br></td>
+</tr>
+<tr>
+<td>tablehead<br></td>
+<td>A table head (first rows)<br></td>
+<td><p class="tablehead"><br>
+...</p><br></td>
+</tr>
+<tr>
+<td>tablecontent<br></td>
+<td>Table contents<br></td>
+<td><p class="tablecontent"><br>
+...</p><br></td>
+</tr>
+</table>
+
+
+<b>24</b><br>
+<hr>
+
+<!-- Page 25 -->
+<A name=25></a>If you use other roles, you must ensure that they are taken into account by the CSS <br>
+files that define the help file display format.<br>
+
+<h3>Defining Index, Contents, and Context Sensitivity</h3>
+
+The help uses one unified bookmarking system to set anchors inside the help files <br>
+which are used by the <b>Index</b> tab, the <b>Contents</b> tab and for context-sensitive help. <br>
+The main element is the bookmark element. A bookmark has a branch attribute <br>
+representing the purpose of the bookmark. Currently there are three branches <br>
+defined: contents, index, and hid.<br>
+To define an anchor for a bookmark inside a help document, the element <bookmark> <br>
+has to be positioned at the place the bookmark wil point to. The branch attribute <br>
+specifies the type of bookmark to be defined (a content entry, an index entry, or a help <br>
+ID), while the sub-element bookmark_value contains the visible bookmark text, if <br>
+applicable.<br>
+ The only child element that is allowed inside the bookmark_value is embedvar to allow <br>
+embedding of commonly used titles for content nodes or index entries. For examples of using <br>
+embedded fragments inside bookmark values, refer to the next sections.<br>
+
+<h4>Contents Branch</h4>
+
+Content entries are displayed on the Content tab page of the help viewer. The branch <br>
+attribute takes the value contents. The bookmark value can contain any number of <br>
+levels separated by slashes, with the last part of the bookmark value serving as the <br>
+entry and the other parts serving as nodes.<br>
+ Note that currently the contents branch <i>is not</i> implemented in the help build process.<br>
+<i>Example</i><br>
+<br><code>
+<bookmark branch="contents" <br>
+xml-lang="en-US" id="bm1"><br>
+ <bookmark_value><br>
+ Text Documents/<br>
+ Objects in Text Documents/<br>
+ Positioning Objects<br>
+ </bookmark_value><br>
+</bookmark><br>
+</code>
+
+A bookmark value can also contain embedded fragments for node titles. This reduces <br>
+redundancy, maintenance effort, and the risk of introducing errors through typos. This <br>
+can be avoided if the top level entries for the content tree are defined separately:<br>
+
+<b>25</b><br>
+<hr>
+<A name=26></a>
+<br><code>
+<variable id="textdocs">Text Documents</variable><br>
+<variable id="objtextdocs">Objects in Text Documents</variable><br>
+and embedded as text fragments:<br>
+<bookmark_value><br>
+ <embedvar href="/text/shared/00/variables.xhp#textdocs"/>/<br>
+ <embedvar href="/text/shared/00/variables.xhp#objtextdocs"/>/<br>
+ ...<br>
+</bookmark><br>
+</code>
+
+<h4>Index Branch</h4>
+
+Index Entries are displayed on the Index tab page of the help viewer. The branch <br>
+attribute takes the value index Currently, index entries can contain <i>two</i> levels <br>
+separated by a semicolon.<br>
+<i>Example</i>:<br>
+<br><code>
+<bookmark branch="index" id="bm1" xml-lang="en-US"><br>
+ <bookmark_value><br>
+ editor;contour editor<br>
+ </bookmark_value><br>
+</bookmark><br>
+</code>
+As with content entries, the bookmark values for index entries can contain embedded <br>
+text fragments by using the embedvar element, which can be useful if names of UI <br>
+elements are used that are subject to change.<br>
+
+<h4>"hid" Branch</h4><br>
+Help IDs are never displayed but instead trigger context-sensitive help inside <br>
+OpenOffice.org. The branch attribute takes the value hid and in addition contains the <br>
+help ID associated with the bookmark.<br>
+<code>
+<bookmark id="bm_9876" xml-lang="en-US" <br>
+branch="<b>hid/HID_SOME_HELP_ID</b>"/><br>
+</code>
+
+A bookmark for a given help ID can only be used <i>once</i> inside the help files since the <br>
+bookmark defines the entry point for the help viewer when context-sensitive help is <br>
+triggered from the UI either through the use of the <b>F1</b> key or the <b>Help</b> button.<br>
+There are two types of help IDs currently used in the help files:<br>
+<br>
+
+<b>Symbolic names</b>, like <code>SID_FM_CONVERTTO_IMAGECONTROL</code> <br>
+<br>
+
+<b>UNO command names</b>, like <code>.uno:InsertCtrl</code><br>
+For details on determining the help ID for a UI element, see <i><A href="HelpAuthorings.html#98">Determining A Help ID</i></a> on <br>
+page <A href="HelpAuthorings.html#98">98</a>.<br>
+
+<b>26</b><br>
+<hr>
+<A name=27></a>
+<h3>Switching Content</h3><br>
+In some cases it is necessary to distinguish between different platforms or <br>
+applications when displaying the help. For example, on one platform a key stroke to <br>
+achieve a certain action can differ from the key stroke used on other platforms. To <br>
+avoid duplicating large amounts of text and to reduce redundancy, switching elements <br>
+are available, which are used to select the correct portion of the content at runtime.<br>
+The help content provider sends additional information along with a help request that <br>
+states the current platform, language and application context. This information can be <br>
+evaluated using the switch constructs to display the corresponding information.<br>
+There are two types of content switching:<br>
+<br>
+Switching complete paragraphs or sections<br>
+and
+<br>
+Switching text fragments inside paragraphs<br>
+<p>
+Currently, the following values are used for the select attribute of a switch and
+switchinline element to specify the switching context:
+<p>
+<table border="1">
+<caption><b>Table 5: Paragraph Switching Contexts</b><caption
+<tr>
+<th>Value</th><br>
+<th>Switching context</th>
+<th>Example/Comment</th>
+</tr>
+<tr>
+<td>sys</td><br>
+<td>Operating System</td><br>
+<td>Switching content for Unix, Windows, or Mac <br>
+platforms.</td><br>
+</tr>
+<tr>
+<td>appl</td><br>
+<td>Application</td><br>
+<td>Switching content for different OpenOffice.org applications (Writer, <br>
+Calc,...) in files that are common to multiple applications. </td><br>
+</tr>
+<tr>
+<td>distrib</td><br>
+<td>Distribution[<A href="HelpAuthorings.html#27">8</a>]</td><br>
+<td>Switching content for different distributions, like OpenOffice.org <br>
+and StarOffice, which contains extra commercial features.</td><br>
+</tr>
+</table>
+<p>
+
+The following values are used for the select attribute of a case and caseinline
+element within a given switching context:
+<p>
+<table border="1">
+<caption><b>Table 6: Inline Switching Contexts</b><caption
+<tr>
+<th>Switching Context
+</th>
+<th>Values
+</th>
+<tr>
+<td>Operating System (sys)<br>
+WIN UNIX MAC<br>
+</td>
+<td>Application (appl)<br>
+WRITER CALC DRAW IMPRESS MATH BASIC CHART<br>
+</td>
+</tr>
+</table>
+
+
+<h4>Switching Complete Paragraphs Or Sections</h4>
+
+This type is used, for example, if contents of a paragraph differ considerably on <br>
+different platforms or for different applications, or if a certain paragraph or section is <br>
+only applicable to a certain platform or application.<br>
+8<br>
+Note, that this switch is currently <i>not evaluated</i> in the main transformation step, since the help content provider does not provide the <br>
+necessary information. Currently, the main transformation style sheet uses the value of the product name to distinguish between open source <br>
+and commercial distributions, but this is only implemented for StarOffice and OpenOffice.org.<br>
+<b>27</b><br>
+<hr>
+<!--Page 28 -->
+<A name=28></a> For example, while mounting a CD-ROM drive can be a necessary step on a Unix <br>
+system, it is usual y not applicable on Windows computers. The switch element can <br>
+be used to accomplish this distinction:<br>
+<br><code>
+<switch select="sys"><br>
+ <case select="UNIX"><br>
+ <paragraph>Mount the cd rom drive.</paragraph><br>
+ </case><br>
+</switch><br>
+</code>
+
+<h4>Switching Text Fragments Inside Paragraphs</h4>
+
+This type is used if only smal text fragments differ on different platforms or <br>
+applications. A typical case is the use of shortcuts on different systems, or the <br>
+notation of file paths on different platforms. <br>
+For example, while on Windows the standard instal ation path for OpenOffice.org <br>
+could be something like C:\Program Files\OpenOffice.org-2.0, it could be <br>
+~/OpenOffice.org-2.0 on a Unix system, making it necessary to distinguish <br>
+between the operating environments when talking about these paths. The <br>
+switchinline element can be used to accomplish the distinction:<br>
+<br><code>
+<paragraph>The software will be installed in the <br>
+<switchinline select="sys"><br>
+ <caseinline select="UNIX"><br>
+ ~/OpenOffice.org-2.0<br>
+ </caseinline><br>
+ <caseinline select="WIN"><br>
+ C:\Program Files\OpenOffice.org-2.0<br>
+ </caseinline><br>
+ <defaultinline><br>
+ home<br>
+ </defaultinline><br>
+</switchinline><br>
+directory.</paragraph><br>
+</code>
+In the code example above, there is also a default value defined by using the optional <br>
+defaultinline element, which is shown if neither UNIX nor WIN is set as the platform <br>
+value when cal ing the help.<br>
+
+<h3>Embedding Content</h3>
+
+You can also reduce redundant content by defining reusable text fragments and <br>
+blocks, which can be referenced from other places. The references are resolved at <br>
+runtime when the help is displayed, and are temporarily resolved at compile time <br>
+when the ful text search index is generated.<br>
+There are two ways of reusing content by means of embedding:<br>
+<br>
+Embedding complete sections<br>
+<br>
+Embedding text fragments<br>
+<b>28</b><br>
+<hr>
+<A name=29></a>
+<h4>Embedding Complete Sections</h4><br>
+Single or multiple paragraphs can apply to more than one help file. For example, <br>
+standard steps inside procedures can be written once and embedded in multiple <br>
+places, reducing maintenance and translation effort.<br>
+The URL for the reference takes the form file#id. If, for instance, the section with <br>
+the ID 12345 from the file text/writer/01/012345.xhp is to be embedded, the URL <br>
+would be text/swriter/01/012345.xhp#12345. The file name refers to the path and <br>
+name that is stored in the jar files.<br>
+Complete sections can be embedded using the embed element. The section to be <br>
+embedded is referenced using the attribute ID, which must be unique within the file.<br>
+If, for example, multiple processes described in the help involve logging on to a <br>
+computer, this particular step can be written once and embedded wherever required:<br>
+<i>Example</i><br>
+Original location (filename: original.xhp):<br>
+<br><code>
+<section id="logon"><br>
+ <paragraph id="par_id12345" role="paragraph" xml-lang="en-US"><br>
+ Log on to your computer using your user name and password.<br>
+ </paragraph><br>
+</section><br>
+Referenced location:<br>
+<paragraph id="par_id9876" role="heading" level="1" xml-lang="en-US"><br>
+ Starting %PRODUCTNAME<br>
+</paragraph><br>
+<list><br>
+ <listitem><embed href="original.xhp#logon"/></listitem><br>
+ <listitem><br>
+ <paragraph id="par_id9877" role="paragraph" xml-lang="en-US"><br>
+ Start %PRODUCTNAME</paragraph><br>
+ </listitem><br>
+</list><br>
+</code>
+This results in the following:<br>
+<br><code>
+<b>Starting OpenOffice.org</b><br>
+1. Log on to your computer using your user name and your password.<br>
+2. Start OpenOffice.org<br>
+</code>
+
+<h4>Embedding Text Fragments</h4>
+
+Text fragments can, for example, represent commonly used phrases or names of UI <br>
+elements. These can be specified once and used in multiple places, reducing <br>
+maintenance and localization effort. <br>
+<b>29</b><br>
+<hr>
+<!--Page 30-->
+<A name=30></a>The URL for the reference takes the form <code><b>file#id</b></code>. If, for instance, the variable with
+the ID 12345 from the file text/swriter/01/012345.xhp is to be embedded, the <br>
+URL would be text/writer/01/012345.xhp#12345. The file name refers to the path <br>
++ name that is stored in the jar files.<br>
+These fragments can be embedded using the embedvar element if they are previously <br>
+defined as being variables, so that they can be referenced. The text fragment to be <br>
+embedded is placed inside a variable element and assigned a unique ID using the <br>
+element's id attribute:<br>
+Original location (filename: original.xhp):<br>
+<p>><code>
+<paragraph id="par_id1234">Press the <variable id="btn_prnprev"><item <br>
+type="button">Print Preview</item></variable> button.</paragraph><br>
+The fragment can then be referenced in other locations using the embedvar element:<br>
+Referenced location:<br>
+<paragraph id="par_id9876">A preview can be shown using the <embedvar <br>
+href="original.xhp#btn_prnprev"/> button.<br>
+</code>
+Result:<br>
+A preview can be shown using the <b>Print Preview</b> button.<br>
+If, for example, the name of the button changes from "Print Preview" to "Show <br>
+Preview" you only need to update one location to make the change available in al <br>
+referenced locations.<br><br>
+
+You can also embed the content of paragraphs by referring to the <b>paragraph ID</b>. Note <br>
+that only the contents of the paragraph are embedded. The paragraph formatting <br>
+information is disregarded:<br>
+Referenced location<br>
+<paragraph id="par_id433122"><embedvar <br>
+id="referenced.xhp#par_id9876"/><br>
+Result:<br>
+A preview can be shown using the <b>Print Preview</b> button.<br>
+
+<h3>Images and Icons</h3>
+
+Al images must be placed inside paragraphs. The image element contains <br>
+information about the image source in the src element and must be assigned a <br>
+unique ID. Every image element must also contain a child element alt that contains a <br>
+short description of the image used if the visual content is not displayed or cannot be <br>
+accessed by visual y impaired users.<br>
+<b>30</b><br>
+<hr>
+<!--Page 31 -->
+<A name=31></a>
+In addition to the alt element, there is also an optional caption element that can take <br>
+a long description as an image caption.<br>
+Starting with OpenOffice.org 2.0, the help retrieves al images from the central image <br>
+repository images.zip, which is available in the share/config directory of the <br>
+OpenOffice.org instal ation. This archive contains al images that OpenOffice.org <br>
+uses, separated by modules. The OpenOffice.org Help fetches any icons displayed in <br>
+the help files from here. Since this also is the place where the application fetched the <br>
+icons to display in the user interface, the icons in the help wil always be in sync with <br>
+the application, even if the images.zip archive contains a customized set of images.<br>
+The help itself also has a subdirectory inside the images.zip archive that contains al <br>
+images that are specific to the help and only used by it, for instance screen captures. <br>
+These images are stored under res/helpimg in the archive.<br>
+
+<h3>Localization Information</h3>
+
+Content that is to be localized is found inside elements with the xml-lang attribute <br>
+that contains the elements language code. Elements can be excluded from <br>
+localization by specifying the localize attribute and setting it to false. Any such <br>
+element <i>and all of its child elements</i> wil be excluded from the localization process.<br>
+ Note that the help does <i>not</i> as yet support the pseudo-language x-comment as value for xml-<br>
+lang to designate comments.<br>
+Al paragraphs contain an l10n attribute, which is used to specify the localization <br>
+status of the paragraph. This attribute was only used in the migration phase and is not <br>
+evaluated. It can be used to store a paragraph authoring status to implement basic <br>
+content management functionality.<br>
+
+<h3>Auxiliary Files</h3>
+
+Some auxiliary files are necessary, apart from the help files *.xhp to build the help <br>
+set. These are found in the source/auxiliary directory of the helpcontent2 <br>
+module. Some of them are just used for building the help, and some are included in <br>
+the helpset.<br>
+
+<h4>Files Used For Building The Help</h4>
+
+Apart from the makefile for this directory makefile.mk, there are a number of XSL <br>
+stylesheets used for help compilation:<br>
+<br>
+default.xsl<br>
+<b>31</b><br>
+<hr>
+<!-- Page 32 -->
+<A name=32></a><br>
+embed.xsl is used for resolving embedded sections in help files during <br>
+compile time to correctly process embedded sections when creating keyword <br>
+and ful text search index<br>
+<br>
+index.xsl is used by the corresponding JAVA routine for creating the ful text <br>
+search index<br>
+
+<h4>Main Transformation Stylesheet</h4>
+
+The main transformation stylesheet main_transform.xsl controls the last <br>
+transformation step of the XML files to HTML before they are displayed in the help <br>
+viewer. The file contains instructions on how to transform elements of the XML files to <br>
+HTML elements to be displayed. It also takes care of some formatting issues, and is <br>
+responsible for replacing variables used in the help files.<br>
+The help content provider passes some parameters to the stylesheet that are used for <br>
+file processing:<br>
+<br>
+Database this parameter identifies the help module context (see also <i><A href="HelpAuthorings.html#13">Help</i></a><br>
+<A href="HelpAuthorings.html#13"><i>Modules and Help Sections</i> </a>on page <A href="HelpAuthorings.html#13">13</a> ). It can have one of the values <br>
+swriter, scalc, sdraw, simpress, schart, sbasic, smath. This value is <br>
+used to evaluate <i>application switches</i> (see<A href="HelpAuthorings.html#27"> <i>Switching Content</i></a> on page <A href="HelpAuthorings.html#27">27</a>).<br>
+<br>
+System this parameter identifies the operating system/platform. This value is <br>
+used to evaluate <i>system switches</i> (see<A href="HelpAuthorings.html#27"> <i>Switching Content</i> </a>on page<A href="HelpAuthorings.html#27"> 27</a>).<br>
+<br>
+productname and productversion these parameters contain the name and <br>
+version string of the product (e.g. "OpenOffice.org" "2.0", or "StarOffice" "8"). <br>
+These are used to replace the variables <code>%PRODUCTNAME</code> and <br>
+<code>%PRODUCTVERSION</code> in the help content (see <i><A href="HelpAuthorings.html#23">Using Variables</i> </a>on page<A href="HelpAuthorings.html#23"> 23</a>).<br>
+<br>
+imgrepos this parameter contains the physical path to the image repository <br>
+images.zip used for requesting the images in the help files.<br>
+<br>
+Id this parameter contains the help ID cal ed. It is displayed in the error <br>
+message when the corresponding help file cannot be found.<br>
+<br>
+Language this parameter contains the current locale of the program.<br>
+
+<h4>Contents Definition Files *.tree</h4>
+
+A number of *.tree files contain the information used to display the table of contents <br>
+on the contents tab of the help viewer. These are XML files based on the fol owing <br>
+simple DTD:<br>
+<br><code>
+<!ELEMENT tree_view (help_section)+><br>
+<!ATTLIST tree_view<br>
+ version CDATA #REQUIRED<br>
+><br>
+<!ELEMENT help_section (node|topic)*><br>
+<!ATTLIST help_section<br>
+</code>
+<b>32</b><br>
+<hr>
+<!-- Page 33 -->
+<A name=33></a>
+<code>
+application CDATA #REQUIRED<br>
+id CDATA #REQUIRED<br>
+title CDATA #REQUIRED<br>
+><br>
+<!ELEMENT node (topic)*><br>
+<!ATTLIST node<br>
+id CDATA #REQUIRED<br>
+title CDATA #REQUIRED<br>
+><br>
+<!ELEMENT topic (#PCDATA)><br>
+<!ATTLIST topic<br>
+id CDATA #REQUIRED<br>
+><br>
+</code>
+<p>
+The main element tree_view encapsulates one or more help_sections that contain <br>
+one or more nodes with one or more topics (or further subnodes). The <br>
+help_sections are the top-most element in the table of contents as displayed by the <br>
+help viewer. Below that, there are nodes, represented by "book" icons in the help <br>
+viewer and, final y, topics that can be selected. A node can have sub-nodes.<br>
+<b>33</b><br>
+<hr>
+<!-- Page 34 -->
+<A name=34></a><hr>
+<!-- Page 35 -->
+<A name=35></a>
+<h2>3 Help File XML Reference</h2>
+This chapter lists all elements of the XML help file DTD in alphabetical order as <br>
+presented in the Document Type Definition in the Appendix.<br>
+The element sections presented here all share a common structure. The name of the <br>
+element serves as a heading and is followed by element details:<br>
+<br>
+<ul>
+<li>Element Description and Purpose</li>
+<br>
+<li>Attributes</li>
+<br>
+<li>Parent Elements</li>
+<br>
+<li>Child Elements</li>
+<br>
+<li>Element Definition</li>
+<br>
+<li>Element Example<br>
+Examples for elements can show an element within its parent or child context.</li>
+</ul>
+
+<h3>Common Attributes</h3>
+
+The following attributes are common to several elements.<br>
+
+<h4>Xml-Lang</h4><br>
+
+The xml-lang attribute designates elements that need localization. The localization <br>
+process identifies elements to be localized by this attribute. It contains the language of <br>
+the element it belongs to as a combination of language ISO code (<i>ISO 639-1</i>) and <br>
+country ISO code (<i>ISO 3166</i>), separated by a dash.<br>
+xml-lang="en-US"<br>
+Al elements containing text to be translated have an xml-lang attribute: alt, <br>
+bookmark, caption, paragraph, and title.<br>
+You can use the comment element to insert comments into the help file. But if they are <br>
+outside an element that wil be localized they wil not be recognized by the localizers.<br>
+<b>35</b><br>
+<hr>
+<!-- page 36 -->
+<A name=36></a>
+
+<h4>Localize<h4><br>
+The localize attribute can only take the value false and designates elements that <br>
+are excluded from the localization process. If an element contains the localize <br>
+attribute set to false, its contents and the contents of all child elements should not <br>
+be translated.[<A href="HelpAuthorings.html#36">9</a>] If the attribute contains any other value than false it wil be ignored. <br>
+The attribute is optional.<br>
+<code>
+localize="false"<br>
+</code>
+All elements containing text to be translated or subelements with text to be translated <br>
+have an optional localize attribute: alt, body, bookmark, bookmark_value, <br>
+caption, list, listitem, paragraph, section, switch, table, tablecell, <br>
+tablerow, and title.<br>
+
+<h4>Id</h4><br>
+The id element contains a unique string used to identify the element for localization <br>
+and referencing purposes. The ID must be <i>unique within a help file</i> so that referencing <br>
+across files and relocating sections and paragraphs across files is possible.<br>
+id="some_unique_value"<br>
+Al elements that can be embedded or have to be translated contain a mandatory id <br>
+attribute: image, bookmark, paragraph, section, table, title, topic, and <br>
+variable.<br>
+Valid characters for the id value are capital or smal letters from a-z, numbers from 0-<br>
+9, and the underscore, in any combination. Other characters are not al owed.[<A href="HelpAuthorings.html#36">10</a>]<br>
+9<br>
+They are automatically excluded in the Sun release engineering localization process.<br>
+10 For legacy reasons, the help files contain many IDs that are not valid XML "id" types. Therefore, the id attribute is defined in the DTD to be of <br>
+the type CDATA.<br>
+<b>36</b><br>
+<hr>
+<!--Page 37 -->
+<A name=37></a>
+<h3>Help File (*.xhp) Elements</h3>
+
+<h4>ahelp</h4>
+This element designates text that is to be used as extended tips (for instance, tool tips <br>
+or active help). It can contain text (PCDATA) and child elements. It can only be used as <br>
+a child of a paragraph.<br>
+
+<table border="1">
+<caption><b>Table 7: Attributes of the ahelp Element</b><caption<br>
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+<tr>
+<td> hid</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>The symbolic help ID for which <br>
+the content is to be displayed.</td>
+
+</tr>
+<tr>
+<td> visibility</td>
+<td>no</td>
+<td>fixed value</td>
+<td>"hidden", "visible"</td>
+<td>The visibility of the ahelp content <br>
+inside the help viewer. If set to <br>
+"hidden" the content is only <br>
+visible in the extended tips popup.<br></td>
+</tr>
+
+</table>
+
+
+
+<p><i>Parent Elements</i><br>
+caseinline, defaultinline, paragraph, variable<br>
+<p><i>Child Elements</i><br>
+comment, embedvar, br, emph, item, link, variable<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT ahelp (#PCDATA | embedvar | br | comment | emph | item | <br>
+ link | switchinline | variable)*><br>
+<!ATTLIST ahelp<br>
+ hid CDATA #REQUIRED<br>
+ visibility (hidden | visible) #IMPLIED<br>
+><br><br>
+<i>Example</i>:<br>
+<code>
+<ahelp hid="HID_SOME_HID" visibility="hidden"><br>
+You will only see this text in the extended tips for the ui control <br>
+with the help id HID_SOME_HID.<br>
+</ahelp><br>
+</code>
+
+<b>37</b><br>
+<hr>
+<!-- Page 38 -->
+<A name=38></a>
+<h4>Alt</h4>
+This element is used to specify an alternative text for an image. It corresponds to the <br>
+HTML attribute of the same name and can only contain PCDATA that is localized (no <br>
+markup).<br>
+<i>Attributes</i><br>
+
+<table border="1">
+<caption><b>Table 8: Attributes of the alt element</b><caption<br>
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>xml-lang </td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>See <A href="HelpAuthorings.html#35">Common Attributes </a>on page <br>
+<A href="HelpAuthorings.html#35">35.</a><br></td>
+</tr>
+<tr>
+<td>id </td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>A unique ID to identify the <br>
+element, <A href="HelpAuthorings.html#35">see Common Attributes </a><br>
+on page <A href="HelpAuthorings.html#35">35</a>.<br></td>
+</tr>
+<tr>
+<td> localize</td>
+<td>no</td>
+<td>fixed value</td>
+<td>"false"</td>
+<td>See <A href="HelpAuthorings.html#35">Common Attributes </a>on page <br>
+<A href="HelpAuthorings.html#35">35.</a><br></td>
+</tr>
+</table>
+
+<p><i>Parent Elements</i><br>
+image<br>
+<p><i>Child Elements</i><br>
+none<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT alt (#PCDATA)><br>
+<!ATTLIST alt<br>
+ xml-lang CDATA #REQUIRED<br>
+ id CDATA #REQUIRED<br>
+ localize CDATA #IMPLIED<br>
+><br><br>
+
+<i>Example</i>:<br>
+<code>
+<image src="img/imagefile.png" id="img_id1235"><br>
+<alt xml-lang="en-US" id="alt_id1235">Dialog File Open</alt><br>
+</image><br><br>
+</code>
+
+<h4>Body</h4>
+This element contains al help content information. It cannot itself contain any <br>
+PCDATA, but rather only child elements.<br>
+
+<table border="1">
+<caption><b>Table 9: Attributes of the body element</b><caption
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+<tr>
+<td> localize</td>
+<td>no</td>
+<td>fixed value</td>
+<td>"false"</td>
+<td>See <A href="HelpAuthorings.html#35">Common Attributes </a>on page <br>
+<A href="HelpAuthorings.html#35">35.</a><br></td>
+</tr>
+</table>
+<b>38</b><br>
+<hr>
+<!--Page 39 -->
+<A name=39></a>
+<p><i>Parent Elements</i><br>
+helpdocument<br>
+<p><i>Child Elements</i><br>
+section, paragraph, table, comment, bookmark, switch, embed, list, sort<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT body (section | paragraph | table | comment | bookmark | <br>
+ switch | embed | list | sort)*><br>
+<!ATTLIST body<br>
+ localize CDATA #IMPLIED<br>
+><br><br>
+
+<i>Example</i>:<br>
+<code>
+<body><br>
+<paragraph>This is the content of a help file</paragraph><br>
+</body><br><br>
+</code>
+
+<h4>Bookmark</h4>
+This element contains information about a bookmark used in the help files. The <br>
+bookmark type is specified inside the branch attribute of the bookmark element while the <br>
+bookmark value is defined in the child element bookmark_value. For more information <br>
+about the bookmarking system in the help please refer to <i><A href="HelpAuthorings.html#25">Defining Index, Contents, and</i></a><br>
+<A href="HelpAuthorings.html#25"><i>Context Sensitivity</i></a> on page <A href="HelpAuthorings.html#25">25</a>.<br>
+
+
+<table border="1">
+<caption><b>Table 10: Attributes of the bookmark element</b><caption
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+
+<tr>
+<td> branch</td>
+<td>yes</td>
+<td>fixed value</td>
+<td>"contents"<br>"index"<br>"hid"</td>
+<td>The bookmark type specified by the <br>branch inside the unified bookmarks <br>tree. <A href="HelpAuthorings.html#25">See <i>Defining Index, Contents, and</i></a><br>
+<A href="HelpAuthorings.html#25"><i>Context Sensitivity</i> </a>on page <A href="HelpAuthorings.html#25">25</a>.<br></td>
+</tr>
+
+<tr>
+<td> xml-lang</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>See <i><A href="HelpAuthorings.html#35">Common Attributes </i></a>on page <A href="HelpAuthorings.html#35">35.</a></td>
+</tr>
+
+<tr>
+<td> localize</td>
+<td>no</td>
+<td>fixed values</td>
+<td>"false"</td>
+<td>"false"</td>
+</tr>
+</table>
+
+
+
+
+<p><i>Parent Elements</i><br>
+body, case, default, section, topic, tablecell, listitem<br>
+<p><i>Child Elements</i><br>
+bookmark_value<br>
+<b>39</b><br>
+<hr>
+<!--Page 40 -->
+<A name=40></a>
+<p><i>Element Definition</i><br>
+<!ELEMENT bookmark (bookmark_value)*><br>
+<!ATTLIST bookmark<br>
+ branch CDATA #REQUIRED<br>
+ xml-lang CDATA #REQUIRED<br>
+ id CDATA #REQUIRED<br>
+ localize CDATA #IMPLIED<br>
+><br><br>
+
+<i>Example</i>:<br>
+<code>
+<bookmark branch="contents" xml-lang="en-US" id="bm_id1234"><br>
+ <bookmark_value><br>
+ StarOffice Writer Help/Working with Fields/Editing Field Contents<br>
+ </bookmark_value><br>
+</bookmark><br>
+<bookmark branch="index" xml-lang="en-US" id="bm_id9876"><br>
+ <bookmark_value><br>
+ Formulas/Exporting<br>
+ </bookmark_value><br>
+</bookmark><br>
+<bookmark branch="hid/12345"/><br><br>
+</code>
+
+<h4>Bookmark_value</h4>
+This element contains the value of a bookmark. See <A href="HelpAuthorings.html#25"> <i>Defining Index, Contents, and</i></a><br>
+<A href="HelpAuthorings.html#25"><i>Context Sensitivity</i> </a>on page<A href="HelpAuthorings.html#25"> 25 </a>for details.<br>
+
+<p><i>Parent Elements</i><br>
+bookmark<br>
+<p><i>Child Elements</i><br>
+embedvar<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT bookmark_value (#PCDATA | embedvar)*><br><br>
+
+<i>Example</i>:<br>
+<code>
+<bookmark branch="contents" xml-lang="en-US" id="bm_123"><br>
+ <bookmark_value><br>
+StarOffice Writer Help/Working with Fields/Editing Field Contents<br>
+ </bookmark_value><br>
+</bookmark><br>
+<bookmark branch="index/scalc" xml-lang="en-US" id="bm_543"><br>
+ <bookmark_value><br>
+ Formulas/Exporting<br>
+ </bookmark_value><br>
+</bookmark><br>
+<bookmark branch="index/scalc" xml-lang="de-DE" id="bm_543"><br>
+ <bookmark_value><br>
+ Formeln/Exportieren<br>
+ </bookmark_value><br>
+</bookmark><br>
+</code>
+
+<b>40</b><br>
+<hr>
+
+<!--Page 41-->
+<A name=41></a>
+<h4>Br</h4>
+This element can be used to place a manual line break. It works like the <br>
+corresponding HTML <br> element. The element itself is empty.<br>
+<p><i>Parent Elements</i><br>
+ahelp, caption, caseinline, defaultinline, paragraph, variable<br>
+<p><i>Child Elements</i><br>
+none<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT br EMPTY><br><br>
+
+<i>Example</i>:<br>
+<code>
+<paragraph>This line must have a<b><br/></b>manual<b><br/></b>line <br>
+break.</paragraph><br>
+</code>
+
+<h4>Caption</h4>
+This element specifies the (optional) caption of an image or a table.<br>
+
+
+<table border="1">
+<caption><b>Table 11: Attributes of the caption element</b><caption<br>
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+
+<tr>
+<td> xml-lang</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>See <i><A href="HelpAuthorings.html#35">Common Attributes </i></a>on page <A href="HelpAuthorings.html#35">35.</a></td>
+</tr>
+
+<tr>
+<td>id</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>A unique ID to identify the <br>
+element, <A href="HelpAuthorings.html#35">see <i>Common Attributes</a> </i><br>
+on <A href="HelpAuthorings.html#35">page 35.</a><br></td>
+</tr>
+
+<tr>
+<td> localize</td>
+<td>no</td>
+<td>fixed values</td>
+<td>"false"</td>
+<td>"false"</td>
+</tr>
+</table>
+
+<p><i>Parent Elements</i><br>
+image, table<br>
+<p><i>Child Elements</i><br>
+embedvar, br, emph, item, link, switchinline, variable<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT caption (#PCDATA | embedvar | br | emph | item | link | <br>
+ switchinline | variable)*><br>
+<!ATTLIST caption<br>
+ xml-lang CDATA #REQUIRED<br>
+ id CDATA #REQUIRED<br>
+ localize CDATA #IMPLIED<br>
+><br>
+<b>41</b><br>
+<hr>
+
+<!--Page 42 -->
+<A name=42></a>
+<i>Example</i>:<br>
+<code>
+<table><br>
+<b><caption xml-lang="en-US" id="cp_1234"></b><br>
+<b> List of all <item type="productname">StarOffice</item> slots.</b><br>
+<b></caption></b><br>
+</table><br>
+</code>
+
+<h4>Case</h4>
+This elements holds the cases of a switch statement.<br>
+
+
+
+<table border="1">
+<caption><b>Table 12: Attributes of the case element</b><caption<br>
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+
+<tr>
+<td> select</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>Contains the value that is to be <br>
+evaluated. S<A href="HelpAuthorings.html#27">ee <i>Switching Content</a> </i><br>
+on page <A href="HelpAuthorings.html#27">27</a> for more information.<br></td>
+</tr>
+</table>
+
+
+<p><i>Parent Elements</i><br>
+switch<br>
+<p><i>Child Elements</i><br>
+paragraph, table, comment, bookmark, embed, list, switch, section<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT case (paragraph | table | comment | bookmark | embed | <br>
+ link | list | switch | section)*><br>
+<!ATTLIST case<br>
+ select CDATA #REQUIRED<br>
+><br><br>
+
+<i>Example</i>:<br>
+<code>
+<switch select="sys"><br>
+ <b><case select="WIN"></b><br>
+<b> <paragraph>This appears in Windows.</paragraph></b><br>
+<b> </case></b><br>
+ <b><case select="UNIX"></b><br>
+<b> <paragraph>This appears in Unix.</paragraph></b><br>
+<b> </case></b><br>
+ <default><br>
+ <paragraph>This appears in all other cases</paragraph><br>
+ </default><br>
+</switch><br>
+</code>
+<b>42</b><br>
+<hr>
+<!--Page 43 -->
+<A name=43></a>
+
+<h4>Caseinline</h4>
+This element holds the cases for an switchinline statement.<br>
+
+<table border="1">
+<caption><b>Table 13: Attributes of the caseinline element</b><caption<br>
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+
+<tr>
+<td> select</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>Contains the value that is to be <br>
+evaluated. S<A href="HelpAuthorings.html#27">ee <i>Switching Content</a> </i><br>
+on page <A href="HelpAuthorings.html#27">27</a> for more information.<br></td>
+</tr>
+</table>
+
+<p><i>Parent Elements</i><br>
+switchinline<br>
+<p><i>Child Elements</i><br>
+image, embedvar, br, emph, item, link, switchinline, variable, ahelp, object<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT caseinline (#PCDATA | image | embedvar | br | emph | <br>
+ item | link | switchinline | variable | <br>
+ ahelp | object)*><br>
+<!ATTLIST caseinline<br>
+ select CDATA #REQUIRED<br>
+><br><br>
+<i>Example</i>:<br>
+<code>
+<paragraph>Press the <br>
+ <switchinline select="sys"><br>
+ <b><caseinline select="WIN">Ctrl</caseinline></b><br>
+ <b><caseinline select="MAC">Apple</caseinline></b><br>
+ <defaultinline>any</defaultinline><br>
+ </switchinline> <br>
+ key to start.<br>
+ </paragraph><br><br>
+ </code>
+
+<h4>Comment</h4>
+This element is used for inserting comments into the help files used by the <br>
+author/editor/translator. They are to be removed when the help files are compiled.<br>
+<i>Attributes</i><br>
+none<br>
+<p><i>Parent Elements</i><br>
+body, case, default, list, listitem, section, switch, tablecell<br>
+<b>43</b><br>
+<hr>
+<!--Page 44 -->
+<A name=44></a>
+<p><i>Child Elements</i><br>
+none<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT comment (#PCDATA)><br><br>
+
+<i>Example</i>:<br>
+<code>
+<section><br>
+ <b><comment>FPE: This section is in a draft state!</comment></b><br>
+ </section><br><br>
+ </code>
+
+<h4>Created</h4>
+This element holds the date of document creation and additional information (author <br>
+or comment).<br>
+
+
+
+<table border="1">
+<caption><b>Table 14: Attributes of the created element</b><caption<br>
+<tr>
+<th>Attribute</th>
+<th>Required</th>
+<th>Content</th>
+<th>Values Allowed</th>
+<th>Description</th>
+</tr>
+
+<tr>
+<td> date</td>
+<td>yes</td>
+<td>CDATA</td>
+<td></td>
+<td>Contains the date of document <br>
+creation in the format<br>
+YYYY-MM-DDThh:mm:ss<br>
+where: <br>
+YYYY = four-digit year<br>
+ MM = two-digit month <br>
+ DD = two-digit day of month<br>
+ hh = two digits of 24 hour<br>
+ mm = two digits of minute<br>
+ ss = two digits of second<br></td>
+</tr>
+</table>
+
+<p><i>Parent Elements</i><br>
+history<br>
+<p><i>Child Elements</i><br>
+none<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT created (#PCDATA)><br>
+<!ATTLIST created<br>
+ date CDATA #REQUIRED<br>
+><br><br>
+
+<i>Example</i>:<br>
+<code>
+<meta><br>
+ <history><br>
+ <b><created date="2002-05-20T15:15:00">New topic created</created></b><br>
+ <lastedited date="2002-06-20T15:15:00">Made changes</lastedited><br>
+ </history><br>
+</meta><br>
+</code>
+
+<b>44</b><br>
+<hr>
+<!-- Page 45-->
+<A name=45></a>
+<h4>Default</h4>
+This elements holds the default values for a switch. It is evaluated if al case <br>
+elements of a switch element evaluate to false.<br>
+<i>Attributes</i><br>
+none<br>
+<p><i>Parent Elements</i><br>
+switch<br>
+<p><i>Child Elements</i><br>
+paragraph, table, comment, bookmark, embed, list, section<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT default (paragraph | table | comment | bookmark | <br>
+ embed | link | list | switch | section)*><br><br>
+
+<i>Example</i>:<br>
+<code>
+<switch select="sys"><br>
+ <case select="WIN"><br>
+ <paragraph>This appears in Windows.</paragraph><br>
+ </case><br>
+ <case select="UNIX"><br>
+ <paragraph>This appears in Unix.</paragraph><br>
+ </case><br>
+<b> <default></b><br>
+<b> <paragraph>This appears in all other cases</paragraph></b><br>
+<b> </default></b><br>
+</switch><br>
+</code>
+
+<h4>Defaultinline</h4>
+This elements holds the default values for an inline switch. It is evaluated if all <br>
+caseinline elements of a switchinline element evaluate to false.<br>
+<i>Attributes</i><br>
+none<br>
+<p><i>Parent Elements</i><br>
+switchinline<br>
+<p><i>Child Elements</i><br>
+image, embedvar, br, emph, item, link, switchinline, variable, ahelp, object<br>
+<p><i>Element Definition</i><br>
+<!ELEMENT defaultinline (#PCDATA | image | embedvar | br | emph | <br>
+ item | link | switchinline | variable | <br>
+ ahelp | object)*><br>
+<b>45</b><br>
+<hr>
+<!--Page 46-->
+<A name=46></a>
+<i>Example</i>:<br>
+<code>
+<paragraph>Press the <br>
+ <switchinline select="sys"><br>
+ <caseinline select="WIN">Ctrl</caseinline><br>
[... 3561 lines stripped ...]