feat: add annotation support for markdown blocks (oeo, sms, fmi, dogont, brick, s4grid, sargon, s4ener, bont, openadr, dices) and update footer links

smutyala1at · smutyala1at · commit aa56cdda9c80 · 2025-04-21T17:32:16.000+02:00
Usage:
Wrap content with &lt;!-- BEGIN-ANNOTATION: ontology_id --&gt; ... &lt;!-- END-ANNOTATION: ontology_id --&gt;
Example: &lt;!-- BEGIN-ANNOTATION: oeo --&gt;Energy is the ability to do work.&lt;!-- END-ANNOTATION: oeo --&gt;
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 venv/
-site/
+site/
+__pycache__/
diff --git a/docs/footer/contact.md b/docs/footer/contact.md
@@ -0,0 +1,15 @@
+# You can reach us here
+
+## Address
+National Research Data Infrastructure (NFDI) eV  
+NFDI Directorate  
+Albert-Nestler-Straße 13 | 76131 Karlsruhe
+
+## Telephone number
++49 721 988 994 0
+
+## Fax
++49 721 988 994 29
+
+## E-mail
+info[at]nfdi.de
diff --git a/docs/footer/legal/imprint.md b/docs/footer/legal/imprint.md
@@ -0,0 +1,35 @@
+# Imprint and Data Privacy statement
+
+## Imprint
+
+This website presents the work of the project NFDI4Energy. The partners of the NFDI4Energy consortium are funded by the [German Research Foundation (DFG)](https://www.dfg.de/de/foerderung/foerderinitiativen/nfdi) as part of the [Bund-Länder-Agreement on the Establishment and Promotion of the National Research Data Infrastructure (NFDI)](https://www.gwk-bonn.de/themen/weitere-arbeitsgebiete/informationsinfrastrukturen-nfdi) of 26 November 2018 (project number [501865131](https://gepris.dfg.de/gepris/projekt/501865131?language=de)). To coordinate the activities, the partners of NFDI4Energy participate as members of the Association [Nationale Forschungsdateninfrastruktur (NFDI) e. V.](https://www.nfdi.de/) and participate in the various organs and structures of the association in accordance with its statutes.
+
+Responsible within the meaning of § 18 para. 2 MStV:
+
+Prof. Dr.-Ing. Astrid Nieße  
+Carl von Ossietzky Universität Oldenburg  
+Faculty II of Computing Science, Business Administration, Economics and Law  
+Department of Computer Science  
+Group of Digitalized Energy Systems
+
+Ammerländer Heerstraße 114 - 118  
+DE - 26129 Oldenburg
+
+Mail: [info@nfdi4energy.org](mailto:info@nfdi4energy.org)
+
+For further information:  
+[https://uol.de/en/imprint](https://uol.de/en/imprint)
+
+## Data privacy
+
+Data protection law
+The European Data Protection Regulation (DSGVO) and the Lower Saxony Data Protection Act (NDSG) as well as the Federal Data Protection Act (BDSG) contain regulations on the processing of personal data.
+
+Right to one's own image
+The Art Copyright Act (KunstUrhG) contains the provisions on the right to one's own image. With a few specific exceptions (pictures of public meetings, persons of contemporary history or pictures in which the persons are only accessories), the person's consent is required before publication.
+
+Copyright
+The Copyright Act (UrhG) regulates the protection of texts, images, audio and video content (so-called works). In most cases, publication or distribution of such works is only permitted with the consent of the respective rights holder.
+
+For further information:  
+[https://uol.de/en/data-privacy-statement](https://uol.de/en/data-privacy-statement)
diff --git a/docs/footer/partners/consortium.md b/docs/footer/partners/consortium.md
@@ -0,0 +1,27 @@
+# Consortium in the NFDI e.V.
+
+The consortium NFDI4Energy is part of the [NFDI e.V.](https://www.nfdi.de/association/?lang=en). Within the NFDI e.V. it consists of the following members:
+
+## Members
+
+| Institution | Representative | Location |
+|-------------|---------------|----------|
+| [Albert-Ludwigs-Universität Freiburg](https://www.uni-freiburg.de/) | [Prof. Dr. Anke Weidlich](https://www.inatech.de/anke-weidlich) | Freiburg |
+| [Carl von Ossietzky Universität Oldenburg](https://uol.de/) | [Prof. Dr. Astrid Nieße (Spokesperson)](https://uol.de/en/des/team/astrid-niesse) | Oldenburg |
+| [DLR e.V.](https://www.dlr.de/de) | Carsten Hoyer-Klick | Köln |
+| [Forschungszentrum Jülich GmbH](https://www.fz-juelich.de/de) | [Dr. Patrick Kuckertz](https://www.fz-juelich.de/profile/kuckertz_p) | Jülich |
+| [Fortiss](https://www.fortiss.org/) | Dr. Markus Duchon | München |
+| [Fraunhofer Society](https://www.fraunhofer.de/en.html) | Nikolaus Wirtz | München |
+| [Friedrich-Alexander-Universität Erlangen-Nürnberg](https://www.fau.eu/) | [Prof. Dr. Reinhard German](https://www.cs7.tf.fau.eu/person/german/) | Erlangen-Nürnberg |
+| [Institut für Angewandte Informatik (InfAI) e.V.](https://infai.org/) | [Dr.-Ing. Sebastian Hellmann](https://infai.org/kompetenzzentren/) | Leipzig |
+| [Karlsruher Institut für Technologie](https://www.kit.edu/english/) | [Prof. Dr. Christof Weinhardt](https://im.iism.kit.edu/english/team_111.php) | Karlsruhe |
+| [Leibinz Universität Hannover](https://www.fz-juelich.de/de) | [Dr.-Ing. Volker Schöber](https://www.epv.uni-hannover.de/de/personensuche/detailansicht-zur-person/person/dr-ing-volker-schober) | Hannover |
+| [OFFIS e.V.](https://www.offis.de/en/) | [Prof. Dr. Sebastian Lehnhoff (Co-Spokesperson)](https://www.offis.de/en/offis/person/sebastian-lehnhoff.html) | Oldenburg |
+| [Reiner Lemoine Institut gGmbH](https://reiner-lemoine-institut.de/en/) | [Dipl.-Ing. Mascha Richter](https://reiner-lemoine-institut.de/person/mascha-richter/) | Berlin |
+| [RWTH Aachen University](https://www.rwth-aachen.de/en/) | [Prof. Antonello Monti, Ph.D.](https://www.acs.eonerc.rwth-aachen.de/cms/E-ON-ERC-ACS/Das-Institut/Mitarbeiter/Lehrstuhl-Leitung/~fcmz/Monti-Antonello/?allou=1&lidx=1) | Aachen |
+| [Soziologisches Forschungsinstitut Göttingen (SOFI) e.V.](https://www.uni-goettingen.de/en/) | [Dr. Franziska Hoffart](http://www.sofi.uni-goettingen.de/nc/de/personen/detail/name/franziska-m-hoffart/) | Göttingen |
+| [Technische Informationsbibliothek](https://www.tib.eu/en/) | [Prof. Dr. Sören Auer](https://www.tib.eu/en/research-development/research-groups-and-labs/data-science-digital-libraries/staff/soeren-auer) | Hannover |
+| [TU Braunschweig](https://www.tu-braunschweig.de/) | [Dr. rer. nat Peter Michalowski](https://www.tu-braunschweig.de/ipat/institut-1/team/dr-rer-nat-peter-michalowski) | Braunschweig |
+| [Universität Bremen](https://www.uni-bremen.de/) | [Dr. Torben Stührmann](https://www.uni-bremen.de/res/team/dr-torben-stuehrmann) | Bremen |
+| [Universität Osnabrück](https://www.uni-osnabrueck.de/startseite/) | [Prof. Dr. Till Mossakowski](https://www.lili.uni-osnabrueck.de/institut_fuer_germanistik/lehre/lehrende/mitarbeiterdetails.html?module=TemplatePersondetails&target=18044&source=16087&config_id=048a134a20a6923c450191af9867826c&range_id=825b6af79a277e4749559e88541383e8&username=tmossakowski) | Osnabrück |
+| [Öko-Institut e.V.](https://www.oeko.de/) | [Dr. Hannah Förster](https://www.oeko.de/das-institut/team/team-detail/hannah-foerster/) | Freiburg |
diff --git a/docs/footer/partners/funded-consortium.md b/docs/footer/partners/funded-consortium.md
@@ -0,0 +1,28 @@
+# Funded Consortium
+
+The consortium NFDI4Energy is funded by the [DFG](https://www.dfg.de/en/research-funding/funding-initiative/nfdi) with the following applicants and participants:
+
+## Applicant Institution
+
+| Spokesperson | University | Location |
+|-----------------|------------|----------|
+| [Prof. Dr. Astrid Nieße](https://uol.de/en/des/team/astrid-niesse) | [Carl von Ossietzky Universität Oldenburg](https://uol.de/) | Oldenburg |
+
+## Co-Applicant Institutions
+
+| Co-Spokesperson | University | Location |
+|-----------------|------------|----------|
+| [Prof. Dr. Anke Weidlich](https://www.inatech.de/anke-weidlich) | [Albert-Ludwigs-Universität Freiburg](https://www.uni-freiburg.de/) | Freiburg |
+| [Prof. Dr. Reinhard German](https://www.cs7.tf.fau.eu/person/german/)<br>[Prof. Dr. Johan Lilliestam](https://www.rifs-potsdam.de/en/people/johan-lilliestam) | [Friedrich-Alexander-Universität Erlangen-Nürnberg](https://www.fau.eu/) | Erlangen-Nürnberg |
+| [Prof. Dr. Christof Weinhardt](https://im.iism.kit.edu/english/team_111.php)<br>[Prof. Dr. Veit Hagenmeyer](https://www.iai.kit.edu/english/921_1213.php) | [Karlsruher Institut für Technologie](https://www.kit.edu/english/) | Karlsruhe |
+| [Prof. Dr. Sebastian Lehnhoff](https://www.offis.de/en/offis/person/sebastian-lehnhoff.html) | [OFFIS e.V.](https://www.offis.de/en/) | Oldenburg |
+| [Prof. Antonello Monti, Ph.D.](https://www.acs.eonerc.rwth-aachen.de/cms/E-ON-ERC-ACS/Das-Institut/Mitarbeiter/Lehrstuhl-Leitung/~fcmz/Monti-Antonello/?allou=1&lidx=1) | [RWTH Aachen University](https://www.rwth-aachen.de/en/) | Aachen |
+| [Prof. Dr. Berthold Vogel](https://sofi.uni-goettingen.de/nc/personen/detail/name/berthold-vogel/) | [Soziologisches Forschungsinstitut Göttingen (SOFI) e.V.](https://www.uni-goettingen.de/en/) | Göttingen |
+| [Prof. Dr. Sören Auer](https://www.tib.eu/en/research-development/research-groups-and-labs/data-science-digital-libraries/staff/soeren-auer) | [Technische Informationsbibliothek](https://www.tib.eu/en/) | Hannover |
+
+## Participants
+
+| Representative | University | Location |
+|-----------------|------------|----------|
+| [Dipl.-Ing. Mascha Richter](https://reiner-lemoine-institut.de/ueber-uns/team/mascha-richter/) | [Reiner Lemoine Institut gGmbH](https://reiner-lemoine-institut.de/en/) | Berlin |
+| [Prof. Dr. Stefan Decker](https://www.fit.fraunhofer.de/de/profil/institutsleitung.html) | [Fraunhofer Institute for Applied Information Technology FIT](https://www.fit.fraunhofer.de/en.html) | Sankt Augustin |
diff --git a/docs/nfdi4ing/01_bp.md b/docs/nfdi4ing/01_bp.md
@@ -18,6 +18,11 @@
 - Process quality assessment
 - Performance evaluation methods
 
+<!-- BEGIN-ANNOTATION: oeo -->
+## Testing Annotation
+electrical energy is a form of energy derived from the potential or kinetic energy of charged particles.
+<!-- END-ANNOTATION: oeo -->
+
 [Learn more about our workflows →](02_workflow.md)
 
 *Source: [NFDI4ING QA Metrics](https://nfdi4ing.de/special-interest-groups-sig/qa-metrics/)*
diff --git a/hooks.py b/hooks.py
@@ -0,0 +1,98 @@
+import requests
+import re
+
+def extract_annotation_blocks(markdown):
+
+    supported_ontologies = ["oeo", "sms", "fmi", "dogont", "brick", "s4grid", "sargon", "s4ener", "bont", "openadr", "dices"]
+
+    ontology_pattern = '|'.join(supported_ontologies)
+    annotation_pattern = fr'<!-- BEGIN-ANNOTATION: ({ontology_pattern}) -->(.*?)<!-- END-ANNOTATION: \1 -->'
+    annotation_matches = re.finditer(annotation_pattern, markdown, re.DOTALL)
+
+    annotation_blocks = []
+
+    for match in annotation_matches:
+        full_match = match.group(0)
+        ontology_id = match.group(1)
+        content = match.group(2)
+        annotation_blocks.append((full_match, ontology_id, content))
+
+    return annotation_blocks
+
+def get_ontology_annotations(config, ontology_id, text):
+
+    api_endpoint = config.get('api_url', 'https://service.tib.eu/sandbox/nfdi4energyannotator/annotate')
+    
+    try:
+        response = requests.post(
+            api_endpoint,
+            json={'text': text, 'ontology_ids': [ontology_id]},
+            headers={'Content-Type': 'application/json'},
+            timeout=30 
+        )
+        
+        response.raise_for_status()
+        response_data = response.json()
+        print(f"Response from {ontology_id} ontology: {response_data}")
+
+        if 'matches' in response_data and isinstance(response_data['matches'], list):
+            text_with_spans = wrap_terms_in_span(text, response_data['matches'])
+            return text_with_spans
+        elif 'annotated_text' in response_data:
+            return response_data['annotated_text']
+        else:
+            return text
+        
+    except Exception as e:
+        print(f"Error annotating text with {ontology_id} ontology: {str(e)}")
+        return text
+
+def wrap_terms_in_span(text, matches):
+    
+    cleaner_matches = [{'matched_term': m['matched_term'], 'start': m['start'], 'end': m['end'], 'iri': m['iri']} for m in matches]
+    sorted_matches = sorted(cleaner_matches, key=lambda m: (-len(m['matched_term']), -m['start']))
+
+    modified_positions = set()
+    
+    modifications = []
+    
+    # First pass: determine which matches to process
+    for match in sorted_matches:
+        overlap = False
+        for pos in range(match['start'], match['end'] + 1):
+            if pos in modified_positions:
+                overlap = True
+                break
+        
+        if overlap:
+            continue
+        
+        for pos in range(match['start'], match['end'] + 1):
+            modified_positions.add(pos)
+
+        modifications.append(match)
+    
+    modifications.sort(key=lambda m: m['start'])
+    
+    # Second pass: apply modifications
+    result = ""
+    last_end = 0
+    
+    for match in modifications:
+        result += text[last_end:match['start']]
+        result += f"<a href={match['iri']} style='border-bottom: 1px dotted #666; text-decoration: none;'>{match['matched_term']}</a> "
+        last_end = match['end'] + 1
+    
+    result += text[last_end:]
+    
+    return result
+
+def on_page_markdown(markdown, page, config, files):
+
+    annotation_blocks = extract_annotation_blocks(markdown)
+    
+    for full_match, ontology_id, content in annotation_blocks:
+        annotated_content = get_ontology_annotations(config, ontology_id, content)
+        markdown = markdown.replace(full_match, annotated_content)
+        
+    return markdown
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,4 +22,10 @@ theme:
         icon: material/weather-sunny
         name: Switch to light mode
 extra_css:
-  - stylesheets/extra.css
+  - stylesheets/extra.css
+
+hooks:
+  - hooks.py
+
+extra:
+  api_url: "https://service.tib.eu/sandbox/nfdi4energyannotator/annotate"
diff --git a/overrides/partials/footer.html b/overrides/partials/footer.html
@@ -64,22 +64,21 @@
     <!-- Further information -->
     <div class="md-footer-meta md-typeset" style="display: flex; justify-content: center;">
         <div class="footer" style="display: flex; justify-content: center; gap: 100px; margin: 19.5px 0;">
-          <div class="footer-section partners-contact">
-            <div class="footer-title">Partners and Contact</div>
-            <a href="" class="footer-link">Consortium in the NFDI e.V.</a>
-            <a href="" class="footer-link">Funded Consortium</a>
-            <a href="" class="footer-link">Contact</a>
-          </div>
-          <div class="footer-section legals">
-            <div class="footer-title">Legals</div>
-            <a href="" class="footer-link">Imprint and Data Privacy Statement</a>
-            <a href="" class="footer-link">Legals UniOldenburg</a>
-          </div>
-          <div class="footer-section follow-us">
-            <div class="footer-title">Follow us</div>
-            <a href="" class="footer-link">Linkedin</a>
-            <a href="" class="footer-link">Facebook</a>
-          </div>
+            <div class="footer-section partners-contact">
+                <div class="footer-title">Partners and Contact</div>
+                <a href="{{ 'footer/partners/consortium' | url }}" class="footer-link">Consortium in the NFDI e.V.</a>
+                <a href="{{ 'footer/partners/funded-consortium' | url }}" class="footer-link">Funded Consortium</a>
+                <a href="{{ 'footer/contact' | url }}" class="footer-link">Contact</a>
+            </div>
+            <div class="footer-section legals">
+                <div class="footer-title">Legals</div>
+                <a href="{{ 'footer/legal/imprint' | url }}" class="footer-link">Imprint and Data Privacy Statement</a>
+                <a href="https://www.uol.de/en/imprint" class="footer-link" target="_blank" rel="noopener">Legals UniOldenburg</a>
+            </div>
+            <div class="footer-section follow-us">
+                <div class="footer-title">Follow us</div>
+                <a href="https://www.linkedin.com/company/nfdi4energy/" class="footer-link">Linkedin</a>
+            </div>
         </div>
         <!-- Social links -->
         {% if config.extra.social %}
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
 mkdocs
-mkdocs-material
+mkdocs-material
+requests

-Original file line number
+Diff line change
@@ @@ -1,2 +1,3 @@ @@
 venv/
 -site/
 +site/
 +__pycache__/