1*7645a134Smseidel<?xml version="1.0" encoding="UTF-8"?>
2*7645a134Smseidel
3fa9048c3SAndrew Rist<!--***********************************************************
45b0494d9Smseidel *
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
125b0494d9Smseidel *
13fa9048c3SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
145b0494d9Smseidel *
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.
215b0494d9Smseidel *
22fa9048c3SAndrew Rist ***********************************************************-->
23fa9048c3SAndrew Rist
24*7645a134Smseidel<helpdocument version="1.0">
251ecadb57SMathias Bauer<meta>
261ecadb57SMathias Bauer<topic id="topic_0805201012483523">
271ecadb57SMathias Bauer<title xml-lang="en-US" id="tit">Setting the Document Root for Help Authoring</title>
281ecadb57SMathias Bauer<filename>org.openoffice.helpauthoring/ha-docroot.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.SetDocumentRoot?language=Basic&amp;location=application" id="bm_id0713201003430568" localize="false"/>
331ecadb57SMathias Bauer<paragraph id="par_id0805201012483620" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Sets the root directory for the help documents. This is an important step since it determines the appearance of the relative URLs for links and embedded content in the help files. Select the folder that is the last in the path that should not appear in the URLs. For example, for core help files this would be "...helpcontent2/source/".</ahelp></paragraph>
341ecadb57SMathias Bauer<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012491583">
351ecadb57SMathias Bauer<bookmark_value>Help Authoring;Document Root</bookmark_value>
361ecadb57SMathias Bauer</bookmark>
371ecadb57SMathias Bauer<paragraph id="hd_id0804201004494931" role="heading" xml-lang="en-US" level="2">Setting the Document Root for Help Authoring</paragraph>
385b0494d9Smseidel<paragraph id="par_id080420100449499" role="paragraph" xml-lang="en-US">The document root entry is required to correctly compute relative URLs for images, links and transcluded (embedded) content. Make sure that you always have your document root set correctly, before working on a help file (unless you know what you are doing).</paragraph>
391ecadb57SMathias Bauer<paragraph id="par_id0804201004494922" role="paragraph" xml-lang="en-US">When working on core help files, i.e. the ones inside the helpcontent2 module, the document root must be set to the <emph>helpcontent2/source</emph> directory. For example, <item type="literal">/cws/so-cwsserv01/hcshared99/DEV300/ooo.m99/helpcontent2/source</item>.</paragraph>
401ecadb57SMathias Bauer<paragraph id="par_id0804201004494943" role="paragraph" xml-lang="en-US">When working on extension help files, the document root must be set to the help/en-US directory that contains the directory named after the extension identifier. For example, <item type="literal">/cws/so-cwsserv01/anextension/DEV300/sun.m99/weird_ext/help/en-US</item>.</paragraph>
411ecadb57SMathias Bauer</body>
425b0494d9Smseidel</helpdocument>
43