1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?><helpdocument version="1.0">
2*b1cdbd2cSJim Jagielski<!--***********************************************************
3*b1cdbd2cSJim Jagielski *
4*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
5*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
6*b1cdbd2cSJim Jagielski * distributed with this work for additional information
7*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
8*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
9*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
10*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
11*b1cdbd2cSJim Jagielski *
12*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
13*b1cdbd2cSJim Jagielski *
14*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
15*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
16*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
18*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
19*b1cdbd2cSJim Jagielski * under the License.
20*b1cdbd2cSJim Jagielski *
21*b1cdbd2cSJim Jagielski ***********************************************************-->
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski
25*b1cdbd2cSJim Jagielski<meta>
26*b1cdbd2cSJim Jagielski<topic id="topic_0805201012483523">
27*b1cdbd2cSJim Jagielski<title xml-lang="en-US" id="tit">Setting the Document Root for Help Authoring</title>
28*b1cdbd2cSJim Jagielski<filename>org.openoffice.helpauthoring/ha-docroot.xhp</filename>
29*b1cdbd2cSJim Jagielski</topic>
30*b1cdbd2cSJim Jagielski</meta>
31*b1cdbd2cSJim Jagielski<body>
32*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.Helpers.SetDocumentRoot?language=Basic&amp;location=application" id="bm_id0713201003430568" localize="false"/>
33*b1cdbd2cSJim Jagielski<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>
34*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012491583">
35*b1cdbd2cSJim Jagielski<bookmark_value>Help Authoring;Document Root</bookmark_value>
36*b1cdbd2cSJim Jagielski</bookmark>
37*b1cdbd2cSJim Jagielski<paragraph id="hd_id0804201004494931" role="heading" xml-lang="en-US" level="2">Setting the Document Root for Help Authoring</paragraph>
38*b1cdbd2cSJim Jagielski<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 trandscluded (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>
39*b1cdbd2cSJim Jagielski<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>
40*b1cdbd2cSJim Jagielski<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>
41*b1cdbd2cSJim Jagielski</body>
42*b1cdbd2cSJim Jagielski</helpdocument>