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_0805201012591739" indexer="topic_080520100201326">
271ecadb57SMathias Bauer<title xml-lang="en-US" id="tit">Special Sections in Help Documents</title>
281ecadb57SMathias Bauer<filename>org.openoffice.helpauthoring/ha-specialsections.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.OtherElements.InsertHowToGet?language=Basic&amp;location=application" id="bm_id071320100343056701" localize="false"/>
331ecadb57SMathias Bauer<paragraph id="par_id0713201005170913" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Inserts a "How to get this function" section.</ahelp></paragraph>
341ecadb57SMathias Bauer<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.OtherElements.InsertRelatedTopics?language=Basic&amp;location=application" id="bm_id071320100343056799" localize="false"/>
351ecadb57SMathias Bauer<paragraph id="par_id0713201005170923" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Inserts a "Related Topics" section.</ahelp></paragraph>
361ecadb57SMathias Bauer<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012435066">
371ecadb57SMathias Bauer<bookmark_value>Help Authoring;Special sections</bookmark_value>
381ecadb57SMathias Bauer</bookmark>
391ecadb57SMathias Bauer<paragraph id="hd_id080520101259183" role="heading" xml-lang="en-US" level="1">Special Sections in Help Documents</paragraph>
401ecadb57SMathias Bauer<paragraph id="par_id0805201002013331" role="paragraph" xml-lang="en-US">There are two pre-defined sections available that trigger special visualization in the help viewer:</paragraph>
411ecadb57SMathias Bauer<list type="unordered">
421ecadb57SMathias Bauer<listitem>
431ecadb57SMathias Bauer<paragraph id="par_id0805201002013486" role="paragraph" xml-lang="en-US"><emph>How to get this function</emph></paragraph>
441ecadb57SMathias Bauer<paragraph id="par_id0805201002013460" role="paragraph" xml-lang="en-US">This section contains information about how to execute the function described in the help file (key strokes, menu items, toolbar icons, etc) and is usually placed near the top of a help file.</paragraph>
451ecadb57SMathias Bauer</listitem>
461ecadb57SMathias Bauer<listitem>
471ecadb57SMathias Bauer<paragraph id="par_id080520100201346" role="paragraph" xml-lang="en-US"><emph>Related topics</emph></paragraph>
481ecadb57SMathias Bauer<paragraph id="par_id0805201002013467" role="paragraph" xml-lang="en-US">This section contains links to related help files and should be located at the very end of a help file.</paragraph>
491ecadb57SMathias Bauer</listitem></list>
501ecadb57SMathias Bauer<paragraph id="par_id080520100201349" role="paragraph" xml-lang="en-US">When selecting <item type="menuitem">Help Authoring &gt; "How to Get" Section</item> or <item type="menuitem">Help Authoring &gt; "Related Topics" Section</item> the corresponding sections are inserted into the document with the required meta data.</paragraph>
511ecadb57SMathias Bauer<paragraph id="hd_id080520100212342" role="heading" xml-lang="en-US" level="4">To be added</paragraph>
521ecadb57SMathias Bauer<list type="unordered">
531ecadb57SMathias Bauer<listitem>
541ecadb57SMathias Bauer<paragraph id="par_id0805201002123497" role="ul_item" xml-lang="en-US">Example, Screenshot</paragraph>
551ecadb57SMathias Bauer</listitem></list>
561ecadb57SMathias Bauer</body>
574fec54abSmseidel</helpdocument>
58