From 210070a19c2ca9248671ff3793f0a1c5d7f09509 Mon Sep 17 00:00:00 2001
From: blake <blake@mobiusconsortium.org>
Date: Thu, 6 Feb 2020 14:03:57 -0600
Subject: [PATCH] LP#1848524: Docs: Fix sections for Antora: "reports"

* Added :toc: for each page
* Upgraded all headings in each page
* Updated nav to display the English name for each page
* fixed Intro page

Signed-off-by: blake <blake@mobiusconsortium.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
---
 docs-antora/modules/reports/nav.adoc               | 22 +++++++++----------
 .../modules/reports/pages/introduction.adoc        |  4 +++-
 .../reports/pages/reporter_add_data_source.adoc    |  9 ++++----
 .../pages/reporter_cloning_shared_templates.adoc   |  3 ++-
 .../reports/pages/reporter_create_templates.adoc   | 12 ++++++-----
 .../modules/reports/pages/reporter_daemon.adoc     |  7 +++---
 .../pages/reporter_export_usingpgAdmin.adoc        |  7 +++---
 .../modules/reports/pages/reporter_folder.adoc     |  7 +++---
 .../reports/pages/reporter_generating_reports.adoc |  6 +++---
 .../pages/reporter_running_recurring_reports.adoc  |  3 ++-
 .../pages/reporter_template_enhancements.adoc      |  7 +++---
 .../pages/reporter_template_terminology.adoc       | 25 +++++++++++-----------
 .../reports/pages/reporter_view_output.adoc        |  3 ++-
 13 files changed, 64 insertions(+), 51 deletions(-)

diff --git a/docs-antora/modules/reports/nav.adoc b/docs-antora/modules/reports/nav.adoc
index 61fa241001..2c48e8e1f2 100644
--- a/docs-antora/modules/reports/nav.adoc
+++ b/docs-antora/modules/reports/nav.adoc
@@ -1,13 +1,13 @@
 * xref:reports:introduction.adoc[Reports]
-** xref:reports:reporter_daemon.adoc[]
-** xref:reports:reporter_folder.adoc[]
-** xref:reports:reporter_create_templates.adoc[]
-** xref:reports:reporter_generating_reports.adoc[]
-** xref:reports:reporter_view_output.adoc[]
-** xref:reports:reporter_cloning_shared_templates.adoc[]
-** xref:reports:reporter_add_data_source.adoc[]
-** xref:reports:reporter_running_recurring_reports.adoc[]
-** xref:reports:reporter_template_terminology.adoc[]
-** xref:reports:reporter_template_enhancements.adoc[]
-** xref:reports:reporter_export_usingpgAdmin.adoc[]
+** xref:reports:reporter_daemon.adoc[Starting and Stopping the Reporter Daemon]
+** xref:reports:reporter_folder.adoc[Folders]
+** xref:reports:reporter_create_templates.adoc[Creating Templates]
+** xref:reports:reporter_generating_reports.adoc[Generating Reports from Templates]
+** xref:reports:reporter_view_output.adoc[Viewing Report Output]
+** xref:reports:reporter_cloning_shared_templates.adoc[Cloning Shared Templates]
+** xref:reports:reporter_add_data_source.adoc[Adding Data Sources to Reporter]
+** xref:reports:reporter_running_recurring_reports.adoc[Running Recurring Reports]
+** xref:reports:reporter_template_terminology.adoc[Template Terminology]
+** xref:reports:reporter_template_enhancements.adoc[Template Enhancements]
+** xref:reports:reporter_export_usingpgAdmin.adoc[Exporting Report Templates Using phpPgAdmin]
 
diff --git a/docs-antora/modules/reports/pages/introduction.adoc b/docs-antora/modules/reports/pages/introduction.adoc
index 447db42729..81389652ee 100644
--- a/docs-antora/modules/reports/pages/introduction.adoc
+++ b/docs-antora/modules/reports/pages/introduction.adoc
@@ -1,2 +1,4 @@
-== Introduction ==
+= Introduction =
+:toc:
+
 Learn how to create and use reports in Evergreen.
diff --git a/docs-antora/modules/reports/pages/reporter_add_data_source.adoc b/docs-antora/modules/reports/pages/reporter_add_data_source.adoc
index 56bb8d50a2..8496222bae 100644
--- a/docs-antora/modules/reports/pages/reporter_add_data_source.adoc
+++ b/docs-antora/modules/reports/pages/reporter_add_data_source.adoc
@@ -1,4 +1,5 @@
-== Adding Data Sources to Reporter ==
+= Adding Data Sources to Reporter =
+:toc:
 
 indexterm:[reports, adding data sources]
 
@@ -35,7 +36,7 @@ Evergreen reporter and/or cstore code that you write.
 definition in _fm_IDL.xml_. You can use this method if you want to be able to 
 access this data source through directly through SQL or using other reporting tool.
 
-=== Create a PostgreSQL query, view, or table for your data source ===
+== Create a PostgreSQL query, view, or table for your data source ==
 
 indexterm:[PostgreSQL]
 
@@ -108,7 +109,7 @@ left join actor.stat_cat_entry_usr_map ag
 where u.active = 't' and u.deleted <> 't';
 ------------------------------------------------------------
 
-=== Add a new class to fm_IDL.xml for your data source ===
+== Add a new class to fm_IDL.xml for your data source ==
 
 Once you have your data source, the next step is to add that data source as a 
 new class in _fm_IDL.xml_.
@@ -199,7 +200,7 @@ control system for any changes to fm_IDL.xml. You will need to keep a separate
 copy of you local class definitions so that you can reapply the changes to 
 _fm_IDL.xml_ after Evergreen upgrades.
 
-=== Restart the affected services to see the new data source in the reporter ===
+== Restart the affected services to see the new data source in the reporter ==
 
 The following steps are needed to for Evergreen to recognize the changes to 
 _fm_IDL.xml_
diff --git a/docs-antora/modules/reports/pages/reporter_cloning_shared_templates.adoc b/docs-antora/modules/reports/pages/reporter_cloning_shared_templates.adoc
index 09e73298fe..3d4b8ba09a 100644
--- a/docs-antora/modules/reports/pages/reporter_cloning_shared_templates.adoc
+++ b/docs-antora/modules/reports/pages/reporter_cloning_shared_templates.adoc
@@ -1,4 +1,5 @@
-== Cloning Shared Templates ==
+= Cloning Shared Templates =
+:toc:
 
 indexterm:[reports, cloning]
 
diff --git a/docs-antora/modules/reports/pages/reporter_create_templates.adoc b/docs-antora/modules/reports/pages/reporter_create_templates.adoc
index 11fd68ee0b..73d2417d70 100644
--- a/docs-antora/modules/reports/pages/reporter_create_templates.adoc
+++ b/docs-antora/modules/reports/pages/reporter_create_templates.adoc
@@ -1,5 +1,6 @@
 [[reporter_creating_templates]]
-== Creating Templates ==
+= Creating Templates =
+:toc:
 
 indexterm:[reports, creating templates]
 
@@ -34,7 +35,7 @@ create a template are the same every time, but the tables chosen, how the data
 is transformed and displayed, and the filters used will vary depending on your 
 needs.
 
-=== Choosing Report Fields ===
+== Choosing Report Fields ==
 
 indexterm:[reports, creating templates, choosing reports fields]
 
@@ -174,7 +175,8 @@ Report output will sort by the first column.
 
 image::media/create-template-23.png[create-template-23]
 
-= [NOTE] =
+[NOTE]
+======
 Note the _Change Transform_ button in the bottom left hand pane. It has the same 
 function as the upper right _Field Transform_ pane for fields that have already 
 been added.
@@ -183,7 +185,7 @@ image::media/create-template-24.png[create-template-24]
 ======
 
 
-=== Applying Filters ===
+== Applying Filters ==
 
 indexterm:[reports, applying filters]
 
@@ -217,7 +219,7 @@ In this example we are going to use a Base Filter to filter out one library’s
 circulations for a specified time frame. The time frame in the template will be 
 configured so that you can change it each time you run the report.
 
-==== Using Base Filters ====
+=== Using Base Filters ===
 
 indexterm:[reports, applying filters, base filter]
 
diff --git a/docs-antora/modules/reports/pages/reporter_daemon.adoc b/docs-antora/modules/reports/pages/reporter_daemon.adoc
index 9a702ab39e..4066851821 100644
--- a/docs-antora/modules/reports/pages/reporter_daemon.adoc
+++ b/docs-antora/modules/reports/pages/reporter_daemon.adoc
@@ -1,4 +1,5 @@
-== Starting and Stopping the Reporter Daemon ==
+= Starting and Stopping the Reporter Daemon =
+:toc:
 
 indexterm:[reports, starting server application]
 
@@ -10,7 +11,7 @@ the reporter daemon from the command line of the Evergreen server.
 The reporter daemon periodically checks for requests for new reports or 
 scheduled reports and gets them running.
 
-=== Starting the Reporter Daemon ===
+== Starting the Reporter Daemon ==
 
 indexterm:[reporter, starting]
 
@@ -42,7 +43,7 @@ restarted before you can view reports unless you have configured your server to
 start the daemon automatically at start up time. 
 =============
 
-=== Stopping the Reporter Daemon ===
+== Stopping the Reporter Daemon ==
 
 indexterm:[reports, stopping server application]
 
diff --git a/docs-antora/modules/reports/pages/reporter_export_usingpgAdmin.adoc b/docs-antora/modules/reports/pages/reporter_export_usingpgAdmin.adoc
index c4a8d1e6ff..9fb5370362 100644
--- a/docs-antora/modules/reports/pages/reporter_export_usingpgAdmin.adoc
+++ b/docs-antora/modules/reports/pages/reporter_export_usingpgAdmin.adoc
@@ -1,4 +1,5 @@
-== Exporting Report Templates Using phpPgAdmin ==
+= Exporting Report Templates Using phpPgAdmin =
+:toc:
 
 indexterm:[reports, exporting templates]
 
@@ -6,7 +7,7 @@ Once the data is exported. Database Administrators/Systems Administrators can
 easily import this data into the templates folder to make it available in the 
 client.
 
-=== Dump the Entire Reports Template Table ===
+== Dump the Entire Reports Template Table ==
 
 The data exported in this method can create issues importing into a different 
 system if you do not have a matching folder and owner. This is going to export 
@@ -26,7 +27,7 @@ appropriate owner and folder information for the new system.
 . Click _export_ button at the bottom
 . A text file will download to your local system
 
-=== Dump Data with an SQL Statement ===
+== Dump Data with an SQL Statement ==
 
 
 The following statement could be used to grab the data in the folder and dump it 
diff --git a/docs-antora/modules/reports/pages/reporter_folder.adoc b/docs-antora/modules/reports/pages/reporter_folder.adoc
index 26cc49e5ba..239e85e69b 100644
--- a/docs-antora/modules/reports/pages/reporter_folder.adoc
+++ b/docs-antora/modules/reports/pages/reporter_folder.adoc
@@ -1,5 +1,6 @@
 [[reporter_folders]]
-== Folders ==
+= Folders =
+:toc:
 
 indexterm:[reports, folders]
 
@@ -18,7 +19,7 @@ account.
 image::media/folder-1.png[folder-1]
 
 [[reporter_creating_folders]]
-=== Creating Folders ===
+== Creating Folders ==
 
 
 indexterm:[reports, folders, creating]
@@ -54,7 +55,7 @@ example, _Circulation (BNCLF)_ is shared with the North Coast Library Federation
 If it is not a shared folder there will be nothing after the folder name. You 
 may create as many folders and sub-folders as you like.
 
-=== Managing Folders ===
+== Managing Folders ==
 
 indexterm:[reports, folders, managing]
 
diff --git a/docs-antora/modules/reports/pages/reporter_generating_reports.adoc b/docs-antora/modules/reports/pages/reporter_generating_reports.adoc
index d49e32dd33..12859236f2 100644
--- a/docs-antora/modules/reports/pages/reporter_generating_reports.adoc
+++ b/docs-antora/modules/reports/pages/reporter_generating_reports.adoc
@@ -1,6 +1,6 @@
 [[generating_reports]]
-Generating Reports from Templates
-----------------------------------
+= Generating Reports from Templates =
+:toc:
 
 indexterm:[reports, generating]
 
@@ -87,7 +87,7 @@ image::media/generate-report-14.png[generate-report-14]
 +
 Once saved, reports stay there forever unless you delete them.
 
-=== Viewing and Editing Report Parameters ===
+== Viewing and Editing Report Parameters ==
 
 New options to view or edit report parameters are available from the reports folder.
 
diff --git a/docs-antora/modules/reports/pages/reporter_running_recurring_reports.adoc b/docs-antora/modules/reports/pages/reporter_running_recurring_reports.adoc
index dd71da7a8f..eec0f39bea 100644
--- a/docs-antora/modules/reports/pages/reporter_running_recurring_reports.adoc
+++ b/docs-antora/modules/reports/pages/reporter_running_recurring_reports.adoc
@@ -1,5 +1,6 @@
 [[recurring_reports]]
-== Running Recurring Reports ==
+= Running Recurring Reports =
+:toc:
 
 indexterm:[reports, recurring]
 
diff --git a/docs-antora/modules/reports/pages/reporter_template_enhancements.adoc b/docs-antora/modules/reports/pages/reporter_template_enhancements.adoc
index e033f726da..31b948c809 100644
--- a/docs-antora/modules/reports/pages/reporter_template_enhancements.adoc
+++ b/docs-antora/modules/reports/pages/reporter_template_enhancements.adoc
@@ -1,6 +1,7 @@
-== Template Enhancements ==
+= Template Enhancements =
+:toc:
 
-=== Documentation URL ===
+== Documentation URL ==
 
 You can add a link to local documentation that can help staff create a report template.  To add documentation to a report template, click *Admin* -> *Local Administration* -> *Reports*, and create a new report template.  A new field, *Documentation URL*, appears in the *Template Configuration* panel.  Enter a URL that points to relevant documentation.
 
@@ -13,7 +14,7 @@ The link to this documentation will also appear in your list of report templates
 
 image::media/2_7_Enhancements_to_Reports2a.jpg[Reports2a]
 
-=== Field Hints ===
+== Field Hints ==
 
 Descriptive information about fields or filters in a report template can be added to the *Field Hints* portion of the *Template Configuration* panel.  For example, a circulation report template might include the field, *Circ ID*.  You can add content to the *Field hints* to further define this field for staff and provide a reminder about the type of information that they should select for this field.
 
diff --git a/docs-antora/modules/reports/pages/reporter_template_terminology.adoc b/docs-antora/modules/reports/pages/reporter_template_terminology.adoc
index 3d36ece214..81185d9628 100644
--- a/docs-antora/modules/reports/pages/reporter_template_terminology.adoc
+++ b/docs-antora/modules/reports/pages/reporter_template_terminology.adoc
@@ -1,63 +1,64 @@
-== Template Terminology ==
+= Template Terminology =
+:toc:
 
-=== Data Types ===
+== Data Types ==
 
 indexterm:[reports, data types]
 
 The information in Evergreen's database can be classified in nine data types, formats that describe the type of data and/or its use.  These were represented by text-only labels in prior versions of Evergreen.  Evergreen 3.0 has replaced the text labels with icons.  When building templates in _Reports_, you will find these icons in the Field Name Pane of the template creation interface.
 
-==== timestamp ====
+=== timestamp ===
 image::media/datatypes_timestamp.png[]
 
 An exact date and time (year, month, day, hour, minutes, and seconds).  Remember to select the appropriate date/time transform. Raw Data includes second and timezone information, which is usually more than is required for a report.
 
-==== link ====
+=== link ===
 
 image::media/datatypes_link.png[]
 
 A link to another database table. Link outputs a number that is a meaningful reference for the database but not of much use to a human user. You will usually want to drill further down the tree in the Sources pane and select fields from the linked table. However, in some instances you might want to use a link field. For example, to count the number of patrons who borrowed items you could do a count on the Patron link data.
 
-==== text ====
+=== text ===
 image::media/datatypes_text.png[]
 
 A field of text. You will usually want to use the Raw Data transform.
 
-==== bool ====
+=== bool ===
 image::media/datatypes_bool.png[]
 
 True or False. Commonly used to filter out deleted item or patron records.
 
-==== org_unit ====
+=== org_unit ===
 image::media/datatypes_orgunit.png[]
 
 Organizational Unit - a number representing a library, library system, or federation. When you want to filter on a library, make sure that the field name is on an org_unit or id data type.
 
-==== id ====
+=== id ===
 
 image::media/datatypes_id.png[]
 
 A unique number assigned by the database to identify each record. These numbers are meaningful references for the database but not of much use to a human user. Use in displayed fields when counting records or in filters.
 
-==== money ====
+=== money ===
 
 image::media/datatypes_money.png[]
 
 A monetary amount.
 
-==== int ====
+=== int ===
 
 image::media/datatypes_int.png[]
 
 Integer (a number)
 
-==== interval ====
+=== interval ===
 
 image::media/datatypes_interval.png[]
 
 A period of time.
 
 [[field_transforms]]
-=== Field Transforms ===
+== Field Transforms ==
 
 indexterm:[reports, field transforms]
 
diff --git a/docs-antora/modules/reports/pages/reporter_view_output.adoc b/docs-antora/modules/reports/pages/reporter_view_output.adoc
index adb7f73aa1..dcba21c09c 100644
--- a/docs-antora/modules/reports/pages/reporter_view_output.adoc
+++ b/docs-antora/modules/reports/pages/reporter_view_output.adoc
@@ -1,5 +1,6 @@
 [[viewing_report_output]]
-== Viewing Report Output ==
+= Viewing Report Output =
+:toc:
 
 indexterm:[reports, output]
 
-- 
2.11.0