From 1f6c03fc3f9b2837378d25dcc905d8d510ad9cac Mon Sep 17 00:00:00 2001
From: Denis Anikiev <anikiev@gfz-potsdam.de>
Date: Wed, 31 Jan 2024 15:55:33 +0100
Subject: [PATCH] Links to data protection and imprint, updates
---
.gitignore | 1 +
CHANGELOG.md | 9 +++++
docs/.pages | 4 ++
docs/assets/stylesheets/extra.css | 6 +++
docs/index.md | 6 ++-
docs/introduction.md | 65 -------------------------------
docs/theme/main.html | 6 ++-
mkdocs.yml | 6 ++-
8 files changed, 34 insertions(+), 69 deletions(-)
delete mode 100644 docs/introduction.md
diff --git a/.gitignore b/.gitignore
index a48cf0d..976c5c0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
public
+*.md_
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4730ac3..2e3b6d2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,10 +5,19 @@ All notable changes to this project will be documented in this file.
This project adheres to simple calendar versioning.
## 2024-01-31
+### Added
+- Announcement with an option to dismiss
+- Links to data protection and imprint from the main website
+
### Changed
+- Updated to mkdocs-material 9.5.6 (python 3.12)
- Adjusted emoji plugin settings
- Replaced buttons with grids
- Updated image to `python:3.12-bookworm`
+- update gitignore to avoid *.md_ files
+
+### Removed
+- introduction
## 2023-10-26
### Added
diff --git a/docs/.pages b/docs/.pages
index 88cc23a..4a8c541 100644
--- a/docs/.pages
+++ b/docs/.pages
@@ -3,3 +3,7 @@ nav:
# - introduction.md
- tutorial
# - workflows.md
+# - privacy.md
+# - terms.md
+ - Data protection: "https://igmas.git-pages.gfz-potsdam.de/igmas-pages/privacy"
+ - Imprint: "https://igmas.git-pages.gfz-potsdam.de/igmas-pages/terms"
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
index f2d7534..2f4ce7b 100644
--- a/docs/assets/stylesheets/extra.css
+++ b/docs/assets/stylesheets/extra.css
@@ -17,6 +17,12 @@ th, td {
display: table
}
+/* Adjust the content area width to take the full space */
+.md-grid {
+ max-width: initial;
+ /* max-width: 1440px; */
+ }
+
/* .md-typeset__table table:not([class]) td, */
.md-typeset__table table:not([class]) th {
background-color: var(--md-primary-fg-color);
diff --git a/docs/index.md b/docs/index.md
index 9ff1e04..a36cc1c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -57,7 +57,7 @@ The former IGMAS+ User Manual is available [here](https://igmas.git-pages.gfz-po
This quick tutorial will show you how to install and run **IGMAS+** on different platforms
- [:octicons-arrow-right-24: Getting started]([#](https://igmas.git-pages.gfz-potsdam.de/igmas-pages/documentation/#getting-started))
+ [:octicons-arrow-right-24: Getting started](https://igmas.git-pages.gfz-potsdam.de/igmas-pages/documentation/#getting-started))
- :fontawesome-solid-circle-info:{ .lg .middle } __About IGMAS+__
@@ -77,4 +77,6 @@ The former IGMAS+ User Manual is available [here](https://igmas.git-pages.gfz-po
</div>
-
+<figure markdown>
+[{width="1400"}](https://www.gfz-potsdam.de)[{width="1400"}](https://www.gfz-potsdam.de)
+</figure>
\ No newline at end of file
diff --git a/docs/introduction.md b/docs/introduction.md
deleted file mode 100644
index fa176e5..0000000
--- a/docs/introduction.md
+++ /dev/null
@@ -1,65 +0,0 @@
-???+ quote
- You can’t blame gravity for falling in love
- ― *Albert Einstein*
-
-## Historical overview
-
-The software has been around [for about 40 years](https://igmas.git-pages.gfz-potsdam.de/igmas-pages/about/#history), initially developed on a mainframe and then transferred to the first DOS PCs, before it was adapted to Linux in the ’90s and finally implemented as a cross-platform Java application with GUI called **IGMAS+**.
-Starting from 2009, a consortium of national and international oil companies and the Norwegian Geological Survey (NGU) supported the software development.
-The Gravity research Group at the University of Kiel was coordinating the project and giving scientific input while the software company Transinsight (Dresden) delivered the professional programming resources and support.
-
-Java was chosen to be the programming platform to allow platform independency.
-The software has proven to be very fast, accurate and easy to use once a model has been established.
-Later, the DGMK (German Society for Petroleum and Coal Science and Technology) funded its research project number 771 entitled “TiPOT3D - Towards an integrative interpretation of potential fields and corresponding gradients by the aid of three-dimensional modelling and visualization” ([Schmidt, Götze and Menzel, 2018](https://igmas.git-pages.gfz-potsdam.de/igmas-pages/publication/schmidt-2018)) and supported the software development on behalf of DEA, Deutsche Erdoel AG (Hamburg), EMPG (Hannover), ENGIE E&P Deutschland (Lingen) and Wintershall Holding GmbH (Kassel).
-
-Since 2019 **IGMAS+** is maintained and developed in [the Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences](https://www.gfz-potsdam.de) by the staff of [Section 4.5 – Basin Modelling](https://www.gfz-potsdam.de/en/section/basin-modeling/overview/) and [ID2 – eScience Centre](https://www.gfz-potsdam.de/en/centre/escience-centre/overview/).
-GFZ headquarters are in the ”Albert Einstein” Science Park on Telegrafenberg in Potsdam, Germany.
-
-<!-- Dark/light legal header -->
-<!-- <figure markdown> -->
-[](https://www.gfz-potsdam.de)[](https://www.gfz-potsdam.de)
-<!-- </figure> -->
-
-## Main features
-
-### Interactivity
-
-Graphical interface in **IGMAS+** allows adjusting the geometries and physical properties of modelled subsurface bodies interactively, i.e. while the corresponding calculated and measured potential field components are visualized together with independent observations.
-
-### Platform independency
-
-**IGMAS+** is based on :fontawesome-brands-java: Java programming language which makes it platform independent.
-
-<figure markdown>
- [{ width="100" }](https://www.java.com)
-</figure>
-
-### Time machine
-
-In interactive modeling you have many data, which evolve over time, like model structure, physical properties, current gravity/magnetic response of the model.
-Also visualization of fields changes over time.
-In **IGMAS+** we introduced the so called **Time Machine**, a timeline-based project management concept which allow the user to go in time with the model and data.
-
-{ style="display:block; margin:0 auto;"}
-<!-- <figure markdown>
- []()
-</figure> -->
-
-The concept involves the project directory structure that keeps the valuable information about project changes over time. In this way the user can always recover any model state.
-
-## Feedback
-
-Although the **IGMAS+** software has been tested by many users worldwide, there can be still a number of issues.
-We apologize for any inconvenience that **IGMAS+** might cause due to unexpected problems, and we want to hear from you in case of any issue that you might experience.
-This means that we invite every user to become a tester in order to contribute to the further development, help us improve **IGMAS+** and design a user-friendly graphical interface as you want it to be.
-
-This is how you can contribute:
-
-- **Report** errors and unexpected behaviour of the program with a brief description, and send it together with a log file and a system report file. (Refer also to Section XXX of the **manual**)
-- **Share** your sample data with us if you think that the detected problem could have something to do with your inputs. We assure that we will use your data only for the purpose to solve the related problem, and that we will delete your data as soon as the problem is solved.
-- **Send** us your ideas and suggestions concerning the user interface (menus, shortcuts, wizards), the functionality, the default values or any other topic. Any comments related to the actual needs of users are appreciated.
-- **Point out** errors, typos and inconsistencies in this manual, as well as topics which are out of date or wrong. The appropriate section title will be marked as ”out of date” **(o.o.d.)** until updated. Missing sections are denoted as ”to be added” **(t.b.a.)** until it is fixed. Accordingly, incomplete sections are denoted as ”to be extended” **(t.b.e.)**. Let us bring the **IGMAS+** user experience to the next level together!
-
-???+ info "Contacts"
-
- Please [send](https://igmas.git-pages.gfz-potsdam.de/igmas-pages/#contact) your feedback, suggestions and concerns.
diff --git a/docs/theme/main.html b/docs/theme/main.html
index 1bcd268..1801334 100644
--- a/docs/theme/main.html
+++ b/docs/theme/main.html
@@ -11,4 +11,8 @@
</small>
</div>
{% endif %}
-{% endblock %}
\ No newline at end of file
+{% endblock %}
+
+{% block announce %}
+ Please note, that this online documentation is under ongoing development
+{% endblock %}
diff --git a/mkdocs.yml b/mkdocs.yml
index f640a4c..dc94931 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -11,7 +11,8 @@ edit_uri: edit/devel/docs/
#edit_uri: edit/master/docs/
# Copyright
-copyright: Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences
+copyright: Copyright © 2024 - Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences<br>This work is licensed under <a href="https://creativecommons.org/licenses/by-nc-nd/4.0"><font color="#00589c">CC BY NC ND 4.0</font></a><br><a href="https://igmas.git-pages.gfz-potsdam.de/igmas-pages/privacy"><font color="#00589c">Data protection</font></a> · <a href="https://igmas.git-pages.gfz-potsdam.de/igmas-pages/terms""><font color="#00589c">Imprint</font></a>
+
# This setting controls the style used for linking to pages within the documentation:
use_directory_urls: true
@@ -36,9 +37,12 @@ theme:
- navigation.expand
#- navigation.tracking
- navigation.instant
+ - navigation.top
+ #- navigation.path
- content.code.copy
- content.action.view
- content.action.edit
+ - announce.dismiss
palette:
--
GitLab