{"id":26150375,"url":"https://github.com/3liz/lizmap-pgmetadata-module","last_synced_at":"2025-03-11T05:59:18.641Z","repository":{"id":44576021,"uuid":"309321871","full_name":"3liz/lizmap-pgmetadata-module","owner":"3liz","description":"PgMetadata Lizmap module","archived":false,"fork":false,"pushed_at":"2024-09-18T09:37:24.000Z","size":415,"stargazers_count":0,"open_issues_count":6,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-01-09T08:24:24.173Z","etag":null,"topics":["lizmap","lizmap-module","metadata","qgis"],"latest_commit_sha":null,"homepage":"https://github.com/3liz/qgis-pgmetadata-plugin","language":"PLpgSQL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3liz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-02T09:35:30.000Z","updated_at":"2024-09-18T09:37:28.000Z","dependencies_parsed_at":"2024-01-27T05:09:43.731Z","dependency_job_id":"4dadb6ba-8ef6-4ec7-8ed2-107c5498e1c5","html_url":"https://github.com/3liz/lizmap-pgmetadata-module","commit_stats":{"total_commits":102,"total_committers":7,"mean_commits":"14.571428571428571","dds":0.6568627450980392,"last_synced_commit":"baa1700fa799c39255d50c88ae7a9ceeeab968d8"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-pgmetadata-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-pgmetadata-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-pgmetadata-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-pgmetadata-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3liz","download_url":"https://codeload.github.com/3liz/lizmap-pgmetadata-module/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242781372,"owners_count":20184154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lizmap","lizmap-module","metadata","qgis"],"created_at":"2025-03-11T05:59:18.075Z","updated_at":"2025-03-11T05:59:18.633Z","avatar_url":"https://github.com/3liz.png","language":"PLpgSQL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PgMetadata Module\n\n[![Lint JS 🎳](https://github.com/3liz/lizmap-pgmetadata-module/actions/workflows/test-lint-js.yml/badge.svg)](https://github.com/3liz/lizmap-pgmetadata-module/actions/workflows/test-lint-js.yml)\n[![Lint PHP 🎳](https://github.com/3liz/lizmap-pgmetadata-module/actions/workflows/test-lint-php.yml/badge.svg)](https://github.com/3liz/lizmap-pgmetadata-module/actions/workflows/test-lint-php.yml)\n[![Release 🚀](https://github.com/3liz/lizmap-pgmetadata-module/actions/workflows/release.yml/badge.svg)](https://github.com/3liz/lizmap-pgmetadata-module/actions/workflows/release.yml)\n[![Packagist](https://img.shields.io/packagist/v/lizmap/lizmap-pgmetadata-module)](https://packagist.org/packages/lizmap/lizmap-pgmetadata-module)\n\nThis module is designed for [Lizmap Web Client](https://github.com/3liz/lizmap-web-client/), and allows \ndisplaying PostgreSQL layers metadata stored in the layer database.\n\nThe metadata must be created in the PostgreSQL database as designed in the\n[PgMetadata QGIS plugin](https://github.com/3liz/qgis-pgmetadata-plugin).\n\n![Metadata information panel](metadata_information_panel.jpeg)\n\n## Installation\n\nOnce Lizmap Web Client application is installed and working, you can install the pgmetadata module:\n\nSince version 0.2.4, it is recommended to install the module\nwith [Composer](https://getcomposer.org), the package manager for PHP.\nIf you can't use it or if you are using Lizmap 3.3 or lower, use the manual way to\ninstall the module (jump to the corresponding section below)\n\n### Automatic installation with Composer and lizmap 3.4 or higher\n\n* into `lizmap/my-packages`, create the file `composer.json` (if it doesn't exist)\n  by copying the file `composer.json.dist`, and install the modules with Composer:\n\n```bash\ncp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json\ncomposer require --working-dir=lizmap/my-packages \"lizmap/lizmap-pgmetadata-module\"\n```\n\n* Then go into `lizmap/install/` and execute Lizmap install scripts :\n\n\nIf you are using Lizmap 3.6 or higher, first execute \n\n```bash\nphp configurator.php pgmetadata\nphp configurator.php pgmetadataAdmin\n```\n\nThen, for Lizmap 3.4 and higher:\n\n```bash\nphp installer.php\n./clean_vartmp.sh\n./set_rights.sh\n```\n\nGo to the next section \"Publish your metadata as a DCAT catalog\".\n\n### Manual installation into lizmap 3.3 or 3.4 without Composer\n\n* Get the last ZIP archive in the [release page](https://github.com/3liz/lizmap-pgmetadata-module/releases) of\n  the GitHub repository.\n* Extract the archive and copy the `pgmetadata` and `pgmetadataAdmin` directories in Lizmap Web Client folder `lizmap/lizmap-modules/`\n* Edit the config file `lizmap/var/config/localconfig.ini.php` and add into \n  the section `[modules]`:\n\n```ini\npgmetadata.access=2\npgmetadataAdmin.access=2\n```\n* Add into the section `[simple_urlengine_entrypoints]`:\n```ini\nadmin=\"jacl2db~*@classic,jacl2db_admin~*@classic,jauthdb_admin~*@classic,master_admin~*@classic,admin~*@classic,jcommunity~*@classic,pgmetadataAdmin~*@classic\"\n```\nIf the parameter already exists, add `,pgmetadataAdmin~*@classic` into the value.\n\n* If you are using Lizmap 3.6 or higher, execute\n\n```bash\nphp lizmap/install/configurator.php pgmetadata\nphp lizmap/install/configurator.php pgmetadataAdmin\n```\n\n* Then execute Lizmap install scripts into `lizmap/install/` :\n\n```bash\nphp lizmap/install/installer.php\n./lizmap/install/clean_vartmp.sh\n./lizmap/install/set_rights.sh\n```\n\n## Publish your metadata as a DCAT catalog\n\nIf you need to publish your metadata catalog as an RDF catalog, for example to be harvested by a third-party\nmetadata platform such as Ckan, you need to declare the needed credentials to your PostgreSQL database hosting the metadata.\n\nTo do it, go into the administration interface of Lizmap, click on the pgmetadata menu item,\nand you could indicate these credentials.\n\nThen, you would be able to access the following URLs\n\n* **The full RDF catalog** with a URL like: https://[YOUR_LIZMAP_URL]/index.php/pgmetadata/dcat/\n* **One dataset record by UUID** identifier with: https://[YOUR_LIZMAP_URL]/index.php/pgmetadata/dcat/?id=76853e57-387e-4b8d-9ee8-f176e11cd9ce\n* **Filter datasets** containing a specified **keyword** (exact match): https://[YOUR_LIZMAP_URL]/index.php/pgmetadata/dcat/?q=akeyword\n\nThe XML created and returned would be like:\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003crdf:RDF\n    xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n    xmlns:dct=\"http://purl.org/dc/terms/\"\n    xmlns:dcat=\"http://www.w3.org/ns/dcat#\"\n    xmlns:owl=\"http://www.w3.org/2002/07/owl#\"\n    xmlns:foaf=\"http://xmlns.com/foaf/0.1/\"\n    xmlns:adms=\"http://www.w3.org/ns/adms#\"\n    xmlns:vcard=\"http://www.w3.org/2006/vcard/ns#\"\n    xmlns:schema=\"http://schema.org/\"\n    xmlns:rdfs=\"http://www.w3.org/2000/01/rdf-schema#\"\u003e\n\u003cdcat:Catalog rdf:about=\"https://lizmap.com\"\u003e\n    \u003cdct:description\u003ePgMetadata DCAT RDF catalog\u003c/dct:description\u003e\n    \u003cdct:language\u003efr\u003c/dct:language\u003e\n    \u003cdct:title\u003ePgMetadata\u003c/dct:title\u003e\n    \u003cdcat:dataset\u003e\n      \u003cdcat:Dataset rdf:about=\"http://lizmap.localhost/index.php/pgmetadata/dcat/?id=76853e57-387e-4b8d-9ee8-f176e11cd9ce\"\u003e\n        \u003cdct:identifier\u003e76853e57-387e-4b8d-9ee8-f176e11cd9ce\u003c/dct:identifier\u003e\n        \u003cdct:title\u003eTest title\u003c/dct:title\u003e\n        \u003cdct:description\u003eTest abstract.\u003c/dct:description\u003e\n        \u003cdct:language\u003een\u003c/dct:language\u003e\n        \u003cdct:license\u003eLicence Ouverte Version 2.1\u003c/dct:license\u003e\n        \u003cdct:rights\u003eOpen\u003c/dct:rights\u003e\n        \u003cdct:accrualPeriodicity\u003eYearly\u003c/dct:accrualPeriodicity\u003e\n        \u003cdct:spatial\u003e{\"type\":\"Polygon\",\"coordinates\":[[[3.854,43.5786],[3.854,43.622],[3.897,43.622],[3.897,43.5786],[3.854,43.5786]]]}\u003c/dct:spatial\u003e\n        \u003cdct:created rdf:datatype=\"http://www.w3.org/2001/XMLSchema#dateTime\"\u003e2020-12-31T09:16:16.980258\u003c/dct:created\u003e\n        \u003cdct:issued rdf:datatype=\"http://www.w3.org/2001/XMLSchema#dateTime\"\u003e2020-12-31T09:16:16.980258\u003c/dct:issued\u003e\n        \u003cdct:modified rdf:datatype=\"http://www.w3.org/2001/XMLSchema#dateTime\"\u003e2020-12-31T09:16:16.980258\u003c/dct:modified\u003e\n        \u003cdcat:contactPoint\u003e\n          \u003cvcard:Organization\u003e\n            \u003cvcard:fn\u003eJane Doe - Acme (GIS)\u003c/vcard:fn\u003e\n            \u003cvcard:hasEmail rdf:resource=\"jane.doe@acme.gis\"\u003ejane.doe@acme.gis\u003c/vcard:hasEmail\u003e\n          \u003c/vcard:Organization\u003e\n        \u003c/dcat:contactPoint\u003e\n        \u003cdct:creator\u003e\n          \u003cfoaf:Organization\u003e\n            \u003cfoaf:name\u003eJane Doe - Acme (GIS)\u003c/foaf:name\u003e\n            \u003cfoaf:mbox\u003ejane.doe@acme.gis\u003c/foaf:mbox\u003e\n          \u003c/foaf:Organization\u003e\n        \u003c/dct:creator\u003e\n        \u003cdct:publisher\u003e\n          \u003cfoaf:Organization\u003e\n            \u003cfoaf:name\u003eBob Robert - Corp (Spatial div)\u003c/foaf:name\u003e\n            \u003cfoaf:mbox\u003ebob.bob@corp.spa\u003c/foaf:mbox\u003e\n          \u003c/foaf:Organization\u003e\n        \u003c/dct:publisher\u003e\n        \u003cdcat:distribution\u003e\n          \u003cdcat:Distribution\u003e\n            \u003cdct:title\u003etest link\u003c/dct:title\u003e\n            \u003cdct:description\u003eLink description\u003c/dct:description\u003e\n            \u003cdcat:downloadURL\u003ehttps://metadata.is.good\u003c/dcat:downloadURL\u003e\n            \u003cdcat:mediaType\u003eapplication/pdf\u003c/dcat:mediaType\u003e\n            \u003cdct:format\u003ea file\u003c/dct:format\u003e\n            \u003cdct:bytesize\u003e590\u003c/dct:bytesize\u003e\n          \u003c/dcat:Distribution\u003e\n        \u003c/dcat:distribution\u003e\n        \u003cdcat:keyword\u003etag_one\u003c/dcat:keyword\u003e\n        \u003cdcat:keyword\u003etag_two\u003c/dcat:keyword\u003e\n        \u003cdcat:theme\u003etest theme\u003c/dcat:theme\u003e\n        \u003cdcat:theme\u003eNew test theme\u003c/dcat:theme\u003e\n      \u003c/dcat:Dataset\u003e\n    \u003c/dcat:dataset\u003e\n\u003c/dcat:Catalog\u003e\n\u003c/rdf:RDF\u003e\n```\n\n## Contribution guide\n\nFor PHP, the project is using PHP-CS-Fixer.\nFor JavaScript, it's using ESLint. Install it using `npm install`.\n\nThere are commands in the Makefile to run them.\n\n\n## Getting help\n* Send an email to the Lizmap mailing list at https://lists.osgeo.org/pipermail/lizmap/\n* Join us on IRC , #lizmap on https://libera.chat\n* Open a Github tickets on https://github.com/3liz/lizmap-adresse-module/issues\n* Commercial support through 3liz , [Contact Us](mailto:info@3liz.com?subject=CommercialSupportRequest)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3liz%2Flizmap-pgmetadata-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3liz%2Flizmap-pgmetadata-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3liz%2Flizmap-pgmetadata-module/lists"}