1<?xml version="1.0" encoding="UTF-8"?><helpdocument version="1.0">
2<!--***********************************************************************
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 *
8 * OpenOffice.org - a multi-platform office productivity suite
9 *
10 * This file is part of OpenOffice.org.
11 *
12 * OpenOffice.org is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License version 3
14 * only, as published by the Free Software Foundation.
15 *
16 * OpenOffice.org is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License version 3 for more details
20 * (a copy is included in the LICENSE file that accompanied this code).
21 *
22 * You should have received a copy of the GNU Lesser General Public License
23 * version 3 along with OpenOffice.org.  If not, see
24 * <http://www.openoffice.org/license.html>
25 * for a copy of the LGPLv3 License.
26 *
27 ************************************************************************ -->
28
29<meta>
30<topic id="topic_0805201012545913" indexer="topic_0805201002104372">
31<title xml-lang="en-US" id="tit">ID Assignment in Help Documents</title>
32<filename>org.openoffice.helpauthoring/ha-ids.xhp</filename>
33</topic>
34</meta>
35<body>
36<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.Helpers.InsertNewParaData?language=Basic&amp;location=application" id="bm_id07132010034305672" localize="false"/>
37<paragraph id="par_id0713201005170889" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Assigns a paragraph ID. ID-less paragraphs automatically get a paragraph ID assigned on validation.</ahelp></paragraph>
38<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012414334">
39<bookmark_value>Help Authoring;Assigning IDs</bookmark_value>
40</bookmark>
41<paragraph id="hd_id0805201012550145" role="heading" xml-lang="en-US" level="1">IDs in Help Documents</paragraph>
42<paragraph id="par_id080520100210452" role="paragraph" xml-lang="en-US">Many elements inside a help document carry an id so that they can be identified in other production steps, mainly for localization purposes. The IDs must be unique within a help document and should even be unique across help documents to allow for moving content across help files (which currently is not officially supported without re-translation).</paragraph>
43<paragraph id="par_id0805201002104581" role="paragraph" xml-lang="en-US">The help authoring environment takes care of assigning IDs to the corresponding elements on creation, or on <link href="org.openoffice.helpauthoring/ha-validating.xhp">validating</link> the help file (which also happens when a help file is saved).</paragraph>
44<paragraph id="par_id0805201002104578" role="note" xml-lang="en-US">If you copy an element within a help file you must make sure that the assigned id is different from the original. Therefore, it is best to copy a paragraph without its leading ID.</paragraph>
45<paragraph id="par_id0805201002104546" role="paragraph" xml-lang="en-US">By default, paragraph IDs are not visible. You can show them by hovering the mouse cursor over the front of a paragraph. The ID will be displayed in a popup window. Also, <link href="org.openoffice.helpauthoring/ha-l10n.xhp">toggeling the localization status of a paragraph</link> makes its ID visible:</paragraph>
46<list type="ordered">
47<listitem>
48<paragraph id="par_id080520100210456" role="ol_item" xml-lang="en-US">Place the cursor inside the paragraph</paragraph>
49</listitem>
50<listitem>
51<paragraph id="par_id0805201002104579" role="ol_item" xml-lang="en-US">Select <item type="menuitem">Help Authoring &gt; Toggle L10N</item><emph>twice</emph> (to switch back to the original state)</paragraph>
52</listitem>
53</list>
54</body>
55</helpdocument>