From: Remington Steed Date: Thu, 5 Dec 2019 16:06:27 +0000 (-0500) Subject: LP#1848524: Docs: Draft of all nav files X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=2738637f5f86838ddee94a76e60cab6d26f0a392;p=Evergreen.git LP#1848524: Docs: Draft of all nav files Some files still contain 'leveloffset' commands which need to be removed, and those previously offset files should probably have their headings adjusted accordingly. Signed-off-by: Remington Steed Signed-off-by: Galen Charlton --- diff --git a/docs-antora/antora.yml b/docs-antora/antora.yml index 471f85f97c..d033b0fb1a 100644 --- a/docs-antora/antora.yml +++ b/docs-antora/antora.yml @@ -2,7 +2,17 @@ name: docs title: Evergreen docs version: 'latest' nav: -- modules/ROOT/nav.adoc +- modules/installation/nav.adoc +- modules/admin_initial_setup/nav.adoc - modules/using_staff_client/nav.adoc - modules/sys_admin/nav.adoc - modules/local_admin/nav.adoc +- modules/acquisitions/nav.adoc +- modules/cataloging/nav.adoc +- modules/serials/nav.adoc +- modules/circulation/nav.adoc +- modules/reports/nav.adoc +- modules/opac/nav.adoc +- modules/development/nav.adoc +- modules/api/nav.adoc +- modules/appendix/nav.adoc diff --git a/docs-antora/modules/ROOT/nav.adoc b/docs-antora/modules/ROOT/nav.adoc deleted file mode 100644 index e2d90d6cf1..0000000000 --- a/docs-antora/modules/ROOT/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* Software Installation -* System Configuration and Customization - diff --git a/docs-antora/modules/acquisitions/nav.adoc b/docs-antora/modules/acquisitions/nav.adoc new file mode 100644 index 0000000000..180c6f675c --- /dev/null +++ b/docs-antora/modules/acquisitions/nav.adoc @@ -0,0 +1,10 @@ +* Acquisitions +** xref:acquisitions:introduction.adoc[Introduction] +** xref:acquisitions:selection_lists_po.adoc[] +** xref:acquisitions:invoices.adoc[] +** xref:acquisitions:receive_items_from_invoice.adoc[] +** xref:acquisitions:vandelay_acquisitions_integration.adoc[] +** xref:acquisitions:purchase_requests_patron_view.adoc[] +** xref:acquisitions:purchase_requests_management.adoc[] +** xref:acquisitions:blanket.adoc[] + diff --git a/docs-antora/modules/admin_initial_setup/nav.adoc b/docs-antora/modules/admin_initial_setup/nav.adoc new file mode 100644 index 0000000000..73ef2b989b --- /dev/null +++ b/docs-antora/modules/admin_initial_setup/nav.adoc @@ -0,0 +1,41 @@ +* System Configuration and Customization +** xref:admin_initial_setup:introduction.adoc[Introduction] +:leveloffset: 1 +** xref:admin_initial_setup:describing_your_organization.adoc[] +** xref:admin_initial_setup:describing_your_people.adoc[] +** xref:admin_initial_setup:migrating_patron_data.adoc[] +** xref:admin_initial_setup:migrating_your_data.adoc[] +** xref:admin_initial_setup:importing_via_staff_client.adoc[] +** xref:admin_initial_setup:ordering_materials.adoc[] +** xref:admin_initial_setup:designing_your_catalog.adoc[] +** xref:admin_initial_setup:different_styles_for_searchbar.adoc[] +** xref:admin:search_interface.adoc[] +** xref:admin_initial_setup:borrowing_items.adoc[] +:leveloffset: 0 +** xref:admin:autorenewals.adoc[] +** xref:admin_initial_setup:hard_due_dates.adoc[] +** xref:admin:template_toolkit.adoc[] +:leveloffset: 1 +** xref:opac:new_skin_customizations.adoc[] +:leveloffset: 0 +** xref:admin:auto_suggest_search.adoc[] +** xref:admin:authentication_proxy.adoc[] +:leveloffset: 1 +** xref:TechRef:KidsOPAC.adoc[] +:leveloffset: 0 +** xref:admin:patron_address_by_zip_code.adoc[] +:leveloffset: 1 +** xref:admin:phonelist.adoc[] +:leveloffset: 0 +** xref:admin:sip_server.adoc[] +:leveloffset: 1 +** xref:admin:sip_privacy.adoc[] +:leveloffset: 0 +** xref:admin:apache_rewrite_tricks.adoc[] +** xref:admin:apache_access_handler.adoc[] +** xref:admin:ebook_api_service.adoc[] +** xref:admin:hold_targeter_service.adoc[] +:leveloffset: 1 +** xref:admin:backups.adoc[] +:leveloffset: 0 + diff --git a/docs-antora/modules/admin_initial_setup/pages/introduction.adoc b/docs-antora/modules/admin_initial_setup/pages/introduction.adoc new file mode 100644 index 0000000000..67166a5b20 --- /dev/null +++ b/docs-antora/modules/admin_initial_setup/pages/introduction.adoc @@ -0,0 +1,5 @@ +== Introduction == +The Evergreen system allows a free range of customizations to every aspect of +the system. Use this part of the documentation to become familiar with the tools +for configuring the system as well as customizing the catalog and staff client. + diff --git a/docs-antora/modules/api/_attributes.adoc b/docs-antora/modules/api/_attributes.adoc new file mode 100644 index 0000000000..dec438a296 --- /dev/null +++ b/docs-antora/modules/api/_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/modules/api/nav.adoc b/docs-antora/modules/api/nav.adoc new file mode 100644 index 0000000000..8a74992c13 --- /dev/null +++ b/docs-antora/modules/api/nav.adoc @@ -0,0 +1,8 @@ +* Getting Data from Evergreen +** xref:development:introduction.adoc[Introduction] +:leveloffset: 1 +** xref:development:data_supercat.adoc[] +** xref:development:data_unapi.adoc[] +** xref:development:data_opensearch.adoc[] +:leveloffset: 0 + diff --git a/docs-antora/modules/api/pages/introduction.adoc b/docs-antora/modules/api/pages/introduction.adoc new file mode 100644 index 0000000000..75db3a09e0 --- /dev/null +++ b/docs-antora/modules/api/pages/introduction.adoc @@ -0,0 +1,5 @@ +== Introduction == +You may be interested in re-using data from your Evergreen installation in +another application. This part describes several methods to get the data +you need. + diff --git a/docs-antora/modules/appendix/nav.adoc b/docs-antora/modules/appendix/nav.adoc new file mode 100644 index 0000000000..e9ecd6804d --- /dev/null +++ b/docs-antora/modules/appendix/nav.adoc @@ -0,0 +1,4 @@ +* Appendix +** xref:shared:attributions.adoc[Attributions] +** xref:shared:licensing.adoc[Licensing] + diff --git a/docs-antora/modules/cataloging/nav.adoc b/docs-antora/modules/cataloging/nav.adoc new file mode 100644 index 0000000000..c87dd49f98 --- /dev/null +++ b/docs-antora/modules/cataloging/nav.adoc @@ -0,0 +1,34 @@ +* Cataloging +** xref:cataloging:introduction.adoc[Introduction] +** xref:cataloging:marc_tag_table.adoc[] +** xref:cataloging:copy-buckets_web_client.adoc[] +** xref:cataloging:item_tags_cataloging.adoc[] +** xref:cataloging:MARC_Editor.adoc[] + +:leveloffset: 1 +** xref:cataloging:record_buckets.adoc[] +:leveloffset: 0 + +** xref:cataloging:merge_overlay_bibs.adoc[] +** xref:cataloging:physical_char_wizard.adoc[] +** xref:admin:staff_client-return_to_results_from_marc.adoc[] +** xref:cataloging:batch_importing_MARC.adoc[] +** xref:cataloging:overlay_record_3950_import.adoc[] +** xref:cataloging:z39.50_search_enhancements.adoc[] +** xref:cataloging:monograph_parts.adoc[] +** xref:cataloging:conjoined_items.adoc[] +** xref:cataloging:cataloging_electronic_resources.adoc[] +** xref:cataloging:item_status.adoc[] +** xref:cataloging:volcopy_editor.adoc[] + +:leveloffset: 1 +** xref:cataloging:tpac_copy_edit_links.adoc[] +** xref:cataloging:holdings_editor_hide_fields.adoc[] +:leveloffset: 0 + +** xref:cataloging:MARC_batch_edit.adoc[] +** xref:cataloging:authorities.adoc[] +** xref:cataloging:link_checker.adoc[] +** xref:admin:schema_bibliographic.adoc[] +** xref:admin:marc_templates.adoc[] + diff --git a/docs-antora/modules/cataloging/pages/introduction.adoc b/docs-antora/modules/cataloging/pages/introduction.adoc new file mode 100644 index 0000000000..acfaa5f583 --- /dev/null +++ b/docs-antora/modules/cataloging/pages/introduction.adoc @@ -0,0 +1,2 @@ +== Introduction == +This part describes cataloging in Evergreen. diff --git a/docs-antora/modules/circulation/nav.adoc b/docs-antora/modules/circulation/nav.adoc new file mode 100644 index 0000000000..092d07fa59 --- /dev/null +++ b/docs-antora/modules/circulation/nav.adoc @@ -0,0 +1,15 @@ +* Circulation +** xref:circulation:introduction.adoc[Introduction] +** xref:circulation:circulating_items_web_client.adoc[] +** xref:circulation:basic_holds.adoc[] +** xref:circulation:advanced_holds.adoc[] +** xref:circulation:booking.adoc[] +** xref:circulation:circulation_patron_records_web_client.adoc[] +** xref:admin:patron_self_registration.adoc[] +** xref:circulation:triggered_events.adoc[] + +:leveloffset: 1 +** xref:circulation:offline_circ_webclient.adoc[] +** xref:circulation:self_check.adoc[] +:leveloffset: 0 + diff --git a/docs-antora/modules/circulation/pages/basic_holds.adoc b/docs-antora/modules/circulation/pages/basic_holds.adoc index e57ea6a8dd..10005f7e50 100644 --- a/docs-antora/modules/circulation/pages/basic_holds.adoc +++ b/docs-antora/modules/circulation/pages/basic_holds.adoc @@ -1,3 +1,4 @@ +== Holds Management == === Placing Holds === diff --git a/docs-antora/modules/circulation/pages/introduction.adoc b/docs-antora/modules/circulation/pages/introduction.adoc new file mode 100644 index 0000000000..2cd36e67ba --- /dev/null +++ b/docs-antora/modules/circulation/pages/introduction.adoc @@ -0,0 +1,4 @@ +== Introduction == +Use this section for understanding the circulation procedures in the Evergreen +system. + diff --git a/docs-antora/modules/development/nav.adoc b/docs-antora/modules/development/nav.adoc new file mode 100644 index 0000000000..923acf0b95 --- /dev/null +++ b/docs-antora/modules/development/nav.adoc @@ -0,0 +1,10 @@ +* Developer Resources +** xref:development:introduction.adoc[Introduction] +** xref:development:support_scripts.adoc[] + +:leveloffset: 1 +** xref:development:pgtap.adoc[] +** xref:development:intro_opensrf.adoc[] +** xref:development:updating_translations_launchpad.adoc[] +:leveloffset: 0 + diff --git a/docs-antora/modules/development/pages/introduction.adoc b/docs-antora/modules/development/pages/introduction.adoc new file mode 100644 index 0000000000..81ea47416f --- /dev/null +++ b/docs-antora/modules/development/pages/introduction.adoc @@ -0,0 +1,4 @@ +== Introduction == +Developers can use this part to learn more about the programming languages, +communication protocols and standards used in Evergreen. + diff --git a/docs-antora/modules/installation/nav.adoc b/docs-antora/modules/installation/nav.adoc index bcf410f1d0..02a4222e40 100644 --- a/docs-antora/modules/installation/nav.adoc +++ b/docs-antora/modules/installation/nav.adoc @@ -1,4 +1,5 @@ * Software Installation +** xref:installation:introduction.adoc[Introduction] ** xref:installation:system_requirements.adoc[System Requirements] ** xref:installation:server_installation.adoc[Installing the Evergreen server] ** xref:installation:server_upgrade.adoc[Upgrading the Evergreen Server] diff --git a/docs-antora/modules/installation/pages/introduction.adoc b/docs-antora/modules/installation/pages/introduction.adoc new file mode 100644 index 0000000000..0f508b0ef3 --- /dev/null +++ b/docs-antora/modules/installation/pages/introduction.adoc @@ -0,0 +1,3 @@ +== Introduction == +This part will guide you through the installation steps installation or +upgrading your Evergreen system. It is intended for system administrators. diff --git a/docs-antora/modules/local_admin/nav.adoc b/docs-antora/modules/local_admin/nav.adoc index 99660992fa..05e0d39c24 100644 --- a/docs-antora/modules/local_admin/nav.adoc +++ b/docs-antora/modules/local_admin/nav.adoc @@ -1,4 +1,5 @@ * Local Administration +** xref:local_admin:introduction.adoc[Introduction] ** xref:admin:librarysettings.adoc[Library Settings Editor] ** xref:admin:lsa-address_alert.adoc[Address Alert] ** xref:admin:lsa-barcode_completion.adoc[Barcode Completion] diff --git a/docs-antora/modules/local_admin/pages/introduction.adoc b/docs-antora/modules/local_admin/pages/introduction.adoc new file mode 100644 index 0000000000..2d3a41f346 --- /dev/null +++ b/docs-antora/modules/local_admin/pages/introduction.adoc @@ -0,0 +1,3 @@ +== Introduction == +This part covers the options in the Local Administration menu found in the staff +client. diff --git a/docs-antora/modules/opac/nav.adoc b/docs-antora/modules/opac/nav.adoc new file mode 100644 index 0000000000..288e6154f6 --- /dev/null +++ b/docs-antora/modules/opac/nav.adoc @@ -0,0 +1,16 @@ +* Using the Public Access Catalog +** xref:opac:introduction.adoc[Introduction] +** xref:opac:using_the_public_access_catalog.adoc[] +** xref:opac:my_lists.adoc[] +** xref:opac:batch_actions_from_search.adoc[] +** xref:opac:kids_opac.adoc[] +** xref:opac:catalog_browse.adoc[] +** xref:opac:advanced_features.adoc[] +** xref:opac:tpac_meta_record_holds.adoc[] +** xref:opac:linked_libraries.adoc[] +** xref:opac:opensearch.adoc[] + +:leveloffset: 1 +** xref:opac:search_form.adoc[] +:leveloffset: 0 + diff --git a/docs-antora/modules/opac/pages/introduction.adoc b/docs-antora/modules/opac/pages/introduction.adoc new file mode 100644 index 0000000000..159087776c --- /dev/null +++ b/docs-antora/modules/opac/pages/introduction.adoc @@ -0,0 +1,12 @@ +== Introduction == + +Evergreen has a public OPAC that meets WCAG guidelines +(http://www.w3.org/WAI/intro/wcag), which helps make the OPAC accessible to +users with a range of disabilities. This part of the documentation explains how +to use the Evergreen public OPAC. It covers the basic catalog and more advanced +search topics. It also describes the ``My Account'' tools users have to find +information and manage their personal library accounts through the OPAC. This +section could be used by staff and patrons but would be more useful for staff as +a generic reference when developing custom guides and tutorials for their users. + + diff --git a/docs-antora/modules/reports/nav.adoc b/docs-antora/modules/reports/nav.adoc new file mode 100644 index 0000000000..fbd54d78b6 --- /dev/null +++ b/docs-antora/modules/reports/nav.adoc @@ -0,0 +1,14 @@ +* Reports +** xref:reports:introduction.adoc[Introduction] +** 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[] + diff --git a/docs-antora/modules/reports/pages/introduction.adoc b/docs-antora/modules/reports/pages/introduction.adoc new file mode 100644 index 0000000000..447db42729 --- /dev/null +++ b/docs-antora/modules/reports/pages/introduction.adoc @@ -0,0 +1,2 @@ +== Introduction == +Learn how to create and use reports in Evergreen. diff --git a/docs-antora/modules/serials/nav.adoc b/docs-antora/modules/serials/nav.adoc new file mode 100644 index 0000000000..1f418c8fe4 --- /dev/null +++ b/docs-antora/modules/serials/nav.adoc @@ -0,0 +1,11 @@ +* Serials +** xref:serials:A-intro.adoc[] +** xref:serials:B-serials_admin.adoc[] +** xref:serials:C-serials_workflow.adoc[] +** xref:serials:D-Receiving.adoc[] +** xref:serials:E-routing_lists.adoc[] +** xref:serials:F-Special_issue.adoc[] +** xref:serials:G-binding.adoc[] +** xref:serials:H-holdings_statements.adoc[] +** xref:serials:Group_Serials_Issues_in_the_OPAC_2.2.adoc[] + diff --git a/docs-antora/modules/shared/pages/licensing.adoc b/docs-antora/modules/shared/pages/licensing.adoc new file mode 100644 index 0000000000..25b1c5e6b0 --- /dev/null +++ b/docs-antora/modules/shared/pages/licensing.adoc @@ -0,0 +1,11 @@ +[[licensing]] +[appendix] += Licensing = + +image::media/ccbysa.png["CC-BY-SA",link="http://creativecommons.org/licenses/by-sa/3.0/"] + +This work is licensed under a +link:http://creativecommons.org/licenses/by-sa/3.0/[Creative +Commons Attribution-ShareAlike 3.0 Unported License]. + + diff --git a/docs-antora/modules/sys_admin/introduction.adoc b/docs-antora/modules/sys_admin/introduction.adoc new file mode 100644 index 0000000000..c7736f2459 --- /dev/null +++ b/docs-antora/modules/sys_admin/introduction.adoc @@ -0,0 +1,3 @@ +== Introduction == +This part deals with the options in the Server Administration menu found in the +staff client. diff --git a/docs-antora/modules/sys_admin/nav.adoc b/docs-antora/modules/sys_admin/nav.adoc index 4259398ed8..18557f38be 100644 --- a/docs-antora/modules/sys_admin/nav.adoc +++ b/docs-antora/modules/sys_admin/nav.adoc @@ -1,4 +1,5 @@ * System Administration From the Staff Client +** xref:sys_admin:introduction.adoc[Introduction] ** xref:admin:acquisitions_admin.adoc[Acquisitions Administration] ** xref:admin:age_hold_protection.adoc[Age hold protection] ** xref:admin:authorities.adoc[Authorities] diff --git a/docs-antora/modules/using_staff_client/nav.adoc b/docs-antora/modules/using_staff_client/nav.adoc index 462e1db4f1..a5eccb5900 100644 --- a/docs-antora/modules/using_staff_client/nav.adoc +++ b/docs-antora/modules/using_staff_client/nav.adoc @@ -1,4 +1,5 @@ * Using the Browser Staff Client +** xref:using_staff_client:introduction.adoc[Introduction] ** xref:admin:web_client-login.adoc[Logging into Evergreen] ** xref:admin:web-client-browser-best-practices.adoc[Best Practices for Using the Browser] ** xref:admin:staff_client-column_picker.adoc[Column Picker] diff --git a/docs-antora/modules/using_staff_client/pages/introduction.adoc b/docs-antora/modules/using_staff_client/pages/introduction.adoc new file mode 100644 index 0000000000..a13c0583d9 --- /dev/null +++ b/docs-antora/modules/using_staff_client/pages/introduction.adoc @@ -0,0 +1,7 @@ +== Introduction == +This part of the documentation deals with general Browser Client usage including +logging in, navigation and shortcuts. + +For information about the XUL client, consult the +http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation]. +