From 272b5373731f8fa28e74f50adebeb548a9155f4e Mon Sep 17 00:00:00 2001 From: Remington Steed Date: Thu, 12 Dec 2019 12:06:53 -0500 Subject: [PATCH] Docs: Convert more links to Antora syntax Antora requires that links to sections in a different file use the xref syntax, not the double-angle-bracket shortcut syntax. As best as I can tell, this commit changes all the links that go to other files (not the file that the link is in). Signed-off-by: Remington Steed --- .../admin_initial_setup/pages/importing_via_staff_client.adoc | 2 +- docs-antora/modules/installation/pages/server_upgrade.adoc | 6 ++++-- .../modules/reports/pages/reporter_cloning_shared_templates.adoc | 7 ++++--- docs-antora/modules/reports/pages/reporter_create_templates.adoc | 3 ++- docs-antora/modules/reports/pages/reporter_generating_reports.adoc | 3 ++- .../modules/reports/pages/reporter_running_recurring_reports.adoc | 6 +++--- docs-antora/modules/shared/pages/about_this_documentation.adoc | 2 +- 7 files changed, 17 insertions(+), 12 deletions(-) diff --git a/docs-antora/modules/admin_initial_setup/pages/importing_via_staff_client.adoc b/docs-antora/modules/admin_initial_setup/pages/importing_via_staff_client.adoc index db6a63a24f..32fdaa8464 100644 --- a/docs-antora/modules/admin_initial_setup/pages/importing_via_staff_client.adoc +++ b/docs-antora/modules/admin_initial_setup/pages/importing_via_staff_client.adoc @@ -109,7 +109,7 @@ Library*, the *Owning Library*, the *Call Number* and the *Barcode*. NOTE: All fields (except for Name and Tag) can contain a MARC subfield code (such as "a") or an XPATH query. You can also use the -<> to set defaults for some of these fields. +xref:admin:librarysettings.adoc#lse-vandelay[related library settings] to set defaults for some of these fields. image::media/batch_import_profile.png[Partial Screenshot of a Holdings Import Profile] diff --git a/docs-antora/modules/installation/pages/server_upgrade.adoc b/docs-antora/modules/installation/pages/server_upgrade.adoc index 0fbe9aa73a..6ccfef72be 100644 --- a/docs-antora/modules/installation/pages/server_upgrade.adoc +++ b/docs-antora/modules/installation/pages/server_upgrade.adoc @@ -301,11 +301,13 @@ Received Data: "250bf1518c7527a03249858687714376" ------------------------------------ -------------------------------------------------------------- + -If this does not work, it's time to do some <>. +If this does not work, it's time to do some +xref:installation:server_installation.adoc#install-troubleshooting-1[troubleshooting]. + . As the *root* user, start the Apache web server. + -If you encounter errors, refer to the <> section +If you encounter errors, refer to the +xref:installation:server_installation.adoc#install-troubleshooting-1[troubleshooting] section of this documentation for tips on finding solutions and seeking further assistance from the Evergreen community. 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 b4ba5550ef..09e73298fe 100644 --- a/docs-antora/modules/reports/pages/reporter_cloning_shared_templates.adoc +++ b/docs-antora/modules/reports/pages/reporter_cloning_shared_templates.adoc @@ -11,7 +11,8 @@ required to clone templates from the _Shared Folders_ section and save them to _ Folders_. The steps below assume you have already created at least one _Templates_ folder. -If you haven’t done this, please see <>. +If you haven’t done this, please see +xref:reports:reporter_folder.adoc#reporter_creating_folders[Creating Folders]. . Access the reports interface from _Administration_ -> _Reports_ . Under _Shared Folders_ expand the _Templates_ folder and the subfolder of the @@ -27,11 +28,11 @@ all content, change the Limit output setting from 10 to All. . Choose the folder where you want to save the cloned template, then click _Select Folder_. Only template folders created with your account will be visible. If there are no folders to choose from please see -<>. +xref:reports:reporter_folder.adoc#reporter_creating_folders[Creating Folders]. . The cloned template opens in the template editor. From here you may modify the template by adding, removing, or editing fields and filters as described in -<>. _Template Name_ and +xref:reports:reporter_create_templates.adoc#reporter_creating_templates[Creating Templates]. _Template Name_ and _Description_ can also be edited. When satisfied with your changes click _Save_. . Click _OK_ in the resulting confirmation windows. diff --git a/docs-antora/modules/reports/pages/reporter_create_templates.adoc b/docs-antora/modules/reports/pages/reporter_create_templates.adoc index 64bb5d4750..11fd68ee0b 100644 --- a/docs-antora/modules/reports/pages/reporter_create_templates.adoc +++ b/docs-antora/modules/reports/pages/reporter_create_templates.adoc @@ -81,7 +81,8 @@ indexterm:[reports, field transform] image::media/create-template-6.png[create-template-6] + _Field Transforms_ have either an _Aggregate_ or _Non-Aggregate_ output type. -See the section called <> for more about +See the section called +xref:reports:reporter_template_terminology.adoc#field_transforms[Field Transforms] for more about _Count, _Count Distinct_, and other transform options. + . Click _Add Selected Fields_ underneath the _Field Transform_ pane to add this diff --git a/docs-antora/modules/reports/pages/reporter_generating_reports.adoc b/docs-antora/modules/reports/pages/reporter_generating_reports.adoc index ed64cddfc8..d49e32dd33 100644 --- a/docs-antora/modules/reports/pages/reporter_generating_reports.adoc +++ b/docs-antora/modules/reports/pages/reporter_generating_reports.adoc @@ -66,7 +66,8 @@ available as an Excel spreadsheet, an HTML table (for display in the staff client or browser), and as a bar chart. + 2) If you want the report to be recurring, check the box and select the -_Recurrence Interval_ as described in <>. +_Recurrence Interval_ as described in +xref:reports:reporter_running_recurring_reports.adoc#recurring_reports[Recurring Reports]. In this example, as this is a report that will only be run once, the _Recurring Report_ box is not checked. + 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 5b52a6bfa5..dd71da7a8f 100644 --- a/docs-antora/modules/reports/pages/reporter_running_recurring_reports.adoc +++ b/docs-antora/modules/reports/pages/reporter_running_recurring_reports.adoc @@ -9,10 +9,10 @@ registration statistics. When you have set up a report to run on a monthly basis you’ll get an email informing you that the report has successfully run. You can click on a link in the email that will take you directly to the report output. You can also access the output through the reporter interface as described in -<>. +xref:reports:reporter_view_output.adoc#viewing_report_output[Viewing Report Output]. -To set up a monthly recurring report follow the procedure in <> but make the changes described below. +To set up a monthly recurring report follow the procedure in +xref:reports:reporter_generating_reports.adoc#generating_reports[Generating Reports from Templates] but make the changes described below. . Select the Recurring Report check-box and set the recurrence interval to 1 month. . Do not select Run ASAP. Instead schedule the report to run early on the first diff --git a/docs-antora/modules/shared/pages/about_this_documentation.adoc b/docs-antora/modules/shared/pages/about_this_documentation.adoc index 8ce1ea463a..dedaa7827e 100644 --- a/docs-antora/modules/shared/pages/about_this_documentation.adoc +++ b/docs-antora/modules/shared/pages/about_this_documentation.adoc @@ -5,7 +5,7 @@ consisting of numerous volunteers from many different organizations. The DIG has drawn together, edited, and supplemented pre-existing documentation contributed by libraries and consortia running Evergreen that were kind enough to release their documentation into the creative commons. Please see the -<> section for a full list of authors and +xref:shared:attributions.adoc#attributions[Attributions] section for a full list of authors and contributing organizations. Just like the software it describes, this guide is a work in progress, continually revised to meet the needs of its users, so if you find errors or omissions, please let us know, by contacting the DIG -- 2.11.0