1*7645a134Smseidel<?xml version="1.0" encoding="UTF-8"?>
2*7645a134Smseidel
3fa9048c3SAndrew Rist<!--***********************************************************
44fec54abSmseidel *
5fa9048c3SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6fa9048c3SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7fa9048c3SAndrew Rist * distributed with this work for additional information
8fa9048c3SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9fa9048c3SAndrew Rist * to you under the Apache License, Version 2.0 (the
10fa9048c3SAndrew Rist * "License"); you may not use this file except in compliance
11fa9048c3SAndrew Rist * with the License.  You may obtain a copy of the License at
124fec54abSmseidel *
13fa9048c3SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
144fec54abSmseidel *
15fa9048c3SAndrew Rist * Unless required by applicable law or agreed to in writing,
16fa9048c3SAndrew Rist * software distributed under the License is distributed on an
17fa9048c3SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18fa9048c3SAndrew Rist * KIND, either express or implied.  See the License for the
19fa9048c3SAndrew Rist * specific language governing permissions and limitations
20fa9048c3SAndrew Rist * under the License.
214fec54abSmseidel *
22fa9048c3SAndrew Rist ***********************************************************-->
23fa9048c3SAndrew Rist
24*7645a134Smseidel<helpdocument version="1.0">
251ecadb57SMathias Bauer<meta>
261ecadb57SMathias Bauer<topic id="topic_0805201012545913" indexer="topic_0805201002104372">
271ecadb57SMathias Bauer<title xml-lang="en-US" id="tit">ID Assignment in Help Documents</title>
281ecadb57SMathias Bauer<filename>org.openoffice.helpauthoring/ha-ids.xhp</filename>
291ecadb57SMathias Bauer</topic>
301ecadb57SMathias Bauer</meta>
311ecadb57SMathias Bauer<body>
321ecadb57SMathias Bauer<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.Helpers.InsertNewParaData?language=Basic&amp;location=application" id="bm_id07132010034305672" localize="false"/>
331ecadb57SMathias Bauer<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>
341ecadb57SMathias Bauer<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012414334">
351ecadb57SMathias Bauer<bookmark_value>Help Authoring;Assigning IDs</bookmark_value>
361ecadb57SMathias Bauer</bookmark>
371ecadb57SMathias Bauer<paragraph id="hd_id0805201012550145" role="heading" xml-lang="en-US" level="1">IDs in Help Documents</paragraph>
381ecadb57SMathias Bauer<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>
391ecadb57SMathias Bauer<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>
401ecadb57SMathias Bauer<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>
414fec54abSmseidel<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">toggling the localization status of a paragraph</link> makes its ID visible:</paragraph>
421ecadb57SMathias Bauer<list type="ordered">
431ecadb57SMathias Bauer<listitem>
441ecadb57SMathias Bauer<paragraph id="par_id080520100210456" role="ol_item" xml-lang="en-US">Place the cursor inside the paragraph</paragraph>
451ecadb57SMathias Bauer</listitem>
461ecadb57SMathias Bauer<listitem>
471ecadb57SMathias Bauer<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>
481ecadb57SMathias Bauer</listitem>
491ecadb57SMathias Bauer</list>
501ecadb57SMathias Bauer</body>
514fec54abSmseidel</helpdocument>
52