source/text/sdatabase/rep_main.xhp | 120 +++++++++++++++++++++++++------------
1 file changed, 84 insertions(+), 36 deletions(-)
New commits:
commit 6192b00a59c9a10fe59eef50f6eb7d25fb3813a3
Author: Olivier Hallot <olivier.hal...@libreoffice.org>
AuthorDate: Fri Jan 21 14:54:26 2022 -0300
Commit: Olivier Hallot <olivier.hal...@libreoffice.org>
CommitDate: Fri Jan 21 22:00:59 2022 +0100
Refactor and update Report design (main)
Change-Id: I2e8b809ec57f97bf96aa27d26f3a597ae48e795e
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/128743
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org>
diff --git a/source/text/sdatabase/rep_main.xhp
b/source/text/sdatabase/rep_main.xhp
index f69c6b589..f020f67c6 100644
--- a/source/text/sdatabase/rep_main.xhp
+++ b/source/text/sdatabase/rep_main.xhp
@@ -33,33 +33,33 @@
<h1 id="hd_id8773155"><variable id="rep_main"><link
href="text/sdatabase/rep_main.xhp">Report Builder</link>
</variable></h1>
<paragraph xml-lang="en-US" id="par_id5248573" role="paragraph">The Report
Builder is a tool to create your own database reports. Unlike with the <link
href="text/shared/autopi/01100000.xhp">Report Wizard</link>, using the Report
Builder you can take control to design the report the way you want. The
generated report is a Writer document that you can edit, too.</paragraph>
- <note id="par_id7128818">To use the Report Builder, the Report Builder
component must be installed. In addition, the Java Runtime Environment (JRE)
software must be installed, and this software must be selected in
%PRODUCTNAME.</note>
+ <note id="par_id7128818">To use the Report Builder, the Java Runtime
Environment (JRE) software must be installed, and this software must be
selected in %PRODUCTNAME.</note>
<h2 id="hd_id556047">To install the JRE software</h2>
<paragraph xml-lang="en-US" id="par_id4515823" role="paragraph">The Report
Builder requires an installed Java Runtime Environment (JRE).</paragraph>
<list type="ordered">
<listitem>
- <paragraph xml-lang="en-US" id="par_id4044312"
role="paragraph">Choose <switchinline select="sys"><caseinline
select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools -
Options</defaultinline></switchinline> - %PRODUCTNAME - <link
href="text/shared/optionen/java.xhp">Advanced</link>.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id4044312"
role="listitem">Choose <switchinline select="sys"><caseinline
select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools -
Options</defaultinline></switchinline> - %PRODUCTNAME - <link
href="text/shared/optionen/java.xhp">Advanced</link>.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id1369060"
role="paragraph">Wait up to one minute, while %PRODUCTNAME collects information
on installed Java software on your system.</paragraph>
- <paragraph xml-lang="en-US" id="par_id860927" role="paragraph">If
a recent JRE version is found on your system, you see an entry in the
list.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id1369060"
role="listitem">Wait up to one minute, while %PRODUCTNAME collects information
on installed Java software on your system.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id860927" role="listitem">If a
recent JRE version is found on your system, you see an entry in the
list.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id8581804"
role="paragraph">Click the option button in front of the entry to enable this
JRE version for use in %PRODUCTNAME.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id8581804"
role="listitem">Click the option button in front of the entry to enable this
JRE version for use in %PRODUCTNAME.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id7730033"
role="paragraph">Ensure that <emph>Use a Java runtime environment</emph> is
enabled.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id7730033"
role="listitem">Ensure that <emph>Use a Java runtime environment</emph> is
enabled.</paragraph>
</listitem>
</list>
<paragraph xml-lang="en-US" id="par_id6317636" role="paragraph">If no
JRE version is found on your system, open your web browser and download the JRE
software from <link href="http://www.java.com";>http://www.java.com</link>.
Install the JRE software. Then restart %PRODUCTNAME and open <switchinline
select="sys"><caseinline select="MAC">%PRODUCTNAME -
Preferences</caseinline><defaultinline>Tools -
Options</defaultinline></switchinline> - %PRODUCTNAME - Advanced
again.</paragraph>
<h2 id="hd_id9759514">To open the Report Builder</h2>
<list type="ordered">
<listitem>
- <paragraph xml-lang="en-US" id="par_id9076509"
role="paragraph">Open a Base file or create a new database. The database must
contain at least one table with at least one data field and a primary key
field.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id9076509"
role="listitem">Open a Base file or create a new database. The database must
contain at least one table with at least one data field and a primary key
field.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id7050691"
role="paragraph">Click the Reports icon in the Base window, then choose Create
Report in Design View.</paragraph>
- <paragraph xml-lang="en-US" id="par_id7118747"
role="paragraph">The Report Builder window opens. </paragraph>
+ <paragraph xml-lang="en-US" id="par_id7050691"
role="listitem">Click the Reports icon in the Base window, then choose Create
Report in Design View.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id7118747" role="listitem">The
Report Builder window opens. </paragraph>
</listitem>
</list>
<paragraph xml-lang="en-US" id="par_id8283639" role="paragraph">The
Report Builder is divided into three parts. On the top you see the menu, with
the toolbars below.</paragraph>
@@ -67,15 +67,15 @@
<paragraph xml-lang="en-US" id="par_id2100589" role="paragraph">The left
part of the Report Builder window shows the Report Builder view. The Report
Builder view is initially divided into three sections, from top to
bottom:</paragraph>
<list type="ordered">
<listitem>
- <paragraph xml-lang="en-US" id="par_id5022125" role="paragraph">
+ <paragraph xml-lang="en-US" id="par_id5022125" role="listitem">
<emph>Page Header</emph> - drag control fields with fixed text
into the Page Header area</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id6844386" role="paragraph">
+ <paragraph xml-lang="en-US" id="par_id6844386" role="listitem">
<emph>Detail</emph> - drag and drop database fields into the
Detail area</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id7018646" role="paragraph">
+ <paragraph xml-lang="en-US" id="par_id7018646" role="listitem">
<emph>Page Footer</emph> - drag control fields with fixed text
into the Page Footer area</paragraph>
</listitem>
</list>
@@ -86,16 +86,16 @@
<h2 id="par_id7479476">To connect the report to a database table</h2>
<list type="ordered">
<listitem>
- <paragraph xml-lang="en-US" id="par_id2218390"
role="paragraph">Move the mouse to the Properties view. You see two tab pages
General and Data.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id2218390"
role="listitem">Move the mouse to the Properties view. You see two tab pages
General and Data.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id7771538" role="paragraph">On
the Data tab page, click Content to open the combo box.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id7771538" role="listitem">On
the Data tab page, click Content to open the combo box.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id366527"
role="paragraph">Select the table for that you want to create the
report.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id366527"
role="listitem">Select the table for that you want to create the
report.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id7996459"
role="paragraph">After selecting the table, press the Tab key to leave the
Content box.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id7996459"
role="listitem">After selecting the table, press the Tab key to leave the
Content box.</paragraph>
</listitem>
</list>
<paragraph xml-lang="en-US" id="par_id2531815" role="paragraph">The <link
href="text/sdatabase/rep_insertfield.xhp" name="add_fields_link">Add fields to
report</link> window opens automatically and shows all fields of the selected
table.</paragraph>
@@ -129,12 +129,21 @@
<paragraph xml-lang="en-US" id="par_id0409200922242661"
role="paragraph"><ahelp hid="." visibility="hidden">Shrinks the selected
section to remove bottom empty space.</ahelp></paragraph>
<paragraph xml-lang="en-US" id="par_id1511581" role="paragraph">After
inserting fields in the Detail view, the report is ready for
execution.</paragraph>
<h2 id="par_id4881740">To execute a report</h2>
- <list type="ordered">
- <listitem>
- <paragraph xml-lang="en-US" id="par_id8286385"
role="paragraph">Click the Execute Report icon
-<image id="img_id3380230" src="cmd/sc_executereport.png" width="0.566cm"
height="0.566cm"><alt xml-lang="en-US" id="alt_id3380230">Icon</alt></image> on
the toolbar.</paragraph>
- </listitem>
- </list>
+ <paragraph xml-lang="en-US" id="par_id8286385" role="paragraph">Click
the Execute Report icon on the toolbar.</paragraph>
+ <section id="executereporticon">
+<table id="tab_id401642784887817">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id341642784887818" role="paragraph">
+ <image src="cmd/sc_executereport.svg"
id="img_id181642784887819" width="1cm" height="1cm"><alt xml-lang="en-US"
id="alt_id561642784887821">Execute Report icon</alt></image>
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id71642784887822" role="paragraph"
xml-lang="en-US">Execute Report icon</paragraph>
+ </tablecell>
+ </tablerow>
+</table>
+</section>
<paragraph xml-lang="en-US" id="par_id2354197" role="paragraph">A Writer
document opens and shows the report you have created, which contains all values
of the database table which you have insert.</paragraph>
<paragraph xml-lang="en-US" id="par_id2485122" role="paragraph">If the
database contents did change, execute the report again to update the result
report.<comment>automatic? message?</comment></paragraph>
<h2 id="hd_id8746910">To edit a report</h2>
@@ -143,47 +152,86 @@
<paragraph xml-lang="en-US" id="par_id8307138" role="paragraph">If you
want to edit the Report Builder view, you can change some of its
properties.</paragraph>
<paragraph xml-lang="en-US" id="par_id7138889" role="paragraph">Click in
the Details area. Then in the Properties window, change some properties, for
example the background color.</paragraph>
<paragraph xml-lang="en-US" id="par_id9869380" role="paragraph">After
finishing, click the Execute Report icon
-<image id="Graphic2" src="cmd/sc_executereport.png" width="0.566cm"
height="0.566cm"><alt xml-lang="en-US" id="alt_">Icon</alt></image> to create a
new report.</paragraph>
+ to create a new report.</paragraph>
+<embed href="text/sdatabase/rep_main.xhp#executereporticon"/>
<paragraph xml-lang="en-US" id="par_id12512" role="paragraph">If you
close the Report Builder, you will be asked if the report should be saved.
Click Yes, give the report a name, and click OK.<comment>report part of Base
file?</comment></paragraph>
<h2 id="par_id2676168">Sorting the report</h2>
<paragraph xml-lang="en-US" id="par_id2626422" role="paragraph">Without
sorting or grouping, the records will be inserted into the report in the order
in which they are retrieved from the database.</paragraph>
<list type="ordered">
<listitem>
- <paragraph xml-lang="en-US" id="par_id1743827"
role="paragraph">Open the Report Builder view and click the Sorting and
Grouping icon
-<image id="img_id9557786" src="cmd/sc_dbsortingandgrouping.png"
width="0.566cm" height="0.566cm"><alt xml-lang="en-US"
id="alt_id9557786">Icon</alt></image> on the toolbar. You see the <link
href="text/sdatabase/rep_sort.xhp">Sorting and Grouping</link>
dialog.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id1743827"
role="listitem">Open the Report Builder view and click the Sorting and Grouping
icon on the toolbar. You see the <link
href="text/sdatabase/rep_sort.xhp">Sorting and Grouping</link>
dialog.</paragraph>
</listitem>
+ </list>
+ <table id="tab_id231642785406291">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id241642785406292" role="paragraph">
+ <image id="img_id9557786"
src="cmd/sc_dbsortingandgrouping.svg" width="1cm" height="1cm"><alt
xml-lang="en-US" id="alt_id9557786">Icon Sort and Gouping</alt></image>
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id81642785406296" role="paragraph"
xml-lang="en-US">Icon Sort and Gouping</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+ <list type="ordered" startwith="2">
<listitem>
- <paragraph xml-lang="en-US" id="par_id4331797" role="paragraph">In
the Groups box, click the field which you want as the first sort field, and set
the Sorting property.<comment>what meaning has the order of fields / move up
down button?</comment></paragraph>
+ <paragraph xml-lang="en-US" id="par_id4331797" role="listitem">In
the Groups box, click the field which you want as the first sort field, and set
the Sorting property.<comment>what meaning has the order of fields / move up
down button?</comment></paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id4191717"
role="paragraph">Execute the report.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id4191717"
role="listitem">Execute the report.</paragraph>
</listitem>
</list>
<h2 id="par_id2318796">Grouping</h2>
<list type="ordered">
<listitem>
- <paragraph xml-lang="en-US" id="par_id399182"
role="paragraph">Open the Report Builder view and click the Sorting and
Grouping icon
-<image id="Graphic21" src="cmd/sc_dbsortingandgrouping.png" width="0.566cm"
height="0.566cm"><alt xml-lang="en-US" id="alt_">Icon</alt></image> on the
toolbar. You see the <link href="text/sdatabase/rep_sort.xhp">Sorting and
Grouping</link> dialog.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id399182" role="listitem">Open
the Report Builder view and click the Sorting and Grouping icon on the toolbar.
You see the <link href="text/sdatabase/rep_sort.xhp">Sorting and
Grouping</link> dialog.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id7588732" role="paragraph">In
the Groups box, open the Group Header list box and select to show a group
header.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id7588732" role="listitem">In
the Groups box, open the Group Header list box and select to show a group
header.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id95828"
role="paragraph">Click the Add Field icon
-<image id="Graphic3" src="cmd/sc_addfield.png" width="0.566cm"
height="0.566cm"><alt xml-lang="en-US" id="alt_">Icon</alt></image> to open the
Add Field window.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id95828" role="listitem">Click
the Add Field icon to open the Add Field window.</paragraph>
</listitem>
+ </list>
+ <table id="tab_id571642785710910">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id911642785710911" role="paragraph">
+ <image id="Graphic3" src="cmd/sc_addfield.png"
width="1cm" height="1cm"><alt xml-lang="en-US" id="alt_">Icon Add
Field</alt></image>
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id831642785710915" role="paragraph"
xml-lang="en-US">Icon Add Field</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
+ <list type="ordered" startwith="4">
<listitem>
- <paragraph xml-lang="en-US" id="par_id5675527"
role="paragraph">Drag-and-drop the field entry that you want to group into the
group header section. Then drag-and-drop the remaining fields into the Detail
section.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id5675527"
role="listitem">Drag-and-drop the field entry that you want to group into the
group header section. Then drag-and-drop the remaining fields into the Detail
section.</paragraph>
</listitem>
<listitem>
- <paragraph xml-lang="en-US" id="par_id3496200"
role="paragraph">Execute the report. The report shows the grouped
records.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id3496200"
role="listitem">Execute the report. The report shows the grouped
records.</paragraph>
</listitem>
</list>
<paragraph xml-lang="en-US" id="par_id7599108" role="paragraph">If you
like to sort and group, open the Report Builder view, then open the Sorting and
Grouping dialog. Select to show a Group Header for the fields that you want to
group, and select to hide the Group Header for the fields that you want to be
sorted. Close the Sorting and Grouping window and execute the
report.</paragraph>
<h2 id="par_id888698">Updating and printing your data</h2>
<paragraph xml-lang="en-US" id="par_id3394573" role="paragraph">When you
insert some new data or edit data in the table, a new report will show the
updated data.</paragraph>
- <paragraph xml-lang="en-US" id="par_id7594225" role="paragraph">Click
the Reports icon
-<image id="img_id4678487" src="dbaccess/res/reports_32.png" width="0.566cm"
height="0.566cm"><alt xml-lang="en-US" id="alt_id4678487">Icon</alt></image>
and double-click your last saved report. A new Writer document will be created
which shows the new data.</paragraph>
+ <paragraph xml-lang="en-US" id="par_id7594225" role="paragraph">Click
the Reports icon and double-click your last saved report. A new Writer document
will be created which shows the new data.</paragraph>
+ <table id="tab_id221642785888795">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id191642785888796" role="paragraph">
+ <image id="img_id4678487"
src="dbaccess/res/reports_32.png" width="1cm" height="1cm"><alt
xml-lang="en-US" id="alt_id4678487">Icon Reports</alt></image>
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id701642785888800" role="paragraph"
xml-lang="en-US">Icon Reports</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
<paragraph xml-lang="en-US" id="par_id8147221" role="paragraph">To print
a report, choose <item type="menuitem">File - Print</item> from the Writer
document.</paragraph>
</body>
</helpdocument>
