From 65839cfc647747796b460b5f5d90d26c0ad2bab4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20N=C3=BCst?= <daniel.nuest@tu-dresden.de> Date: Mon, 31 Jul 2023 11:17:14 +0200 Subject: [PATCH] update README --- .gitignore | 2 ++ README.md | 16 ++++++++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5e3e242 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ + +.pytest_cache/ diff --git a/README.md b/README.md index bdea239..347793d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,27 @@ [![OPTIMETA Logo](https://projects.tib.eu/fileadmin/_processed_/e/8/csm_Optimeta_Logo_web_98c26141b1.png)](https://projects.tib.eu/optimeta/en/) -# OPTIMETA geo plugin theme +# OPTIMETA Geo Plugin Theme [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) -OJS child theme for extending OJS's default theme with views of the geospatial metadata for the OPTIMETA Geoplugin, <https://github.com/TIBHannover/optimetaGeo>. +OJS child theme for extending OJS's default theme with views of the geospatial metadata for the OPTIMETA Geo Plugin, <https://github.com/TIBHannover/optimetaGeo>. Based on <https://github.com/NateWr/defaultChild>. **Issues are managed on the mein repository at TIBHannover/optimetaGeo.** +## Features + +- Add spatial and temporal metadata (timeline & map) to **issue pages** + + The theme adds a wrapper that is filled from the plugin. + +- Add a button in the **main menu for the journal-wide map** + ## Making your theme compatible -This theme is a child theme overriding seleted components of the OJS frontend that need to be extended for the OPTIMETE Geoplugin. -If your plugin overrides the same components, then the geoplugin might not behave correctly. +This theme is a child theme overriding seleted components of the OJS frontend that need to be extended for the OPTIMETA Geo Plugin. +If your plugin overrides the same components, then the OPTIMETA Geo Plugin might not behave correctly. Therefore, please open an issue with the label `theme` by [clicking this link](https://github.com/TIBHannover/optimetaGeo/issues/new?labels=theme) if you want to add support for your template - we will help you! ### Currently supported themes