tdf#126923 Add guide for subtotals tool

Change-Id: I941214be272d6e959c1129b074891bb6f229ba26
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/91079
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>

6 files changed, 106 insertions, 57 deletions

diff --git a/AllLangHelp_scalc.mk b/AllLangHelp_scalc.mk
index d2a7e20c0b..32fe1d62e0 100644
--- a/AllLangHelp_scalc.mk
+++ b/AllLangHelp_scalc.mk
@@ -384,6 +384,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,scalc,\
     helpcontent2/source/text/scalc/guide/scenario \
     helpcontent2/source/text/scalc/guide/sorted_list \
     helpcontent2/source/text/scalc/guide/specialfilter \
+    helpcontent2/source/text/scalc/guide/subtotaltool \
     helpcontent2/source/text/scalc/guide/super_subscript \
     helpcontent2/source/text/scalc/guide/table_cellmerge \
     helpcontent2/source/text/scalc/guide/table_rotate \
diff --git a/source/auxiliary/scalc.tree b/source/auxiliary/scalc.tree
index 52f2631dce..a82517becb 100644
--- a/source/auxiliary/scalc.tree
+++ b/source/auxiliary/scalc.tree
@@ -140,19 +140,22 @@
 <topic id="scalc/text/scalc/guide/datapilot_filtertable.xhp">Filtering Pivot Tables</topic>
 <topic id="scalc/text/scalc/guide/datapilot_tipps.xhp">Selecting Pivot Table Output Ranges</topic>
 <topic id="scalc/text/scalc/guide/datapilot_updatetable.xhp">Updating Pivot Tables</topic>
-		</node>
-                <node id="08091" title="Pivot Chart">
-                    <topic id="scalc/text/scalc/guide/pivotchart.xhp">Pivot Chart</topic>
-                    <topic id="scalc/text/scalc/guide/pivotchart_create.xhp">Creating Pivot Charts</topic>
-                    <topic id="scalc/text/scalc/guide/pivotchart_edit.xhp">Editing Pivot Charts</topic>
-                    <topic id="scalc/text/scalc/guide/pivotchart_filter.xhp">Filtering Pivot Charts</topic>
-                    <topic id="scalc/text/scalc/guide/pivotchart_update.xhp">Updating Pivot Charts</topic>
-                    <topic id="scalc/text/scalc/guide/pivotchart_delete.xhp">Deleting Pivot Charts</topic>
-                </node>
-		<node id="0810" title="Scenarios">
+</node>
+<node id="08091" title="Pivot Chart">
+<topic id="scalc/text/scalc/guide/pivotchart.xhp">Pivot Chart</topic>
+<topic id="scalc/text/scalc/guide/pivotchart_create.xhp">Creating Pivot Charts</topic>
+<topic id="scalc/text/scalc/guide/pivotchart_edit.xhp">Editing Pivot Charts</topic>
+<topic id="scalc/text/scalc/guide/pivotchart_filter.xhp">Filtering Pivot Charts</topic>
+<topic id="scalc/text/scalc/guide/pivotchart_update.xhp">Updating Pivot Charts</topic>
+<topic id="scalc/text/scalc/guide/pivotchart_delete.xhp">Deleting Pivot Charts</topic>
+</node>
+<node id="0810" title="Scenarios">
 <topic id="scalc/text/scalc/guide/scenario.xhp">Using Scenarios</topic>
-		</node>
-		<node id="0811" title="References">
+</node>
+<node id="08101" title="Subtotals">
+<topic id="scalc/text/scalc/guide/subtotaltool.xhp">Using Subtotals Tool</topic>
+</node>
+<node id="0811" title="References">
 <topic id="scalc/text/scalc/guide/relativ_absolut_ref.xhp">Addresses and References, Absolute and Relative</topic>
 <topic id="scalc/text/scalc/guide/cellreferences.xhp">Referencing a Cell in Another Document</topic>
 <topic id="scalc/text/scalc/guide/cellreferences_url.xhp">References to Other Sheets and Referencing URLs</topic>
diff --git a/source/text/scalc/01/12050000.xhp b/source/text/scalc/01/12050000.xhp
index f9a1f947f9..8b6ed83112 100644
--- a/source/text/scalc/01/12050000.xhp
+++ b/source/text/scalc/01/12050000.xhp
@@ -30,7 +30,7 @@
 
 <bookmark branch="hid/.uno:DataSubTotals" xml-lang="en-US" id="bm_id3154515" localize="false"/>
 <section id="subtotalheader">
-<h1 id="hd_id3153822"><link href="text/scalc/01/12050000.xhp" name="subtotals">Subtotals</link></h1>
+    <h1 id="hd_id3153822"><variable id="subtotalheaderh1"><link href="text/scalc/01/12050000.xhp" name="subtotals">Subtotals</link></variable></h1>
   <paragraph role="paragraph" id="par_id3145119" xml-lang="en-US"><variable id="teilergebnisse"><ahelp hid=".uno:DataSubTotals" visibility="visible">Calculates subtotals for the columns that you select.</ahelp></variable> $[officename] uses the SUM function to automatically calculate the subtotal and grand total values in a labeled range. You can also use other functions to perform the calculation. $[officename] automatically recognizes a defined database area when you place the cursor in it.</paragraph>
   </section>
   <section id="howtoget">
@@ -42,6 +42,8 @@
   <embed href="text/shared/00/00000001.xhp#zurueck"/>
   <h2 id="hd_id3163708">Delete</h2>
   <paragraph role="paragraph" id="par_id3154125" xml-lang="en-US">Deletes the subtotal rows in the selected area.</paragraph>
-
+  <section id="relatedtopics">
+    <embed href="text/scalc/guide/subtotaltool.xhp#subtotaltoolh1"/>
+</section>
  </body>
 </helpdocument>
diff --git a/source/text/scalc/01/12050100.xhp b/source/text/scalc/01/12050100.xhp
index 4c317808f9..eee5400783 100644
--- a/source/text/scalc/01/12050100.xhp
+++ b/source/text/scalc/01/12050100.xhp
@@ -1,6 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-
 <!--
  * This file is part of the LibreOffice project.
  *
@@ -18,7 +16,6 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  -->
-
 <helpdocument version="1.0">
 <meta>
 <topic id="textscalc0112050100xml" indexer="include" status="PUBLISH">
@@ -33,41 +30,23 @@
 <section id="gruppe">
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotalgrppage/SubTotalGrpPage" id="bm_id3147335" localize="false"/>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotalgrppage/@@nowidget@@" id="bm_id3147335" localize="false"/>
-<paragraph role="heading" id="hd_id3149784" xml-lang="en-US" level="1"><link href="text/scalc/01/12050100.xhp" name="1st, 2nd, 3rd Group">1st, 2nd, 3rd Group</link></paragraph>
+<h1 id="hd_id3149784"><link href="text/scalc/01/12050100.xhp" name="1st, 2nd, 3rd Group">1st, 2nd, 3rd Group</link></h1>
 <paragraph role="paragraph" id="par_id3145068" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotalgrppage/SubTotalGrpPage">Specify the settings for up to three subtotal groups. Each tab has the same layout.</ahelp></paragraph>
 </section>
 <section id="howtoget">
   <embed href="text/scalc/00/00000412.xhp#dntezd"/>
 </section>
-<paragraph role="paragraph" id="par_id3148797" xml-lang="en-US">To insert subtotal values into a table:</paragraph>
-<list type="ordered">
-<listitem>
-<paragraph role="listitem" id="par_id3154908" xml-lang="en-US">Ensure that the columns of the table have labels.</paragraph>
-</listitem>
-<listitem>
-<paragraph role="listitem" id="par_id3153968" xml-lang="en-US">Select the table or the area in the table that you want to calculate subtotals for, and then choose <emph>Data – Subtotals</emph>.</paragraph>
-</listitem>
-<listitem>
-<paragraph role="listitem" id="par_id3161831" xml-lang="en-US">In the <emph>Group By</emph> box, select the column that you want to add the subtotals to.</paragraph>
-</listitem>
-<listitem>
-<paragraph role="listitem" id="par_id3153188" xml-lang="en-US">In the <emph>Calculate subtotals for</emph> box, select the check boxes for the columns containing the values that you want to subtotal.</paragraph>
-</listitem>
-<listitem>
-<paragraph role="listitem" id="par_id3152460" xml-lang="en-US">In the <emph>Use function</emph> box, select the function that you want to use to calculate the subtotals.</paragraph>
-</listitem>
-<listitem>
-<paragraph role="listitem" id="par_id3154321" xml-lang="en-US">Click <emph>OK</emph>.</paragraph>
-</listitem>
-</list>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotalgrppage/group_by" id="bm_id3163713" localize="false"/>
-<paragraph role="heading" id="hd_id3156441" xml-lang="en-US" level="2">Group by</paragraph>
+<h2 id="hd_id3156441">Group by</h2>
 <paragraph role="paragraph" id="par_id3154013" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotalgrppage/group_by">Select the column that you want to control the subtotal calculation process. If the contents of the selected column change, the subtotals are automatically recalculated.</ahelp></paragraph>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotalgrppage/columns" id="bm_id3149379" localize="false"/>
-<paragraph role="heading" id="hd_id3154943" xml-lang="en-US" level="2">Calculate subtotals for</paragraph>
+<h2 id="hd_id3154943">Calculate subtotals for</h2>
 <paragraph role="paragraph" id="par_id3147125" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotalgrppage/columns">Select the column(s) containing the values that you want to subtotal.</ahelp></paragraph>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotalgrppage/functions" id="bm_id3149413" localize="false"/>
-<paragraph role="heading" id="hd_id3156283" xml-lang="en-US" level="2">Use function</paragraph>
+<h2 id="hd_id3156283">Use function</h2>
 <paragraph role="paragraph" id="par_id3145647" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotalgrppage/functions">Select the mathematical function that you want to use to calculate the subtotals.</ahelp></paragraph>
+<section id="relatedtopics">
+    <embed href="text/scalc/guide/subtotaltool.xhp#subtotaltoolh1"/>
+</section>
 </body>
 </helpdocument>
diff --git a/source/text/scalc/01/12050200.xhp b/source/text/scalc/01/12050200.xhp
index 6c178aa17e..ab8b830c5f 100644
--- a/source/text/scalc/01/12050200.xhp
+++ b/source/text/scalc/01/12050200.xhp
@@ -1,7 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-
-
 <!--
  * This file is part of the LibreOffice project.
  *
@@ -19,9 +16,7 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  -->
-
-
-		<helpdocument version="1.0">
+<helpdocument version="1.0">
 <meta>
 <topic id="textscalc0112050200xml" indexer="include" status="PUBLISH">
 <title id="tit" xml-lang="en-US">Options</title>
@@ -34,27 +29,30 @@
 </bookmark>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/SubTotalOptionsPage" id="bm_id3150543" localize="false"/>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/@@nowidget@@" id="bm_id3150543" localize="false"/>
-<paragraph role="heading" id="hd_id3154758" xml-lang="en-US" level="1"><link href="text/scalc/01/12050200.xhp" name="Options">Options</link></paragraph>
+<h1 id="hd_id3154758"><link href="text/scalc/01/12050200.xhp" name="Options">Options</link></h1>
 <paragraph role="paragraph" id="par_id3154124" xml-lang="en-US"><ahelp hid=".">Specify the settings for calculating and presenting subtotals.</ahelp></paragraph>
 </section>
 <section id="howtoget">
   <embed href="text/scalc/00/00000412.xhp#dntopi"/>
 </section>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/pagebreak" id="bm_id3155131" localize="false"/><paragraph role="heading" id="hd_id3156422" xml-lang="en-US" level="2">Page break between groups</paragraph>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/pagebreak" id="bm_id3155131" localize="false"/><h2 id="hd_id3156422">Page break between groups</h2>
 <paragraph role="paragraph" id="par_id3147317" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotaloptionspage/pagebreak">Inserts a new page after each group of subtotaled data.</ahelp></paragraph>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/case" id="bm_id3151115" localize="false"/><paragraph role="heading" id="hd_id3146985" xml-lang="en-US" level="2">Case sensitive</paragraph>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/case" id="bm_id3151115" localize="false"/><h2 id="hd_id3146985">Case sensitive</h2>
 <paragraph role="paragraph" id="par_id3153190" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotaloptionspage/case">Recalculates subtotals when you change the case of a data label.</ahelp></paragraph>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/sort" id="bm_id3152596" localize="false"/><paragraph role="heading" id="hd_id3151119" xml-lang="en-US" level="2">Pre-sort area according to groups</paragraph>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/sort" id="bm_id3152596" localize="false"/><h2 id="hd_id3151119">Pre-sort area according to groups</h2>
 <paragraph role="paragraph" id="par_id3149664" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotaloptionspage/sort">Sorts the area that you selected in the <emph>Group by</emph> box of the Group tabs according to the columns that you selected.</ahelp></paragraph>
-<paragraph role="heading" id="hd_id3153951" xml-lang="en-US" level="2">Sort</paragraph>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/formats" id="bm_id3147397" localize="false"/><paragraph role="heading" id="hd_id3145252" xml-lang="en-US" level="3">Include formats</paragraph>
+<h2 id="hd_id3153951">Sort</h2>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/formats" id="bm_id3147397" localize="false"/><h3 id="hd_id3145252">Include formats</h3>
 <paragraph role="paragraph" id="par_id3147125" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotaloptionspage/formats">Considers formatting attributes when sorting.</ahelp></paragraph>
 <bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/btnuserdef" id="bm_id3154729" localize="false"/>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/lbuserdef" id="bm_id3153877" localize="false"/><paragraph role="heading" id="hd_id3155418" xml-lang="en-US" level="3">Custom sort order</paragraph>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/lbuserdef" id="bm_id3153877" localize="false"/><h3 id="hd_id3155418">Custom sort order</h3>
 <paragraph role="paragraph" id="par_id3149400" xml-lang="en-US"><ahelp hid=".">Uses a custom sorting order that you defined in the Options dialog box at <emph>%PRODUCTNAME Calc - Sort Lists</emph>.</ahelp></paragraph>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/ascending" id="bm_id3150327" localize="false"/><paragraph role="heading" id="hd_id3149121" xml-lang="en-US" level="3">Ascending</paragraph>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/ascending" id="bm_id3150327" localize="false"/><h3 id="hd_id3149121">Ascending</h3>
 <paragraph role="paragraph" id="par_id3155068" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotaloptionspage/ascending">Sorts beginning with the lowest value. You can define the sort rules on Data - Sort - Options.</ahelp> You define the default on <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language settings - Languages</menuitem>.</paragraph>
-<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/descending" id="bm_id3150324" localize="false"/><paragraph role="heading" id="hd_id3155443" xml-lang="en-US" level="3">Descending</paragraph>
+<bookmark xml-lang="en-US" branch="hid/modules/scalc/ui/subtotaloptionspage/descending" id="bm_id3150324" localize="false"/><h3 id="hd_id3155443">Descending</h3>
 <paragraph role="paragraph" id="par_id3153766" xml-lang="en-US"><ahelp hid="modules/scalc/ui/subtotaloptionspage/descending">Sorts beginning with the highest value. You can define the sort rules on Data - Sort - Options.</ahelp> You define the default on <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language settings - Languages</menuitem>.</paragraph>
+<section id="relatedtopics">
+    <embed href="text/scalc/guide/subtotaltool.xhp#subtotaltoolh1"/>
+</section>
 </body>
 </helpdocument>
diff --git a/source/text/scalc/guide/subtotaltool.xhp b/source/text/scalc/guide/subtotaltool.xhp
new file mode 100644
index 0000000000..9762007409
--- /dev/null
+++ b/source/text/scalc/guide/subtotaltool.xhp
@@ -0,0 +1,66 @@
+<?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="usingsubtotaltooltopic" indexer="include" status="PUBLISH">
+    <title id="tit" xml-lang="en-US">Using Subtotals Tool</title>
+    <filename>/text/scalc/guide/subtotaltool.xhp</filename>
+  </topic>
+</meta>
+<body>
+<bookmark xml-lang="en-US" branch="index" id="bm_id521585182060496">
+    <bookmark_value>subtotals;using subtotals tool</bookmark_value>
+</bookmark>
+<section id="usingsubtotal">
+    <h1 id="hd_id631585177069332"><variable id="subtotaltoolh1"><link href="text/scalc/guide/subtotaltool.xhp" name="Using Subtotal Tool">Using Subtotal Tool</link></variable></h1>
+    <paragraph id="par_id301585177069332" role="paragraph">Calc offers the Subtotals tool as a more comprehensive alternative to the <link href="text/scalc/01/04060106.xhp#Section12" name="subtotal">SUBTOTAL function</link>. In contrast to SUBTOTAL, which only works on a single array, the Subtotals tool can create subtotals for up to three arrays arranged in labeled columns. It also groups subtotals by category and sorts them automatically, thereby eliminating the need to apply AutoFilters and filter categories by hand.</paragraph>
+</section>
+<section id="howtoget">
+    <embed href="text/scalc/00/00000412.xhp#dntegs"/>
+</section>
+<h2 id="hd_id891585177511329">Using the Subtotals tool</h2>
+<paragraph role="paragraph" id="par_id91585177517697">To insert subtotal values into a worksheet:</paragraph>
+  <list type="ordered">
+        <listitem>
+        <paragraph id="par_id241585177550504" role="listitem">Select the cell range for the subtotals that you want to calculate, and remember to include the column heading labels. Alternatively, click on a single cell within your data to allow Calc to automatically identify the range.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id421585177574387" role="listitem">Select <menuitem>Data > Subtotals</menuitem>  from the Menu bar to open the Subtotals dialog.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id41585177608508" role="listitem">In the Group by drop-down list on the first Group page, select a column by its label. Entries in the cell range from step 1 will be grouped and sorted by matching values in this column.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id451585177625978" role="listitem">In the Calculate subtotals for box on the first Group page, select a column containing values to be subtotaled. If you later change values in this column, Calc will automatically recalculate the subtotals.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id661585177644535" role="listitem"> In the Use function box on the first Group page, select a function to calculate the subtotals for the column selected in step 4.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id351585177661529" role="listitem">Repeat steps 4 and 5 to create subtotals for other columns on the first Group page.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id511585177679372" role="listitem">You can create two more subtotal categories by using the second Group and third Group pages and repeating steps 3 to 6. If you do not want to add more groups, then leave the Group by list for each page set to “- none -”.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id301585177698777" role="listitem">Click OK. Calc will add subtotal and grand total rows to your cell range.</paragraph>
+    </listitem>
+</list>
+<h2 id="hd_id211585178799496">Subtotal outline</h2>
+<paragraph role="paragraph" id="par_id841585178819108">
+When you use the Subtotals tool, Calc inserts an outline to the left of the row number column. This outline represents the hierarchical structure of your subtotals, and can be used to hide or show data at different levels in the hierarchy using the numbered column indicators at the top of the outline or the group indicators, denoted by plus <emph>(+)</emph> and minus <emph>(-)</emph> signs.</paragraph>
+<paragraph role="paragraph" id="par_id371585181820075">This feature is useful if you have many subtotals, as you can simply hide low-level details, such as individual entries, to produce a high-level summary of your data.</paragraph>
+<paragraph role="paragraph" id="par_id161585178829165">To turn off outlines, select <menuitem>Data > Group and Outline > Remove Outline</menuitem>  from the Menu bar. To reinstate them, select <menuitem>Data > Group and Outline > AutoOutline</menuitem>.</paragraph>
+<section id="relatedtopics">
+<embed href="text/scalc/01/12050000.xhp#subtotalheaderh1"/>
+</section>
+</body>
+</helpdocument>