1<?xml version="1.0" encoding="UTF-8"?><helpdocument version="1.0"> 2<!--*********************************************************************** 3 * 4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 5 * 6 * Copyright 2000, 2010 Oracle and/or its affiliates. 7 * 8 * OpenOffice.org - a multi-platform office productivity suite 9 * 10 * This file is part of OpenOffice.org. 11 * 12 * OpenOffice.org is free software: you can redistribute it and/or modify 13 * it under the terms of the GNU Lesser General Public License version 3 14 * only, as published by the Free Software Foundation. 15 * 16 * OpenOffice.org is distributed in the hope that it will be useful, 17 * but WITHOUT ANY WARRANTY; without even the implied warranty of 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 * GNU Lesser General Public License version 3 for more details 20 * (a copy is included in the LICENSE file that accompanied this code). 21 * 22 * You should have received a copy of the GNU Lesser General Public License 23 * version 3 along with OpenOffice.org. If not, see 24 * <http://www.openoffice.org/license.html> 25 * for a copy of the LGPLv3 License. 26 * 27 ************************************************************************ --> 28 29<meta> 30<topic id="topic_0805201012591739" indexer="topic_080520100201326"> 31<title xml-lang="en-US" id="tit">Special Sections in Help Documents</title> 32<filename>org.openoffice.helpauthoring/ha-specialsections.xhp</filename> 33</topic> 34</meta> 35<body> 36<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.OtherElements.InsertHowToGet?language=Basic&location=application" id="bm_id071320100343056701" localize="false"/> 37<paragraph id="par_id0713201005170913" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Inserts a "How to get this function" section.</ahelp></paragraph> 38<bookmark xml-lang="en-US" branch="hid/vnd.sun.star.script:HelpAuthoring.OtherElements.InsertRelatedTopics?language=Basic&location=application" id="bm_id071320100343056799" localize="false"/> 39<paragraph id="par_id0713201005170923" role="paragraph" xml-lang="en-US"><ahelp hid="" visibility="hidden">Inserts a "Related Topics" section.</ahelp></paragraph> 40<bookmark xml-lang="en-US" branch="index" id="bm_id0805201012435066"> 41<bookmark_value>Help Authoring;Special sections</bookmark_value> 42</bookmark> 43<paragraph id="hd_id080520101259183" role="heading" xml-lang="en-US" level="1">Special Sections in Help Documents</paragraph> 44<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> 45<list type="unordered"> 46<listitem> 47<paragraph id="par_id0805201002013486" role="paragraph" xml-lang="en-US"><emph>How to get this function</emph></paragraph> 48<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> 49<paragraph id="par_id0805201002185331" role="paragraph" xml-lang="en-US"> 50<image id="img_id080520100218213" src="../img/howtoget.png"><alt xml-lang="en-US" id="alt_id080520100218213">How to get this function</alt> 51 </image></paragraph> 52</listitem> 53<listitem> 54<paragraph id="par_id080520100201346" role="paragraph" xml-lang="en-US"><emph>Related topics</emph></paragraph> 55<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> 56</listitem></list> 57<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> 58<paragraph id="hd_id080520100212342" role="heading" xml-lang="en-US" level="4">To be added</paragraph> 59<list type="unordered"> 60<listitem> 61<paragraph id="par_id0805201002123497" role="ul_item" xml-lang="en-US">Example, Screenshot</paragraph> 62</listitem></list> 63</body> 64</helpdocument>
