From 632b5cd61a7ea6d18dfdee6f5a640b962167333d Mon Sep 17 00:00:00 2001 From: Remington Steed Date: Tue, 25 Feb 2020 10:45:20 -0500 Subject: [PATCH] LP#1848524: Docs: Attempt an Acq topic manual This is a first draft at structuring a topic manual in Antora (mostly reusing files from the main "docs" component). Signed-off-by: Remington Steed Signed-off-by: Galen Charlton --- docs-antora/modules/ROOT/pages/index.adoc | 7 ++++++- docs-antora/topics/acquisitions/antora.yml | 5 +++++ .../acquisitions/modules/ROOT/_attributes.adoc | 4 ++++ .../topics/acquisitions/modules/ROOT/nav.adoc | 23 ++++++++++++++++++++++ .../acquisitions/modules/ROOT/pages/index.adoc | 5 +++++ 5 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs-antora/topics/acquisitions/antora.yml create mode 100644 docs-antora/topics/acquisitions/modules/ROOT/_attributes.adoc create mode 100644 docs-antora/topics/acquisitions/modules/ROOT/nav.adoc create mode 100644 docs-antora/topics/acquisitions/modules/ROOT/pages/index.adoc diff --git a/docs-antora/modules/ROOT/pages/index.adoc b/docs-antora/modules/ROOT/pages/index.adoc index 337148df75..6105a13baf 100644 --- a/docs-antora/modules/ROOT/pages/index.adoc +++ b/docs-antora/modules/ROOT/pages/index.adoc @@ -7,5 +7,10 @@ endif::[] :idseparator: - -== It's Powered by Antora! +== Topic Manuals == + +Browse all the documentation topics using the left sidebar. Or, try one of +these smaller topic manuals: + +xref:acq:ROOT:index.adoc[Acquisitions Manual] diff --git a/docs-antora/topics/acquisitions/antora.yml b/docs-antora/topics/acquisitions/antora.yml new file mode 100644 index 0000000000..2c13efd3f4 --- /dev/null +++ b/docs-antora/topics/acquisitions/antora.yml @@ -0,0 +1,5 @@ +name: acq +title: Evergreen Acquisitions Manual +version: 'latest' +nav: +- modules/ROOT/nav.adoc diff --git a/docs-antora/topics/acquisitions/modules/ROOT/_attributes.adoc b/docs-antora/topics/acquisitions/modules/ROOT/_attributes.adoc new file mode 100644 index 0000000000..dec438a296 --- /dev/null +++ b/docs-antora/topics/acquisitions/modules/ROOT/_attributes.adoc @@ -0,0 +1,4 @@ +:attachmentsdir: {moduledir}/assets/attachments +:examplesdir: {moduledir}/examples +:imagesdir: {moduledir}/assets/images +:partialsdir: {moduledir}/pages/_partials diff --git a/docs-antora/topics/acquisitions/modules/ROOT/nav.adoc b/docs-antora/topics/acquisitions/modules/ROOT/nav.adoc new file mode 100644 index 0000000000..7f7d22c3c5 --- /dev/null +++ b/docs-antora/topics/acquisitions/modules/ROOT/nav.adoc @@ -0,0 +1,23 @@ +* xref:ROOT:index.adoc[Introduction] +** xref:docs:shared:about_evergreen.adoc[About Evergreen] +* xref:docs:admin:web_client-login.adoc[Logging into Evergreen] +* xref:docs:admin:web-client-browser-best-practices.adoc[Best Practices for Using the Browser] +* xref:docs:shared:workstation_settings.adoc[Configuring Evergreen for Your +Workstation] +* xref:docs:acquisitions:introduction.adoc[Acquisitions] +* xref:docs:acquisitions:selection_lists_po.adoc[Selection Lists and Purchase +Orders] +* xref:docs:acquisitions:vandelay_acquisitions_integration.adoc[Load MARC Order +Records] +* xref:docs:acquisitions:invoices.adoc[Invoices] +* xref:docs:acquisitions:receive_items_from_invoice.adoc[] +* xref:docs:acquisitions:purchase_requests_management.adoc[Managing Patron +Purchase Requests] +* xref:docs:acquisitions:purchase_requests_patron_view.adoc[] +* xref:docs:opac:using_the_public_access_catalog.adoc[Using the Public Access +Catalog] +* xref:docs:shared:attributions.adoc[Attributions] +* xref:docs:shared:attributions.adoc[Appendix A. Attributions] +* xref:docs:shared:licensing.adoc[Appendix B. Licensing] +* xref:docs:appendix:glossary.adoc[Glossary] +* xref:docs:shared:index.adoc[Index] diff --git a/docs-antora/topics/acquisitions/modules/ROOT/pages/index.adoc b/docs-antora/topics/acquisitions/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000000..86bf5a31c7 --- /dev/null +++ b/docs-antora/topics/acquisitions/modules/ROOT/pages/index.adoc @@ -0,0 +1,5 @@ += Evergreen Acquisitions Manual = + +This guide to Evergreen is intended to meet the needs of library workers who use +Evergreen's Acquisitions module. It is organized into Parts, Chapters, and +Sections addressing key aspects of the software. -- 2.11.0