1<?xml version="1.0" encoding="UTF-8"?><helpdocument version="1.0"> 2<!--*********************************************************** 3 * 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 * 21 ***********************************************************--> 22 23 24 25<meta> 26<topic id="topic_0805201012591739" indexer="topic_080520100201326"> 27<title xml-lang="en-US" id="tit">Special Sections in Help Documents</title> 28<filename>org.openoffice.helpauthoring/ha-specialsections.xhp</filename> 29</topic> 30</meta> 31<body> 32<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.OtherElements.InsertHowToGet?language=Basic&location=application" id="bm_id071320100343056701" localize="false"/> 33<paragraph id="par_id0713201005170913" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Inserts a "How to get this function" section.</ahelp></paragraph> 34<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.OtherElements.InsertRelatedTopics?language=Basic&location=application" id="bm_id071320100343056799" localize="false"/> 35<paragraph id="par_id0713201005170923" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Inserts a "Related Topics" section.</ahelp></paragraph> 36<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012435066"> 37<bookmark_value>Help Authoring;Special sections</bookmark_value> 38</bookmark> 39<paragraph id="hd_id080520101259183" role="heading" xml-lang="en-US" level="1">Special Sections in Help Documents</paragraph> 40<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> 41<list type="unordered"> 42<listitem> 43<paragraph id="par_id0805201002013486" role="paragraph" xml-lang="en-US"><emph>How to get this function</emph></paragraph> 44<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> 45<paragraph id="par_id0805201002185331" role="paragraph" xml-lang="en-US"> 46<image id="img_id080520100218213" src="../img/howtoget.png"><alt xml-lang="en-US" id="alt_id080520100218213">How to get this function</alt> 47 </image></paragraph> 48</listitem> 49<listitem> 50<paragraph id="par_id080520100201346" role="paragraph" xml-lang="en-US"><emph>Related topics</emph></paragraph> 51<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> 52</listitem></list> 53<paragraph id="par_id080520100201349" role="paragraph" xml-lang="en-US">When selecting <item type="menuitem">Help Authoring > "How to Get" Section</item> or <item type="menuitem">Help Authoring > "Related Topics" Section</item> the corresponding sections are inserted into the document with the required meta data.</paragraph> 54<paragraph id="hd_id080520100212342" role="heading" xml-lang="en-US" level="4">To be added</paragraph> 55<list type="unordered"> 56<listitem> 57<paragraph id="par_id0805201002123497" role="ul_item" xml-lang="en-US">Example, Screenshot</paragraph> 58</listitem></list> 59</body> 60</helpdocument>
