| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> |
| |
| <HTML> |
| <HEAD> |
| <meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8"></meta> |
| <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-passthru.html#23">2:</a> <br> |
| "<a href="HelpAuthorings-passthru.html#23"><i>Help File XML format Basics</i></a>" on page<a href="HelpAuthorings-passthru.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><i>Page 9</i></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-passthru.html#16"> <i>Application Help Calls</i></a> on page <a href="HelpAuthorings-passthru.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-passthru.html#12"> Fig. 1 </a>on page<a href="HelpAuthorings-passthru.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-passthru.html#12">Fig. 2</a> on page <a href="HelpAuthorings-passthru.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 index list.<br> |
| The keywords are defined inside the help files as bookmarks. See also section <br> |
| <a href="HelpAuthorings-passthru.html#95"><i>Bookmarks</i></a> on page <a href="HelpAuthorings-passthru.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-passthru.html#12"> Fig. 3 </a>on page<a href="HelpAuthorings-passthru.html#12"> 12</a>).<br> |
| <b><i>Page 10</i></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-passthru.html#12">Fig. 4</a> on page <a href="HelpAuthorings-passthru.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><i>Page 11</i></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><i>Page 12</i></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-passthru.html#16">see <i>The Main</i></a> |
| <a href="HelpAuthorings-passthru.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-passthru.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-passthru.html#15">Help Module Contents</i></a> |
| <a href="HelpAuthorings-passthru.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-passthru.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-passthru.html#15">Help</i></a> |
| <a href="HelpAuthorings-passthru.html#15"><i>Module Contents Files (Section Archives)</i> </a>)<a href="HelpAuthorings-passthru.html#13">[1</a>]</td> |
| </tr> |
| <tr> |
| <td>help/{lang}/{module}.cfg</td> |
| <td>The configuration files for a help module (<a href="HelpAuthorings-passthru.html#14">see <i>Help Module</i></a> |
| <a href="HelpAuthorings-passthru.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-passthru.html#15">see <i>Help Module Lookup</i></a><br> |
| <a href="HelpAuthorings-passthru.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-passthru.html#15">see <i>Help Module Extended</i></a> |
| <a href="HelpAuthorings-passthru.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-passthru.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-passthru.html#15">Help Module Contents</i></a></td> |
| </tr> |
| </table> |
| |
| |
| <a href="HelpAuthorings-passthru.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><i>Page 13</i></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-passthru.html#18"> <i>Structure of the CVS Help Module</i></a> on page <a href="HelpAuthorings-passthru.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-passthru.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-passthru.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><i>Page 14</i></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-passthru.html#99"><i>Switching Content</i> </a>on page<a href="HelpAuthorings-passthru.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-passthru.html#13">Help</i></a><br> |
| <a href="HelpAuthorings-passthru.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-passthru.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-passthru.html#16">Application Help</i></a><br> |
| <a href="HelpAuthorings-passthru.html#16"><i>Cal s</i> </a>on page<a href="HelpAuthorings-passthru.html#16"> 16</a>). The data for that table come from the bookmark elements in the <br> |
| help files (see<a href="HelpAuthorings-passthru.html#95"> <i>Bookmarks</i></a> on page <a href="HelpAuthorings-passthru.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-passthru.html#95"> <i>Bookmarks</i></a> on page <a href="HelpAuthorings-passthru.html#95">95</a>). It is extracted from the <br> |
| help files at compile time.<br> |
| |
| <b><i>Page 15</i></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-passthru.html#95"><i>Bookmarks</i></a> on page <a href="HelpAuthorings-passthru.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-passthru.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><i>Page 16</i></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-passthru.html#13">Help Modules and</i></a><br> |
| <a href="HelpAuthorings-passthru.html#13"><i>Help Sections</i></a> on page <a href="HelpAuthorings-passthru.html#13">13)</a>.<br> |
| |
| <b><i>Page 17</i></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-passthru.html#75">see Authoring Help With OpenOffice.org </a>on <a href="HelpAuthorings-passthru.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-passthru.html#31">see Auxiliary Files</a> on <a href="HelpAuthorings-passthru.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-passthru.html#20">Makefiles for</i></a><br> |
| <a href="HelpAuthorings-passthru.html#20"><i>linking the compiled files</i> </a>on page <a href="HelpAuthorings-passthru.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><i>Page 18</i></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><i>Page 19</i></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><i>Page 20</i></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><i>Page 21</i></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><i>Page 22</i></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><i>Page 23</i></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-passthru.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-passthru.html#16"> <i>The Main Transformation Style Sheet</i> </a>on page<a href="HelpAuthorings-passthru.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-passthru.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-passthru.html#86">Paragraph Formatting</i></a> on <br> |
| page <a href="HelpAuthorings-passthru.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><i>Page 24</i></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><i>Page 25</i></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-passthru.html#98">Determining A Help ID</i></a> on <br> |
| page <a href="HelpAuthorings-passthru.html#98">98</a>.<br> |
| |
| <b><i>Page 26</i></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:<br><br> |
| |
| <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-passthru.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:<br><br> |
| |
| 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> |
| <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><i>Page 27</i></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><i>Page 28</i></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><i>Page 29</i></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><i>Page 30</i></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><i>Page 31</i></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-passthru.html#13">Help</i></a><br> |
| <a href="HelpAuthorings-passthru.html#13"><i>Modules and Help Sections</i> </a>on page <a href="HelpAuthorings-passthru.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-passthru.html#27"> <i>Switching Content</i></a> on page <a href="HelpAuthorings-passthru.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-passthru.html#27"> <i>Switching Content</i> </a>on page<a href="HelpAuthorings-passthru.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-passthru.html#23">Using Variables</i> </a>on page<a href="HelpAuthorings-passthru.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><i>Page 32</i></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><i>Page 33</i></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><i>Page 35</i></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-passthru.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-passthru.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><i>Page 36</i></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><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><i>Page 37</i></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><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-passthru.html#35">Common Attributes </a>on page <br> |
| <a href="HelpAuthorings-passthru.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-passthru.html#35">see Common Attributes </a><br> |
| on page <a href="HelpAuthorings-passthru.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-passthru.html#35">Common Attributes </a>on page <br> |
| <a href="HelpAuthorings-passthru.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><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-passthru.html#35">Common Attributes </a>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35.</a><br></td> |
| </tr> |
| </table> |
| <b><i>Page 38</i></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-passthru.html#25">Defining Index, Contents, and</i></a><a href="HelpAuthorings-passthru.html#25"><i>Context Sensitivity</i></a> on page <a href="HelpAuthorings-passthru.html#25">25</a>.<br><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-passthru.html#25">See <i>Defining Index, Contents, and</i></a><br> |
| <a href="HelpAuthorings-passthru.html#25"><i>Context Sensitivity</i> </a>on page <a href="HelpAuthorings-passthru.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-passthru.html#35">Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.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><i>Page 39</i></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-passthru.html#25"> <i>Defining Index, Contents, and</i></a><br> |
| <a href="HelpAuthorings-passthru.html#25"><i>Context Sensitivity</i> </a>on page<a href="HelpAuthorings-passthru.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><i>Page 40</i></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><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-passthru.html#35">Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.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-passthru.html#35">see <i>Common Attributes</a> </i><br> |
| on <a href="HelpAuthorings-passthru.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><i>Page 41</i></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> |
| <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-passthru.html#27">ee <i>Switching Content</a> </i><br> |
| on page <a href="HelpAuthorings-passthru.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><i>Page 42</i></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> |
| <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-passthru.html#27">ee <i>Switching Content</a> </i><br> |
| on page <a href="HelpAuthorings-passthru.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><i>Page 43</i></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> |
| <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><i>Page 44</i></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><i>Page 45</i></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> |
| <caseinline select="MAC">Apple</caseinline><br> |
| <h4><defaultinline>any</defaultinline></h4> |
| </switchinline> <br> |
| key to start.<br> |
| </paragraph><br><br> |
| </code> |
| |
| <b>Embed</b><br> |
| This element is used to embed content from a different source at the current position. <br> |
| The only elements that can be embedded from somewhere else are sections or <br> |
| paragraphs, which are identified by their URL. For smal er text fragments, embedvar <br> |
| can be used. See <i><a href="HelpAuthorings-passthru.html#28">Embedding Content</i> </a>on page <a href="HelpAuthorings-passthru.html#28">28.</a><br> |
| The optional role attribute can override the role of a paragraph. For embedded <br> |
| sections, the role attribute has no effect.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 15: Attributes of the embed element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>href<br></td> |
| <td>yes<br></td> |
| <td>URL<br></td> |
| <td></td> |
| <td>A URL pointing to the content to <br> |
| be embedded. The URL has the <br> |
| form filepath#id. Filepath is <br> |
| the path of the file as contained in <br> |
| the jar archive.<br></td> |
| </tr> |
| |
| <tr> |
| <td>role<br></td> |
| <td>no<br></td> |
| <td>see <i><a href="HelpAuthorings-passthru.html#24">Paragraph</i></a><br></td> |
| <td></td> |
| <td>The role in which the embedded <br> |
| <a href="HelpAuthorings-passthru.html#24"><i>Roles</i> </a>on page <a href="HelpAuthorings-passthru.html#24">24.</a> <br> |
| paragraph will appear. If this <br> |
| attribute is specified the <br> |
| paragraph is displayed with this <br> |
| role overwriting its original role <br> |
| (not applicable for sections).<br></td> |
| </tr> |
| |
| <tr> |
| <td>level<br></td> |
| <td>no<br></td> |
| <td>fixed values<br></td> |
| <td>numerical value<br></td> |
| <td>The heading level if the role <br> |
| attribute is set to "heading"<br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| body, case, default, listitem, section, tablecell<br> |
| <p><i>Child Elements</i><br> |
| none<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT embed EMPTY><br> |
| <!ATTLIST embed<br> |
| href CDATA #REQUIRED<br> |
| role CDATA #IMPLIED<br> |
| level CDATA #IMPLIED<br> |
| ><br> |
| <b><i>Page 46</i></b> |
| <hr> |
| <!--Page 47--> |
| <a name="47"></a> |
| <i>Example</i>:<br> |
| <code> |
| <embed href="text/swriter/guide/editing#4711"/><br> |
| <embed href="text/scalc/01/0123456#9876" role="warning"/><br><br> |
| </code> |
| |
| <h4>Embedvar</h4> |
| This element is used to embed smal er text fragments with and without markup, which <br> |
| were previously declared as being variables. See also<a href="HelpAuthorings-passthru.html#28"> <i>Embedding Content</i></a> on page <br> |
| <a href="HelpAuthorings-passthru.html#28">28</a>.<br> |
| |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 16: Attributes of the embedvar element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>href<br></td> |
| <td>yes<br></td> |
| <td>URL<br></td> |
| <td></td> |
| <td>A URL pointing to the content to <br> |
| be embedded. The URL has the <br> |
| form filepath#id. Filepath is <br> |
| the path of the file as contained in <br> |
| the jar archive.<br></td> |
| </tr> |
| |
| <tr> |
| <td>markup<br></td> |
| <td>no<br></td> |
| <td>fixed values<br></td> |
| <td>"keep"<br> |
| "ignore"<br></td> |
| <td>Specifies whether markup <br> |
| contained in the variable to be <br> |
| embedded is ignored or kept in <br> |
| the target position. The default is <br> |
| to keep markup within the text <br> |
| fragment.<br></td> |
| </tr> |
| </table> |
| |
| |
| |
| <p><i>Parent Elements</i><br> |
| ahelp, caption, caseinline, defaultinline, link, paragraph, variable<br> |
| <p><i>Child Elements</i><br> |
| none<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT embedvar EMPTY><br> |
| <!ATTLIST embedvar<br> |
| href CDATA #REQUIRED<br> |
| markup (keep | ignore) #IMPLIED<br> |
| ><br><br> |
| <i>Example</i>:<br> |
| <code> |
| <paragraph>This element can be found on the <b><embedvar </b><br> |
| <b>href="text/swriter/01/dialogs#fileopen" markup="ignore"/> </b><br> |
| dialog.</paragraph><br> |
| </code> |
| |
| <b><i>Page 47</i></b><br> |
| <hr> |
| <!--Page 48--> |
| <a name="48"></a> |
| <h4>Emph</h4> |
| This element is used to mark emphasized content. It can only contain PCDATA.<br> |
| |
| <i>Attributes</i>:<br> |
| none<br> |
| <p><i>Parent Elements</i>:<br> |
| ahelp, caption, caseinline, defaultinline, link, paragraph, variable<br></li> |
| <p><i>Child Elements</i>:<br> |
| item, comment, help-id-missing<br> |
| <p><i>Element Definition</i>:<br> |
| <!ELEMENT emph (#PCDATA | item | comment)*><br><br> |
| |
| |
| <i>Example</i>:<br> |
| |
| <code> |
| <paragraph><b><emph>Never</emph></b> delete the paragraph</paragraph><br> |
| </code> |
| |
| <h4>Filename</h4> |
| This element contains the path and name of the help topic file as included in the jar <br> |
| file, for example, text/swriter/01/1234567.xhp.<br><br> |
| |
| <i>Attributes</i>:<br> |
| none<br> |
| <p><i>Parent Elements</i>:<br> |
| topic<br></li> |
| <p><i>Child Elements</i>:<br> |
| none<br> |
| <p><i>Element Definition</i>:<br> |
| <!ELEMENT filename (#PCDATA)><br><br> |
| |
| |
| <i>Example</i>:<br> |
| <code> |
| <filename>text/swriter/01/08154711.xhp</filename><br> |
| </code> |
| |
| <b><i>Page 48</i></b><br> |
| <hr> |
| <!--Page 49--> |
| <a name="49"></a> |
| <h4>Helpdocument</h4> |
| This is the root element of a help document and contains the meta and body part of <br> |
| the help topic.<br> |
| |
| <table border="1"> |
| <caption><b>Table 17: Attributes of the helpdocument element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>ontents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>yes</td> |
| <td>CDATA</td> |
| <td>Contains the Help XML format <br> |
| version number currently 1.0) for <br> |
| compatibility to future versions.<br></td> |
| </tr> |
| </table> |
| |
| |
| <p><i>Parent Elements</i>:<br> |
| none<br> |
| <p><i>Child Elements</i>:<br> |
| meta, body<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT helpdocument (meta, body)><br> |
| <!ATTLIST helpdocument<br> |
| version CDATA #REQUIRED<br> |
| ><br> |
| <i>Example</i>:<br> |
| <code> |
| <b><helpdocument version="1.0"></b><br> |
| <meta></meta><br> |
| <body></body><br> |
| <b></helpdocument></b><br><br> |
| </code> |
| |
| <h4>Help-id-missing</h4> |
| This element is only used to display the help ID for a help file that cannot be found. It <br> |
| is only used in the help error page and replaced by the missing help ID.<br> |
| <p><i>Parent Elements</i>:<br> |
| <p><i>Child Elements</i>:<br> |
| None<br> |
| <p><i>Element Definition</i>:<br> |
| <!ELEMENT help-id-missing EMPTY><br> |
| <b><i>Page 49</i></b><br> |
| <hr> |
| <a name="50"></a> |
| |
| <h4>History</h4> |
| This element contains information about the author and the date of creation, as wel <br> |
| as the same information about the last editing cycle.<br> |
| |
| <i>Attributes</i>:<br> |
| none<br></li> |
| <p><i>Parent Elements</i><br> |
| meta<br></li> |
| <p><i>Child Elements</i><br> |
| created, lastedited<br></ |
| <p><i>Element Definition</i>:<br> |
| <!ELEMENT history (created, lastedited)><br> |
| <br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <meta><br> |
| <b> <history></b><br> |
| <created date="2002-05-20T15:15:00">New topic created</created><br> |
| <lastedited date="2002-06-20T15:15:00">Made changes</created><br> |
| <b> </history></b><br> |
| </meta><br><br> |
| </code> |
| |
| <h4>Image</h4> |
| This element carries information about images in the document.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 18: Attributes of the image element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>src</td> |
| <td>yes</td> |
| <td>URL</td> |
| <td>A URL pointing to the image as <br> |
| <td>included in the picture archive <br> |
| picture.jar.</td> |
| </tr> |
| <tr> |
| <td>width</td> |
| <td>no</td> |
| <td>CDATA</td> |
| <td>The image width. If missing, it is <br> |
| set to 100%.</td> |
| </tr> |
| <tr> |
| <td>height</td> |
| <td>no</td> |
| <td>CDATA</td> |
| <td>The image height. If missing, it is <br> |
| set to 100%</td> |
| </tr> |
| <tr> |
| <td>id</td> |
| <td>yes</td> |
| <td>CDATA</td> |
| <td>A unique ID to identify the image, <br> |
| see <i><a href="HelpAuthorings-passthru.html#35">Common Attributes </i></a>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35.</a><br></td> |
| </tr> |
| <tr> |
| <td>localize</td> |
| <td>no</td> |
| <td>CDATA</td> |
| <td>Used to designate images that <br> |
| need localization. Used by the <br> |
| transformation style sheet. Only <br> |
| the value true is recognized.<br></td> |
| </tr> |
| </table> |
| |
| |
| <b><i>Page 50</i></b><br> |
| <hr> |
| |
| <!--Page 51--> |
| <a name="51"></a> |
| <p><i>Parent Elements</i>:<br> |
| caseinline, defaultinline, paragraph, variable, tablecell<br> |
| <p><i>Child Elements</i>:<br> |
| caption, alt<br> |
| <p><i>Element Definition</i>:<br> |
| <code> |
| <!ELEMENT image (caption* | alt+)?><br> |
| <!ATTLIST image<br> |
| src CDATA #REQUIRED<br> |
| width CDATA #IMPLIED<br> |
| height CDATA #IMPLIED<br> |
| id CDATA #REQUIRED<br> |
| ><br> |
| </code> |
| <br> |
| |
| <code> |
| <i>Example</i>:<br> |
| <code> |
| <b><image src="picture/win/common/writermainwin.xhp" id="img4711" </b><br> |
| <b>width="75" height="75"></b><br> |
| <b> </b><caption xml-lang="en-US" id="cp4711"><br> |
| The <emph>main writer windows</emph> showing all <br> |
| writer toolbars.<br> |
| </caption><br> |
| <alt xml-lang="en-US" id="alt4711">Main program window</alt><br> |
| <b></image></b><br><br> |
| </code> |
| |
| <h4>Item</h4> |
| This generic element is used to mark up objects that are to be formatted in a unique <br> |
| way. The attribute type is used to specify the item type (a keystroke, a menu item, a <br> |
| dialog title etc). This element resembles the <span class=""> element in HTML.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 19: Attributes of the item element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>type</td> |
| <td>yes</td> |
| <td></td> |
| <td></td> |
| |
| <td>The item type that is used to <br> |
| format the data, for example <br> |
| "menuitem".<br></td> |
| </tr> |
| </table> |
| |
| |
| |
| <p><i>Parent Elements</i><br> |
| ahelp, caption, caseinline, defaultinline, link, paragraph, variable, emph<br> |
| <p><i>Child Elements</i><br> |
| none<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT item (#PCDATA)><br> |
| <!ATTLIST item<br> |
| type CDATA #REQUIRED<br> |
| ><br> |
| <b><i>Page 51</i></b><br> |
| <hr> |
| <!--Page52--> |
| <a name="52"></a> |
| <i>Example</i>:<br> |
| <code> |
| <paragraph>You see the <b><item type="dialog">File Open</item></b> dialog. <br> |
| </paragraph><br> |
| </code> |
| |
| <h4>Lastedited</h4> |
| This element contains the date when the document was last edited inside the date <br> |
| attribute. Additional information can be specified as PCDATA.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 20: Attributes of the lastedited element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</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 when the <br> |
| document was last edited, in the <br> |
| 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 lastedited (#PCDATA)><br> |
| <!ATTLIST lastedited<br> |
| date CDATA #REQUIRED<br> |
| ><br> |
| <i>Example</i>:<br> |
| <code> |
| <meta><br> |
| <history><br> |
| <created date="2002-05-20T15:15:00">New topic created</created><br> |
| <b> <lastedited date="2002-06-20T15:15:00">Made changes</lastedited></b><br> |
| </history><br> |
| </meta><br> |
| </code> |
| |
| <b><i>Page 52</i></b><br> |
| <hr> |
| <!--Page 53--> |
| <a name="53"></a> |
| <h4>Link</h4> |
| This element contains a link to another document inside or outside the help system. <br> |
| For links to other help files, the URL syntax is<br> |
| filename#anchor_target<br> |
| with<br> |
| <br> |
| filename<br> |
| Path and name of the help file as contained in the help jar archive, for <br> |
| instance text/swriter/01/123345.xhp. <br> |
| <br> |
| |
| anchor_target<br> |
| Anchor target to jump to (optional). These can be the IDs of bookmarks, <br> |
| sections, or paragraphs.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 21: Attributes of the link element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>href<br> |
| <td>yes<br> |
| <td>URL<br> |
| <td>This contains the link address as <br> |
| URL.<br> |
| </tr> |
| <tr> |
| <td>name<br> |
| <td>yes<br> |
| <td></td> |
| <td></td> |
| <td>This is the link name, needed to <br> |
| fulfill accessibility requirements.<br> |
| </tr> |
| <tr> |
| <td>type<br> |
| <td>no<br> |
| <td></td> |
| <td></td> |
| <td>This specifies the link type, for <br> |
| example, a popup. Currently not <br> |
| evaluated.<br> |
| </tr> |
| <tr> |
| target<br> |
| no<br> |
| Can be used to specify a target <br> |
| frame.<br> |
| </tr> |
| </table> |
| |
| |
| |
| <p><i>Parent Elements</i><br> |
| ahelp, caption, caseinline, defaultinline, paragraph, variable<br> |
| <p><i>Child Elements</i><br> |
| emph, item, variable, embedvar, switchinline<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT link (#PCDATA | embedvar | emph | item | variable | <br> |
| switchinline)*><br> |
| <!ATTLIST link<br> |
| href CDATA #REQUIRED<br> |
| name CDATA #REQUIRED<br> |
| type CDATA #IMPLIED<br> |
| target CDATA #IMPLIED<br> |
| ><br> |
| <b><i>Page 53</i></b><br> |
| <hr> |
| <!--Page 54 --> |
| |
| <a name="54"></a> |
| <i>Example</i>:<br> |
| Please refer to <b><link href="http://www.openoffice.org" name="Link to </b><br> |
| <b>the OpenOffice.org Website">the <emph>OpenOffice.org</emph> </b><br> |
| <b>website</link></b> for further details.<br> |
| More details can be found in <b><link </b><br> |
| <b>href="text/common/guide/overview.xhp" name="Link to the overview">the </b><br> |
| <b>overview</link></b>.<br> |
| |
| <h4>List</h4> |
| This element represents ordered (numbered) and unordered (bul eted) lists. The <br> |
| element itself does not contain any PCDATA, but only child elements that carry the <br> |
| content or comments.<br> |
| <i>Attributes</i><br> |
| Note that not all attributes are currently evaluated in the transformation style sheet (see also <i><a href="HelpAuthorings-passthru.html#16">The</i></a><br> |
| |
| <a href="HelpAuthorings-passthru.html#16"> |
| <i>Main Transformation Style Sheet</i></a> on <a href="HelpAuthorings-passthru.html#16">page 16)</a><br> |
| |
| <table border="1"> |
| <caption><b>Table 22: Attributes of the list element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>type</td> |
| <td>yes</td> |
| <td>fixed </td> |
| <td> |
| "ordered" or <br> |
| "unordered"</td> |
| <td>Describes the list type as either being <br> |
| <b>ordered</b> (numbered) or <b>unordered </b> |
| (bulleted).<br></td> |
| <tr> |
| <td>startwith</td> |
| <td>no</td> |
| <td>CDATA</td> |
| <td></td> |
| <td>The starting number of an ordered list; if <br> |
| omitted, the list starts with 1.<br></td> |
| </tr> |
| <tr> |
| <td>format</td> |
| <td>no</td> |
| <td>fixed </td> |
| <td>"1", "i", "I", "a", </td> |
| <td> |
| The number format used in numbered <br> |
| values<br> |
| "A"<br> |
| (ordered) lists:<br> |
| |
| "1": arabic numerals<br> |
| "i": small roman numerals<br> |
| "I": capital roman numerals<br> |
| "a": small letters<br> |
| "A": capital letters<br> |
| If omitted the list uses "1".<br></td> |
| </tr> |
| <tr> |
| <td>bullet<br></td> |
| <td>no<br></td> |
| <td>fixed <br></td> |
| <td>"disc", "circle", <br> |
| "square"<br></td> |
| <td>The bullet to be used in bulleted <br> |
| (unordered) lists.<br></td> |
| </tr> |
| <tr> |
| <td>localize</td> |
| <td>no</td> |
| <td>fixed value</td> |
| <td>"false"<br></td> |
| <td>See <i><a href="HelpAuthorings-passthru.html#35">Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.html#35">35</a><br></td> |
| </tr> |
| <tr> |
| <td>sorted</td> |
| <td>no</td> |
| <td>fixed </td> |
| <td>"asc", "desc"<br> |
| values<br></td> |
| <td>Specifies whether the list should be <br> |
| sorted, either ascending or descending. If <br> |
| this attribute is not given, the list is not <br> |
| sorted. If it is given, the listitem child <br> |
| elements are sorted according to the <br> |
| current locale.<br></td> |
| </tr> |
| </table> |
| |
| |
| |
| <p><i>Parent Elements</i><br> |
| body, case, default, section, tablecell<br> |
| <p><i>Child Elements</i><br> |
| listitem, comment<br> |
| <b><i>Page 54</i></b><br> |
| <hr> |
| <!--Page 55--> |
| <a name="55"></a> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT list (listitem | (comment)*)+><br> |
| <!ATTLIST list<br> |
| type CDATA #REQUIRED<br> |
| startwith CDATA #IMPLIED<br> |
| format (1 | i | I | a | A) #IMPLIED<br> |
| bullet (disc | circle | square) #IMPLIED<br> |
| localize CDATA #IMPLIED<br> |
| sorted (asc | desc) #IMPLIED<br> |
| ><br> |
| <i>Example</i>:<br> |
| <code> |
| <b><list type="ordered" startwith="5" format="a"></b><br> |
| <listitem>...</listitem><br> |
| <b></list></b><br><br> |
| </code> |
| |
| <h4>Listitem</h4> |
| This element holds the contents of a list in child elements.<br> |
| <i>Attributes</i><br> |
| Note that not all attributes are currently evaluated in the transformation style sheet (see also <i><a href="HelpAuthorings-passthru.html#16">The</i></a><br> |
| <a href="HelpAuthorings-passthru.html#16"><i>Main Transformation Style Sheet</i> </a>on page <a href="HelpAuthorings-passthru.html#16">16</a>)<br> |
| |
| <table border="1"> |
| <caption><b>Table 23: Attributes of the listitem element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| |
| <tr> |
| <td>format</td> |
| <td>no</td> |
| <td>fixed values</td> |
| <td>"1", "i", "I", "a", </td><br> |
| <td>The number format used in numbered <br> |
| "A"<br> |
| (ordered) list items:<br> |
| "1": arabic numerals<br> |
| "i": small roman numerals<br> |
| "I": capital roman numerals<br> |
| "a": small letters<br> |
| "A": capital letters<br> |
| If omitted the list item uses the value set <br> |
| in the list.</td> |
| </tr> |
| <tr> |
| <td>bullet</td> |
| <td>no</td> |
| <td>fixed values</td> |
| <td>quot;disc", "circle",</td> |
| <td>The bullet to be used in bulleted </td> |
| "square"<br> |
| (unordered) list items.</td> |
| </tr> |
| <tr> |
| <td>localize</td> |
| <td>no</td> |
| <td>fixed value</td> |
| <td>"false"</td> |
| <td>S<a href="HelpAuthorings-passthru.html#35">ee <i>Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.html#35">35</a><br></td> |
| </tr> |
| <tr> |
| <td>class</td> |
| <td>no</td> |
| <td></td> |
| <td></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| |
| <p><i>Parent Elements</i><br> |
| list<br> |
| <p><i>Child Elements</i><br> |
| comment, section, paragraph, table, switch, embed, bookmark<br> |
| |
| |
| <b><i>Page 55</i></b><br> |
| <hr> |
| <!--Page 56--> |
| <a name="56"></a> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT listitem (comment | section | paragraph | table | <br> |
| switch | embed | bookmark)*><br> |
| <!ATTLIST listitem<br> |
| format (1 | i | I | a | A) #IMPLIED<br> |
| bullet (disc | circle | square) #IMPLIED<br> |
| localize CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| ><br> |
| <i>Example</i>:<br> |
| <code> |
| <b><listitem bullet="disc"></b><br> |
| <paragraph>Insert the CD.</paragraph><br> |
| <b></listitem></b><br><br> |
| </code> |
| |
| <h4>Meta</h4> |
| This element contains sub-elements with data used to organize the help.<br> |
| <i>Attributes</i><br> |
| none<br> |
| <p><i>Parent Elements</i><br> |
| helpdocument<br> |
| <p><i>Child Elements</i><br> |
| topic, history<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT meta (topic, history?)><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <helpdocument><br> |
| <b> <meta></b><br> |
| <history>...</history><br> |
| <b> </meta></b><br> |
| <body><br> |
| </body><br> |
| </helpdocument><br> |
| </code> |
| |
| <b><i>Page 56</i></b><br> |
| <hr> |
| <!--Page 57--> |
| |
| <a name="57"></a> |
| <h4>Object</h4> |
| This generic element contains information about objects to be embedded into the help <br> |
| page like audio or video files. It is reserved for future use. |
| <br> |
| <table border="1"> |
| <caption><b>Table 24: Attributes of the object element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>type</td> |
| <td>yes</td> |
| <td>CDATA</td> |
| <td></td> |
| <td>Specifies the mime type of the <br> |
| embedded object data.</td><br> |
| </tr> |
| <tr> |
| <td>id</td><br> |
| <td>yes</td><br> |
| <td>CDATA<br> |
| <td></td> |
| <td>A unique ID to identify the image, <br> |
| <a href="HelpAuthorings-passthru.html#35"> see <i>Common Attributes</a> </i>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a>.</td> |
| </tr> |
| <tr> |
| <td>data</td><br> |
| <td>yes</td><br> |
| <td>CDATA</td><br> |
| <td></td> |
| <td>Specifies the object file.</td><br> |
| </tr> |
| <tr> |
| <td>height</td><br> |
| <td>no</td><br> |
| <td>CDATA</td>br> |
| <td></td> |
| <td>Specifies the width of the object.</td><br> |
| </tr> |
| <tr> |
| <td>width</td><br> |
| <td>no</td><br> |
| <td>CDATA</td><br> |
| <td></td> |
| <td>Specifies the height of the object.</td><br> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| paragraph, caseinline, defaultinline, variable<br> |
| <p><i>Child Elements</i><br> |
| none<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT object EMPTY><br> |
| <!ATTLIST object<br> |
| type CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| data CDATA #REQUIRED<br> |
| height CDATA #IMPLIED<br> |
| width CDATA #IMPLIED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <object data="clock.svg" id="objClock" type="image/svg+xml" <br> |
| width="200" height="200"><br> |
| </code> |
| <b><i>Page 57</i></b><br> |
| <hr> |
| <!--Page 58--> |
| |
| <a name="58"></a> |
| |
| <h4>Paragraph</h4> |
| This element is the standard element holding content. The role attribute defines its <br> |
| context in greater detail. See also <a href="HelpAuthorings-passthru.html#24"><i>Paragraph Roles</i> </a>on page<a href="HelpAuthorings-passthru.html#24"> 24.</a> |
| |
| <table border="1"> |
| <caption><b>Table 25: Attributes of the paragraph element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>role</td><br> |
| <td>yes</td><br> |
| <td>CDATA</td><br> |
| <td></td> |
| <td>Describes the current role of the paragraph, <br> |
| for example a simple paragraph or a heading <br> |
| or an example or a note. See also <a href="HelpAuthorings-passthru.html#24"><i>Paragraph</i></a><br> |
| <a href="HelpAuthorings-passthru.html#24"><i>Roles</i></a> on page <a href="HelpAuthorings-passthru.html#24">24.</a></td><br> |
| <tr> |
| <td>level</td><br> |
| <td>no</td><br> |
| <td></td> |
| <td></td> |
| <td>Defines the heading level if the paragraph <br> |
| role is set to "heading".</td><br> |
| </tr> |
| <tr> |
| <td>id</td><br> |
| <td>yes</td><br> |
| <td></td> |
| <td></td> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.html#35">35</a>.</td><br> |
| </tr> |
| <tr> |
| <td>l10n</td><br> |
| <td>yes</td><br> |
| <td></td> |
| <td></td> |
| <td>Contains the localization status of the old <br> |
| help files and is only used for migration <br> |
| purposes.</td><br> |
| </tr> |
| <tr> |
| <td>xml-lang<</td>br> |
| <td>yes</td><br> |
| <td>CDATA</td><br> |
| <td></td> |
| <td>S<a href="HelpAuthorings-passthru.html#35">ee <i>Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.html#35">35</a>.</td><br> |
| </tr> |
| <tr> |
| <td>oldref</td><br> |
| <td>no</td><br> |
| <td>CDATA</td><br> |
| <td></td> |
| <td>This contains the reference number used by <br> |
| the old help files and is only used for <br> |
| migration purposes. </td><br> |
| </tr> |
| <tr> |
| <td>localize</td><br> |
| <td>no<br> |
| <td>gixed value</td><br> |
| <td>"false"</td><br> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes </i></a>on page <a href="HelpAuthorings-passthru.html#35">35</a><br> |
| <i>Table 25: Attributes of the paragraph element</i></td><br> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| body, case, default, listitem, section, tablecell<br> |
| <p><i>Child Elements</i><br> |
| image, embedvar, br, emph, help-id-missing, item, link, switchinline, <br> |
| variable, ahelp, object, bookmark<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT paragraph (#PCDATA | image | comment | embedvar | br | <br> |
| emph | item | link | switchinline | variable | <br> |
| ahelp | object | bookmark)*><br> |
| <!ATTLIST paragraph<br> |
| role CDATA #REQUIRED<br> |
| level CDATA #IMPLIED<br> |
| id CDATA #REQUIRED<br> |
| l10n CDATA #REQUIRED<br> |
| xml-lang CDATA #REQUIRED<br> |
| oldref CDATA #IMPLIED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <b><i>Page 58</i></b><br> |
| <hr> |
| <a name="59"></a> |
| <i>Example</i>:<br> |
| <code> |
| <b><paragraph role="heading" level="1" id="par4711_001" xml_lang="en-US"></b><br> |
| Italic characters<br> |
| <b></paragraph></b><br> |
| <b><paragraph role="paragraph" id="par4711_002" xml_lang="en-US"></b><br> |
| Proceed as follows to write an italic character<br> |
| <b></paragraph></b><br><br> |
| </code> |
| |
| <h4>Section</h4> |
| This element serves as a generic container for multiple elements to make them able <br> |
| to be embedded in other documents. Each section takes a unique ID which is used <br> |
| to identify it when embedded in other documents. Subsections are al owed. A <br> |
| section can only contain sub-elements. |
| |
| <table border="1"> |
| <captin>Table 26: Attributes of the section element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td></td> |
| <td></td> |
| <a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes</i></a> on page <br></td> |
| <a href="HelpAuthorings-passthru.html#35">35</a>.<br></td> |
| </tr> |
| <tr> |
| <td>localize<br></td> |
| <td>no<br></td> |
| <td>fixed value<br></td> |
| <td>"false"<br></td> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes</i></a> on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a><br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| body, listitem, section, tablecell, case, default<br> |
| <p><i>Child Elements</i><br> |
| section, paragraph, table, list, comment, bookmark, embed, switch, sort<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT section (section | paragraph | table | list | comment | <br> |
| bookmark | embed | switch | sort )*><br> |
| <!ATTLIST section<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <b><section id="4711"></b><paragraph>This applies to multiple <br> |
| applications</paragraph><b><section></b><br> |
| </code> |
| |
| <b><i>Page 59</i></b><br> |
| <hr> |
| <!--Page 60--> |
| <a name="60"></a> |
| <h4>Sort</h4> |
| This element is used to mark up a set of sections that are to be sorted. The sequence <br> |
| of the sections inside the sort element plays no role for the display sequence.<br> |
| Note that sorting does not work for embedded sections.<br> |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 27: Attributes of the sort element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>order<br></td> |
| <td>no<br></td> |
| <td>fixed values<br></td> |
| <td>"asc", "desc"<br></td> |
| <td>Defines the sorting order as being <br> |
| <b>asc</b>ending or <b>desc</b>ending.<br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| body, section<br> |
| <p><i>Child Elements</i><br> |
| section<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT sort (section+)><br> |
| <!ATTLIST sort<br> |
| order (asc | desc) #IMPLIED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <b><sort order="asc"></b><br> |
| <section id="123243">...</section><br> |
| <section id="24345">...</section><br> |
| <b></sort></b><br> |
| </code. |
| <b><i>Page 60</i></b><br> |
| <hr> |
| <!--Page 61--> |
| <a name="61"></a> |
| <h4>Switch</h4> |
| This element is used to switch sections or paragraphs for different platform, <br> |
| application, distribution, target medium or language context. For switching content <br> |
| inside paragraphs, switchinline must be used.<br> |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 28: Attributes of the switch element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>select<br> |
| <td>yes<br> |
| <td>fixed values<br> |
| <td>"sys"<br> |
| <td>Defines the context that is to be <br> |
| "appl"<br> |
| evaluated, see <a href="HelpAuthorings-passthru.html#27">also <i>Switching</i></a><br> |
| "distrib"<br> |
| <a href="HelpAuthorings-passthru.html#27"><i>Content</i> </a>on page <a href="HelpAuthorings-passthru.html#27">27</a>.<br> |
| "target"<br> |
| "lang"<br> |
| "ver"<br> |
| </tr> |
| <tr> |
| <td>localize<br> |
| <td>no<br> |
| <td>fixed value<br> |
| <td>"false"<br> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes</i></a> on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a><br> |
| </tr> |
| </table> |
| |
| |
| <p><i>Parent Elements</i><br> |
| body, listitem, section<br> |
| <p><i>Child Elements</i><br> |
| case, comment, default<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT switch ((case | comment)* | default?)*><br> |
| <!ATTLIST switch<br> |
| select (sys | appl | distrib | target | lang | ver) #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <b><i>Page 61</i></b><br> |
| <hr> |
| <!--Page 62--> |
| <a name="62"></a> |
| <i>Example</i>:<br> |
| <code> |
| <b><switch select="sys"></b><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> |
| <default><br> |
| <paragraph>This appears in all other cases</paragraph><br> |
| </default><br> |
| <b></switch></b><br><br> |
| </code> |
| |
| <h4>Switchinline</h4> |
| This element is used to switch parts of paragraphs for different platform, application, <br> |
| distribution, target medium or language context. For switching complete paragraphs or <br> |
| sections switch must be used.<br> |
| |
| <table border="1"> |
| <caption><b>Table 29: Attributes of the switchinline element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>select<br></td> |
| <td>yes<br></td> |
| <td>fixed values<br> |
| "sys", "appl", <br></td> |
| <td>Defines the context that is to be <br> |
| "distrib", "target", <br> |
| evaluated, see also <i><a href="HelpAuthorings-passthru.html#27">Switching</i></a><br> |
| "lang", "ver"<br> |
| <a href="HelpAuthorings-passthru.html#27"><i>Content</i></a> on <a href="HelpAuthorings-passthru.html#27">page 27.</a><br></td> |
| |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| caption, caseinline, defaultinline, paragraph, variable, link<br> |
| <p><i>Child Elements</i><br> |
| caseinline, defaultinline<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT switchinline ((caseinline)+, (defaultinline?)?)><br> |
| <!ATTLIST switchinline<br> |
| select (sys | appl | distrib | target | ver | lang) #REQUIRED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <paragraph>Press the <br> |
| <b> <switchinline select="sys"></b><br> |
| <caseinline select="WIN">Ctrl</caseinline><br> |
| <caseinline select="MAC">Apple</caseinline><br> |
| <defaultinline>any</defaultinline><br> |
| <b> </switchinline> </b><br> |
| key to start.<br> |
| </paragraph><br> |
| </code> |
| |
| <b><i>Page 62</i></b><br> |
| <hr> |
| <!--Page 63--> |
| <a name="63"></a> |
| <h4>Table</h4> |
| This element defines a table containing one or more tablerows. The table element <br> |
| itself only contains child elements.<br> |
| <i>Attributes</i><br> |
| Note that not all attributes are currently evaluated in the transformation style sheet (see also <a href="HelpAuthorings-passthru.html#16"><i>The |
| Main Transformation Style Sheet</i> </a>on page <a href="HelpAuthorings-passthru.html#16">16</a>)<br> |
| <table border="1"> |
| <caption><b>Table 30: Attributes of the table element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| |
| <tr> |
| <td>name<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains a table name.<br></td> |
| </tr> |
| <tr> |
| <td>width<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains the width of the table in units as <br> |
| given in the units attribute. If omitted, the <br> |
| table width is set by the help viewer.<br></td> |
| </tr> |
| <tr> |
| <td>height<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains the height of the table in units as <br> |
| given in the units attribute. If omitted, the <br> |
| table height is set by the help viewer.<br></td> |
| </tr> |
| <tr> |
| <td>unit<br></td> |
| <td>no<br></td> |
| <td>fixed <br></td> |
| <td>"px", "pt", <br> |
| <td>Contains the unit to be used for table width <br> |
| values<br> |
| "cm", "in", <br> |
| and height:<br> |
| "pct"<br> |
| px = pixels<br> |
| pt = points<br> |
| cm = centimeters<br> |
| in = inches<br> |
| pct = percent (%)<br> |
| If omitted, pixels (px) are used as units.<br></td> |
| </tr> |
| <tr> |
| <td>class<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains a class descriptor for the table <br> |
| which can be used to assign special formats.<br></td> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes</i></a> on <a href="HelpAuthorings-passthru.html#35">page 35.</a><br></td> |
| </tr> |
| <tr> |
| <td>localize<br></td> |
| <td>no<br></td> |
| <td>fixed value<br></td> |
| <td>"false"<br></td> |
| <td>S<a href="HelpAuthorings-passthru.html#35">ee <i>Common Attributes</i></a> on <a href="HelpAuthorings-passthru.html#35">page 35</a><br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| body, case, default, listitem, section<br> |
| <p><i>Child Elements</i><br> |
| caption, tablerow<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT table (caption*, tablerow+)><br> |
| <!ATTLIST table<br> |
| name CDATA #IMPLIED<br> |
| width CDATA #IMPLIED<br> |
| height CDATA #IMPLIED<br> |
| unit CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <b><i>Page 63</i></b><br> |
| <hr> |
| <!--Page 64--> |
| <a name="64"></a> |
| <i>Example</i>:<br> |
| </code> |
| <b><table id="tab4711" name="List of Shortcuts" </b><br> |
| <b> width="90" unit="pct" class="shortcutlist"></b><br> |
| <caption><br> |
| <paragraph>List of shortcuts</paragraph><br> |
| </caption><br> |
| <tablerow>...</tablerow><br> |
| <b></table></b><br><br> |
| </code> |
| |
| <h4>Tablecell</h4> |
| This element contains child elements taking the cel content. Complex tables can be <br> |
| created using the rowspan and colspan attributes of tablecell.<br> |
| <i>Attributes</i><br> |
| Note that not all attributes are currently evaluated in the transformation style sheet (see also <a href="HelpAuthorings-passthru.html#16"><i>The Main Transformation Style Sheet</i></a> on <a href="HelpAuthorings-passthru.html#16">page 16)</a><br> |
| <table border="1"> |
| <caption><b>Table 31: Attributes of the tablecell element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>colspan<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains the number of columns <br> |
| spanned by this cell. If omitted, <br> |
| the cell spans 1 column.<br></td> |
| </tr> |
| <tr> |
| <td>rowspan<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains the number of rows <br> |
| spanned by this cell. If omitted, <br> |
| the cell spans 1 row.<br></td> |
| </tr> |
| <tr> |
| <td>width<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains the width of the table <br> |
| cell in units as given in the <br> |
| units attribute. If omitted, the <br> |
| table cell width is set by the help <br> |
| viewer.<br></td> |
| </tr> |
| <tr> |
| <td>unit<br></td> |
| <td>no<br></td> |
| <td>fixed values<br></td> |
| <td>"px", "pt", "cm", "in", |
| "pct"<br></td> |
| <td>Contains the unit to be used for <br> |
| width:<br> |
| px = pixels<br> |
| pt = points<br> |
| cm = centimeters<br> |
| in = inches<br> |
| pct = percent (%)<br> |
| If omitted, pixels (px) are used as <br> |
| units.<br></td> |
| </tr> |
| <tr> |
| <td>class<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>Contains a class descriptor for the <br> |
| table cell, which can be used to <br> |
| assign special formats.<br></td> |
| </tr> |
| <tr> |
| <td>localize<br></td> |
| <td>no<br></td> |
| <td>fixed value<br></td> |
| <td>"false"<br></td> |
| <td>See <a href="HelpAuthorings-passthru.html#35"><i>Common Attributes </i></a>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a><br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| tablerow<br> |
| <b><i>Page 64</i></b><br> |
| <hr> |
| <!--Page 65 --> |
| <a name="65"></a> |
| <p><i>Child Elements</i><br> |
| section, paragraph, comment, embed, bookmark, image, list<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT tablecell (section | paragraph | comment | embed | <br> |
| bookmark | image | list)*><br> |
| <!ATTLIST tablecell<br> |
| colspan CDATA #IMPLIED<br> |
| rowspan CDATA #IMPLIED<br> |
| width CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| unit CDATA #IMPLIED<br> |
| localize CDATA #IMPLIED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <table <br> |
| id="tab_4711" name="List of Shortcuts" <br> |
| width="90" unit="pct" class="shortcutlist"><br> |
| <tablerow><br> |
| <b> <tablecell>Column 1</tablecell></b><br> |
| <b> <tablecell>Column 2</tablecell></b><br> |
| <b> <tablecell>Column 3</tablecell></b><br> |
| </tablerow><br> |
| <tablerow><br> |
| <b> <tablecell colspan="2"></b><br> |
| This cell spans 2 columns, namely column 1 and 2<br> |
| <b> </tablecell></b><br> |
| <b> <tablecell></b><br> |
| This cell spans 1 column, namely column 3<br> |
| <b> </tablecell></b><br> |
| </tablerow><br> |
| </table><br> |
| </code> |
| |
| <b><i>Page 65</i></b><br> |
| <hr> |
| <!--Page 66--> |
| <a name="66"></a> |
| <h4>Tablerow</h4> |
| This element contains table rows, which themselves only contain table cel s.<br> |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 32: Attributes of the tablerow element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>height<br> |
| <td>no<br> |
| <td>CDATA<br> |
| <td>Contains the height of the table <br> |
| row in units as given in the <br> |
| units attribute. If omitted, the <br> |
| table row height is set by the help <br> |
| viewer.<br> |
| </tr> |
| <tr> |
| <td>unit<br> |
| <td>no<br> |
| <td>fixed values<br> |
| <td>"px", "pt", "cm", "in", <td>Contains the unit to be used for <br> |
| "pct"<br> |
| height:<br> |
| px = pixels<br> |
| pt = points<br> |
| cm = centimeters<br> |
| in = inches<br> |
| pct = percent (%)<br> |
| If omitted, pixels (px) are used as <br> |
| units.<br> |
| </tr> |
| <tr> |
| <td>class<br></td> |
| <td>no<br></td> |
| <td>CDATA<br></td> |
| <td>Contains a class descriptor for the <br> |
| table row which can be used to <br> |
| assign special formats.<br></td> |
| </tr> |
| <tr> |
| <td>localize<br></td> |
| <td>no<br></td> |
| <td>fixed value<br></td> |
| <td>"false"<br></td> |
| <td>See <a href="HelpAuthorings-passthru.html#35"><i>Common Attributes </i></a>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a><br></td> |
| |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| table<br> |
| <p><i>Child Elements</i><br> |
| tablecell<br> |
| <b><i>Page 66</i></b><br> |
| <hr> |
| <!--Page 67--> |
| <a name="67"></a> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT tablerow (tablecell+)><br> |
| <!ATTLIST tablerow<br> |
| height CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| unit CDATA #IMPLIED<br> |
| localize CDATA #IMPLIED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <table id="tab_4711" name="List of Shortcuts" <br> |
| width="90" unit="pct" class="shortcutlist"><br> |
| <b> <tablerow></b><br> |
| <tablecell>Column 1</tablecell><br> |
| <tablecell>Column 2</tablecell><br> |
| <tablecell>Column 3</tablecell><br> |
| <b> </tablerow></b><br> |
| </table><br><br> |
| </code> |
| |
| <h4>Title</h4> |
| This is the title of the help page as displayed in the list on the <b>Contents</b> tab page, the <br> |
| <b>Index</b> list and the search results. The title content can<i>not</i> contain HTML entities like <br> |
| &apos; or &amp;. <br> |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 33: Attributes of the title element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>xml-lang<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes</i></a> on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a>.<br></td> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes</i></a> on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a>.<br></td> |
| </tr> |
| <tr> |
| <td>localize<br></td> |
| <td>no<br></td> |
| <td>fixed value<br></td> |
| <td>"false"<br></td> |
| <td>S<a href="HelpAuthorings-passthru.html#35">ee <i>Common Attributes</i></a> on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35</a>.<br></td> |
| </tr> |
| </table> |
| |
| |
| <p><i>Parent Elements</i><br> |
| topic<br> |
| <p><i>Child Elements</i><br> |
| none<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT title (#PCDATA)><br> |
| <!ATTLIST title<br> |
| xml-lang CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <b><i>Page 67</i></b><br> |
| <hr> |
| <a name="68"></a><i>Example</i>:<br> |
| <code> |
| <topic><br> |
| <b><title xml_lang="en-US" id="tit1233">Opening a text document</title></b><br> |
| </topic><br><br> |
| </code> |
| |
| <h4>Topic</h4> |
| This element contains child elements with information about the current help topic.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 34: Attributes of the topic element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>See <a href="HelpAuthorings-passthru.html#35"><i>Common Attributes </i></a>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35.</a><br></td> |
| </tr> |
| <tr> |
| <td>indexer<br></td> |
| <td>no<br></td> |
| <td>fixed value<br></td> |
| <td>"exclude", "include"<br></td> |
| <td>Specifies whether the current file <br> |
| is to be excluded from the <br> |
| indexing process. An excluded file <br> |
| cannot be found using the help <br> |
| search facility.<br></td> |
| </tr> |
| </table> |
| |
| |
| <p><i>Parent Elements</i><br> |
| meta<br> |
| <p><i>Child Elements</i><br> |
| title, bookmark, filename<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT topic (title+, filename, bookmark*)><br> |
| <!ATTLIST topic<br> |
| id CDATA #REQUIRED<br> |
| indexer (exclude | include) #IMPLIED<br> |
| ><br><br> |
| <i>Example</i>:<br> |
| <code> |
| <b><topic id="4711" indexer="exclude"></b><br> |
| <title xml_lang="en-US">Invisible help file</title><br> |
| <filename>text/swriter/01/08154711</filename><br> |
| <b></topic></b><br> |
| </code> |
| |
| <b><i>Page 68</i></b><br> |
| <hr> |
| <!--page 69--> |
| <a name="69"></a> |
| <h4>Variable</h4> |
| This element is used to define reusable text fragments. The fragments can be <br> |
| embedded in other contexts by means of the embedvar element.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 35: Attributes of the variable element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td><a href="HelpAuthorings-passthru.html#35">See <i>Common Attributes </i></a>on page <br> |
| <a href="HelpAuthorings-passthru.html#35">35.</a><br></td> |
| </tr> |
| <tr> |
| <td>visibility<br></td> |
| <td>no<br></td> |
| <td>fixed values<br> |
| <td>"hidden", "visible"<br></td> |
| <td>Specifies whether the element <br> |
| content wil be shown in the help <br> |
| viewer. If this attribute is omitted, <br> |
| the variable wil be <b>visible</b>.<br></td> |
| |
| </tr> |
| </table> |
| |
| |
| <p><i>Parent Elements</i><br> |
| ahelp, caption, caseinline, defaultinline, link, paragraph, variable<br> |
| <p><i>Child Elements</i><br> |
| ahelp, embedvar, br, emph, item, link, variable, image, object, switchinline<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT variable (#PCDATA | ahelp | embedvar | br | emph | <br> |
| item | link | variable | image | object | <br> |
| switchinline)*><br> |
| <!ATTLIST variable<br> |
| id CDATA #REQUIRED<br> |
| visibility (hidden | visible) #IMPLIED<br> |
| ><br><br> |
| <i>Example</i>:<br> |
| <code> |
| You may use the <b><variable id="dlg_FileOpen"></b><item type="dialog">Open a <br> |
| file</item><b></variable></b> to open a file.<br> |
| <comment>List of menu names to be embedded</comment><br> |
| <paragraph xml_lang="en-US"><br> |
| <b><variable id="menu_File" visibility="hidden">File Menu</variable></b><br> |
| <b><variable id="menu_Edit" visibility="hidden">Edit Menu</variable></b><br> |
| <b><variable id="menu_View" visibility="hidden">View Menu</variable></b><br> |
| </paragraph><br> |
| </code> |
| |
| <b><i>Page 69</i></b><br> |
| <hr> |
| <!--Page 70--> |
| <a name="70"></a> |
| <h3>Contents File (*.tree) Elements</h3><br> |
| The contents files (*.tree) are used to specify the hierarchy displayed on the <br> |
| <b>Contents</b> tab page of the help viewer (see also<a href="HelpAuthorings-passthru.html#10"> <i>Hierarchical List of Contents</i> </a>on page <br> |
| <a href="HelpAuthorings-passthru.html#10">10)</a>.<br><br> |
| |
| |
| <h4>Tree_view</h4> |
| This is the root element for a contents file.<br> |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 36: Attributes of the tree_view element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>version<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| none<br> |
| <p><i>Child Elements</i><br> |
| help_section<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT tree_view (help_section)+><br> |
| <!ATTLIST tree_view<br> |
| version CDATA #REQUIRED<br> |
| ><br><br> |
| <i>Example</i>:<br> |
| <code> |
| <b><tree_view version="24-Aug-2004"></b><br> |
| <help_section application="swriter" id="01" title="Installation"><br> |
| ...<br> |
| </help_section><br> |
| <b></tree_view></b><br> |
| </code> |
| |
| <b><i>Page 70</i></b><br> |
| <hr> |
| <!--Page 71--> |
| <a name="71"></a> |
| <h4>Help_section</h4> |
| The help_sections are the top-most elements in the table of contents as displayed <br> |
| by the help viewer.<br> |
| <i>Attributes</i><br> |
| |
| <table border="1"> |
| <caption><b>Table 37: Attributes of the help_section element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>application<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td>Designates the help module <br> |
| that a help_section is referring <br> |
| to<br></td> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>title<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>This is the title of a <br> |
| help_section as displayed in <br> |
| the help viewer<br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| tree_view<br> |
| <p><i>Child Elements</i><br> |
| node, topic<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT help_section (node|topic)*><br> |
| <!ATTLIST help_section<br> |
| application CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| title CDATA #REQUIRED<br> |
| ><br><br> |
| <i>Example</i>:<br> |
| <code> |
| <tree_view version="24-Aug-2004"><br> |
| <b> <help_section application="swriter" id="01" title="Installation"></b><br> |
| ...<br> |
| <b> </help_section></b><br> |
| </tree_view><br> |
| </code> |
| |
| <b><i>Page 71</i></b><br> |
| <hr> |
| <a name="72"></a> |
| <h4>Node</h4> |
| Nodes are the hierarchical elements that represent topic groups and contain help <br> |
| topics. In the help viewer, they are represented by book icons. Nodes can have <br> |
| subnodes.<br> |
| <i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 38: Attributes of the node element</b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td></td> |
| <tr> |
| <td>title<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td>This is the title of a node as <br> |
| displayed in the help viewer<br></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| help_section<br> |
| <p><i>Child Elements</i><br> |
| node, topic<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT node (topic)*><br> |
| <!ATTLIST node<br> |
| id CDATA #REQUIRED<br> |
| title CDATA #REQUIRED<br> |
| ><br><br> |
| <i>Example</i>:<br> |
| <code> |
| <tree_view version="24-Aug-2004"><br> |
| <help_section application="swriter" id="10" title="Common Topics"><br> |
| <b> <node id="1001" title="General Information"></b><br> |
| <topic id="shared/text/shared/main0400.xhp">Shortcut <br> |
| Keys</topic><br> |
| ...<br> |
| <b> </node></b><br> |
| </help_section><br> |
| </tree_view><br> |
| </code> |
| |
| <h4>Topic</h4> |
| Topics are links that point to help files. The id attribute contains the URL of the file to <br> |
| be loaded. The element contains the file title.<br> |
| When the script update_tree.pl from the helpers directory in the helpcontent2 <br> |
| module is used to update the tree files, the element content is automatically updated based on the <br> |
| file titles. This also applies to localized languages.<br> |
| <b><i>Page 72</i></b><br> |
| <hr> |
| <a name="73"></a><i>Attributes</i><br> |
| <table border="1"> |
| <caption><b>Table 39: Attributes of the topic element </b></caption> |
| <tr> |
| <th>Attribute</th> |
| <th>Required</th> |
| <th>Contents</th> |
| <th>Values allowed</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td>id<br></td> |
| <td>yes<br></td> |
| <td>CDATA<br></td> |
| <td></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| <p><i>Parent Elements</i><br> |
| help_section, node<br> |
| <p><i>Child Elements</i><br> |
| none<br> |
| <p><i>Element Definition</i><br> |
| <!ELEMENT topic (#PCDATA)><br> |
| <!ATTLIST topic<br> |
| id CDATA #REQUIRED<br> |
| ><br><br> |
| |
| <i>Example</i>:<br> |
| <code> |
| <tree_view version="24-Aug-2004"><br> |
| <help_section application="swriter" id="10" title="Common Topics"><br> |
| <node id="1001" title="General Information"><br> |
| <b> <topic id="shared/text/shared/main0400.xhp">Shortcut </b><br> |
| <b>Keys</topic></b><br> |
| ...<br> |
| </node><br> |
| </help_section><br> |
| </tree_view><br> |
| </code> |
| |
| <b><i>Page 73</i></b><br> |
| <hr> |
| <!--Page 74 --> |
| <a name="74"></a><hr> |
| <!-- Page 75 --> |
| <a name="75"></a> |
| <h2>4 Authoring Help With OpenOffice.org <i>(Needs updating!)</i></h2> |
| You need at least OpenOffice 3.x.x to use the help authoring environment. <br> |
| |
| <h3>Setting Up the Environment </h3> |
| |
| There is an import/export filter available that allows for direct editing of OpenOffice.org |
| help files without the need of extra conversion steps. |
| |
| The following describes how you set up the filter.<br> |
| The filters are xsl files that are used in conjunction with an import template and takes <br> |
| advantage of OpenOffice.org xsl filter functionality.<br> |
| The help files use the extension <b>xhp</b>.<br> |
| |
| <h3>Directory Hierarchy</h3> |
| |
| The correct function of the help authoring environment with OpenOffice.org relies on <br> |
| the CVS module directory layout. Since all help file and image references are <br> |
| expressed relatively, the environment needs to know the absolute paths to be able to <br> |
| assemble and disassemble the references correctly for display in OpenOffice.org.<br> |
| Us the fol owing directory structure when checking out the modules from CVS. If you <br> |
| work in a Child Workspace, this is the default directory layout:<br> |
| $root<br> |
| |__default_images <-- check out from CVS<br> |
| |__helpcontent2 <-- check out from CVS<br> |
| |__helpers<br> |
| |__util<br> |
| |__prj<br> |
| |__source<br> |
| |__text<br> |
| |__auxiliary<br> |
| Before you set up the environment you need to select and create a root directory for <br> |
| working on the help files ($root), for example: /opt/ooohelp or D:\ooohelp<br> |
| <b><i>Page 75</i></b><br> |
| <hr> |
| <a name="76"></a> |
| <h3>Creating the image directory</h3><br> |
| The CVS module default_images contains al images thatare used by the help.<br> |
| <br> |
| Check out the module default_images from OpenOffice.org CVS into the <br> |
| help root directory (as described above).<br> |
| <i>Creating the help files directory</i><br> |
| <br> |
| Check out the module helpcontent2 from OpenOffice.org CVS into the help <br> |
| root directory (as described above).<br> |
| |
| <h3>Installing The Import/Export Filters</h3> |
| |
| Ensure that the XML Filter option is installed in OpenOffice.org. If this option is not <br> |
| installed, install it using the option from the the OpenOffice.org setup. <br> |
| 1. Get the filter package from the helpers/helpauthoring directory of the <br> |
| helpcontent2 svn module. There is one common package for Windows <br> |
| and Unix.<br> |
| 2. The packages contain the <i>XSLT Import/Export filters</i> and the <i>template</i>.<br> |
| 3. Open a text document in OpenOffice.org. The menu item for the XML Settings <br> |
| will only be visible if a document is loaded.<br> |
| 4. Choose <b>Tools - XML Filter Settings</b><br> |
| 5. Click <b>Open Package</b><br> |
| 6. Browse to the filter package and click <b>Open</b>.<br> |
| 7. Click <b>Close</b> <br> |
| You can now open and save files in OpenOffice.org help format. <br> |
| Note that occasionally, OpenOffice.org seems to corrupt the packaged files while <br> |
| unpacking. If you are unable to load or save help files, check the xsl files in the <br> |
| user/xslt/Help directory and the template in the user/template/Help directory. <br> |
| You can also, extract the file manually from the package using a zip file utility.<br> |
| |
| <h3>Installing The Supporting Macros </h3> |
| <font color="red">(NOT AVAILABLE! needs conversion to work with OpenOffice 4.x!)</font> |
| |
| The macro set is used to perform tasks inside the help files.<br> |
| The macros are only tested with OpenOffice.org versions 1.1.x<br> |
| Feel free to contact<a href="mailto:fpe@openoffice.org"> fpe@openoffice.org</a> if you want to port them to OOo 2.0!<br> |
| <b><i>Page 76</i></b><br> |
| <hr> |
| <!--Page 77--> |
| |
| <a name="77"></a> |
| 1. Get the macro archive<br> |
| HelpAuthoring.tar.gz <br> |
| from <br> |
| helpers/helpauthoring directory of the helpcontent 2 CVS module.<br> |
| 2. Unpack it to a temporary directory.<br> |
| 3. Choose <b>Tools - Macros - Macro</b> <br> |
| 4. Click <b>Organizer</b> <br> |
| 5. Click the <b>Libraries</b> tab<br> |
| 6. Click <b>Append</b> and browse to the temporary directory with the unpacked <br> |
| macros<br> |
| 7. Select the file script.xlb inside the macro directory and click <b>Open</b> <br> |
| 8. Select <b>Replace existing libraries</b> and click <b>Ok</b> <br> |
| 9. Close the macro dialogs<br> |
| You can now use the macros for help authoring. The macros create a configuration <br> |
| file helpauthoring.cfg to store various information and settings in your <br> |
| user/config directory.<br> |
| For some tasks, the macro set needs to recognize the paths to your help files and images as <br> |
| described on page <a href="HelpAuthorings-passthru.html#75">75</a>. You will be asked to provide these paths once a macro needs it. The paths <br> |
| will then be stored inside your user/config directory in the file helpauthoring.cfg. You <br> |
| need to delete this file when the paths to your help files or images change.<br> |
| |
| <h3>Installing The Help Authoring Menu</h3> |
| |
| The Help Authoring menu allows easy access to the macros to perform standard <br> |
| tasks with the help files.<br> |
| This procedure overwrites any menu customization that you have made!<br> |
| 1. Get the menu archive<br> |
| helpauthoring_menu.zip <br> |
| from the <br> |
| helpers/helpauthoring directory of the helpcontent 2 CVS module.<br> |
| 2. Choose <b>Tools - Configure</b> and select the <b>Menu</b> tab<br> |
| 3. Click <b>Load</b> <br> |
| 4. Locate the helpauthoring_menu.zip file<br> |
| 5. Select the file and then click <b>Ok</b> <br> |
| <h3>77</h3> |
| |
| <hr> |
| <a name="78"></a>If all steps were performed successfully, you should now be able to use the menu. <br> |
| |
| <h3>Editing Help Files - Basics</h3> |
| |
| Since OpenOffice.org cannot simply be used as an XML edito,r we need to make <br> |
| some effort to map elements and attributes in the help file to elements that are <br> |
| recognized by OpenOffice.org.<br> |
| For now, not all attributes for the elements are supported for editing in OpenOffice.org. The major <br> |
| ones, however, are available.<br> |
| |
| <h4>Paragraphs And Paragraph Formatting</h4> |
| |
| Paragraphs are the central content carrying element in a help file. A paragraph in the <br> |
| help file maps to a paragraph in OpenOffice.org. The role attribute of a paragraph <br> |
| maps to a paragraph <i>style</i> in OpenOffice.org.<br> |
| For every paragraph role in the help file there is a paragraph style beginning with hlp_ <br> |
| and ending with the role name, e.g. the role paragraph maps to a style named <br> |
| hlp_paragraph. <br> |
| There are also special paragraph styles that start with hlp_aux_. These are used for <br> |
| identifying special elements and should <i>never</i> be used for paragraphs. <br> |
| Any paragraph that does <i>not</i> have a paragraph style starting with hlp_ will be <b>disregarded on </b><br> |
| <b>export</b> by the export filter. Its content will be <b>lost</b> on the next reload of that file.<br> |
| The default paragraph styles for a help file (that is, the default roles of a paragraph) <br> |
| are already pre-defined in the help authoring template (xmlhelptemplate.stw) that is <br> |
| used for loading the help files in OpenOffice.org. This template is part of the <br> |
| import/export package and automatically installed in your user/template directory.<br> |
| You can define new paragraph styles that are transformed to roles in the help files on <br> |
| export by creating a custom style beginning with hlp_ and ending in the role name. <br> |
| This new style wil be recreated on loading that file in OpenOffice.org next time. <br> |
| However, there wil be no formatting information for OpenOffice.org associated with it. <br> |
| For that, the style needs to be added to the template.<br> |
| Note, that these styles don't have any effect on the help as it is displayed <i>as such</i>. In <br> |
| order to adjust the help appearance the roles that are created from the paragraph <br> |
| styles must be transformed by the main transformation style sheet and/or assigned to <br> |
| formats using the cascading style sheets of the help.<br> |
| <b><i>Page 78</i></b><br> |
| <hr> |
| |
| <!--Page 79--> |
| <a name="79"></a> |
| <h4>Sections</h4><br> |
| A section in the help file maps to a section in OpenOffice.org. You can use the <br> |
| navigator to get an overview of existing sections or use the <b>Insert - Section</b> and <br> |
| <b>Format - Sections </b>menus to modify existing sections. The section ID maps to <br> |
| the section name in OpenOffice.org. Nested sections are supported. <br> |
| |
| <h4>Tables</h4> |
| |
| A table in an OpenOffice.org help file transforms to a visible table in the <br> |
| OpenOffice.org file. The table name holds al attributes for that table. If the table has a <br> |
| caption defined in the help file, a paragraph is created directly after the table that <br> |
| contains the caption. It is important that this sequence is <i>not modified</i> since the export <br> |
| filter relies on that sequence. <br> |
| Tables should no longer be used for formatting purposes, for instance, to place <br> |
| images or to mimic numbered lists. Nevertheless, there stil is a considerable amount <br> |
| of legacy help files that do that.<br> |
| |
| <h4>Images</h4> |
| |
| Images are mapped to image objects in OpenOffice.org that are <i>linked</i> (not <br> |
| embedded) to the OpenOffice.org file and anchored <i>as character</i>. The alternative text <br> |
| is defined in the <b>Alternative</b> property of the image object that can be accessed <br> |
| through the <b>Graphics</b> properties dialog (by double-clicking the image) on the <br> |
| |
| <b>Options</b> tab page. The ID of an image is stored in the name of the image object and <br> |
| should not be altered manual y.<br> |
| The images will only be displayed in OpenOffice.org correctly if the path to the image files was <br> |
| correctly specified in the import and export filters (<a href="HelpAuthorings-passthru.html#79">see </a>on <a href="HelpAuthorings-passthru.html#79">page )</a>.<br> |
| |
| <h4>Lists</h4> |
| |
| There are two types of lists in the help (unordered and ordered) that match to the <br> |
| corresponding list type in OpenOffice.org. <br> |
| |
| <h4>Embedding</h4> |
| |
| The embedding technique is unique to the help. Therefore, we use some workarounds <br> |
| to implement embedding when editing the help files in OpenOffice.org: <br> |
| <br> |
| <i>Sections to be embedded</i> are represented as sections. <br> |
| <br> |
| <i>Paragraph parts to be embedded</i><b> </b>are surrounded by a variable tag pair.<br> |
| <br> |
| <i>Places where sections are embedded</i><b> </b>are designated by an embed tag. <br> |
| <br> |
| <i>Places where parts of paragraphs are embedded</i><b> </b>are designated by an <br> |
| embedvar tag. <br> |
| <b><i>Page 79</i></b><br> |
| <hr> |
| <!--Page 80 --> |
| <a name="80"></a> |
| <h4>Character Formatting</h4><br> |
| Direct (hard) formatting is <i>not</i> supported. Any character with a direct format wil <i>lose </i><br> |
| its format definition on export. Instead, character formatting is achieved using <br> |
| character styles. The importing template already contains a list of pre-defined <br> |
| character styles. Al styles that begin with hlp_ can be used for character formatting <br> |
| except for the styles beginning with hlp_aux_ because those are used for internal <br> |
| purpose.<br> |
| Similar to the paragraph styles, you can define new character styles that are <br> |
| transformed to type attributes of item elements in the help files on export. To do this, <br> |
| create a custom character style beginning with hlp_ and ending in the type name <br> |
| (e.g., hlp_dialogname). This new style wil be recreated on loading that file in <br> |
| OpenOffice.org next time. However, there will be no formatting information for <br> |
| OpenOffice.org associated with it. For that, the style needs to be added to the help <br> |
| authoring template.<br> |
| Note that these styles don't have any effect on the help as it is displayed <i>as such</i>. In order to adjust <br> |
| the help appearance, the item types that are created from the character styles must be transformed <br> |
| by the main transformation style sheet and/or assigned to formats using the style sheets of the help.<br> |
| |
| <h3>Working With the Help Files</h3> |
| |
| Ensure that you have set up your work environment correctly as described in <i><a href="HelpAuthorings-passthru.html#75">Setting Up the Envi</i>-</a><br> |
| <a href="HelpAuthorings-passthru.html#75"><i>ronment</i></a> on <a href="HelpAuthorings-passthru.html#75">page 75.</a><br> |
| |
| <h4>Creating A Help File</h4> |
| |
| 1. Start OpenOffice.org and open a new empty Writer window.<br> |
| The help authoring menu is only available in the <b>Writer context</b>. So you need <br> |
| to have a Writer window open.<br> |
| 2. Choose <b>Help Authoring - Create New Help File</b>.<br> |
| You should always create a new file this way to ensure that all settings are <br> |
| made correctly.<br> |
| 3. Select a file name inside the help directory structure<br> |
| The directory structure is described on page <a href="HelpAuthorings-passthru.html#75"> 75</a>. You will be automatical y <br> |
| prompted to save the file. You need to save it before you can actually work on <br> |
| it.<br> |
| 4. Insert an initial comment (optional)<br> |
| You wil be prompted to insert a comment on file creation. This comment wil <br> |
| be stored in the file metadata and cannot be changed using OpenOffice.org.<br> |
| <b><i>Page 80</i></b><br> |
| <hr> |
| <!--Page 81 --> |
| <a name="81"></a> |
| Now you have created a fresh empty help document. The file title is set to the generic <br> |
| term <Set Topic Title>. To adjust the topic title see<a href="HelpAuthorings-passthru.html#94"> <i>Meta Data </i></a>on page<a href="HelpAuthorings-passthru.html#94"> 94.</a><br> |
| Switch the Stylist to show <b>Custom</b> styles to view a list of al styles that are al owed in <br> |
| the help file. None but these (and the ones created by you fol owing the guidelines <br> |
| above) can be used.<br> |
| After the file is finished it needs to be added to the list of files to be processed by the help compiler. <br> |
| This is done by adding the file to the makefile of its directory. You can either do that manually or run <br> |
| the createmakefiles.pl script when you have finished working on the help files. For details, <br> |
| see <i><a href="HelpAuthorings-passthru.html#19">Building the Help Set </i></a>on page <a href="HelpAuthorings-passthru.html#19">19</a>.<br> |
| |
| <h4>Opening A Help File</h4> |
| |
| 1. Choose <b>File Open </b> <br> |
| Browse to the file you want to open and select <b>Help (*.xhp)</b> as the file <br> |
| type<br> |
| 2. Click <b>Open</b> <br> |
| |
| <h4>Removing A Help File</h4> |
| |
| Since a help file is referenced from multiple locations, simply deleting a file from disk <br> |
| is <i>not</i> sufficient for removing a help file from the set of help files.<br> |
| To remove a help file from the set of help files that are compiled, you need to remove <br> |
| it from the <i>makefile</i> of its directory. In this way, it wil not be included in the index, or <br> |
| the ful text search. However, it wil still be included in the help files archive *.jar.<br> |
| To delete a help file completely, you need to <i>remove it from your local disk</i> and <br> |
| remove its entry in the <i>makefile</i> of its directory. If you work on the CVS you also need <br> |
| to <i>remove it from the CVS repository</i>.<br> |
| You also need to remove al <i>dependency files</i> in the output tree that are created <br> |
| during a help build that refer to the deleted file See also <i><a href="HelpAuthorings-passthru.html#19">Building the Help Set</i> </a>on page <br> |
| <a href="HelpAuthorings-passthru.html#19">19</a>. If you haven't built the help set before you don't need to worry about this. If you <br> |
| have changed multiple files it is safer to remove the output tree completely and rebuild <br> |
| the help from scratch.<br> |
| Finally, you need to ensure that the deleted file is not referenced by other help files or <br> |
| by the content files *.tree in the auxiliary directory.<br> |
| <i>To remove a help file</i><br> |
| 1. If this change wil be committed back to the CVS, remove the help file from <br> |
| the CVS repository, for example, using the cvs remove command. <a href="HelpAuthorings-passthru.html#81">[11]</a><br> |
| 11 See<a href="http://tools.openoffice.org/"> http://tools.openoffice.org/</a><br> |
| <a href="http://tools.openoffice.org/"> </a><br> |
| <a href="http://tools.openoffice.org/"> </a><br> |
| for information about OpenOffice.org CVS<br> |
| <b><i>Page 81</i></b><br> |
| <hr> |
| <a name="82"></a> |
| 2. Delete the help file on your local disk. <br> |
| 3. In the makefile.mk of its directory, locate the help file's entry (it has the <br> |
| extension .hzip instead of .xhp) and delete the corresponding line.<br> |
| <br> |
| This step is not required if you use the createmakefile.pl script from <br> |
| helpcontent2/helpers to update al makefiles before building the help.<br> |
| 4. Check if the help file is referenced in on of the *.tree files in <br> |
| helpcontent2/source/auxiliary and delete its reference there, if required.<br> |
| 5. If you have built the help before and you have an existing output tree with <br> |
| dependency files *.dphh, delete any dependency files that reference the <br> |
| deleted help file. A dependency file lists al files that it depends on.<br> |
| |
| <h4>Moving A Help File</h4> |
| |
| From the build environment's view, moving a help file from one directory to another is <br> |
| equivalent to removing a file from one directory and creating a file in another directory.<br> |
| 1. Copy the help files to the new directory.<br> |
| 2. Fol ow the procedure described previously for removing a help file.<br> |
| 3. Ensure that al links inside the moved help file to itself have been adjusted.<br> |
| 4. Add the file to the makefile of the new directory.<br> |
| This step is not required if you use the createmakefile.pl script from <br> |
| helpcontent2/helpers to update al makefiles before building the help.<br> |
| Note that moving a help file can create new localization effort since the moved help file looks like a <br> |
| brand new file to the localization process. However, translation memory systems should be able to <br> |
| automatically translate it because the content did not change - except for internal links.<br> |
| |
| <h3>Sections and Paragraphs</h3> |
| |
| Sections are used to specify parts of help files that are used for referencing purpose in <br> |
| other files. Sections can be embedded and linked.<br> |
| |
| <h4>Where Are The Sections?</h4> |
| |
| Since OpenOffice.org natively supports sections, we make use of them to represent <br> |
| sections in help files. The ID attribute of a section in the help is represented by the <br> |
| name property of the section in OpenOffice.org.<br> |
| Al other properties of sections inside OpenOffice.org have no influence on the help <br> |
| sections. Any layout settings made to sections (background, visibility...) are <i>lost</i> on <br> |
| next reload.<br> |
| <b><i>Page 82</i></b><br> |
| <hr> |
| <!--Page 83--> |
| <a name="83"></a> |
| You can use the navigator to view and navigate sections. Nested sections are also <br> |
| supported ,both by the help and by OpenOffice.org.<br> |
| Sections start and end with a section tag that is placed in the first paragraph directly <br> |
| after the section starts, and in the last paragraph before the section ends:<br> |
| <br><br> |
| <i>Fig. 6: Section tags and section areas</i><br><br> |
| <img src="Fig6.png" alt="Figure 6: Placement of section tag" /> |
| |
| <p> |
| If you want to insert something before or after a section, ensure that you place it <br> |
| before or after the section delimiter line, not just before or after the section tag.<br> |
| If the section <i>starts at the top</i> of the document and you want to insert something <br> |
| before that section, go to the top of the section and press <b>Alt+Return</b> to create a <br> |
| paragraph in front of the section.<br> |
| If the section <i>ends at the bottom</i> of the document and you want to insert something <br> |
| after that section, go to the bottom of the section and press <b>Alt+Return</b> to create a <br> |
| paragraph after the section.<br> |
| |
| <h4>Adding A Section</h4> |
| |
| 1. Depending on whether you want to insert a new empty section or build a <br> |
| section around existing text, do one of the fol owing:<br> |
| <br> |
| Place the cursor where you want to insert the new empty section.<br> |
| <br> |
| Mark the piece of the document that you want to include in a section.<br> |
| 2. Choose <b>Help Authoring - Insert Section</b><br> |
| 3. Insert an identifier for the section in the text box.<br> |
| This section identifier will be used as ID attribute for the section in the help <br> |
| file. It must be <i>unique within the file</i>. It is advisable to use some kind of <br> |
| descriptive name. Use only letters, numbers and the underscore.<br> |
| <b><i>Page 83</i></b><br> |
| <hr> |
| <!--Page 84 --> |
| <a name="84"></a> |
| <h4>Adding A Subsection</h4><br> |
| A subsection is a section that is the child of another section. OpenOffice.org supports <br> |
| nested sections. The procedure to insert a subsection is the same as inserting a <br> |
| section, except that if you insert a section with the cursor inside an existing section <br> |
| you wil create a subsection.<br> |
| You cannot create overlapping sections. Neither the help format nor OpenOffice.org <br> |
| support this. <br> |
| |
| <h4>Removing A Section</h4> |
| |
| 1. If you want to remove a section <i>including</i> its content, delete the section <br> |
| content first.<br> |
| 2. Choose <b>Format Sections</b>.<br> |
| 3. Select the section you want to remove from the list of sections and click <br> |
| |
| <b>Remove</b>.<br> |
| If you remove a section that has subsections only, the selected section wil be <br> |
| removed while the subsections wil be preserved.<br> |
| If you remove a section, ensure that no other file references it to avoid broken links.<br> |
| |
| <h4>Linking To A Section</h4> |
| |
| You can create a link to a section by specifying the section ID as the target in the <br> |
| hyperlink URL when creating a link, for example<br> |
| <link href="text/shared/guide/file_name.xhp#section_id"><br> |
| For details, see <i><a href="HelpAuthorings-passthru.html#94">Linking</i></a> on page <a href="HelpAuthorings-passthru.html#94">94.</a><br> |
| |
| <h4>Embedding A Section</h4> |
| |
| You can embed a section using the embed element. You need the file name and the <br> |
| ID of the section that you want to embed. The embedded section preserves its <br> |
| structure. For details on embedding, see <i><a href="HelpAuthorings-passthru.html#93">Embedding Content</a> </i>on page <a href="HelpAuthorings-passthru.html#93">93.</a><br> |
| |
| <h3>Adding A Paragraph</h3> |
| |
| Paragraphs in the Help have some attribute values that cannot be represented in <br> |
| OpenOffice.org without using certain workarounds. Therefore, you need to fol ow the <br> |
| fol owing instructions to create valid paragraphs.<br> |
| You can write the paragraph content in the usual way. You only have to ensure that<br> |
| <br> |
| the paragraph has <i>meta information</i> associated with it <br> |
| <b><i>Page 84</i></b><br> |
| <hr> |
| <!--Page 85--> |
| <a name="85"></a><br> |
| and the paragraph has a valid <i>paragraph format</i> assigned <br> |
| The paragraph <i>meta information</i> consists of the paragraph ID, the language (which in <br> |
| the source files is always en-US), the localize attribute, and some other attributes <br> |
| that are not relevant in this context.<br> |
| All of these values are stored in a <i>variable field</i> at the beginning of the paragraph. The <br> |
| paragraph ID identifies the paragraph contents in the localization database. <br> |
| If the ID of a paragraph gets lost or is changed it is regarded as new for the database and needs to <br> |
| be localized again. So tampering with IDs must be strictly avoided.<br> |
| Before saving the final file, each paragraph must have a valid and unique ID. The <br> |
| easiest way to do this is to place the cursor somewhere in the paragraph and to <br> |
| choose <b>Help Authoring - Paragraph - Set Paragraph ID</b>. If the paragraph <br> |
| does not have the correct style associated (see below) ID creation wil be denied. <br> |
| Paragraph IDs are also be assigned when the file is validated using <b>HelpAuthoring </b><br><br> |
| |
| <h4> Paragraph Validation</h4>.<br> |
| Not all paragraphs get IDs. Some paragraphs only contain structural information, such <br> |
| as opening and closing tags, or bookmarks, and don't need an ID because they don't <br> |
| transform back to content paragraphs in the help file. Al these paragraphs have a <br> |
| paragraph style assigned that starts with hlp_aux_. <br> |
| If you forget to assign IDs to al corresponding paragraphs, the application wil do that <br> |
| for you on saving, provided the template was correctly instal ed.<br> |
| |
| <h4>Editing A Paragraph</h4> |
| |
| Editing the contents of a paragraph does not need any further action. The localization <br> |
| process finds out for itself when in the content of a paragraph has changed.[<a href="HelpAuthorings-passthru.html#85">12]</a><br> |
| This has two consequences for the writers:<br> |
| 1. You do not need to worry about whether a change has an influence on the <br> |
| localization.<br> |
| 2. You cannot force re-translation of a paragraph by just setting any editing flag.<br> |
| For basic content management purposes, the l10n attribute of a paragraph can be <br> |
| used for setting paragraph status values, since this attribute was only relevant for the <br> |
| migration phase.<br> |
| <p> |
| For instance, you can set the paragraph status to NEW or CHG (changed) to al ow <br> |
| reviewers to easily spot these paragraphs for content review. Any other values come <br> |
| from the migration phase and are no longer relevant. Paragraphs that have been <br> |
| reviewed don't carry an l10n attribute (or carry an empty one).<br> |
| For details on the localization process see l10n.openoffice.org.<br> |
| <b><i>Page 85</i></b><br> |
| <hr> |
| <!--Page 86--> |
| <a name="86"></a> Note that this attribute is evaluated <i>nowhere</i>. It only influences the display of the paragraph in <br> |
| OpenOffice.org (the meta data appear with yellow background). If you want to use it, you will have <br> |
| to take care of its evaluation in the context of content management yourself. <br> |
| |
| <h4>Paragraph Formatting</h4> |
| |
| Al paragraphs in a help file are formatted using paragraph styles. Direct formatting <br> |
| (borders, indentation, etc.) is <i>strictly unsupported</i>. In fact, al direct formatting wil <br> |
| simply be <i>lost</i> on export.<br> |
| Use the predefined styles to format the paragraphs. The fol owing styles are available <br> |
| in the help authoring template (switch to the <b>Custom</b> view in the Stylist):<br> |
| <br> |
| <b>hlp_default</b><br> |
| This is the parent style for al hlp_* styles and only used as a fall back. It <br> |
| translates to a paragraph@role="paragraph" in the help file.<br> |
| <br> |
| <b>hlp_paragraph </b><br> |
| This is the standard style to be used for paragraphs. It translates to a <br> |
| paragraph@role="paragraph" in the help file.<br> |
| <br> |
| <b>hlp_head, and hlp_head1...hlp_head5</b><br> |
| <br> |
| The hlp_head style is the parent style for the other hlp_head* styles and <br> |
| should never be used as such. The hlp_head* styles designate heading <br> |
| elements of different levels. They translate to <br> |
| paragraph@role="heading"@level="x" in the help file with x corresponding <br> |
| to the heading level.<br> |
| <br> |
| <b>hlp_listitem</b><br> |
| This is the style to be used for list items. Its use is optional, as paragraphs <br> |
| inside list items can also have the paragraph style. It translates to a <br> |
| paragraph@role="listitem" in the help file.<br> |
| <br> |
| <b>hlp_tablehead</b><br> |
| This is the style to be used for table header cel s. It translates to a <br> |
| paragraph@role="tablehead" <br> |
| in the help file when the <br> |
| main_transform.xsl stylesheet is used.<br> |
| <br> |
| <b>hlp_tablecontent</b><br> |
| <br> |
| This is the style to be used for table content cel s. It translates to a paragraph <br> |
| @role="tablecontent" in the help file.<br> |
| <br><br> |
| <b>A couple of hlp_aux_* styles</b> <br> |
| These are not meant to be used by the writers. These styles designate <br> |
| paragraphs that contain structural information rather than content.<br> |
| <b><i>Page 86</i></b><br> |
| <hr> |
| <!--Page 87--> |
| <a name="87"></a> |
| <h3>Creating New Styles</h3><br> |
| If the styles in the pre-defined set are not sufficient for your purpose you can create <br> |
| new styles as long as they fol ow these rules:<br> |
| <br> |
| A new paragraph style <i>must</i> be based on the hlp_default style <br> |
| <br> |
| The style name <i>must</i> begin with hlp_ <br> |
| <br> |
| The style name <i>must not</i> begin with hlp_aux_ <br><br> |
| You can use these styles in the help document. They wil be transformed to values of |
| the role attribute for a paragraph in the help file, for instance, hlp_mystyle wil result |
| in a paragraph with the role set to mystyle. |
| This style wil be reconstructed when the help file is loaded. But any formatting |
| information for OpenOffice.org will be lost. Also, the style wil only be available in that |
| file. If you want the style to be available for all documents and have a defined |
| appearance it must be added to the help authoring template. |
| In order to have a special appearance in the final help, the role must also be |
| addressed in the stylesheets that are delivered with the help and define its |
| appearance. <br> |
| |
| <h4>Changing A Paragraph Style</h4> |
| |
| Changing the style of a paragraph has no impact on the localization process. Only the <br> |
| contents of a paragraph (including inline elements) are subject to localization.<br> |
| |
| <h4>Changing A Character Style</h4> |
| |
| Changing the style of a character inside a paragraph <i>does</i> have an impact on the <br> |
| localization of that paragraph since the character style transforms to an <br> |
| <item type=""> inline element.<br> |
| |
| <h3>Moving A Paragraph Inside A Help File</h3> |
| |
| You can safely move a paragraph in a help file without the need of further action. The <br> |
| paragraph styles might need adjustment if the paragraph is moved to a different <br> |
| context in a help file.<br> |
| Ensure that you also move the paragraph meta data that are stored in the variable field at the start <br> |
| of the paragraph. If you <i>copy</i> a paragraph, however, <i>never</i> copy the meta data. The ID of a para-<br> |
| graph <i>must</i> be unique within a help file. <br> |
| |
| <h3>Moving A Paragraph To A Different Help File</h3> |
| |
| Moving a paragraph from one file to another is a sequence of deleting and creating <br> |
| that can be accomplished by cutting and pasting the paragraph <i>without</i> its meta data. <br> |
| <b><i>Page 87</i></b><br> |
| <hr> |
| <!--Page 88--> |
| <a name="88"></a> |
| For localization purposes, this will be recognized as a new paragraph.<br> |
| |
| <h3>Excluding A Paragraph From Localization</h3> |
| |
| Paragraphs can be excluded from localization. In this case, the localized help files <br> |
| contain the English source for the corresponding paragraph. This is control ed by the <br> |
| localize attribute of a paragraph. If it is set to false the paragraph wil not be <br> |
| localized, in <i>al other cases</i> it wil .<br> |
| To exclude a paragraph from localization choose <b>Help Authoring - Paragraph </b><br> |
| <b>- Exclude from L10N</b>.<br> |
| <b><i>Page 88</i></b><br> |
| <hr> |
| <!--page 88--> |
| <a name="89"></a> |
| <h3>Tables </h3><br> |
| |
| <h4>Adding A Table</h4> |
| |
| 1. Choose <b>Help Authoring - Table - Insert Table</b> <br> |
| 2. Insert the initial number of rows and columns in the corresponding text boxes.<br> |
| 3. You can change the table layout after creation, if required.<br> |
| 4. The width and height values are currently unsupported.<br> |
| 5. If required, insert a table caption in the <b>Caption</b> text field.<br> |
| 6. You can exclude the caption from localization by clearing the <b>Localize </b><br> |
| check box.<br> |
| 7. Click <b>Ok</b> |
| <p> |
| Nested tables are unsupported. You cannot insert a table in another table. <br> |
| The meta data of the table are stored "encoded" in the <i>Name</i> property of the table in |
| OpenOffice.org. This must be left untouched. |
| The created table is fol owed by a paragraph containing the caption, if a caption was |
| defined. <br> |
| |
| <h4>Modifying The Table Layout</h4> |
| |
| After creation of the table you can change the table layout to suit your needs. You can |
| add or remove rows or columns. |
| Initially, the column widths wil be distributed equal y. You can manually resize the |
| column widths but for now this wil <i>be lost</i> on next reload. |
| <p> |
| <i>Never ever</i> merge cells. Complex layouts are untested and can lead to unexpected results. <br> |
| <b><i>Page 89</i></b><br> |
| <hr> |
| <!--Page 90--> |
| <a name="90"></a> |
| <h4>Deleting A Table</h4><br> |
| Delete a table as usual in OpenOffice.org. Make sure that the trailing paragraph with <br> |
| the caption is also removed.<br> |
| |
| <h4>Using A Table For Formatting Purposes</h4> |
| |
| <i>Don't do that!</i><br> |
| There are still many places in the help files that use tables for formatting. We will try to |
| get rid of these occurrences over time.<br> |
| |
| <h4>Adding A Caption To An Existing Table</h4> |
| |
| When you have created a table and want to add a caption to it proceed as fol ows:<br> |
| 1. Place the cursor <i>after</i> the paragraph containing the table attributes.<br> |
| In any other place the script will reject adding a caption.<br> |
| 2. Choose <b>Help Authoring - Table - Insert Table Caption</b> <br> |
| 3. Specify the caption text and click <b>Ok</b>.<br> |
| |
| <h3>Lists</h3> |
| |
| |
| <h4>Inserting, Removing, Modifying Lists</h4> |
| |
| You can work with lists as you would usually do in OpenOffice.org if you note the |
| following:<br> |
| |
| <h4>Interrupting A List</h4> |
| |
| A list that is interrupted by a paragraph that is not part of the list, and then continued <br> |
| with the next number as displayed below on the left, is unsupported. If you create <br> |
| such a list in OpenOffice.org it wil transform to the list below on the right after the <br> |
| reload. You wil end up with two separate lists both starting with 1 (see<a href="HelpAuthorings-passthru.html#91"> Fig. 7)</a>.<br> |
| <p> |
| A list where the paragraph is unnumbered but is stil part of the list item is supported <br> |
| and wil work fine. In OpenOffice.org you achieve this by pressing the <b>Backspace</b> key <br> |
| once to get rid of the list number.<br> |
| <b><i>Page 90</i></b><br> |
| <hr> |
| <!--Page 91--> |
| <!-- need images! --> |
| <a name="91"></a> |
| <i>Fig. 7: Incorrect list design</i><br> |
| Before and after reload<br><br> |
| <img src="Fig7.png" alt="Figure 7: Incorrectlist specification" /> |
| <br><br> |
| <i>Fig. 8: Correct list design</i><br><br> |
| Before and after reload<br><br> |
| <img src="Fig8.png" Alt="Figure 8: Correct list specification" /> |
| |
| |
| Images in lists can be placed in such paragraphs. There is no need to mimic lists |
| using table constructions.<br> |
| |
| <h3>Working with Images</h3> |
| |
| |
| <h4>Help Image Repository</h4> |
| |
| Help images are stored inside the res/helpimg subdirectory of the default_images <br> |
| CVS module. Images that are used by the help need to be added to this repository <br> |
| module. See tools.openoffice.org for details on working with the OpenOffice.org <br> |
| CVS repository.<br> |
| <p> |
| The helpimg directory contains all help images in English. Subdirectories for each <br> |
| language (except for the source language which is en-US) contain the localized |
| images. If an image does not need localization it only needs to be present in the <br> |
| helpimg directory. The subdirectories are named using the ISO codes for language <br> |
| and country as described on page <a href="HelpAuthorings-passthru.html#13">13</a>.<br> |
| <p> |
| <b><i>To add an image to the repository</i></b><br> |
| 1. Place the English image inside the res/helpimg directory of the <br> |
| default_images module.<br> |
| 2. Place the localized images inside the corresponding language subdirectories of <br> |
| res/helpimg, for example zh-CN for simplified Chinese.<br> |
| You must mark the image as to be localized using the <b>Help Authoring - </b><br> |
| <b>Image Image needs L10N</b> menu. An image that needs localization will <br> |
| <b><i>Page 91</i></b><br> |
| <hr> |
| <!--Page 92--> |
| <a name="92"></a> |
| appear with a red border in OpenOffice.org (not in the final help, of course).<br> |
| You can use <b>Help Authoring - Image No L10N for Image</b> to clear <br> |
| the localization mark.<br> |
| If the image is not marked as to be localized, the help will <b>always</b> display the English <br> |
| image regardless whether there are localized images available.<br> |
| 3. Open the file helpimg.ilst in the util directory of the helpcontent2 <br> |
| module and add the English and all localized variants to the file. Keep the file <br> |
| entries sorted.<br> |
| <b><i>To Remove an Image from the Repository</i></b><br> |
| 1. Remove the English and localized files from the CVS<br> |
| 2. Open the file helpimg.ilst in the util directory of the helpcontent2 <br> |
| module and remove the corresponding file entries.<br> |
| |
| <h4>Inserting A Block Image</h4> |
| |
| A block image is an image that is located in a paragraph of its own. It can contain a <br> |
| caption.<br> |
| 1. Choose <b>HelpAuthoring - Image - Insert Image</b>.<br> |
| 2. Select an image file to insert and click <b>Open</b>.<br> |
| The image <i>must</i> be located inside the help file hierarchy as described in <br> |
| <a href="HelpAuthorings-passthru.html#75"><i>Setting Up the Environment </i></a>on page<a href="HelpAuthorings-passthru.html#75"> 75.</a><br> |
| 3. Specify an alternative text for the image (<i>mandatory</i>). This text is needed to <br> |
| comply with accessibility regulations.<br> |
| 4. Specify a caption text for the image (<i>optional</i>).<br> |
| The image wil be added on a paragraph of its own surrounded by img tags. If you <br> |
| have specified a caption this caption text wil appear inside imgcaption tags.<br> |
| |
| <h4>Inserting An Inline Image</h4> |
| |
| An inline image is an image that is displayed inline in between paragraph text. It can <br> |
| not contain a caption.<br> |
| 1. Choose <b>HelpAuthoring - Image - Insert Inline Image</b>.<br> |
| 2. Select an image file to insert and click <b>Open</b>.<br> |
| The image <i>must</i> be located inside the help file hierarchy as described in <br> |
| <a href="HelpAuthorings-passthru.html#75"><i>Setting Up the Environment </i></a>on page<a href="HelpAuthorings-passthru.html#75"> 75.</a><br> |
| 3. Specify an alternative text for the image (<i>mandatory</i>).<br> |
| This text is needed to comply with accessibility regulations. The image wil be <br> |
| added to the paragraph surrounded by img tags.<br> |
| <b><i>Page 92</i></b><br> |
| <hr> |
| <!--Page 93 --> |
| <a name="93"></a> |
| <h4>Adding An Image Caption</h4><br> |
| You can add a caption to an existing block image.<br> |
| 1. Choose <b>HelpAuthoring - Image - Insert Caption</b>.<br> |
| 2. Specify a caption and click <b>Ok</b>.<br> |
| |
| <h3>Embedding Content </h3> |
| |
| |
| <h4>Embedding A Section Or Variable</h4> |
| |
| 1. Choose <b>Help Authoring - Embed Sections or Variables</b> <br> |
| 2. Enter the name of the file that contains the section or variable to be <br> |
| embedded in the <b>File Name</b> text box or click <b>Browse</b> to browse for a file. <br> |
| The path starts with the text directory in the help directory hierarchy (see <br> |
| page<a href="HelpAuthorings-passthru.html#75"> 75)</a>.<br> |
| 3. Select whether a variable (text block in a paragraph or the complete contents <br> |
| of a paragraph) or a section is to be embedded.<br> |
| 4. Insert the section or variable ID or click Browse to browse al sections, <br> |
| variables, and paragraphs in the selected file.<br> |
| <b><i>Page 93</i></b><br> |
| <hr> |
| <!--page 94--> |
| <a name="94"></a> |
| <h3>Linking</h3><br> |
| |
| <h4>Linking To Another Help File</h4> |
| |
| 1. Mark the text that you want to appear as hyperlink.<br> |
| 2. Choose <b>Help Authoring - Insert Link</b> <br> |
| 3. Enter the name of the file to link to in the <b>Link target</b> box. The path starts <br> |
| with the text directory in the help file hierarchy. The path can contain a target <br> |
| anchor, for example, text/swriter/01/01020304.xhp#anchor<br> |
| 4. Click <b>Ok</b> <br> |
| |
| <h4>Linking To The WWW</h4> |
| |
| Proceed as with links to help files, but instead specify a WWW URL as link target.<br> |
| |
| <h3>Meta Data</h3> |
| |
| The meta data are available through the <b>Help Authoring - Meta Data</b> menu <br> |
| that calls the <b>Meta Data</b> dialog:<br> |
| <b><i>Page 94</i></b><br> |
| <hr> |
| <!--Page 95--> |
| <a name="95"></a> |
| <h3>Setting The Topic Title</h3> |
| On help file creation, the topic title is set to a generic string. This must be changed <br> |
| before final y saving the file.<br> |
| 1. Choose <b>Help Authoring - Meta Data</b> <br> |
| 2. Insert a topic title in the corresponding text box or click <b>Fetch</b> to fetch the <br> |
| topic title from the first heading in the document.<br> |
| The topic title must not be empty.<br> |
| |
| <h3>Setting The Topic ID</h3> |
| |
| On document creation, the topic ID wil be set from the file name. There is usual y no <br> |
| need for setting the topic ID manual y but you can do so by entering the ID in the <br> |
| corresponding text box. Characters that are not al owed are automatically stripped <br> |
| from the ID. Clicking <b>Suggest</b> creates an ID based on the filename (like when the file <br> |
| is created).<br> |
| |
| <h3>Excluding A File From The Search Index</h3> |
| |
| By default, all files are included in the ful text search index creation. You can exclude <br> |
| files form this search index by selecting the <b>exclude</b> option in the <b>Indexing</b> section. <br> |
| |
| <h3>Changing The Initial File Creation Comment</h3> |
| |
| If you are do not like your initial comment you need to patch the xhp file.<br> |
| |
| <h3>Changing The Last Edited Comment</h3> |
| |
| You can insert a comment when you edit and save a help file. This comment can be <br> |
| used to describe why a change was made and what changes were performed. A new <br> |
| comment overrides existing comments.<br> |
| |
| <h3>Bookmarks</h3> |
| |
| Bookmarks host index entries, help IDs, and entries for the table of contents <br> |
| (TOC)<a href="HelpAuthorings-passthru.html#95">[13</a>]<br> |
| |
| <h4>Adding A New Bookmark Set With Index Entries</h4> |
| |
| 1. Place the cursor where you want the index entry to appear.<br> |
| Remember that an index entry transforms to an anchor target in the help file. <br> |
| Therefore, an index entry should always be placed directly <i>above</i> the text it <br> |
| refers to. Index entries that refer to the complete help topic should be placed <br> |
| at the top of the file.<br> |
| 13 TOC entries are currently unused.<br> |
| <b><i>Page 95</i></b><br> |
| <hr> |
| <!--Page 96--> |
| <a name="96"></a> |
| 2. Choose <b>Help Authoring - Bookmarks - Insert Index Entries</b>.<br> |
| Enter the first and second level of the index entry in the <b>Index Entry</b> text <br> |
| boxes and click <b>Add</b> or press the <b>Ins</b> key to add it to the list of index entries.<br> |
| You can remove index entries from the list by selecting them and clicking <br> |
| |
| <b>Remove Selected</b>. <br> |
| 3. Select <b>Add parent bookmark tag</b> to create a new set of index entries. If <br> |
| you want to add index entries to an existing set you need to clear this box <br> |
| (see next procedure).<br> |
| 4. Click <b>Ok</b>.<br> |
| |
| <h4>Adding Index Entries To An Existing Bookmark Set</h4> |
| |
| You cannot mix different types of bookmarks (index entries, help ids, and TOC entries).<br> |
| 1. Place the cursor inside the set of index entries where you want to add index <br> |
| entries.<br> |
| 2. Choose <b>Help Authoring - Bookmarks - Insert Index Entries</b>.<br> |
| 3. Compile the list of index entries that you want to add to the bookmark set like <br> |
| described in the previous procedure.<br> |
| 4. Clear the <b>Add parent bookmark tag</b> box.<br> |
| If the box is checked a <i>new</i> bookmark set with the specified index entries wil <br> |
| be created after the set at the cursor position.<br> |
| 5. Click <b>Ok</b>.<br> |
| <b><i>Page 96</i></b><br> |
| <hr> |
| <a name="97"></a> |
| |
| <h4>Modifying Index Entries In An Existing Bookmark Set</h4><br> |
| If you need to modify an existing index entry (for instance, to correct a typographical <br> |
| error) delete and recreate this index entry as described previously.<br> |
| |
| <h4>Adding A New Bookmark Set With TOC Entries[<a href="HelpAuthorings-passthru.html#97">14]</a></h4><br> |
| 1. Place the cursor where you want the TOC entry to appear.<br> |
| 2. Remember that a TOC entry transforms to an anchor target in the help file. <br> |
| Therefore, a TOC entry should always be placed directly <b>above</b> the text it <br> |
| refers to.<br> |
| TOC entries that refer to the complete help topic must be placed at the start of <br> |
| the help topic.<br> |
| 3. Choose <b>Help Authoring - Bookmarks - Insert TOC Entries</b>.<br> |
| Enter the TOC entry string in the <b>TOC Entry</b> text box and click <b>Add</b> to add it <br> |
| to the list of TOC entries.<br> |
| The TOC levels are separated using a slash /, for details see page <a href="HelpAuthorings-passthru.html#25">25.</a><br> |
| You can remove TOC entries from the list by selecting them and clicking <br> |
| |
| <b>Remove Selected</b>. <br> |
| 4. Select <b>Add parent bookmark tag</b> to create a new bookmark set of TOC <br> |
| entries. If you want to add TOC entries to an existing bookmark set you need <br> |
| to clear this box (see next procedure).<br> |
| 5. Click <b>Ok</b>.<br> |
| |
| <h4>Adding TOC Entries To An Existing Bookmark Set</h4> |
| |
| You cannot mix different types of bookmarks (index entries, help ids, and TOC entries).<br> |
| 1. Place the cursor inside the bookmark set of TOC entries where you want to <br> |
| add TOC entries.<br> |
| 14 These bookmarks are currently not evaluated when the help is compiled.<br> |
| <b><i>Page 97</i></b><br> |
| <hr> |
| <!--Page 98--> |
| <a name="98"></a> |
| 2. Choose <b>Help Authoring - Bookmarks - Insert TOC Entries</b>.<br> |
| 3. Compile the list of TOC entries that you want to add to the bookmark set, as <br> |
| described previously.<br> |
| 4. Clear the <b>Add parent bookmark tag</b> box.<br> |
| 5. If the box is checked a <i>new</i> bookmark set with the specified TOC entries will <br> |
| be created after the set at the cursor position.<br> |
| 6. Click <b>Ok</b>.<br> |
| |
| <h3>Determining A Help ID</h3> |
| |
| The help ID inserted into the help file must either be the <i>symbolic ID</i> or an <i>UNO </i><br> |
| <i>command</i> (see<a href="HelpAuthorings-passthru.html#26"> <i>"hid" Branch</i></a> on page <a href="HelpAuthorings-passthru.html#26">26</a>). You can determine the <i>numerical ID</i> or the <br> |
| <i>UNO command</i> from the UI by setting an environmental variable HELP_DEBUG and <br> |
| setting it to TRUE before you start OpenOffice.org.<br> |
| If the variable is set you will see the help ID of an element together with its extended <br> |
| tip whenever you rest the mouse over it (provided the extended tips are enabled). This <br> |
| help ID can either be<br> |
| <br> |
| a <b>numerical ID</b>, in this case it must be converted to the symbolic ID before <br> |
| inserting it into the help file (see below)<br> |
| <br> |
| an <b>UNO command.</b> This can be inserted into the help file without need for conversion<br> |
| To convert the numerical help ID into a symbolic help ID you need a matching table called <br> |
| help_hid.lst that can be found in the helpers directory of the helpcontent2 module <br> |
| (<a href="HelpAuthorings-passthru.html#18">see <i>Structure of the CVS Help Module</i> </a>on page <a href="HelpAuthorings-passthru.html#18">18</a>).<br> |
| You can either use this mapping table to look up a symbolic help ID yourself, or you can place it <br> |
| into your local user/configuration directory of OpenOffice.org to allow the corresponding help <br> |
| authoring macro convert it for you.<br> |
| |
| <h3>Adding A Help ID</h3> |
| |
| 1. Place the cursor where you want the Help ID to appear.<br> |
| Remember that a Help ID transforms to an anchor target in the help file. <br> |
| Therefore, the Help ID must be placed directly <i>above</i> the text it refers to and <br> |
| above any extended tip that it corresponds to.<br> |
| Help IDs that refer to the complete help topic must be placed at the beginning <br> |
| of the help topic.<br> |
| 2. Choose <b>Help Authoring - Bookmarks - Insert Help ID</b>.<br> |
| |
| <b><i>Page 98</i></b><br> |
| <hr> |
| <!--page 99--> |
| |
| <a name="99"></a> |
| 3. Insert the Help ID in the <b>Help ID</b> text box<br> |
| 4. If you only have the numerical help ID, click <b>Convert to Symbol</b> to convert <br> |
| it to the symbolic Help ID. If this button is disabled you need to place a <br> |
| help_hid.lst file into the user/configuration directory of your <br> |
| OpenOffice.org instal ation.<br> |
| 5. Click <b>Ok</b>.<br> |
| |
| <h3>Switching Content</h3> |
| |
| |
| <h4>Inline Switching</h4> |
| |
| Inline switching uses conditional tags to switch parts of a paragraph for different <br> |
| context situations. An inline switch consists of an outer switchinline element that <br> |
| encloses one or more caseinline elements that define the conditions and optional y <br> |
| one defaultinline element. The complete switch must be in one paragraph. <br> |
| <switchinline select="switch_type"><br> |
| <caseinline select="condition_1"></caseinline><br> |
| <caseinline select="condition_2"></caseinline><br> |
| ...<br> |
| <defaultinline></defaultinline><br> |
| </switchinline> <br> |
| 1. Place the cursor where you want the inline switch to start or select the text <br> |
| passage that you want in the first condition.<br> |
| 2. Choose <b>Help Authoring - Switching - Open Switchinline </b><br> |
| 3. Select a switch type from the dialog. Currently, there are three switch types <br> |
| available:<br> |
| <br> |
| <i>System</i><b> </b>switches are used to switch between different platforms <br> |
| (Windows, Unix,...). <br> |
| <br> |
| <i>Application </i>switches are used to switch between different applications <br> |
| (Writer, Calc, Draw,...) <br> |
| <br> |
| <i>Distribution</i> switches are used to switch between open source and <br> |
| commercial distributions (OpenOffice.org, StarOffice,...) [<a href="HelpAuthorings-passthru.html#99">15</a>]<br> |
| 15 Not currently evaluated.<br> |
| |
| <b><i>Page 99</i></b><br> |
| <hr> |
| <!--page 100--> |
| <a name="100"></a> |
| 4. Click <b>Ok</b> <br> |
| 5. Select the first condition (caseinline).<br> |
| You can either select one of the pre-defined conditions from the list or specify <br> |
| your own condition string.<br> |
| 6. Enter further conditions by selecting text and choosing <b>Help Authoring - </b><br> |
| <b>Switching - Insert Caseinline</b> for the corresponding switch type.<br> |
| <br> |
| There is no text allowed (including spaces or line breaks) between a closing <br> |
| and an opening tag inside an inline switch, e.g.<br> |
| <i>wrong:</i> </caseinline> <caseinline> <br> |
| <i>correct:</i> </caseinline><caseinline><br> |
| 7. Optionally, insert a default condition by selecting text and choosing <b>Help </b><br> |
| <b>Authoring - Switching - Insert Defaultinline</b>. <br> |
| 8. Insert a closing switchinline element <b>directly</b> after the last caseinline <br> |
| element by choosing <b>Help Authoring - Switching - Close </b><br> |
| <b>Switchinline</b>.<br> |
| If you have inserted a default condition as described above, the <br> |
| switchinline element wil automatical y be closed. <br> |
| If you are not sure if you have actual y created a valid switch choose <b>Help </b><br> |
| <b>Authoring - Validate</b> and you wil be notified of any errors.<br> |
| The pre-defined conditions are processed when the help is displayed. If you want to specify your <br> |
| own condition string, you will have to ensure that the condition is processed when the help is <br> |
| compiled (see <a href="HelpAuthorings-passthru.html#19">page 19)</a> and displayed. Usually, you will only use the pre-defined conditions. <br> |
| |
| <h4>Switching Complete Sections Or Paragraphs</h4> |
| |
| Other than inline switches, this type of switches encloses one or more paragraphs <br> |
| including graphics and tables. Similar to inline switches, they consist of an outer <br> |
| switch element that encloses one or more case elements that define the conditions <br> |
| |
| <b><i>Page 100</i></b><br> |
| <hr> |
| <!--Page 101--> |
| |
| <a name="101"></a> |
| and optional y one default element. Each of those elements must be in a paragraph <br> |
| of its own that is assigned the hlp_aux_switch style. The macros handle al that for <br> |
| you. <br> |
| 1. Place the cursor where you want the switch to start.<br> |
| If you are in a non-empty paragraph the switch wil start <i>before</i> that <br> |
| paragraph.<br> |
| 2. Choose <b>Help Authoring - Switching - Open Switch</b><br> |
| 3. Select a switch type from the dialog. Currently, there are three switch types <br> |
| available:<br> |
| <br> |
| <i>System</i> switches are used to switch between different platforms <br> |
| (Windows, Unix,...). <br> |
| <br> |
| <i>Application</i> switches are used to switch between different applications <br> |
| (Writer, Calc, Draw,...)<br> |
| <br> |
| <i>Distribution</i> switches are used to switch between open source and <br> |
| commercial distributions (OpenOffice.org, StarOffice,...). <br> |
| 4. Select the first condition (case).<br> |
| You can either select one of the pre-defined conditions from the list or specify <br> |
| your own condition string.<br> |
| 5. Place the cursor where the condition ends.<br> |
| If you are in a non-empty paragraph the condition wil end <b>after</b> that <br> |
| paragraph.<br> |
| |
| <b><i>Page 101</i></b><br> |
| <hr> |
| <!--page 102 --> |
| <a name="102"></a> |
| 6. Choose <b>Help Authoring - Switching - Close Case</b> to close a <br> |
| condition.<br> |
| 7. Now insert further conditions by<br> |
| <br> |
| placing the cursor in the <i>first</i> paragraph of the condition <br> |
| <br> |
| choosing <b>Help Authoring - Switching - Open Case</b> <br> |
| <br> |
| placing the cursor in the <i>last</i> paragraph of the condition <br> |
| <br> |
| choosing <b>Help Authoring - Switching - Close Case</b>.<br> |
| There are no paragraphs allowed between a closing and an opening tag <br> |
| inside an switch, for example: <br> |
| <i>Wrong:</i><br> |
| </case><br> |
| {Some other text, even an empty paragraph}<br> |
| <case><br> |
| <i>Correct:</i><br> |
| <b></case></b><br> |
| <b><case> </b><br> |
| 8. You can optional y enter a default condition as follows:<br> |
| <br> |
| place the cursor in the <i>first</i> paragraph of the default condition <br> |
| <br> |
| choose <b>Help Authoring - Switching - Open Default</b><br> |
| <br> |
| place the cursor in the <i>last</i> paragraph of the default condition<br> |
| <br> |
| choose <b>Help Authoring - Switching - Close Default</b>.<br> |
| 9. Close the switch by placing the cursor <i>directly</i> behind the last case element <br> |
| and choosing <b>Help Authoring - Switching - Close Switch</b>.<br> |
| If you have inserted a default condition the switch wil automatical y be closed.<br> |
| If you are not sure if you have actual y created a valid switch, choose <b>Help </b><br> |
| <b>Authoring - Validate</b> and you wil be notified of any errors.<br> |
| The pre-defined conditions are processed when the help is displayed. If you want to specify your <br> |
| own condition string you will have to ensure that the condition is processed when the help is <br> |
| compiled (see <a href="HelpAuthorings-passthru.html#19">page 19)</a> and displayed. Usually, you will only use the pre-defined conditions. <br> |
| |
| <b><i>Page 102</i></b><br> |
| <hr> |
| <!--Page 103 --> |
| <a name="103"></a> |
| <h3>Miscellaneous</h3><br> |
| |
| <h3>Extended Tips</h3> |
| |
| Extended tips come in two flavors, <i>visible</i> and <i>hidden</i>. Visible extended tips are part of <br> |
| the normal help text while hidden extended tips are hidden from the normal help <br> |
| content. Each extended tip is assigned a help ID to which it responds.<br> |
| In the current implementation, the hid attribute of the extended tip elements AVIS and AHID are <br> |
| not evaluated. The corresponding Help IDs must be placed as bookmarks in a paragraph before the <br> |
| extended tip. The extended tip will be shown for <i>all help IDs</i> specified as bookmarks <i>after the last </i><br> |
| <i>extended tip</i> in the file. <br> |
| 1. Select the part of the paragraph that you want to use as extended tip.<br> |
| An extended tip <i>must not</i> be spread over multiple paragraphs.<br> |
| 2. Choose <b>Help Authoring - Insert Visible Extended Tip</b> or <b>Help </b><br> |
| |
| <b>Authoring - Insert Hidden Extended Tip</b>.<br> |
| If you enclose text by a hidden extended tip this text portion will <i>no longer be </i><br> |
| <i>visible</i> in the help viewer.<br> |
| 3. Insert a help ID to be assigned to the extended tip. Note the comment about <br> |
| help IDs above.<br> |
| |
| <h3>Sorting</h3> |
| |
| Sorting is a new feature in OpenOffice.org Help. It can be used to sort sections based <br> |
| on their content. This is useful, for example, for glossaries or other sorted lists that are <br> |
| localized and would otherwise lose their correct sort order.<br> |
| Note that sorting does not work for embedded sections.<br> |
| 1. Place the cursor <i>before</i> the first section to be sorted.<br> |
| In the current implementation the sort element sorts the content of sections. <br> |
| The sort element must not have any other child elements than sections.<br> |
| 2. Choose <b>Help Authoring - Sorting - Open Sort</b> <br> |
| 3. Place the cursor <i>after</i> the last section to be sorted.<br> |
| 4. Choose <b>Help Authoring - Sorting - Close Sort</b> <br> |
| |
| <h3>Validating</h3> |
| |
| There is a basic validation procedure available that tests the help files before they are <br> |
| exported from OpenOffice.org. To cal it, choose <b>Help Authoring - Validate</b>.<br> |
| Note that this procedure catches some of the most common and severe errors but it is <br> |
| not fool-proof. It does <i>not</i> perform an XML validation on the file.<br> |
| It is, however, recommended to validate a file before saving.<br> |
| |
| <b><i>Page 103</i></b><br> |
| <hr> |
| <!--Page 104--> |
| <a name="104"></a> |
| <h3>Troubleshooting</h3> |
| |
| <h3>A Help File Cannot Be Opened</h3> |
| |
| The reason is probably an invalid help xhp file. To verify this, open the help file in any <br> |
| XML or text editor and check its validity. Fix any invalid syntax and reload the file. <br> |
| If the XML file is valid and you cannot open <i>any</i> help file, see below.<br> |
| |
| <h3>A Help File Cannot Be Saved</h3> |
| |
| The reason could be insufficient access rights to the directory or file you want to save <br> |
| to. Change the access rights accordingly.<br> |
| If you cannot save <i>any</i> help file, see below.<br> |
| |
| <h3>No Help File Can Be Opened Or Saved</h3> |
| |
| The reason is probably a corrupted XSLT export/import filter. Occasional y, instal ing <br> |
| the help authoring filter produces an error in the xsl files. To repair this proceed as <br> |
| fol ows:<br> |
| <i>If you are familiar with XSLT</i><br> |
| 1. Change to the user/xslt/Help directory of your OpenOffice.org instal ation.<br> |
| 2. Open the import and/or export xsl file.<br> |
| 3. Got to the end of the file and check if there is any obvious duplicated content. <br> |
| Occasional y, the last lines of the stylesheet get duplicated. There must only <br> |
| be one single </xsl:stylesheet> tag in the file.<br> |
| <i>If you are unfamiliar with XSLT</i><br> |
| 1. Get the help authoring filter package (see<a href="HelpAuthorings-passthru.html#76"> <i>Instal ing the Import/Export Filters</a> </i><br> |
| on page<a href="HelpAuthorings-passthru.html#76"> 76</a>) and unpack it to a temporary directory.<br> |
| 2. Copy the *.xsl files from the Help subdirectory of the files that you just <br> |
| unpacked to the user/xslt/Help directory of your OpenOffice.org instal ation <br> |
| overwriting the existing files.<br> |
| |
| <h3>Paragraph Content Has Vanished On Reload</h3> |
| |
| The reason is probably the use of a wrong paragraph format. Remember, that for <br> |
| paragraphs with content you must use one of the predefined hlp_* paragraph styles. <br> |
| See also <i><a href="HelpAuthorings-passthru.html#78">Paragraphs and Paragraph Formatting</i></a> on page <a href="HelpAuthorings-passthru.html#78">78.</a><br> |
| |
| <b><i>Page 104</i></b><br> |
| <hr> |
| <!--Page 105--> |
| <a name="105"></a> |
| <h2>5 Appendix</h2> |
| |
| <h3>Glossary</h3> |
| |
| <b>Application</b> A OpenOffice.org "module" for different document types. There are the following <br> |
| applications: <i>Writer</i> for text documents, <i>Calc</i> for spreadsheets, <i>Impress</i> for <br> |
| presentations, <i>Draw</i> for drawings, <i>Math</i> for formulas, <i>Basic</i> for Macros.<br> |
| <b>Active Help</b> - A synonym for an extended tip.<br> |
| <b>Anchor</b> A location inside a help file which serves as a bookmark to which the help viewer <br> |
| jumps, displaying the help for a certain context.<br> |
| <b>Attribute</b> Component of an XML element carrying information that specifies the element in <br> |
| greater detail, for example, the role attribute in the paragraph element.<br> |
| <b>Bookmark</b> 1. A help function that allows you to set user-defined bookmarks to help topics to <br> |
| make them easier to access. 2. An element of a help XML file that is used to define <br> |
| anchor points for help ids or keywords.<br> |
| <b>Build List</b> The file build.lst controls the build process of a module by defining module <br> |
| directories to be built and application dependencies between them.<br> |
| <b>Cascading Style Sheet</b> The style sheet used to define the layout of a help page displayed in <br> |
| the help viewer.<br> |
| <b>Context-Sensitive Help</b> When called from within the OpenOffice.org application, the help <br> |
| receives information about the user interface context,such as active dialog, or selected <br> |
| element. This information is used by the help to display information related to that <br> |
| context, provided this relation is defined in the help files. <i>Help IDs</i> are used to define this <br> |
| relation.<br> |
| <b>CVS</b> Concurrent Versioning System, a widespread version control system that is also used by <br> |
| OpenOffice.org. See tools.openoffice.org.<br> |
| <b>CVS Module</b> A part of the CVS that contains code for a section of the OpenOffice.org <br> |
| product.<br> |
| <b>Dependency Files</b> When a module is re-compiled, only changed files and files that depend <br> |
| on them need to be compiled again. Dependency files describe these dependencies. <br> |
| These files are used by the make utility. <br> |
| <b>DTD</b> Document Type Definition, a file that describes the document syntax for an XML <br> |
| document. The DTD is needed to validate an XML file.<br> |
| <b>Embedding</b> In OpenOffice.org help files can contain references to parts of other help files <br> |
| that are dynamically inserted when the help is displayed.<br> |
| |
| <b><i>Page 105</i></b><br> |
| <hr> |
| <a name="106"></a><b>Extended Tip</b> Yellow "bubble" on the application user interface that contains information <br> |
| about the element under the mouse cursor. Extended tips appear when the mouse <br> |
| cursor rests over a user interface element. In OpenOffice.org 1.1.x they are <br> |
| enabled/disabled using <b>Help Extended Tips</b>.<br> |
| <b>Full-Text Search</b> A help function that allows you to search through the text of the set of help <br> |
| files. The function uses a search index that is created when the help files are compiled <br> |
| and built. Help files can be excluded from this search index using the exclude value in <br> |
| the indexer attribute of the topic element.<br> |
| <b>Help Authoring Template</b> The help authoring filter contains XSLT import/export filters and a <br> |
| help authoring template that specifies the layout of the help documents inside <br> |
| OpenOffice.org.<br> |
| <b>Help Compiler</b> A program that compiles the help files into an intermediate "object" format <br> |
| that is used by the help linker to assemble the final help files that are installed with <br> |
| OpenOffice.org.<br> |
| <b>Help Content Provider</b> A service inside OpenOffice.org that provides the Help to the help <br> |
| viewer.<br> |
| <b>Help IDs</b> Numerical or symbolic identifiers that are defined for user interface elements in the <br> |
| application code. Help IDs can be used to identify the context in which the help is called <br> |
| and to define a relation between an application context and the help topic that is <br> |
| displayed.<br> |
| <b>Help Module</b> Each OpenOffice.org application has a help module associated: <i>Writer</i>, <i>Calc</i>, <br> |
| <i>Draw</i>, <i>Impress</i>, <i>Math</i>, <i>Basic</i>.<br> |
| <b>Help Section</b> A subdirectory of helpcontent2/source/text. Each help module contains <br> |
| the help files of one or more help sections.<br> |
| <b>Help Topic</b> The contents of a help file. Usually, a help topic describes one task or a logical <br> |
| group of reference information.<br> |
| <b>Help Viewer</b> - OpenOffice.org component that displays the help files and provides help <br> |
| functionality.<br> |
| <b>Icon</b> An image that is taken from the resource repository of the application itself. Icons are <br> |
| stored in different CVS modules and after installation are available in the images.zip <br> |
| file.<br> |
| <b>Image</b> Graphical content that is specific to the help files. All images are stored in the <br> |
| helpimg directory of the res CVS module and after installation are available in the <br> |
| images.zip file.<br> |
| <b>Block Image</b> An image that is on a paragraph of its own. Block images can have captions. <br> |
| <b>Inline Image</b> An image that is part of another paragraph and surrounded by text content. <br> |
| Inline images cannot have captions.<br> |
| <b>Import/Export Filter</b> XSLT files that control the conversion of the help files from xhp to <br> |
| OpenOffice.org and vice versa. Using a template they also control the appearance of the <br> |
| files in OpenOffice.org.<br> |
| <b>Index of Keywords</b> A two-level list of keywords associated with help topics. Keywords are <br> |
| explicitly defined in the help files.<br> |
| <b>Instructional Information</b> Information in OpenOffice.org help that provides instructions on <br> |
| how to fulfill tasks.<br> |
| <b>makefile</b> File that describes the processes for "making" (compiling/linking) files inside a <br> |
| |
| <b><i>Page 106</i></b><br> |
| <hr> |
| <a name="107"></a>directory. Used by the make utility.<br> |
| <b>Meta Data</b> Help file data that describe the help file, like file name, topic title, creation date. <br> |
| These are stored inside the meta element of the help file.<br> |
| <b>Nested Sections</b> Sections containing other subsections. Nested sections are supported in <br> |
| the help files.<br> |
| <b>Nested Tables</b> Tables containing other tables. Nested tables are <i>unsupported</i> in the help <br> |
| files.<br> |
| <b>Node</b> A node is a part of the help content tree that is used to group help topics. See <i><a href="HelpAuthorings-passthru.html#25">Contents</i></a><br> |
| <a href="HelpAuthorings-passthru.html#25"><i>Branch</i></a> on page<a href="HelpAuthorings-passthru.html#25"> 25</a>.<br> |
| <b>Output Tree</b> A directory tree (aka <i>solver</i>) that takes all files that are produced on "making" <br> |
| (compiling/linking) source files. See tools.openoffice.org.<br> |
| <b>Platform</b> Operating System, such as Linux, Solaris x86, Solaris SPARC, or Windows.<br> |
| <b>Reference Information</b> Information in OpenOffice.org help that explains the effect or function <br> |
| of a user interface element.<br> |
| <b>Role</b> In the help files that type of a paragraph is specified by its role attribute.<br> |
| <b>Section Delimiter Line</b> A section inside OpenOffice.org is delimited by two gray lines.<br> |
| <b>Solver</b> see <i>Output Tree</i>.<br> |
| <b>Style Sheet</b> A document containing commands for transforming an XML file (transformation <br> |
| style sheet) or for displaying an XML or HTML file (cascading style sheet).<br> |
| <b>Symbolic Name</b> The help IDs used in the applications can be transformed to symbolic <br> |
| names that are defined in the list of help ids, hid.lst. They are symbolic identifiers that <br> |
| give the number a somewhat descriptive name.<br> |
| <b>Tool Tip</b> A synonym for an extended tip.<br> |
| <b>Topic ID</b> Each help file (aka topic) has a unique topic ID to be identified. It usually is created <br> |
| from the help file name.<br> |
| <b>Transformation Style Sheet</b> The style sheet used for transformation.<br> |
| <b>Transformation</b> In this context, the process of converting the XML format of the help <br> |
| document. The major transformation takes place when the help is displayed. The <br> |
| transformation style sheet main_transform.xsl is used for that.<br> |
| <b>UNO Command Name</b> One type of help ID that is used in the applications. Other than <br> |
| "normal" help ids which are numerical, these command names are symbolic identifiers <br> |
| and don't need to be converted.<br> |
| <b>Validation</b> The process of checking the validity of a help file. See <i><a href="HelpAuthorings-passthru.html#103">Validating</i></a> on page <a href="HelpAuthorings-passthru.html#103">103</a>.<br> |
| |
| <b><i>Page 107</i></b><br> |
| <hr> |
| <a name="108"></a><b>XML Help Document Type Definition</b><br> |
| <!-- <br> |
| Version 03-Feb-2006<br> |
| added optional localize attribute to images<br> |
| --><br> |
| <!ELEMENT ahelp (#PCDATA | embedvar | br | comment | emph | item | link | <br> |
| switchinline | variable)*><br> |
| <!ATTLIST ahelp<br> |
| hid CDATA #REQUIRED<br> |
| visibility (hidden | visible) #IMPLIED<br> |
| ><br> |
| <!ELEMENT alt (#PCDATA)><br> |
| <!ATTLIST alt<br> |
| xml-lang CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT body (section | paragraph | table | comment | bookmark | switch | <br> |
| embed | list | sort)*><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> |
| <!ELEMENT bookmark_value (#PCDATA | embedvar)*><br> |
| <!ELEMENT br EMPTY><br> |
| <!ELEMENT caption (#PCDATA | embedvar | br | emph | item | link | switchinline | <br> |
| variable)*><br> |
| <!ATTLIST caption<br> |
| xml-lang CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT case (paragraph | table | comment | bookmark | embed | link | list | <br> |
| switch | section | sort)*><br> |
| <!ATTLIST case<br> |
| select CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT caseinline (#PCDATA | image | embedvar | br | emph | item | link | <br> |
| switchinline | variable | ahelp | object)*><br> |
| <!ATTLIST caseinline<br> |
| select CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT comment (#PCDATA)><br> |
| <!ELEMENT created (#PCDATA)><br> |
| <!ATTLIST created<br> |
| date CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT default (paragraph | table | comment | bookmark | embed | link | list <br> |
| | switch | section | sort)*><br> |
| <!ELEMENT defaultinline (#PCDATA | image | embedvar | br | emph | item | link | <br> |
| switchinline | variable | ahelp | object)*><br> |
| <!ELEMENT embed EMPTY><br> |
| <!ATTLIST embed<br> |
| href CDATA #REQUIRED<br> |
| role CDATA #IMPLIED<br> |
| level CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT embedvar EMPTY><br> |
| <!ATTLIST embedvar<br> |
| href CDATA #REQUIRED<br> |
| |
| <b><i>Page 108</i></b><br> |
| <hr> |
| <a name="109"></a> markup (keep | ignore) #IMPLIED<br> |
| ><br> |
| <!ELEMENT emph (#PCDATA | item | comment | help-id-missing)*><br> |
| <!ELEMENT filename (#PCDATA)><br> |
| <!ELEMENT helpdocument (meta, body)><br> |
| <!ATTLIST helpdocument<br> |
| version CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT history (created, lastedited)><br> |
| <!ELEMENT image (caption* | alt+)?><br> |
| <!ATTLIST image<br> |
| src CDATA #REQUIRED<br> |
| width CDATA #IMPLIED<br> |
| height CDATA #IMPLIED<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT item (#PCDATA)><br> |
| <!ATTLIST item<br> |
| type CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT lastedited (#PCDATA)><br> |
| <!ATTLIST lastedited<br> |
| date CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT link (#PCDATA | embedvar | emph | item | variable | switchinline)*><br> |
| <!ATTLIST link<br> |
| href CDATA #REQUIRED<br> |
| name CDATA #IMPLIED<br> |
| type CDATA #IMPLIED<br> |
| target CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT list (listitem | (comment)*)+><br> |
| <!ATTLIST list<br> |
| type CDATA #REQUIRED<br> |
| startwith CDATA #IMPLIED<br> |
| format (1 | i | I | a | A) #IMPLIED<br> |
| bullet (disc | circle | square) #IMPLIED<br> |
| sorted (asc | desc) #IMPLIED<br> |
| ><br> |
| <!ELEMENT listitem (comment | section | paragraph | table | switch | embed | <br> |
| bookmark)*><br> |
| <!ATTLIST listitem<br> |
| format (1 | i | I | a | A) #IMPLIED<br> |
| bullet (disc | circle | square) #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT meta (topic, history?)><br> |
| <!ELEMENT object EMPTY><br> |
| <!ATTLIST object<br> |
| type CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| data CDATA #REQUIRED<br> |
| height CDATA #IMPLIED<br> |
| width CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT paragraph (#PCDATA | image | comment | embedvar | br | emph | item | <br> |
| link | switchinline | variable | ahelp | object | bookmark | help-id-missing)*><br> |
| <!ATTLIST paragraph<br> |
| role CDATA #REQUIRED<br> |
| level CDATA #IMPLIED<br> |
| id CDATA #REQUIRED<br> |
| l10n CDATA #IMPLIED<br> |
| xml-lang CDATA #REQUIRED<br> |
| oldref CDATA #IMPLIED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT section (section | paragraph | table | list | comment | bookmark | <br> |
| |
| <b><i>Page 109</i></b><br> |
| <hr> |
| <a name="110"></a>embed | switch | sort )*><br> |
| <!ATTLIST section<br> |
| id CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT sort (section+)><br> |
| <!ATTLIST sort<br> |
| order (asc | desc) #IMPLIED<br> |
| ><br> |
| <!ELEMENT switch ((case | comment)* | default?)*><br> |
| <!ATTLIST switch<br> |
| select (sys | appl | distrib | target | lang | ver) #REQUIRED<br> |
| ><br> |
| <!ELEMENT switchinline ((caseinline)+, (defaultinline?)?)><br> |
| <!ATTLIST switchinline<br> |
| select (sys | appl | distrib | target | ver | lang) #REQUIRED<br> |
| ><br> |
| <!ELEMENT table (caption*, tablerow+)><br> |
| <!ATTLIST table<br> |
| name CDATA #IMPLIED<br> |
| width CDATA #IMPLIED<br> |
| height CDATA #IMPLIED<br> |
| unit CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| id CDATA #REQUIRED<br> |
| ><br> |
| <!ELEMENT tablecell (section | paragraph | comment | embed | bookmark | image | <br> |
| list)*><br> |
| <!ATTLIST tablecell<br> |
| colspan CDATA #IMPLIED<br> |
| rowspan CDATA #IMPLIED<br> |
| width CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| unit CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT tablerow (tablecell+)><br> |
| <!ATTLIST tablerow<br> |
| height CDATA #IMPLIED<br> |
| class CDATA #IMPLIED<br> |
| unit CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT title (#PCDATA)><br> |
| <!ATTLIST title<br> |
| xml-lang CDATA #REQUIRED<br> |
| id CDATA #REQUIRED<br> |
| localize CDATA #IMPLIED<br> |
| ><br> |
| <!ELEMENT topic (title+, filename, bookmark*)><br> |
| <!ATTLIST topic<br> |
| id CDATA #REQUIRED<br> |
| indexer (exclude | include) #IMPLIED<br> |
| status (DRAFT | FINAL | PUBLISH | STALLED | DEPRECATED) #IMPLIED<br> |
| ><br> |
| <!ELEMENT variable (#PCDATA | ahelp | embedvar | br | emph | item | link | <br> |
| variable | image | object | switchinline)*><br> |
| <!ATTLIST variable<br> |
| id CDATA #REQUIRED<br> |
| visibility (hidden | visible) #IMPLIED<br> |
| ><br> |
| <!ELEMENT help-id-missing EMPTY><br> |
| |
| <b><i>Page 110</i></b><br> |
| <hr> |
| <a name="outline"></a><h1>Document Outline</h1> |
| <ul> |
| <li><a href="HelpAuthorings-passthru.html#1">Credits and Table of Contents</a> |
| <li><A href="HelpAuthorings-passthru.html#9">How OpenOffice Help Works</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#9">Help Ingredients</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#9">Extended Tips</A> |
| <li><A href="HelpAuthorings-passthru.html#9">Context-Senstive Help</A> |
| <li><A href="HelpAuthorings-passthru.html#10">Hierarchical List of Contents</A> |
| <li><A href="HelpAuthorings-passthru.html#10">Index of Keywords</A> |
| <li><A href="HelpAuthorings-passthru.html#10">Full-Text Search</A> |
| <li><A href="HelpAuthorings-passthru.html#11">Bookmarks</A> |
| <li><A href="HelpAuthorings-passthru.html#11">Help Agent</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#13">Installed Help Files</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#13">Help Modules and Help Sections</A> |
| <li><A href="HelpAuthorings-passthru.html#14">Help Module Configuration Files</A> |
| <li><A href="HelpAuthorings-passthru.html#15">Help Module Contents Files</A> |
| <li><A href="HelpAuthorings-passthru.html#15">Help Module Lookup Files</A> |
| <li><A href="HelpAuthorings-passthru.html#15">Help Module Extended Tip Files</A> |
| <li><A href="HelpAuthorings-passthru.html#16">Help Module Index Files</A> |
| <li><A href="HelpAuthorings-passthru.html#16">The Main Transformation Style Sheet</A> |
| <li><A href="HelpAuthorings-passthru.html#16">CSS</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#16">Applicatin Help Calls</A> |
| <li><A href="HelpAuthorings-passthru.html#18">Structure of the CVS Help Modules</A> |
| <li><A href="HelpAuthorings-passthru.html#19">Building the Help Set</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#19">Setting Up the Build Environment</A> |
| <li><A href="HelpAuthorings-passthru.html#19">Makefiles for the Help</A> |
| <li><A href="HelpAuthorings-passthru.html#21">Help Build Process</A> |
| <li><A href="HelpAuthorings-passthru.html#22">Adding/Removing a Help File</A> |
| <li><A href="HelpAuthorings-passthru.html#22">Help Images</A> |
| </ul></ul><li><A href="HelpAuthorings-passthru.html#23">Help File XML Format Basics</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#23">Document Structure</A> |
| <li><A href="HelpAuthorings-passthru.html#23">Using Variables</A> |
| <li><A href="HelpAuthorings-passthru.html#24">Paragraph Roles</A> |
| <li><A href="HelpAuthorings-passthru.html#25">Definint Index, Contents, and Context Sensitivity</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#25">Contents Branch</A> |
| <li><A href="HelpAuthorings-passthru.html#26">Index Branch</A> |
| <li><A href="HelpAuthorings-passthru.html#26">"hid" Branch</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#27">Switching Content</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#27">Switching Complete Paragraphs or Sections</A> |
| <li><A href="HelpAuthorings-passthru.html#28">Switching Text Fragments Inside Paragraphs</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#28">Embedding Content</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#29">Embedding Complete Sections</A> |
| <li><A href="HelpAuthorings-passthru.html#29">Embedding Text Fragments</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#30">Images and Icons</A> |
| <li><A href="HelpAuthorings-passthru.html#31">Localization Information</A> |
| <li><A href="HelpAuthorings-passthru.html#31">Auxiliary Files</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#31">Files Used For Building the Help</A> |
| <li><A href="HelpAuthorings-passthru.html#32">Main Transformation Stylesheet</A> |
| <li><A href="HelpAuthorings-passthru.html#32">Contents Definition files *.tree</A> |
| </ul></ul><li><A href="HelpAuthorings-passthru.html#35">Help File XML Reference</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#35">Common Attributes</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#35">xml-lang</A> |
| <li><A href="HelpAuthorings-passthru.html#36">localize</A> |
| <li><A href="HelpAuthorings-passthru.html#36">id</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#37">Help File (*.xhp) Elements</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#37">ahelp</A> |
| <li><A href="HelpAuthorings-passthru.html#38">alt</A> |
| <li><A href="HelpAuthorings-passthru.html#38">body</A> |
| <li><A href="HelpAuthorings-passthru.html#39">bookmark</A> |
| <li><A href="HelpAuthorings-passthru.html#40">bookmark_value</A> |
| <li><A href="HelpAuthorings-passthru.html#41">br</A> |
| <li><A href="HelpAuthorings-passthru.html#41">caption</A> |
| <li><A href="HelpAuthorings-passthru.html#42">case</A> |
| <li><A href="HelpAuthorings-passthru.html#43">caseinline</A> |
| <li><A href="HelpAuthorings-passthru.html#43">comment</A> |
| <li><A href="HelpAuthorings-passthru.html#44">created</A> |
| <li><A href="HelpAuthorings-passthru.html#45">default</A> |
| <li><A href="HelpAuthorings-passthru.html#45">defaultinline</A> |
| <li><A href="HelpAuthorings-passthru.html#46">embed</A> |
| <li><A href="HelpAuthorings-passthru.html#47">embedvar</A> |
| <li><A href="HelpAuthorings-passthru.html#48>emph</A> |
| <li><A href="HelpAuthorings-passthru.html#48">filename</A> |
| <li><A href="HelpAuthorings-passthru.html#49">helpdocument</A> |
| <li><A href="HelpAuthorings-passthru.html#49">help-id-missing</A> |
| <li><A href="HelpAuthorings-passthru.html#50">History</A> |
| <li><A href="HelpAuthorings-passthru.html#50">image</A> |
| <li><A href="HelpAuthorings-passthru.html#51">item</A> |
| <li><A href="HelpAuthorings-passthru.html#52">lastedited</A> |
| <li><A href="HelpAuthorings-passthru.html#53">link</A> |
| <li><A href="HelpAuthorings-passthru.html#54">list</A> |
| <li><A href="HelpAuthorings-passthru.html#55">listitem</A> |
| <li><A href="HelpAuthorings-passthru.html#56">meta</A> |
| <li><A href="HelpAuthorings-passthru.html#57">object</A> |
| <li><A href="HelpAuthorings-passthru.html#58">paragraph</A> |
| <li><A href="HelpAuthorings-passthru.html#59">section</A> |
| <li><A href="HelpAuthorings-passthru.html#60">sort</A> |
| <li><A href="HelpAuthorings-passthru.html#61">switch</A> |
| <li><A href="HelpAuthorings-passthru.html#62">switchinline</A> |
| <li><A href="HelpAuthorings-passthru.html#63">table</A> |
| <li><A href="HelpAuthorings-passthru.html#64">tablecell</A> |
| <li><A href="HelpAuthorings-passthru.html#66">tablerow</A> |
| <li><A href="HelpAuthorings-passthru.html#67">title</A> |
| <li><A href="HelpAuthorings-passthru.html#68">topic</A> |
| <li><A href="HelpAuthorings-passthru.html#69">variable</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#70">Contents File (*.tree) Elements</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#70">tree_view</A> |
| <li><A href="HelpAuthorings-passthru.html#71">help_section</A> |
| <li><A href="HelpAuthorings-passthru.html#72">node</A> |
| <li><A href="HelpAuthorings-passthru.html#72">topic</A> |
| </ul></ul><li><A href="HelpAuthorings-passthru.html#75">Authoring Help With OpenOffice.org</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#75">Setting Up the Environment</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#75">Directory Hierachy</A> |
| <li><A href="HelpAuthorings-passthru.html#76">Installing Import/Export Filters</A> |
| <li><A href="HelpAuthorings-passthru.html#76">Installing the Supporting Macros</A> |
| <li><A href="HelpAuthorings-passthru.html#77">Installing the Help Authoring Menu</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#78">Editing Help File Basics</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#78">Paragraphs and Paragraph Formatting</A> |
| <li><A href="HelpAuthorings-passthru.html#79">Sections</A> |
| <li><A href="HelpAuthorings-passthru.html#79">Tables</A> |
| <li><A href="HelpAuthorings-passthru.html#79">Images</A> |
| <li><A href="HelpAuthorings-passthru.html#79">Lists</A> |
| <li><A href="HelpAuthorings-passthru.html#79">Embedding</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#80">Cahracter Formatting</A> |
| <li><A href="HelpAuthorings-passthru.html#80">Working With the Help Files</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#80">Creating a Help File</A> |
| <li><A href="HelpAuthorings-passthru.html#81">Opening a Help File</A> |
| <li><A href="HelpAuthorings-passthru.html#81">Removing a Help File</A> |
| <li><A href="HelpAuthorings-passthru.html#82">Moving Help File</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#82">Sections and Paragraphs</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#82">Where are the Sections?</A> |
| <li><A href="HelpAuthorings-passthru.html#83">Adding a Section</A> |
| <li><A href="HelpAuthorings-passthru.html#84">Adding a Subsection</A> |
| <li><A href="HelpAuthorings-passthru.html#84">Removing a Section</A> |
| <li><A href="HelpAuthorings-passthru.html#84">Linking to a Section</A> |
| <li><A href="HelpAuthorings-passthru.html#84">Embedding a Section</A> |
| <li><A href="HelpAuthorings-passthru.html#84">Adding a Paragraph</A> |
| <li><A href="HelpAuthorings-passthru.html#85">Editing a Paragraph</A> |
| <li><A href="HelpAuthorings-passthru.html#86">Paragraph Formatting</A> |
| <li><A href="HelpAuthorings-passthru.html#87">Creating New Styles</A> |
| <li><A href="HelpAuthorings-passthru.html#87">Changing a Paragraph Style</A> |
| <li><A href="HelpAuthorings-passthru.html#87">Changing a Character Style</A> |
| <li><A href="HelpAuthorings-passthru.html#87">Moving a Paragraph Inside a Help File</A> |
| <li><A href="HelpAuthorings-passthru.html#87">Moving a Paragraph to a Different Help File</A> |
| <li><A href="HelpAuthorings-passthru.html#88">Excluding a Paragraph from Localization</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#89">Tables</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#89">Adding a Talbe</A> |
| <li><A href="HelpAuthorings-passthru.html#89">Modifying the Table Layout</A> |
| <li><A href="HelpAuthorings-passthru.html#90">Deleting a Table</A> |
| <li><A href="HelpAuthorings-passthru.html#90">Using a Table for Formatting Purposes</A> |
| <li><A href="HelpAuthorings-passthru.html#90">Addin a Caption to an Existing Table</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#90">Lists</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#90">Inserting, Removing, Modifying Lists</A> |
| <li><A href="HelpAuthorings-passthru.html#90">Interrupting a List</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#91">Working with Images</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#91">Help Image Repository</A> |
| <li><A href="HelpAuthorings-passthru.html#92">Inserting a block image</A> |
| <li><A href="HelpAuthorings-passthru.html#92">Inserting an inline image</A> |
| <li><A href="HelpAuthorings-passthru.html#93">Adding an image caption</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#93">Embedding Content</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#93">Embedding a Section or Variable</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#94">Linking</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#94">Linking to another help file</A> |
| <li><A href="HelpAuthorings-passthru.html#94">Linking to the WWW</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#94">Meta Data</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#95">Setting the topic title</A> |
| <li><A href="HelpAuthorings-passthru.html#95">Setting the topic id</A> |
| <li><A href="HelpAuthorings-passthru.html#95">Excluding a file from the search index</A> |
| <li><A href="HelpAuthorings-passthru.html#95">Changing the initial file creation comment</A> |
| <li><A href="HelpAuthorings-passthru.html#95">chaning the Last Edited comment</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#95">Bookmarks</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#95">Adding a new bookmark with Index Entries</A> |
| <li><A href="HelpAuthorings-passthru.html#96">Adding Index Entries to an existing bokmark set</A> |
| <li><A href="HelpAuthorings-passthru.html#97">Modifying Index Entries in an existin bookmark set</A> |
| <li><A href="HelpAuthorings-passthru.html#97">Adding a new bookmark set with TOC Entries</A> |
| <li><A href="HelpAuthorings-passthru.html#97">Adding TOC Entries to an exisitng bookmark set</A> |
| <li><A href="HelpAuthorings-passthru.html#98">Determining a Help ID</A> |
| <li><A href="HelpAuthorings-passthru.html#98">Adding a Help ID</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#99">Switching Content</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#99">Inline Switching</A> |
| <li><A href="HelpAuthorings-passthru.html#100">1Swithcing complete sections or pragraphs</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#103">Miscellaneous</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#103">Extended Tips</A> |
| <li><A href="HelpAuthorings-passthru.html#103">Sorting</A> |
| <li><A href="HelpAuthorings-passthru.html#103">Validating</A> |
| </ul><li><A href="HelpAuthorings-passthru.html#104">Troubleshooting</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#104">A help file can not be opened</A> |
| <li><A href="HelpAuthorings-passthru.html#104">A help file can not be saved</A> |
| <li><A href="HelpAuthorings-passthru.html#104">No help can be opened or saved</A> |
| <li><A href="HelpAuthorings-passthru.html#104">Paragraph content has vanished on reload</A> |
| </ul></ul><li><A href="HelpAuthorings-passthru.html#105">Appendic</A> |
| <ul><li><A href="HelpAuthorings-passthru.html#105">Glossary</A> |
| <li><A href="HelpAuthorings-passthru.html#108">XML Help Document Type Definition</A> |
| </ul></ul><hr> |
| </BODY> |
| </HTML> |
