lizmap / lizmap-pgmetadata-module
Jelix module for Lizmap, which adds tools to show layers metadata created with PgMetadata
Fund package maintenance!
www.3liz.com/en/contacts.html
Installs: 30
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 7
Forks: 4
Open Issues: 6
Type:jelix-module
README
This module is designed for Lizmap Web Client, and allows displaying PostgreSQL layers metadata stored in the layer database.
The metadata must be created in the PostgreSQL database as designed in the PgMetadata QGIS plugin.
Installation
Once Lizmap Web Client application is installed and working, you can install the pgmetadata module:
Since version 0.2.4, it is recommended to install the module with Composer, the package manager for PHP. If you can't use it or if you are using Lizmap 3.3 or lower, use the manual way to install the module (jump to the corresponding section below)
Automatic installation with Composer and lizmap 3.4 or higher
- into
lizmap/my-packages
, create the filecomposer.json
(if it doesn't exist) by copying the filecomposer.json.dist
, and install the modules with Composer:
cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json
composer require --working-dir=lizmap/my-packages "lizmap/lizmap-pgmetadata-module"
- Then execute Lizmap install scripts into
lizmap/install/
:
php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh
Go to the next section "Publish your metadata as a DCAT catalog".
Manual installation into lizmap 3.3 or 3.4 without Composer
- Get the last ZIP archive in the release page of the GitHub repository.
- Extract the archive and copy the
pgmetadata
directory in Lizmap Web Client folderlizmap/lizmap-modules/
- Edit the config file
lizmap/var/config/localconfig.ini.php
and add into the section[modules]
:
pgmetadata.access=2
- Then execute Lizmap install scripts into
lizmap/install/
:
php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh
Publish your metadata as a DCAT catalog
If you need to publish your metadata catalog as an RDF catalog, for example to be harvested by a third-party
metadata platform such as Ckan, you need to declare in the file lizmap/var/config/profiles.ini.php
a new
section [jdb:pgmetadata]
with the needed credentials to your PostgreSQL database hosting the metadata. For
example:
[jdb:pgmetadata] driver=pgsql database=pgmetadata host=localhost port=5432 user=your_user password=your_password persistent=off ;search_path=""
Then, you would be able to access the following URLs
- The full RDF catalog with a URL like: https://[YOUR_LIZMAP_URL]/index.php/pgmetadata/dcat/
- One dataset record by UUID identifier with: https://[YOUR_LIZMAP_URL]/index.php/pgmetadata/dcat/?id=76853e57-387e-4b8d-9ee8-f176e11cd9ce
- Filter datasets containing a specified keyword (exact match): https://[YOUR_LIZMAP_URL]/index.php/pgmetadata/dcat/?q=akeyword
The XML created and returned would be like:
<?xml version="1.0" encoding="UTF-8"?> <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:dct="http://purl.org/dc/terms/" xmlns:dcat="http://www.w3.org/ns/dcat#" xmlns:owl="http://www.w3.org/2002/07/owl#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:adms="http://www.w3.org/ns/adms#" xmlns:vcard="http://www.w3.org/2006/vcard/ns#" xmlns:schema="http://schema.org/" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"> <dcat:Catalog rdf:about="https://lizmap.com"> <dct:description>PgMetadata DCAT RDF catalog</dct:description> <dct:language>fr</dct:language> <dct:title>PgMetadata</dct:title> <dcat:dataset> <dcat:Dataset rdf:about="http://lizmap.localhost/index.php/pgmetadata/dcat/?id=76853e57-387e-4b8d-9ee8-f176e11cd9ce"> <dct:identifier>76853e57-387e-4b8d-9ee8-f176e11cd9ce</dct:identifier> <dct:title>Test title</dct:title> <dct:description>Test abstract.</dct:description> <dct:language>en</dct:language> <dct:license>Licence Ouverte Version 2.1</dct:license> <dct:rights>Open</dct:rights> <dct:accrualPeriodicity>Yearly</dct:accrualPeriodicity> <dct:spatial>{"type":"Polygon","coordinates":[[[3.854,43.5786],[3.854,43.622],[3.897,43.622],[3.897,43.5786],[3.854,43.5786]]]}</dct:spatial> <dct:created rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">2020-12-31T09:16:16.980258</dct:created> <dct:issued rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">2020-12-31T09:16:16.980258</dct:issued> <dct:modified rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">2020-12-31T09:16:16.980258</dct:modified> <dcat:contactPoint> <vcard:Organization> <vcard:fn>Jane Doe - Acme (GIS)</vcard:fn> <vcard:hasEmail rdf:resource="jane.doe@acme.gis">jane.doe@acme.gis</vcard:hasEmail> </vcard:Organization> </dcat:contactPoint> <dct:creator> <foaf:Organization> <foaf:name>Jane Doe - Acme (GIS)</foaf:name> <foaf:mbox>jane.doe@acme.gis</foaf:mbox> </foaf:Organization> </dct:creator> <dct:publisher> <foaf:Organization> <foaf:name>Bob Robert - Corp (Spatial div)</foaf:name> <foaf:mbox>bob.bob@corp.spa</foaf:mbox> </foaf:Organization> </dct:publisher> <dcat:distribution> <dcat:Distribution> <dct:title>test link</dct:title> <dct:description>Link description</dct:description> <dcat:downloadURL>https://metadata.is.good</dcat:downloadURL> <dcat:mediaType>application/pdf</dcat:mediaType> <dct:format>a file</dct:format> <dct:bytesize>590</dct:bytesize> </dcat:Distribution> </dcat:distribution> <dcat:keyword>tag_one</dcat:keyword> <dcat:keyword>tag_two</dcat:keyword> <dcat:theme>test theme</dcat:theme> <dcat:theme>New test theme</dcat:theme> </dcat:Dataset> </dcat:dataset> </dcat:Catalog> </rdf:RDF>
Contribution guide
For PHP, the project is using PHP-CS-Fixer.
For JavaScript, it's using ESLint. Install it using npm install
.
There are commands in the Makefile to run them.
Getting help
- Send an email to the Lizmap mailing list at https://lists.osgeo.org/pipermail/lizmap/
- Join us on IRC , #lizmap on https://libera.chat
- Open a Github tickets on https://github.com/3liz/lizmap-adresse-module/issues
- Commercial support through 3liz , Contact Us