LP#1848524: Docs: Attempt an Acq topic manual
authorRemington Steed <rjs7@calvin.edu>
Tue, 25 Feb 2020 15:45:20 +0000 (10:45 -0500)
committerGalen Charlton <gmc@equinoxinitiative.org>
Fri, 4 Sep 2020 20:41:35 +0000 (16:41 -0400)
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 <rjs7@calvin.edu>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
docs-antora/modules/ROOT/pages/index.adoc
docs-antora/topics/acquisitions/antora.yml [new file with mode: 0644]
docs-antora/topics/acquisitions/modules/ROOT/_attributes.adoc [new file with mode: 0644]
docs-antora/topics/acquisitions/modules/ROOT/nav.adoc [new file with mode: 0644]
docs-antora/topics/acquisitions/modules/ROOT/pages/index.adoc [new file with mode: 0644]

index 337148d..6105a13 100644 (file)
@@ -7,5 +7,10 @@ endif::[]
 :idseparator: -\r
 \r
 \r
-== It's Powered by Antora!\r
+== Topic Manuals ==\r
+\r
+Browse all the documentation topics using the left sidebar.  Or, try one of\r
+these smaller topic manuals:\r
+\r
+xref:acq:ROOT:index.adoc[Acquisitions Manual]\r
 \r
diff --git a/docs-antora/topics/acquisitions/antora.yml b/docs-antora/topics/acquisitions/antora.yml
new file mode 100644 (file)
index 0000000..2c13efd
--- /dev/null
@@ -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 (file)
index 0000000..dec438a
--- /dev/null
@@ -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 (file)
index 0000000..7f7d22c
--- /dev/null
@@ -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 (file)
index 0000000..86bf5a3
--- /dev/null
@@ -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.