summaryrefslogtreecommitdiff
path: root/source/text/shared/05/new_help.xhp
blob: 5c2400b7e4a867e7e0eab5202daaa23f755a14e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
    <!--
    * This file is part of the LibreOffice project.
    *
    * This Source Code Form is subject to the terms of the Mozilla Public
    * License, v. 2.0. If a copy of the MPL was not distributed with this
    * file, You can obtain one at http://mozilla.org/MPL/2.0/.
    -->

    <meta>
        <topic id="textshared0500000110xml" indexer="include" status="PUBLISH">
            <title xml-lang="en-US" id="tit">The %PRODUCTNAME Help Window</title>
            <filename>/text/shared/05/new_help.xhp</filename>
        </topic>
    </meta>
    <body>
    <bookmark xml-lang="en-US" branch="index" id="bm_id301534906947308">
        <bookmark_value>%PRODUCTNAME Help</bookmark_value>
        <bookmark_value>Help pages;Index</bookmark_value>
        <bookmark_value>Help pages;search in index</bookmark_value>
        <bookmark_value>search;Help index</bookmark_value>
        <bookmark_value>Help pages;contents</bookmark_value>
    </bookmark>
    <bookmark xml-lang="en-US" branch="hid/.uno:HelpOnHelp" id="bm_id3706162" localize="false"/>
    <bookmark xml-lang="en-US" branch="hid/.uno:HelpIndex" id="bm_id3806162" localize="false"/>
    <h1 id="hd_id3153884"><variable id="newhlp"><link href="text/shared/05/new_help.xhp" name="The %PRODUCTNAME Help Window">The %PRODUCTNAME Help</link></variable></h1>
    <embed href="text/shared/06/youtubevideos.xhp#whatisit"/>
    <bookmark xml-lang="en-US" branch="hid/SFX2_HID_HELP_TOOLBOX" id="bm_id3153114" localize="false"/>
    <paragraph role="paragraph" id="par_id171534888116942" xml-lang="en-US">%PRODUCTNAME Help pages are displayed in your system default web browser.</paragraph>
    <embed href="text/shared/05/00000100.xhp#neuehilfe"/>
    <warning id="par_id3156183">The Help system for all versions of the software is based on the same source files. Some of the functions described in Help may not be included in this particular distribution. Some features specific to a distribution may not be mentioned in this Help.</warning>
    <paragraph xml-lang="en-US" id="par_id3147143" role="paragraph"><ahelp hid=".uno:HelpOnHelp" visibility="hidden">Provides an overview of the Help system.</ahelp></paragraph>
    <note id="par_id341534965962279">Help pages of %PRODUCTNAME Extensions still use the old Help system. The old Help system help pages <link href="text/shared/05/00000110.xhp" name="oldhelp">are available from here</link>.</note>
    <h2 id="hd_id701534964258231">The %PRODUCTNAME Help pages features</h2>
    <h3 id="hd_id561534964266978">The Module List</h3>
    <paragraph role="paragraph" id="par_id851534964274673" xml-lang="en-US">Located on the top of the page, click to open the drop-down list and select the %PRODUCTNAME module to display the module Help main entry page.</paragraph>
    <h3 id="hd_id1001534964280630">The Language List (Help online only).</h3>
    <paragraph role="paragraph" id="par_id801534964285706" xml-lang="en-US">Available only in the online version, select the language to display the current help page.</paragraph>

    <section id="helpindx">
        <h3 id="hd_id821534891267696"><variable id="hlpindx01"><link href="text/shared/05/new_help.xhp#helpindx" name="The Help Index">The Help Index</link></variable></h3>
    <paragraph xml-lang="en-US" id="par_id3151351" role="paragraph">The Help Index displays a list of keywords for all %PRODUCTNAME modules. Click on any keyword in the list to open the linked Help page.</paragraph>
    <h3 id="hd_id151534901836252">Searching the Help Index</h3>
    <paragraph role="paragraph" id="par_id311534901893169" xml-lang="en-US">Type the keyword in the Search text box. The search is performed immediately, while you type the keyword.</paragraph>
    <paragraph role="paragraph" id="par_id201534891524377" xml-lang="en-US">The search results is displayed as a filtered list of matches. The module name is displayed as a heading on the list. The <emph>GLOBAL</emph> heading indicates a match for keywords relevant to more than one %PRODUCTNAME module. For example, cell borders applies to spreadsheets cells as well as text and presentation table cells or frames.</paragraph>
    <paragraph role="paragraph" id="par_id261534891513315" xml-lang="en-US">Use the arrow icons on the bottom of the Index to scroll forward or backward the Index entries or filtered result list.</paragraph>
    </section>

    <section id="hlpcnts">
        <h3 id="hd_id901534891620807"><variable id="hlpcnts01"><link href="text/shared/05/new_help.xhp#hlpcnts" name="Contents - The Main Help Topics">Contents - The Main Help Topics</link></variable></h3>
    <paragraph xml-lang="en-US" id="par_id3145748" role="paragraph">Displays an index of the main topics of all modules.</paragraph>
    <list type="unordered">
        <listitem>
            <paragraph role="paragraph" id="par_id3150774" xml-lang="en-US">Click a closed folder (<emph>⊞</emph>) to open it and display the subfolders and Help pages.</paragraph>
        </listitem>
        <listitem>
            <paragraph role="paragraph" id="par_id3154749" xml-lang="en-US">Click an open folder (<emph>⊟</emph>) to close it and hide the subfolders and Help pages.</paragraph>
        </listitem>
        <listitem>
            <paragraph role="paragraph" id="par_id3152909" xml-lang="en-US">Click a link to display the corresponding Help page.</paragraph>
        </listitem>
    </list>
</section>
    <h2 id="hd_id441534964525171">Using the browser for %PRODUCTNAME Help</h2>
    <h3 id="hd_id471534889101620">Navigating in Help pages</h3>
    <paragraph role="paragraph" id="par_id871534889171418" xml-lang="en-US">Use the <emph>Back</emph> and <emph>Forward</emph> buttons of the browser to navigate between pages. In most browsers, a long click on the <emph>Back</emph> button displays a dropdown list of previously visited pages and a long click on the <emph>Forward</emph> button display a list of visited pages after the current one.</paragraph>

    <section id="bkmhlppag">
        <h3 id="hd_id321534889287756"><variable id="bkm01"><link href="text/shared/05/new_help.xhp#bkmhlppag" name="Bookmarking Help pages">Bookmarking Help pages</link></variable></h3>
    <paragraph role="paragraph" id="par_id581534889349758" xml-lang="en-US">Use the bookmark feature of the browser for quick access to relevant Help pages. To bookmark a page in most browsers:</paragraph>
    <list type="ordered">
        <listitem>
            <paragraph id="par_id71534889492593" role="listitem" xml-lang="en-US">Open the <emph>Bookmark</emph> menu of the browser,</paragraph>
        </listitem>
        <listitem>
            <paragraph id="par_id71534889724361" role="listitem" xml-lang="en-US">select <emph>Add bookmark</emph>, or</paragraph>
            <paragraph role="paragraph" id="par_id961534889672410" xml-lang="en-US">Press <switchinline select="sys">
                    <caseinline select="MAC"><emph>Command</emph></caseinline><defaultinline><emph>Ctrl</emph></defaultinline></switchinline><emph>+D</emph> on most browsers.</paragraph>
        </listitem>
        <listitem>
            <paragraph id="par_id191534889878558" role="listitem" xml-lang="en-US">Enter the name, folder and meaningful tags for the bookmark.</paragraph>
        </listitem>
        <listitem>
            <paragraph id="par_id771534889897625" role="listitem" xml-lang="en-US">Close the bookmark dialog of the web browser.</paragraph>
        </listitem>
        </list>
    </section>

    <h3 id="hd_id571534890260376">Help Pages Navigation History</h3>
    <paragraph role="paragraph" id="par_id411534890266018" xml-lang="en-US">Each Help page visited is recorded in the web browser history. To open the navigation history:</paragraph>
    <list type="ordered">
        <listitem>
            <paragraph id="par_id401534890287783" role="listitem" xml-lang="en-US">Choose the <emph>History</emph> menu of the web browser,</paragraph>
        </listitem>
        <listitem>
            <paragraph id="par_id991534890295828" role="listitem" xml-lang="en-US">Select <emph>Show History</emph>.</paragraph>
        </listitem>
        <listitem>
            <paragraph id="par_id591534890299255" role="listitem" xml-lang="en-US">Click on any entry of the history main window to open the corresponding help page.</paragraph>
        </listitem>
    </list>

    <h3 id="hd_id841534888870987">Copying Help contents to clipboard</h3>
    <paragraph xml-lang="en-US" id="par_idN10926" role="paragraph">You can copy contents from the Help page to the clipboard on your operating system with standard copy commands. For example:</paragraph>
    <list type="ordered">
        <listitem>
            <paragraph xml-lang="en-US" id="par_idN1092C" role="paragraph">On a Help page, select the text that you want to copy.</paragraph>
        </listitem>
        <listitem>
            <paragraph xml-lang="en-US" id="par_idN10930" role="paragraph">Press <switchinline select="sys"><caseinline select="MAC"><emph>Command</emph></caseinline><defaultinline><emph>Ctrl</emph></defaultinline></switchinline><emph>+C</emph>.</paragraph>
        </listitem>
    </list>
    <paragraph role="paragraph" id="par_id791534903145827" xml-lang="en-US">Some contents in help pages can be copied to the system clipboard with only one mouse click. In these cases a tooltip appears when hovering the mouse on the copy-enabled contents. For example, the following line is copy-enabled:</paragraph>
    <paragraph role="paragraph" id="par_id381534903133044" xml-lang="en-US"><item type="input">=SUM(A1:A10)</item></paragraph>
    <h3 id="hd_id201534888332793">Searching in current page</h3>
    <paragraph xml-lang="en-US" id="par_idN10933" role="paragraph">To search in the current Help page:</paragraph>
    <list type="ordered">
        <listitem>
            <paragraph xml-lang="en-US" id="par_idN10939" role="paragraph">Open the View menu of your default web browser and choose <emph>Find on this Page</emph> entry.</paragraph>
            <paragraph xml-lang="en-US" id="par_idN10A36" role="paragraph">You can also press <switchinline select="sys"><caseinline select="MAC"><emph>Command</emph></caseinline><defaultinline><emph>Ctrl</emph></defaultinline></switchinline><emph>+F</emph>.</paragraph>
        </listitem>
        <listitem>
            <paragraph xml-lang="en-US" id="par_idN10A22" role="paragraph">In the <emph>Search for</emph> box, enter the text that you want to find.</paragraph>
        </listitem>
        <listitem>
            <paragraph xml-lang="en-US" id="par_idN10A48" role="paragraph">Select the search options that you want to use.</paragraph>
        </listitem>
        <listitem>
            <paragraph xml-lang="en-US" id="par_idN10A26" role="paragraph">Press <emph>Enter</emph>.</paragraph>
        </listitem>
    </list>
    <paragraph xml-lang="en-US" id="par_idN10A59" role="paragraph">To find the next occurrence of the search term on the page, click on the <emph>Up arrow</emph> or <emph>Down arrow</emph> to find the previous or next occurrence.</paragraph>
    <h2 id="hd_id141534964599864">Contents general information</h2>
    <embed href="text/shared/05/00000002.xhp#symbole"/>
    <section id="relatedtopics">
        <embed href="text/shared/05/00000001.xhp#00000001"/>
    </section>
</body>
</helpdocument>