From 289347400e5b7d2d1cc519f17899ee0d8c739c58 Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Thu, 21 Sep 2023 13:51:35 -0700 Subject: [PATCH] update to toctree conversion with document titles --- .../configuring-the-catalog/index.md | 12 ++-- docs/manual/docs/administrator-guide/index.md | 8 +-- .../managing-classification-systems/index.md | 6 +- .../managing-metadata-standards/index.md | 6 +- .../managing-users-and-groups/index.md | 8 +-- docs/manual/docs/annexes/index.md | 4 +- docs/manual/docs/annexes/standards/index.md | 8 +-- docs/manual/docs/contributing/index.md | 8 +-- .../docs/customizing-application/index.md | 24 +++---- .../search-ui/index.md | 10 +-- docs/manual/docs/index.md | 6 -- docs/manual/docs/install-guide/index.md | 20 +++--- .../docs/maintainer-guide/statistics/index.md | 4 +- docs/manual/docs/tutorials/customui/index.md | 2 +- .../docs/tutorials/customui/search/index.md | 6 +- .../tutorials/hookcustomizations/index.md | 10 +-- docs/manual/docs/tutorials/index.md | 6 +- docs/manual/docs/tutorials/inspire/index.md | 8 +-- .../introduction/deployment/index.md | 2 +- .../docs/tutorials/introduction/edit/index.md | 2 +- .../docs/tutorials/introduction/index.md | 10 +-- .../manual/docs/user-guide/analyzing/index.md | 4 +- .../user-guide/associating-resources/index.md | 8 +-- .../linking-documents.md | 6 +- .../associating-resources/linking-records.md | 12 ++-- .../describing-information/index.md | 14 ++-- .../docs/user-guide/harvesting/index.md | 22 +++---- docs/manual/docs/user-guide/index.md | 14 ++-- .../docs/user-guide/publishing/index.md | 6 +- .../docs/user-guide/tag-information/index.md | 4 +- .../docs/user-guide/workflow/batchupdate.md | 6 +- docs/manual/docs/user-guide/workflow/index.md | 10 +-- docs/manual/translate/cli.py | 30 +++++---- docs/manual/translate/translate.py | 66 ++++++++++++++----- 34 files changed, 199 insertions(+), 173 deletions(-) diff --git a/docs/manual/docs/administrator-guide/configuring-the-catalog/index.md b/docs/manual/docs/administrator-guide/configuring-the-catalog/index.md index dbbf9430f9a..0e84f5ea037 100644 --- a/docs/manual/docs/administrator-guide/configuring-the-catalog/index.md +++ b/docs/manual/docs/administrator-guide/configuring-the-catalog/index.md @@ -1,9 +1,9 @@ # Configuring the catalog -- [System Configuration](system-configuration.md) +- [System configuration](system-configuration.md) - [User Interface Configuration](user-interface-configuration.md) -- [Css Configuration](css-configuration.md) -- [Csw Configuration](csw-configuration.md) -- [Portal Configuration](portal-configuration.md) -- [Inspire Configuration](inspire-configuration.md) -- [Map Server Configuration](map-server-configuration.md) +- [Configuring CSS & Style](css-configuration.md) +- [Configuring CSW](csw-configuration.md) +- [Portal configuration](portal-configuration.md) +- [Configuring for the INSPIRE Directive](inspire-configuration.md) +- [Map servers configuration for geopublication](map-server-configuration.md) diff --git a/docs/manual/docs/administrator-guide/index.md b/docs/manual/docs/administrator-guide/index.md index 520ec5b766e..7d2a75603e7 100644 --- a/docs/manual/docs/administrator-guide/index.md +++ b/docs/manual/docs/administrator-guide/index.md @@ -1,9 +1,9 @@ # Administrator guide -- [Configuring The Catalog](configuring-the-catalog/index.md) -- [Managing Users And Groups](managing-users-and-groups/index.md) -- [Managing Classification Systems](managing-classification-systems/index.md) -- [Managing Metadata Standards](managing-metadata-standards/index.md) +- [Configuring the catalog](configuring-the-catalog/index.md) +- [Managing users and groups](managing-users-and-groups/index.md) +- [Managing classification system](managing-classification-systems/index.md) +- [Managing metadata & template](managing-metadata-standards/index.md) ![](img/admin.png) diff --git a/docs/manual/docs/administrator-guide/managing-classification-systems/index.md b/docs/manual/docs/administrator-guide/managing-classification-systems/index.md index 491094aff59..b7cbca16ebe 100644 --- a/docs/manual/docs/administrator-guide/managing-classification-systems/index.md +++ b/docs/manual/docs/administrator-guide/managing-classification-systems/index.md @@ -1,5 +1,5 @@ # Managing classification system -- [Managing Categories](managing-categories.md) -- [Managing Directories](managing-directories.md) -- [Managing Thesaurus](managing-thesaurus.md) +- [Managing categories](managing-categories.md) +- [Managing directories](managing-directories.md) +- [Managing thesaurus](managing-thesaurus.md) diff --git a/docs/manual/docs/administrator-guide/managing-metadata-standards/index.md b/docs/manual/docs/administrator-guide/managing-metadata-standards/index.md index 27318fb811f..4b5c7cb1d90 100644 --- a/docs/manual/docs/administrator-guide/managing-metadata-standards/index.md +++ b/docs/manual/docs/administrator-guide/managing-metadata-standards/index.md @@ -1,5 +1,5 @@ # Managing metadata & template {#metadata-and-template} -- [Standards](standards.md) -- [Configure Validation](configure-validation.md) -- [Metadata Identifier](metadata-identifier.md) +- [Managing metadata standards](standards.md) +- [Configuring validation levels](configure-validation.md) +- [Configuring metadata identifier](metadata-identifier.md) diff --git a/docs/manual/docs/administrator-guide/managing-users-and-groups/index.md b/docs/manual/docs/administrator-guide/managing-users-and-groups/index.md index a1d435c17a2..9f23c7fbcce 100644 --- a/docs/manual/docs/administrator-guide/managing-users-and-groups/index.md +++ b/docs/manual/docs/administrator-guide/managing-users-and-groups/index.md @@ -1,9 +1,9 @@ # Managing users and groups -- [Creating Group](creating-group.md) -- [Creating User](creating-user.md) -- [User Self Registration](user-self-registration.md) -- [Authentication Mode](authentication-mode.md) +- [Creating group](creating-group.md) +- [Creating user](creating-user.md) +- [User Self-Registration](user-self-registration.md) +- [Authentication mode](authentication-mode.md) ## Default user {#user-defaults} diff --git a/docs/manual/docs/annexes/index.md b/docs/manual/docs/annexes/index.md index 237579ae41f..985df36e4ab 100644 --- a/docs/manual/docs/annexes/index.md +++ b/docs/manual/docs/annexes/index.md @@ -1,5 +1,5 @@ # Annexes -- [Mef Format](mef-format.md) -- [Gallery Gallery](gallery/gallery.md) +- [Metadata Exchange Format (MEF)](mef-format.md) +- [Some GeoNetwork nodes](gallery/gallery.md) - [Standards](standards/index.md) diff --git a/docs/manual/docs/annexes/standards/index.md b/docs/manual/docs/annexes/standards/index.md index 92994b83b1a..6216f402afd 100644 --- a/docs/manual/docs/annexes/standards/index.md +++ b/docs/manual/docs/annexes/standards/index.md @@ -4,10 +4,10 @@ The catalog support the following standards: ![](img/standardlist.png) -- [Iso19115 3.2018](iso19115-3.2018.md) -- [Iso19139](iso19139.md) -- [Iso19110](iso19110.md) -- [Dublin Core](dublin-core.md) +- [Geographic information -- Metadata (iso19115-3.2018)](iso19115-3.2018.md) +- [Geographic information -- Metadata (iso19139:2007) (iso19139)](iso19139.md) +- [Geographic information -- Methodology for feature cataloguing (Deprecated - use ISO19115-3) (iso19110)](iso19110.md) +- [Dublin core (dublin-core)](dublin-core.md) ISO19110 can be used to encode feature catalogue (but ISO19115-3 is recommended). diff --git a/docs/manual/docs/contributing/index.md b/docs/manual/docs/contributing/index.md index 1d864be4788..be0df40ac84 100644 --- a/docs/manual/docs/contributing/index.md +++ b/docs/manual/docs/contributing/index.md @@ -2,8 +2,8 @@ The guide for people who want to contribute to GeoNetwork. -- [Writing Documentation](writing-documentation.md) +- [Writing documentation](writing-documentation.md) - [Style Guide](style-guide.md) -- [Translating](translating.md) -- [Making A Pull Request](making-a-pull-request.md) -- [Doing A Release](doing-a-release.md) +- [Translating the application](translating.md) +- [Making a pull request](making-a-pull-request.md) +- [Doing a GeoNetwork release](doing-a-release.md) diff --git a/docs/manual/docs/customizing-application/index.md b/docs/manual/docs/customizing-application/index.md index 842566d8a90..e7a85d096bc 100644 --- a/docs/manual/docs/customizing-application/index.md +++ b/docs/manual/docs/customizing-application/index.md @@ -1,15 +1,15 @@ # Customizing guide -- [Search Ui](search-ui/index.md) -- [Creating Custom View](creating-custom-view.md) -- [Editor Ui Creating Custom Editor](editor-ui/creating-custom-editor.md) -- [Editor Ui Custom Editor Examples](editor-ui/custom-editor-examples.md) -- [Editor Ui Tutorial](editor-ui/tutorial.md) -- [Changing Layout](changing-layout.md) -- [Configuring Search Fields](configuring-search-fields.md) -- [Configuring Faceted Search](configuring-faceted-search.md) -- [Advanced Configuration](advanced-configuration.md) -- [Adding Static Pages](adding-static-pages.md) -- [Implementing A Schema Plugin](implementing-a-schema-plugin.md) +- [Search application](search-ui/index.md) +- [Customizing metadata views](creating-custom-view.md) +- [Customizing editor](editor-ui/creating-custom-editor.md) +- [Custom editor examples](editor-ui/custom-editor-examples.md) +- [Building a custom form step by step](editor-ui/tutorial.md) +- [Theming](changing-layout.md) +- [Configuring search fields](configuring-search-fields.md) +- [Term aggregation on a field](configuring-faceted-search.md) +- [Advanced configuration](advanced-configuration.md) +- [Adding static pages](adding-static-pages.md) +- [Implementing schema plugins](implementing-a-schema-plugin.md) - [Characterset](characterset.md) -- [Misc](misc.md) +- [Miscellaneous](misc.md) diff --git a/docs/manual/docs/customizing-application/search-ui/index.md b/docs/manual/docs/customizing-application/search-ui/index.md index a5a80d00eb2..30b5c4e3328 100644 --- a/docs/manual/docs/customizing-application/search-ui/index.md +++ b/docs/manual/docs/customizing-application/search-ui/index.md @@ -1,7 +1,7 @@ # Search application {#customizing-searchui} -- [Loadview](loadview.md) -- [Configdefault](configdefault.md) -- [Customview](customview.md) -- [Enrichview](enrichview.md) -- [Wro4Jdependencies](wro4jdependencies.md) +- [The view parameter](loadview.md) +- [Change default view configuration](configdefault.md) +- [Create your own view](customview.md) +- [Enrich your custom view](enrichview.md) +- [Wro4j resource management](wro4jdependencies.md) diff --git a/docs/manual/docs/index.md b/docs/manual/docs/index.md index beda7f1877d..c0667f30016 100644 --- a/docs/manual/docs/index.md +++ b/docs/manual/docs/index.md @@ -1,9 +1,3 @@ ---- -hide: - - navigation - - toc ---- - # GeoNetwork {#toc} Welcome to GeoNetwork. this documentation is organized into specific guides targeting different audience: diff --git a/docs/manual/docs/install-guide/index.md b/docs/manual/docs/install-guide/index.md index da432fff541..49e763b27d1 100644 --- a/docs/manual/docs/install-guide/index.md +++ b/docs/manual/docs/install-guide/index.md @@ -9,11 +9,11 @@ Before you can use GeoNetwork on your own computer, you need to install it. There are several different ways to install GeoNetwork: -- [Installing From Zip](installing-from-zip.md) -- [Installing From War File](installing-from-war-file.md) -- [Installing With Docker](installing-with-docker.md) -- [Installing From Source Code](installing-from-source-code.md) -- [Installing Index](installing-index.md) +- [Installing using a ZIP file](installing-from-zip.md) +- [Installing from WAR file](installing-from-war-file.md) +- [Installing with docker](installing-with-docker.md) +- [Building from Source Code](installing-from-source-code.md) +- [Installing search platform](installing-index.md) !!! note @@ -22,8 +22,8 @@ Before you can use GeoNetwork on your own computer, you need to install it. Ther After installing the application, you can configure the following: -- [Configuring Database](configuring-database.md) -- [Customizing Data Directory](customizing-data-directory.md) -- [Logging](logging.md) -- [Map Print Setup](map-print-setup.md) -- [Loading Samples](loading-samples.md) +- [Configuring the database](configuring-database.md) +- [Customizing the data directory](customizing-data-directory.md) +- [Customising the log file location](logging.md) +- [Configuring printing of the map](map-print-setup.md) +- [Loading templates and sample data](loading-samples.md) diff --git a/docs/manual/docs/maintainer-guide/statistics/index.md b/docs/manual/docs/maintainer-guide/statistics/index.md index dba64c0a193..0784a301bd3 100644 --- a/docs/manual/docs/maintainer-guide/statistics/index.md +++ b/docs/manual/docs/maintainer-guide/statistics/index.md @@ -11,6 +11,6 @@ GeoNetwork 3.8.x supports ElasticSearch/Kibana 7.2, other versions may not work This guide doesn't provide a production level setup for ElasticSearch/Kibana. Please refer to the ElasticSearch/Kibana documentation to do a proper setup/configuration for a production environment. -- [Setup Elasticsearch](setup-elasticsearch.md) +- [Setup ElasticSearch](setup-elasticsearch.md) - [Setup Kibana](setup-kibana.md) -- [Setup Geonetwork](setup-geonetwork.md) +- [Setup GeoNetwork](setup-geonetwork.md) diff --git a/docs/manual/docs/tutorials/customui/index.md b/docs/manual/docs/tutorials/customui/index.md index 83c96090959..a7e8a77f82e 100644 --- a/docs/manual/docs/tutorials/customui/index.md +++ b/docs/manual/docs/tutorials/customui/index.md @@ -1,6 +1,6 @@ # Customize your GeoNetwork UI {#tuto-customui} - [Search](search/index.md) -- [View](view/index.md) +- [Formatter](view/index.md) For editor customization see [creating-custom-editor](creating-custom-editor.md):. diff --git a/docs/manual/docs/tutorials/customui/search/index.md b/docs/manual/docs/tutorials/customui/search/index.md index 17dbad33af0..0beb8cbb438 100644 --- a/docs/manual/docs/tutorials/customui/search/index.md +++ b/docs/manual/docs/tutorials/customui/search/index.md @@ -1,5 +1,5 @@ # Search page {#tuto-customui-search} -- [Loadpage](loadpage.md) -- [Defaultview](defaultview.md) -- [Customview](customview.md) +- [Understand loading page mechanisms](loadpage.md) +- [Customizing default view](defaultview.md) +- [Customizing default view](customview.md) diff --git a/docs/manual/docs/tutorials/hookcustomizations/index.md b/docs/manual/docs/tutorials/hookcustomizations/index.md index 8215dee548f..970dba19571 100644 --- a/docs/manual/docs/tutorials/hookcustomizations/index.md +++ b/docs/manual/docs/tutorials/hookcustomizations/index.md @@ -2,10 +2,10 @@ At the end of this tutorial, you should be able to customize your own code into GeoNetwork on a clean and easy to upgrade way. You should start with the [tuto-introduction](tuto-introduction.md) tutorial first. -- [Newproject](newproject/index.md) -- [Events](events/index.md) -- [Ui](ui/index.md) -- [Schemaplugins](schemaplugins/index.md) -- [Searchfields](searchfields/index.md) +- [Separate your code](newproject/index.md) +- [Using Events](events/index.md) +- [Adding new User Interface](ui/index.md) +- [Schema Plugins](schemaplugins/index.md) +- [Search Fields](searchfields/index.md) For ui customization see [tuto-customui](tuto-customui.md). diff --git a/docs/manual/docs/tutorials/index.md b/docs/manual/docs/tutorials/index.md index 93a4ab45998..2d485285509 100644 --- a/docs/manual/docs/tutorials/index.md +++ b/docs/manual/docs/tutorials/index.md @@ -1,6 +1,6 @@ # Tutorials -- [Introduction](introduction/index.md) -- [Customui](customui/index.md) -- [Hookcustomizations](hookcustomizations/index.md) +- [GeoNetwork opensource](introduction/index.md) +- [Customize your GeoNetwork UI](customui/index.md) +- [Hook your own code](hookcustomizations/index.md) - [Inspire I](inspire/i.md) diff --git a/docs/manual/docs/tutorials/inspire/index.md b/docs/manual/docs/tutorials/inspire/index.md index 002672521bd..00cc09ed68c 100644 --- a/docs/manual/docs/tutorials/inspire/index.md +++ b/docs/manual/docs/tutorials/inspire/index.md @@ -2,8 +2,8 @@ The tutorials in this section target specific GeoNetwork implementation scenarios related to the [European INSPIRE Directive](http://inspire.ec.europa.eu/). INSPIRE mandates European organisations to set up view- and download services and to describe them using metadata in discovery services. To respond to all aspects of the technical guidelines requires to compose an infrastructure of various components. For now we provide tutorials for view services in `mapserver `{.interpreted-text role="doc"} and `geoserver `{.interpreted-text role="doc"} and download services using `Atom `{.interpreted-text role="doc"} and `geoserver `{.interpreted-text role="doc"}. -- [View Geoserver](view-geoserver.md) -- [View Mapserver](view-mapserver.md) -- [Download Atom](download-atom.md) -- [Download Geoserver](download-geoserver.md) +- [Tutorial setting up INSPIRE view service with GeoNetwork and GeoServer](view-geoserver.md) +- [Tutorial setting up INSPIRE view service with GeoNetwork and Mapserver](view-mapserver.md) +- [Tutorial setting up an Atom/OpenSearch based INSPIRE download service](download-atom.md) +- [Tutorial setting up a WFS based INSPIRE download service with GeoServer](download-geoserver.md) - [.md](.md) diff --git a/docs/manual/docs/tutorials/introduction/deployment/index.md b/docs/manual/docs/tutorials/introduction/deployment/index.md index f98b86c1911..2dc34d2afed 100644 --- a/docs/manual/docs/tutorials/introduction/deployment/index.md +++ b/docs/manual/docs/tutorials/introduction/deployment/index.md @@ -8,5 +8,5 @@ For this workshop we will focus on the use of docker, but we also provide some g - [Docker](docker.md) - [Deploy](deploy.md) -- [Build](build.md) +- [Build from source code](build.md) - [.md](.md) diff --git a/docs/manual/docs/tutorials/introduction/edit/index.md b/docs/manual/docs/tutorials/introduction/edit/index.md index f6b8a7af51f..a7f0588b5c6 100644 --- a/docs/manual/docs/tutorials/introduction/edit/index.md +++ b/docs/manual/docs/tutorials/introduction/edit/index.md @@ -3,4 +3,4 @@ On this step we will learn how to edit metadata and configure the editor. - [Edit](edit.md) -- [Editor](editor.md) +- [Customize Editor (Optional)](editor.md) diff --git a/docs/manual/docs/tutorials/introduction/index.md b/docs/manual/docs/tutorials/introduction/index.md index c894cb9c1a8..7f0be2fb2b5 100644 --- a/docs/manual/docs/tutorials/introduction/index.md +++ b/docs/manual/docs/tutorials/introduction/index.md @@ -18,12 +18,12 @@ At various points references are made to the product documentation to find more ## Tutorial contents -- [Introduction](introduction/index.md) -- [Introduction Discover](introduction/discover.md) -- [Introduction Map](introduction/map.md) -- [Introduction Schema](introduction/schema.md) +- [Metadata in the spatial domain](introduction/index.md) +- [Discovering information](introduction/discover.md) +- [Maps and dataset visualisation](introduction/map.md) +- [Standardised exchange of records](introduction/schema.md) - [Deployment.](deployment/index..md) - [Setup](setup/index.md) -- [Edit](edit/index.md) +- [Editing Metadata](edit/index.md) - [Harvesting](harvesting/index.md) - [Extra](extra/index.md) diff --git a/docs/manual/docs/user-guide/analyzing/index.md b/docs/manual/docs/user-guide/analyzing/index.md index cc0f9ad1415..b89f398e3f1 100644 --- a/docs/manual/docs/user-guide/analyzing/index.md +++ b/docs/manual/docs/user-guide/analyzing/index.md @@ -1,4 +1,4 @@ # Analyzing data {#analyzing} -- [Metadata](metadata.md) -- [Data](data.md) +- [Statistics on catalog content](metadata.md) +- [Analyze and visualize data](data.md) diff --git a/docs/manual/docs/user-guide/associating-resources/index.md b/docs/manual/docs/user-guide/associating-resources/index.md index cae24ced620..fa4296170b7 100644 --- a/docs/manual/docs/user-guide/associating-resources/index.md +++ b/docs/manual/docs/user-guide/associating-resources/index.md @@ -14,7 +14,7 @@ Use the wizard panel to create or delete associated resources. A list of current You can associate different types of resources: -- [Linking Documents](linking-documents.md) -- [Linking Records](linking-records.md) -- [Doi](doi.md) -- [Cite](cite.md) +- [Associating documents](linking-documents.md) +- [Associating another record](linking-records.md) +- [Digital Object Identifier (DOI)](doi.md) +- [Cite a resource](cite.md) diff --git a/docs/manual/docs/user-guide/associating-resources/linking-documents.md b/docs/manual/docs/user-guide/associating-resources/linking-documents.md index 5b48726379c..10bbacece64 100644 --- a/docs/manual/docs/user-guide/associating-resources/linking-documents.md +++ b/docs/manual/docs/user-guide/associating-resources/linking-documents.md @@ -4,6 +4,6 @@ You can associate a record with documents using a URL. A document could be an overview, a quality report, a website available in different formats (eg. png, jpg, pdf, html) on the web. -- [Using Filestore](using-filestore.md) -- [Linking Thumbnail](linking-thumbnail.md) -- [Linking Online Resources](linking-online-resources.md) +- [Uploading attachments](using-filestore.md) +- [Illustrating with an overview](linking-thumbnail.md) +- [Linking website, web services, \... using URL](linking-online-resources.md) diff --git a/docs/manual/docs/user-guide/associating-resources/linking-records.md b/docs/manual/docs/user-guide/associating-resources/linking-records.md index 714d9b2d88c..87d4988035f 100644 --- a/docs/manual/docs/user-guide/associating-resources/linking-records.md +++ b/docs/manual/docs/user-guide/associating-resources/linking-records.md @@ -1,8 +1,8 @@ # Associating another record {#associating_resources_record} -- [Linking Parent](linking-parent.md) -- [Linking Source](linking-source.md) -- [Linking Dataset Or Service](linking-dataset-or-service.md) -- [Linking Feature Catalog](linking-feature-catalog.md) -- [Linking Others](linking-others.md) -- [Linking Remote Records](linking-remote-records.md) +- [Grouping datasets in a series (ie. parent/child relation)](linking-parent.md) +- [Referencing sources of a dataset](linking-source.md) +- [Linking a dataset with a service](linking-dataset-or-service.md) +- [Describing attributes table in a feature Catalog](linking-feature-catalog.md) +- [Other types of resources (eg. sensor, publication)](linking-others.md) +- [Linking to a remote record](linking-remote-records.md) diff --git a/docs/manual/docs/user-guide/describing-information/index.md b/docs/manual/docs/user-guide/describing-information/index.md index bd7d10274a1..b3da73798fe 100644 --- a/docs/manual/docs/user-guide/describing-information/index.md +++ b/docs/manual/docs/user-guide/describing-information/index.md @@ -19,12 +19,12 @@ The editor form provides uploading of data, graphics, documents, pdf files and a Add links to corresponding section -- [Managing Templates](managing-templates.md) -- [Creating Metadata](creating-metadata.md) -- [Importing Metadata](importing-metadata.md) -- [Editing Metadata](editing-metadata.md) -- [Deleting Metadata](deleting-metadata.md) -- [Multilingual Editing](multilingual-editing.md) -- [Inspire Editing](inspire-editing.md) +- [Managing templates](managing-templates.md) +- [Creating a new record](creating-metadata.md) +- [Importing a new record](importing-metadata.md) +- [Editing metadata](editing-metadata.md) +- [Deleting a record](deleting-metadata.md) +- [Multilingual editing](multilingual-editing.md) +- [Describing resources for the INSPIRE directive](inspire-editing.md) Based on user profiles (see [creating-user](creating-user.md)), a dashboard provides easy access to their informations and tasks. diff --git a/docs/manual/docs/user-guide/harvesting/index.md b/docs/manual/docs/user-guide/harvesting/index.md index 410acad8260..61420dcc96b 100644 --- a/docs/manual/docs/user-guide/harvesting/index.md +++ b/docs/manual/docs/user-guide/harvesting/index.md @@ -7,17 +7,17 @@ Harvesting is the process of ingesting metadata from remote sources and storing The following sources can be harvested: - [Harvesting Geonetwork](harvesting-geonetwork.md) -- [Harvesting Csw](harvesting-csw.md) -- [Harvesting Ogcwxs](harvesting-ogcwxs.md) -- [Harvesting Simpleurl](harvesting-simpleurl.md) -- [Harvesting Filesystem](harvesting-filesystem.md) -- [Harvesting Webdav](harvesting-webdav.md) -- [Harvesting Oaipmh](harvesting-oaipmh.md) -- [Harvesting Sde](harvesting-sde.md) -- [Harvesting Geoportal](harvesting-geoportal.md) -- [Harvesting Thredds](harvesting-thredds.md) -- [Harvesting Wfs Features](harvesting-wfs-features.md) -- [Harvesting Z3950](harvesting-z3950.md) +- [Harvesting CSW services](harvesting-csw.md) +- [Harvesting OGC Services](harvesting-ogcwxs.md) +- [Simple URL harvesting (opendata)](harvesting-simpleurl.md) +- [Local File System Harvesting](harvesting-filesystem.md) +- [WEBDAV Harvesting](harvesting-webdav.md) +- [OAIPMH Harvesting](harvesting-oaipmh.md) +- [Harvesting an ARCSDE Node](harvesting-sde.md) +- [GeoPortal REST Harvesting](harvesting-geoportal.md) +- [THREDDS Harvesting](harvesting-thredds.md) +- [WFS GetFeature Harvesting](harvesting-wfs-features.md) +- [Z3950 Harvesting](harvesting-z3950.md) ## Mechanism overview diff --git a/docs/manual/docs/user-guide/index.md b/docs/manual/docs/user-guide/index.md index e9ffdc4762d..c70f83f0263 100644 --- a/docs/manual/docs/user-guide/index.md +++ b/docs/manual/docs/user-guide/index.md @@ -2,13 +2,13 @@ Operational user-guide describing the editing, review and management of records. -- [Quick Start](quick-start/index.md) -- [Map](map/index.md) -- [Describing Information](describing-information/index.md) -- [Associating Resources](associating-resources/index.md) -- [Tag Information](tag-information/index.md) +- [Quick start](quick-start/index.md) +- [Maps and dataset visualisation](map/index.md) +- [Describing information](describing-information/index.md) +- [Associating resources](associating-resources/index.md) +- [Classify information](tag-information/index.md) - [Publishing](publishing/index.md) -- [Analyzing](analyzing/index.md) +- [Analyzing data](analyzing/index.md) - [Workflow](workflow/index.md) - [Harvesting](harvesting/index.md) -- [Export](export/index.md) +- [Exporting records](export/index.md) diff --git a/docs/manual/docs/user-guide/publishing/index.md b/docs/manual/docs/user-guide/publishing/index.md index 7840274edf3..a6f82f57405 100644 --- a/docs/manual/docs/user-guide/publishing/index.md +++ b/docs/manual/docs/user-guide/publishing/index.md @@ -1,5 +1,5 @@ # Publishing -- [Managing Privileges](managing-privileges.md) -- [Restricting Information To Metadata Sections](restricting-information-to-metadata-sections.md) -- [Transferring Privileges](transferring-privileges.md) +- [Managing privileges](managing-privileges.md) +- [Restricting information to metadata sections](restricting-information-to-metadata-sections.md) +- [Transferring privileges](transferring-privileges.md) diff --git a/docs/manual/docs/user-guide/tag-information/index.md b/docs/manual/docs/user-guide/tag-information/index.md index d3fb921d0a8..f1d6809d6e0 100644 --- a/docs/manual/docs/user-guide/tag-information/index.md +++ b/docs/manual/docs/user-guide/tag-information/index.md @@ -1,4 +1,4 @@ # Classify information {#tag-information} -- [Tagging With Categories](tagging-with-categories.md) -- [Tagging With Keywords](tagging-with-keywords.md) +- [Tagging with categories](tagging-with-categories.md) +- [Tagging with keywords](tagging-with-keywords.md) diff --git a/docs/manual/docs/user-guide/workflow/batchupdate.md b/docs/manual/docs/user-guide/workflow/batchupdate.md index 15ecf3f38b0..f09a49bd4b5 100644 --- a/docs/manual/docs/user-guide/workflow/batchupdate.md +++ b/docs/manual/docs/user-guide/workflow/batchupdate.md @@ -2,6 +2,6 @@ In some circumstances, users may want to update a set of records. The catalog provides 2 options for that: -- [Batchediting](batchediting.md) -- [Batchupdate From Admin](batchupdate-from-admin.md) -- [Batchupdate Xsl](batchupdate-xsl.md) +- [Updating a set of records](batchediting.md) +- [Updating a set of records from the admin console](batchupdate-from-admin.md) +- [Updating a set of records using XSLT](batchupdate-xsl.md) diff --git a/docs/manual/docs/user-guide/workflow/index.md b/docs/manual/docs/user-guide/workflow/index.md index 4dd1f85837e..451c2b9280a 100644 --- a/docs/manual/docs/user-guide/workflow/index.md +++ b/docs/manual/docs/user-guide/workflow/index.md @@ -1,8 +1,8 @@ # Workflow -- [Validation](validation.md) -- [Suggestion](suggestion.md) -- [Life Cycle](life-cycle.md) -- [Geopublication](geopublication.md) +- [Validating records](validation.md) +- [Suggestion for improving metadata content](suggestion.md) +- [Life cycle](life-cycle.md) +- [Publishing GIS data in a map server](geopublication.md) - [Versioning](versioning.md) -- [Batchupdate](batchupdate.md) +- [Updating a set of records](batchupdate.md) diff --git a/docs/manual/translate/cli.py b/docs/manual/translate/cli.py index 6ae381ae4ca..03fdbf96588 100644 --- a/docs/manual/translate/cli.py +++ b/docs/manual/translate/cli.py @@ -118,20 +118,20 @@ def index( anchor_file.write(index) print(anchor_path) -@app.command() -def fix_references( - anchor_txt: str, md_path: Annotated[List[str], typer.Argument(help="path to md file(s)")] - ): - """ - Using an anchor.txt file of reference=path#anchor to translate [reference](reference) links - left over from conversion from rst. - """ - init_anchors() - - for md_file in collect_paths(md_path,'md'): - count = fix_anchors(md_file) - print(md_file,"fixed",count) - print() +# @app.command() +# def fix_references( +# anchor_txt: str, md_path: Annotated[List[str], typer.Argument(help="path to md file(s)")] +# ): +# """ +# Using an anchor.txt file of reference=path#anchor to translate [reference](reference) links +# left over from conversion from rst. +# """ +# init_anchors() +# +# for md_file in collect_paths(md_path,'md'): +# count = fix_anchors(md_file) +# print(md_file,"fixed",count) +# print() @app.command() def rst( @@ -146,6 +146,8 @@ def rst( Manual cleanup required for: figure """ + init_anchors() + if not rst_path: rst_glob = translate.translate.rst_folder+"/**/*.rst" rst_path = [rst_glob] diff --git a/docs/manual/translate/translate.py b/docs/manual/translate/translate.py index 75c64085f8c..3a90042e333 100644 --- a/docs/manual/translate/translate.py +++ b/docs/manual/translate/translate.py @@ -101,19 +101,23 @@ def load_anchors(anchor_txt:str) -> dict[str,str]: reference=/absolut/path/to/file.md#anchor """ if not os.path.exists(anchor_txt): + logger.warning("Anchors definition file not avaialble - to creae run: python3 -m translate index") raise FileNotFoundError(errno.ENOENT, f"anchors definition file does not exist at location:", anchor_txt) + index = {} with open(anchor_txt,'r') as file: for line in file: if '=' in line: (anchor,path) = line.split('=') - index[anchor] = path + index[anchor] = path[0:-1] - return anchors + return index def init_anchors(): global anchors + global anchor_file anchors = load_anchors(anchor_file) + logging.debug("anchors loaded:"+str(len(anchors))) def collect_path(path: str, extension: str) -> list[str]: """ @@ -310,7 +314,7 @@ def convert_rst(rst_file: str) -> str: convert_directory = os.path.dirname(md_tmp_file) if not os.path.exists(convert_directory): - print("Conversion directory:",convert_directory) + logger.info("Creating conversion directory '"+convert_directory+"'") os.makedirs(convert_directory) rst_prep = re.sub(r"\.md",r".prep.rst", md_tmp_file) @@ -349,7 +353,7 @@ def preprocess_rst(rst_file:str, rst_prep: str) -> str: # process toc_tree directive into a list of links if '.. toctree::' in text: - text = _preprocess_rst_toctree(text) + text = _preprocess_rst_toctree(rst_file,text) if ':doc:' in text: text = _preprocess_rst_doc(text) @@ -411,6 +415,9 @@ def _preprocess_rst_doc(text: str) -> str: """ Preprocess rst content replacing doc references with links. """ + global anchors + + # doc links processed in order from most to least complicated # :doc:`normal <../folder/index.rst>` @@ -470,7 +477,7 @@ def _preprocess_rst_ref(text: str) -> str: ) return text -def _preprocess_rst_toctree(text: str) -> str: +def _preprocess_rst_toctree(path, text: str) -> str: """ scan document for toctree directives to process """ @@ -490,8 +497,7 @@ def _preprocess_rst_toctree(text: str) -> str: if line[0:3] == ' ': # processing directive link = line[3:-4] - label = _labelify(link) - + label = _labelify(path,link) toctree += f"* `{label} <{link}.md>`__\n" else: # end directive @@ -507,19 +513,43 @@ def _preprocess_rst_toctree(text: str) -> str: return process -def _labelify(link: str) -> str: +def _labelify(path: str, link: str) -> str: """ - Create a label basde on a link + Create a label title, based on a documentation link. + Will make use of anchors index if available to look up correct title. """ - label = link.replace('.rst','') - label = label.replace('.md','') - label = label.replace('/index', '') - label = label.replace('-', ' ') - label = label.replace('_', ' ') - label = label.replace('/', ' ') - label = label.title() - - return label + resolved_path = _linkify(path,link) + # example: + # /install-guide/loading-samples.rst=/install-guide/loading-samples.rst + # /install-guide/loading-samples.rst.text=Loading templates and sample data + title_key = resolved_path+'.rst.text' + if title_key in anchors: + return anchors[title_key] + else: + label = link.replace('.rst','') + label = label.replace('.md','') + label = label.replace('/index', '') + label = label.replace('-', ' ') + label = label.replace('_', ' ') + label = label.replace('/', ' ') + label = label.title() + + return label + +def _linkify(path: str, link: str) -> str: + """ + Determines absolute path for link, relative to provided path. + :param path: path of file containing the link + :param link: the link (may be absolute or relative) + :return: absolute link + """ + if link.startswith("/"): + return link + else: + dir = os.path.dirname(path) + link_path = os.path.join(dir, link) + doc_path = os.path.relpath(link_path, docs_folder) + return '/'+doc_path def postprocess_rst_markdown(md_file: str, md_clean: str): """