-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Edtf #196
Edtf #196
Conversation
|
WalkthroughThe pull request introduces significant changes to the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
pages/data.md (3)
7-11
: Consider adding rel="noopener noreferrer" for securityWhen using
target="_blank"
for external links, it's recommended to addrel="noopener noreferrer"
to prevent potential security vulnerabilities.-[auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="_blank"} +[auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="_blank" rel="noopener noreferrer"}🧰 Tools
🪛 LanguageTool
[style] ~11-~11: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen?
Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht...(IN_ZUSAMMENHANG_MIT)
[typographical] ~11-~11: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...stadt-geschichte-basel){:target="_blank"}. Die im Rahmen von Konferenzen und Wor...(DE_UNPAIRED_QUOTES)
28-63
: Enhance code example readabilityConsider using fenced code blocks for EDTF examples to improve readability and enable syntax highlighting.
For example, change:
- `1900/1950` steht für die Zeitspanne von 1900 bis 1950. + ```edtf + 1900/1950 + ``` + steht für die Zeitspanne von 1900 bis 1950.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...kmale sind: 1. Einfache Datumsangaben Wie bei ISO 8601 üblich, kann man präzis...(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~31-~31: Hier scheint es einen Fehler zu geben.
Context: ...024`. 2. Ungewisse und ungefähre Daten Mit speziellen Zeichen lässt sich angeben, ...(AI_DE_MERGED_MATCH)
[uncategorized] ~32-~32: Hier scheint es einen Fehler zu geben.
Context: ...hre Daten** Mit speziellen Zeichen lässt sich angeben, wenn ein Datum nur ungefähr oder unsic...(AI_DE_MERGED_MATCH)
[uncategorized] ~38-~38: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...fähr 3. Datumsbereiche und Intervalle Man kann Zeiträume als Intervalle ausdrü...(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~46-~46: Das sieht falsch aus. Überlegen Sie, es zu ersetzen.
Context: .../1950?`. 4. Listen und Sets von Daten Man kann mehrere mögliche oder relevante...(AI_DE_GGEC_REPLACEMENT_OTHER)
[style] ~47-~47: Diese Formulierung ist möglicherweise redundant. Die Wörter „können“ und „möglicherweise“ drücken dasselbe aus.
Context: ... Sets von Daten** Man kann mehrere mögliche oder relevante Daten in einer Liste ang...(VERDOPPELUNG)
[uncategorized] ~51-~51: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...vanten Daten. 5. Saisons und Quartale EDTF erlaubt die Angabe von Jahreszeiten...(AI_DE_GGEC_UNNECESSARY_SPACE)
1-68
: Address formatting consistency issuesThe static analysis tool identified several formatting inconsistencies:
- Inconsistent spacing between sentences
- Unnecessary spaces in list items
- Missing spaces after punctuation marks
Consider running a Markdown formatter to ensure consistent formatting throughout the document.
🧰 Tools
🪛 LanguageTool
[style] ~11-~11: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen?
Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht...(IN_ZUSAMMENHANG_MIT)
[typographical] ~11-~11: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...stadt-geschichte-basel){:target="_blank"}. Die im Rahmen von Konferenzen und Wor...(DE_UNPAIRED_QUOTES)
[whitespace] ~15-~15: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...senschaften. ## Datenarchiv Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve...(DE_SENTENCE_WHITESPACE)
[whitespace] ~15-~15: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: .... ## Datenarchiv Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie...(DE_SENTENCE_WHITESPACE)
[typographical] ~15-~15: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...erungsfreie-metadaten/){:target="_blank"} erstellt und aufbereitet worden. ## D...(DE_UNPAIRED_QUOTES)
[uncategorized] ~19-~19: Hier scheint es einen Tippfehler zu geben. Überlegen Sie, ihn zu korrigieren.
Context: ...plattform vorgestellten Elemente werden gemäss einem Datenmodell bereitgestellt, das v...(AI_DE_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELL)
[uncategorized] ~19-~19: Hier scheint es einen Fehler zu geben.
Context: ...s einem Datenmodell bereitgestellt, das vom Stadt.Geschichte.Basel Research Data Managemen...(AI_DE_MERGED_MATCH)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...tenmodell bereitgestellt, das vom Stadt.Geschichte.Basel Research Data Management Team ent...(DE_SENTENCE_WHITESPACE)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ereitgestellt, das vom Stadt.Geschichte.Basel Research Data Management Team entwickel...(DE_SENTENCE_WHITESPACE)
[uncategorized] ~19-~19: Dieser Satzbau sieht falsch aus. Überlegen Sie, ihn zu ändern.
Context: ...hte.Basel Research Data Management Team entwickelt wurde, um den Anforderungen der vielfältigen ...(AI_DE_GGEC_REPLACEMENT_WORD_ORDER)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ierungsfreie-metadaten/), das von Stadt.Geschichte.Basel entwickelt wurde. Die folgende G...(DE_SENTENCE_WHITESPACE)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...e-metadaten/), das von Stadt.Geschichte.Basel entwickelt wurde. Die folgende Grafik ...(DE_SENTENCE_WHITESPACE)
[uncategorized] ~28-~28: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...kmale sind: 1. Einfache Datumsangaben Wie bei ISO 8601 üblich, kann man präzis...(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~31-~31: Hier scheint es einen Fehler zu geben.
Context: ...024`. 2. Ungewisse und ungefähre Daten Mit speziellen Zeichen lässt sich angeben, ...(AI_DE_MERGED_MATCH)
[uncategorized] ~32-~32: Hier scheint es einen Fehler zu geben.
Context: ...hre Daten** Mit speziellen Zeichen lässt sich angeben, wenn ein Datum nur ungefähr oder unsic...(AI_DE_MERGED_MATCH)
[uncategorized] ~38-~38: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...fähr 3. Datumsbereiche und Intervalle Man kann Zeiträume als Intervalle ausdrü...(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~46-~46: Das sieht falsch aus. Überlegen Sie, es zu ersetzen.
Context: .../1950?`. 4. Listen und Sets von Daten Man kann mehrere mögliche oder relevante...(AI_DE_GGEC_REPLACEMENT_OTHER)
[style] ~47-~47: Diese Formulierung ist möglicherweise redundant. Die Wörter „können“ und „möglicherweise“ drücken dasselbe aus.
Context: ... Sets von Daten** Man kann mehrere mögliche oder relevante Daten in einer Liste ang...(VERDOPPELUNG)
[uncategorized] ~51-~51: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...vanten Daten. 5. Saisons und Quartale EDTF erlaubt die Angabe von Jahreszeiten...(AI_DE_GGEC_UNNECESSARY_SPACE)
[typographical] ~68-~68: Wenn ‚sowie‘ als Ersatz für ‚und‘ verwendet wird, dann wird kein Komma gesetzt.
Context: ...ärfen, komplexen Zeiträumen und offenen Enden, sowie die Angabe von Mengen, Intervallen oder...(KEIN_KOMMA_VOR_SOWIE)
🪛 Markdownlint (0.35.0)
26-26: null
Spaces inside link text(MD039, no-space-in-links)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (2)
_data/config-metadata.csv
is excluded by!**/*.csv
assets/img/sgb_datamodel.png
is excluded by!**/*.png
📒 Files selected for processing (1)
pages/data.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/data.md
[style] ~11-~11: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen?
Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht...
(IN_ZUSAMMENHANG_MIT)
[typographical] ~11-~11: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...stadt-geschichte-basel){:target="_blank"}. Die im Rahmen von Konferenzen und Wor...
(DE_UNPAIRED_QUOTES)
[whitespace] ~15-~15: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...senschaften. ## Datenarchiv Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~15-~15: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: .... ## Datenarchiv Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie...
(DE_SENTENCE_WHITESPACE)
[typographical] ~15-~15: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...erungsfreie-metadaten/){:target="_blank"} erstellt und aufbereitet worden. ## D...
(DE_UNPAIRED_QUOTES)
[uncategorized] ~19-~19: Hier scheint es einen Tippfehler zu geben. Überlegen Sie, ihn zu korrigieren.
Context: ...plattform vorgestellten Elemente werden gemäss einem Datenmodell bereitgestellt, das v...
(AI_DE_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELL)
[uncategorized] ~19-~19: Hier scheint es einen Fehler zu geben.
Context: ...s einem Datenmodell bereitgestellt, das vom Stadt.Geschichte.Basel Research Data Managemen...
(AI_DE_MERGED_MATCH)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...tenmodell bereitgestellt, das vom Stadt.Geschichte.Basel Research Data Management Team ent...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ereitgestellt, das vom Stadt.Geschichte.Basel Research Data Management Team entwickel...
(DE_SENTENCE_WHITESPACE)
[uncategorized] ~19-~19: Dieser Satzbau sieht falsch aus. Überlegen Sie, ihn zu ändern.
Context: ...hte.Basel Research Data Management Team entwickelt wurde, um den Anforderungen der vielfältigen ...
(AI_DE_GGEC_REPLACEMENT_WORD_ORDER)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ierungsfreie-metadaten/), das von Stadt.Geschichte.Basel entwickelt wurde. Die folgende G...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~19-~19: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...e-metadaten/), das von Stadt.Geschichte.Basel entwickelt wurde. Die folgende Grafik ...
(DE_SENTENCE_WHITESPACE)
[uncategorized] ~28-~28: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...kmale sind: 1. Einfache Datumsangaben Wie bei ISO 8601 üblich, kann man präzis...
(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~31-~31: Hier scheint es einen Fehler zu geben.
Context: ...024`. 2. Ungewisse und ungefähre Daten Mit speziellen Zeichen lässt sich angeben, ...
(AI_DE_MERGED_MATCH)
[uncategorized] ~32-~32: Hier scheint es einen Fehler zu geben.
Context: ...hre Daten** Mit speziellen Zeichen lässt sich angeben, wenn ein Datum nur ungefähr oder unsic...
(AI_DE_MERGED_MATCH)
[uncategorized] ~38-~38: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...fähr 3. Datumsbereiche und Intervalle Man kann Zeiträume als Intervalle ausdrü...
(AI_DE_GGEC_UNNECESSARY_SPACE)
[uncategorized] ~46-~46: Das sieht falsch aus. Überlegen Sie, es zu ersetzen.
Context: .../1950?`. 4. Listen und Sets von Daten Man kann mehrere mögliche oder relevante...
(AI_DE_GGEC_REPLACEMENT_OTHER)
[style] ~47-~47: Diese Formulierung ist möglicherweise redundant. Die Wörter „können“ und „möglicherweise“ drücken dasselbe aus.
Context: ... Sets von Daten** Man kann mehrere mögliche oder relevante Daten in einer Liste ang...
(VERDOPPELUNG)
[uncategorized] ~51-~51: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen.
Context: ...vanten Daten. 5. Saisons und Quartale EDTF erlaubt die Angabe von Jahreszeiten...
(AI_DE_GGEC_UNNECESSARY_SPACE)
[typographical] ~68-~68: Wenn ‚sowie‘ als Ersatz für ‚und‘ verwendet wird, dann wird kein Komma gesetzt.
Context: ...ärfen, komplexen Zeiträumen und offenen Enden, sowie die Angabe von Mengen, Intervallen oder...
(KEIN_KOMMA_VOR_SOWIE)
🪛 Markdownlint (0.35.0)
pages/data.md
26-26: null
Spaces inside link text
(MD039, no-space-in-links)
🔇 Additional comments (2)
pages/data.md (2)
2-3
: LGTM: Front matter changes improve document organization
The changes to title, layout, and permalink enhance document accessibility and better reflect its content.
22-22
: Verify image file existence and accessibility
Let's ensure the referenced image file exists in the correct location.
✅ Verification successful
Image file exists and is accessible
The image file assets/img/sgb_datamodel.png
exists in the correct location and has a size of 171KB, confirming its accessibility for the documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the image file exists
if [ -f "assets/img/sgb_datamodel.png" ]; then
echo "Image file exists"
# Get file size and dimensions
ls -lh "assets/img/sgb_datamodel.png"
file "assets/img/sgb_datamodel.png"
else
echo "Image file not found"
fi
Length of output: 333
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
pages/data.md (2)
17-17
: Fix typo in "Forschungdatenmanagement"There's a typo in the word "Forschungdatenmanagement" (missing 's').
-das vom Team für Forschungdatenmanagement der Stadt.Geschichte.Basel +das vom Team für Forschungsdatenmanagement der Stadt.Geschichte.Basel🧰 Tools
🪛 LanguageTool
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ... für Forschungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforder...(DE_SENTENCE_WHITESPACE)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforderungen ...(DE_SENTENCE_WHITESPACE)
[uncategorized] ~17-~17: Hier scheint es einen Tippfehler zu geben. Überlegen Sie, ihn zu korrigieren.
Context: ...ss) folgen dem [Handbuch zur Erstellung diskriminerungsfreier Metadaten für historische Quellen und F...(AI_DE_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELL)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ie-metadaten/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende G...(DE_SENTENCE_WHITESPACE)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...n/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende Grafik ...(DE_SENTENCE_WHITESPACE)
31-34
: Consider using code blocks for better readabilityWhile the inline code formatting works, consider using fenced code blocks (```) for multi-line examples to improve readability. This would be particularly helpful for the date format examples and their explanations.
Example format:
```text 1960? # unsicheres Jahr 1900/1950 # ZeitspanneAlso applies to: 37-40, 48-50, 54-56 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~31-~31: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...in Datum nur ungefähr oder unsicher ist: - `?` kennzeichnet Unsicherheit (z. B. `1960?`... (AI_DE_GGEC_UNNECESSARY_SPACE) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 3ab015ae0f059b29d5f3e4885e9955679fed91d9 and 3f79b3ba0f139514065529d144cfba9ec86aaaae. </details> <details> <summary>⛔ Files ignored due to path filters (1)</summary> * `assets/img/sgb_datamodel.svg` is excluded by `!**/*.svg` </details> <details> <summary>📒 Files selected for processing (1)</summary> * `pages/data.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>pages/data.md</summary> [whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ml --- # Datendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...atendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie... (DE_SENTENCE_WHITESPACE) --- [style] ~13-~13: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen? Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht... (IN_ZUSAMMENHANG_MIT) --- [uncategorized] ~13-~13: Hier scheint ein Satzzeichen überflüssig zu sein. Überlegen Sie, es zu löschen. Context: ... mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](https://zenodo.or... (AI_DE_GGEC_UNNECESSARY_PUNCTUATION_OPEN_BRACKET) --- [uncategorized] ~13-~13: Das sieht falsch aus. Überlegen Sie, es zu ersetzen. Context: ...schungsprojekt stehen, sind [auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="\_blank... (AI_DE_GGEC_REPLACEMENT_OTHER) --- [typographical] ~13-~13: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen Context: ...stadt-geschichte-basel){:target="\_blank"}. Die im Rahmen von Konferenzen und Wor... (DE_UNPAIRED_QUOTES) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ... für Forschungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforder... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforderungen ... (DE_SENTENCE_WHITESPACE) --- [uncategorized] ~17-~17: Hier scheint es einen Tippfehler zu geben. Überlegen Sie, ihn zu korrigieren. Context: ...ss) folgen dem [Handbuch zur Erstellung diskriminerungsfreier Metadaten für historische Quellen und F... (AI_DE_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELL) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ie-metadaten/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende G... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...n/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende Grafik ... (DE_SENTENCE_WHITESPACE) --- [typographical] ~21-~21: Vor Einheitenzeichen sollte ein Leerzeichen gesetzt werden. Context: ...g/sgb_datamodel.svg){:style="max-width: 70%; display: block; margin: auto;"} ## ED... (EINHEIT_LEERZEICHEN) --- [uncategorized] ~27-~27: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...kmale sind: 1. **Einfache Datumsangaben** Wie bei ISO 8601 üblich, kann man präzis... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [uncategorized] ~30-~30: Hier scheint es einen Fehler zu geben. Context: ...024`. 2. **Ungewisse und ungefähre Daten** Mit speziellen Zeichen lässt sich angeben, ... (AI_DE_MERGED_MATCH) --- [uncategorized] ~31-~31: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...in Datum nur ungefähr oder unsicher ist: - `?` kennzeichnet Unsicherheit (z. B. `1960?`... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [typographical] ~39-~39: Zwei aufeinander folgende Punkte. Auch wenn ein Satz mit einer Abkürzung endet, endet er nur mit einem Punkt (§103 Regelwerk). Context: ...950. - Unvollständige Intervalle wie `1900/..` oder `../1950` drücken offene Zeiträum... (DE_DOUBLE_PUNCTUATION) --- [uncategorized] ~42-~42: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: .../1950?`. 4. **Listen und Sets von Daten** Man kann mehrere mögliche oder relevante... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [style] ~43-~43: Diese Formulierung ist möglicherweise redundant. Die Wörter „können“ und „möglicherweise“ drücken dasselbe aus. Context: ... Sets von Daten** Man kann mehrere mögliche oder relevante Daten in einer Liste ang... (VERDOPPELUNG) --- [uncategorized] ~43-~43: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ... relevante Daten in einer Liste angeben: - Eine Liste wie `[1960, 1962, 1965]` bede... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [uncategorized] ~46-~46: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...n Daten. 5. **Jahreszeiten und Quartale** EDTF erlaubt die Angabe von Jahreszeiten... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [uncategorized] ~47-~47: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...hen Zusammenhängen relevant sein können: - `1960-33` stellt beispielsweise die Angabe „Erstes... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [style] ~48-~48: Der Ausdruck ‚beispielsweise‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen? Context: ...vant sein können: - `1960-33` stellt beispielsweise die Angabe „Erstes Quartal des Jahres 1... (ZUM_BEISPIEL_STYLE) --- [uncategorized] ~50-~50: Diese Verbform sieht falsch aus. Überlegen Sie, sie zu ersetzen. Context: ...uen Entsprechungen von Zeiten und Codes ist in der Spezifikation des EDTF-Standards... (AI_DE_GGEC_REPLACEMENT_VERB_FORM) --- [typographical] ~60-~60: Wenn ‚sowie‘ als Ersatz für ‚und‘ verwendet wird, dann wird kein Komma gesetzt. Context: ...ärfen, komplexen Zeiträumen und offenen Enden, sowie die Angabe von Mengen, Intervallen oder... (KEIN_KOMMA_VOR_SOWIE) </details> </details> </details> <details> <summary>🔇 Additional comments (3)</summary> <details> <summary>pages/data.md (3)</summary> `2-3`: **LGTM: Front matter changes are consistent** The changes to title and layout, along with the addition of permalink, align well with the document's new focus on data documentation. --- `9-13`: **LGTM: Introduction provides clear context** The introduction effectively outlines the scope of available data and the connection to project publications. The external link to Zenodo appropriately opens in a new tab. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ml --- # Datendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...atendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie... (DE_SENTENCE_WHITESPACE) --- [style] ~13-~13: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen? Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht... (IN_ZUSAMMENHANG_MIT) --- [uncategorized] ~13-~13: Hier scheint ein Satzzeichen überflüssig zu sein. Überlegen Sie, es zu löschen. Context: ... mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](https://zenodo.or... (AI_DE_GGEC_UNNECESSARY_PUNCTUATION_OPEN_BRACKET) --- [uncategorized] ~13-~13: Das sieht falsch aus. Überlegen Sie, es zu ersetzen. Context: ...schungsprojekt stehen, sind [auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="\_blank... (AI_DE_GGEC_REPLACEMENT_OTHER) --- [typographical] ~13-~13: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen Context: ...stadt-geschichte-basel){:target="\_blank"}. Die im Rahmen von Konferenzen und Wor... (DE_UNPAIRED_QUOTES) </details> </details> --- `1-60`: **Documentation changes are well-structured and comprehensive** The revisions have successfully transformed this into a more comprehensive data documentation that: - Clearly explains the data model and its implementation - Provides detailed EDTF documentation with practical examples - Maintains good organization and readability The changes align well with the PR objectives of enhancing the documentation. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ml --- # Datendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...atendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie... (DE_SENTENCE_WHITESPACE) --- [style] ~13-~13: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen? Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht... (IN_ZUSAMMENHANG_MIT) --- [uncategorized] ~13-~13: Hier scheint ein Satzzeichen überflüssig zu sein. Überlegen Sie, es zu löschen. Context: ... mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](https://zenodo.or... (AI_DE_GGEC_UNNECESSARY_PUNCTUATION_OPEN_BRACKET) --- [uncategorized] ~13-~13: Das sieht falsch aus. Überlegen Sie, es zu ersetzen. Context: ...schungsprojekt stehen, sind [auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="\_blank... (AI_DE_GGEC_REPLACEMENT_OTHER) --- [typographical] ~13-~13: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen Context: ...stadt-geschichte-basel){:target="\_blank"}. Die im Rahmen von Konferenzen und Wor... (DE_UNPAIRED_QUOTES) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ... für Forschungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforder... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforderungen ... (DE_SENTENCE_WHITESPACE) --- [uncategorized] ~17-~17: Hier scheint es einen Tippfehler zu geben. Überlegen Sie, ihn zu korrigieren. Context: ...ss) folgen dem [Handbuch zur Erstellung diskriminerungsfreier Metadaten für historische Quellen und F... (AI_DE_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELL) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...ie-metadaten/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende G... (DE_SENTENCE_WHITESPACE) --- [whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein. Context: ...n/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende Grafik ... (DE_SENTENCE_WHITESPACE) --- [typographical] ~21-~21: Vor Einheitenzeichen sollte ein Leerzeichen gesetzt werden. Context: ...g/sgb_datamodel.svg){:style="max-width: 70%; display: block; margin: auto;"} ## ED... (EINHEIT_LEERZEICHEN) --- [uncategorized] ~27-~27: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...kmale sind: 1. **Einfache Datumsangaben** Wie bei ISO 8601 üblich, kann man präzis... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [uncategorized] ~30-~30: Hier scheint es einen Fehler zu geben. Context: ...024`. 2. **Ungewisse und ungefähre Daten** Mit speziellen Zeichen lässt sich angeben, ... (AI_DE_MERGED_MATCH) --- [uncategorized] ~31-~31: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...in Datum nur ungefähr oder unsicher ist: - `?` kennzeichnet Unsicherheit (z. B. `1960?`... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [typographical] ~39-~39: Zwei aufeinander folgende Punkte. Auch wenn ein Satz mit einer Abkürzung endet, endet er nur mit einem Punkt (§103 Regelwerk). Context: ...950. - Unvollständige Intervalle wie `1900/..` oder `../1950` drücken offene Zeiträum... (DE_DOUBLE_PUNCTUATION) --- [uncategorized] ~42-~42: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: .../1950?`. 4. **Listen und Sets von Daten** Man kann mehrere mögliche oder relevante... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [style] ~43-~43: Diese Formulierung ist möglicherweise redundant. Die Wörter „können“ und „möglicherweise“ drücken dasselbe aus. Context: ... Sets von Daten** Man kann mehrere mögliche oder relevante Daten in einer Liste ang... (VERDOPPELUNG) --- [uncategorized] ~43-~43: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ... relevante Daten in einer Liste angeben: - Eine Liste wie `[1960, 1962, 1965]` bede... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [uncategorized] ~46-~46: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...n Daten. 5. **Jahreszeiten und Quartale** EDTF erlaubt die Angabe von Jahreszeiten... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [uncategorized] ~47-~47: Das sieht falsch platziert oder unnötig aus. Überlegen Sie, es zu löschen. Context: ...hen Zusammenhängen relevant sein können: - `1960-33` stellt beispielsweise die Angabe „Erstes... (AI_DE_GGEC_UNNECESSARY_SPACE) --- [style] ~48-~48: Der Ausdruck ‚beispielsweise‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen? Context: ...vant sein können: - `1960-33` stellt beispielsweise die Angabe „Erstes Quartal des Jahres 1... (ZUM_BEISPIEL_STYLE) --- [uncategorized] ~50-~50: Diese Verbform sieht falsch aus. Überlegen Sie, sie zu ersetzen. Context: ...uen Entsprechungen von Zeiten und Codes ist in der Spezifikation des EDTF-Standards... (AI_DE_GGEC_REPLACEMENT_VERB_FORM) --- [typographical] ~60-~60: Wenn ‚sowie‘ als Ersatz für ‚und‘ verwendet wird, dann wird kein Komma gesetzt. Context: ...ärfen, komplexen Zeiträumen und offenen Enden, sowie die Angabe von Mengen, Intervallen oder... (KEIN_KOMMA_VOR_SOWIE) </details> </details> </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
pages/data.md (5)
7-9
: Consider improving paragraph structureConsider adding a line break after the heading for better readability. The content itself is well-structured and clear.
# Datendokumentation + Die Stadt.Geschichte.Basel macht projektbezogene Daten...
🧰 Tools
🪛 LanguageTool
[whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ml --- # Datendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve...(DE_SENTENCE_WHITESPACE)
[whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...atendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie...(DE_SENTENCE_WHITESPACE)
13-13
: Enhance external link securityFor links opening in new tabs, consider adding
rel="noopener noreferrer"
for security:-[auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="_blank"} +[auf Zenodo archiviert](https://zenodo.org/communities/stadt-geschichte-basel){:target="_blank" rel="noopener noreferrer"}🧰 Tools
🪛 LanguageTool
[style] ~13-~13: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen?
Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht...(IN_ZUSAMMENHANG_MIT)
[typographical] ~13-~13: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...stadt-geschichte-basel){:target="_blank"}. Die im Rahmen von Konferenzen und Wor...(DE_UNPAIRED_QUOTES)
21-21
: Enhance image accessibilityConsider providing a more descriptive alt text for the data model diagram:
-![Datenmodell](assets/img/sgb_datamodel.svg){:style="max-width: 70%; display: block; margin: auto;"} +![Datenmodell der Stadt.Geschichte.Basel mit Metadatenfeldern und Medienobjekt-Beziehungen](assets/img/sgb_datamodel.svg){:style="max-width: 70%; display: block; margin: auto;"}🧰 Tools
🪛 LanguageTool
[typographical] ~21-~21: Vor Einheitenzeichen sollte ein Leerzeichen gesetzt werden.
Context: ...g/sgb_datamodel.svg){:style="max-width: 70%; display: block; margin: auto;"} ## ED...(EINHEIT_LEERZEICHEN)
41-41
: Fix ellipsis in code examplesFor consistency and clarity in code examples, consider using three dots without slashes:
-`1900/..` oder `../1950` +`1900...` oder `...1950`🧰 Tools
🪛 LanguageTool
[typographical] ~41-~41: Zwei aufeinander folgende Punkte. Auch wenn ein Satz mit einer Abkürzung endet, endet er nur mit einem Punkt (§103 Regelwerk).
Context: ...950. - Unvollständige Intervalle wie1900/..
oder../1950
drücken offene Zeiträum...(DE_DOUBLE_PUNCTUATION)
64-64
: Fix German grammar: Remove comma before "sowie"According to German grammar rules, no comma should be placed before "sowie" when used as a replacement for "und":
-komplexen Zeiträumen und offenen Enden, sowie die Angabe +komplexen Zeiträumen und offenen Enden sowie die Angabe🧰 Tools
🪛 LanguageTool
[typographical] ~64-~64: Wenn ‚sowie‘ als Ersatz für ‚und‘ verwendet wird, dann wird kein Komma gesetzt.
Context: ...ärfen, komplexen Zeiträumen und offenen Enden, sowie die Angabe von Mengen, Intervallen oder...(KEIN_KOMMA_VOR_SOWIE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
pages/data.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/data.md
[whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ml --- # Datendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in ve...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~9-~9: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...atendokumentation Die Stadt.Geschichte.Basel macht projektbezogene Daten in verschie...
(DE_SENTENCE_WHITESPACE)
[style] ~13-~13: Der Ausdruck ‚im Zusammenhang mit‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen?
Context: ...ssenschaftliche Veröffentlichungen, die im Zusammenhang mit dem Forschungsprojekt stehen, sind [auf Zenodo archiviert](ht...
(IN_ZUSAMMENHANG_MIT)
[typographical] ~13-~13: Zeichen ohne sein Gegenstück: ‚"‘ scheint zu fehlen
Context: ...stadt-geschichte-basel){:target="_blank"}. Die im Rahmen von Konferenzen und Wor...
(DE_UNPAIRED_QUOTES)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ... für Forschungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforder...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ungdatenmanagement der Stadt.Geschichte.Basel entwickelt wurde, um den Anforderungen ...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...ie-metadaten/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende G...
(DE_SENTENCE_WHITESPACE)
[whitespace] ~17-~17: Fügen Sie zwischen Sätzen ein Leerzeichen ein.
Context: ...n/), das ebenfalls von Stadt.Geschichte.Basel entwickelt wurde. Die folgende Grafik ...
(DE_SENTENCE_WHITESPACE)
[typographical] ~21-~21: Vor Einheitenzeichen sollte ein Leerzeichen gesetzt werden.
Context: ...g/sgb_datamodel.svg){:style="max-width: 70%; display: block; margin: auto;"} ## ED...
(EINHEIT_LEERZEICHEN)
[style] ~31-~31: Wenn ‚lässt‘ im Sinne von ‚können‘ gemeint ist, ist es möglicherweise stilistisch besser, eine weniger umgangssprachliche Formulierung zu benutzen.
Context: ...hre Daten** Mit speziellen Zeichen lässt sich angeben, wenn ein Datum nur ungefähr oder unsic...
(LASSEN_SICH_VERINF_STIL)
[typographical] ~41-~41: Zwei aufeinander folgende Punkte. Auch wenn ein Satz mit einer Abkürzung endet, endet er nur mit einem Punkt (§103 Regelwerk).
Context: ...950. - Unvollständige Intervalle wie 1900/..
oder ../1950
drücken offene Zeiträum...
(DE_DOUBLE_PUNCTUATION)
[style] ~45-~45: Diese Formulierung ist möglicherweise redundant. Die Wörter „können“ und „möglicherweise“ drücken dasselbe aus.
Context: ... Sets von Daten** Man kann mehrere mögliche oder relevante Daten in einer Liste ang...
(VERDOPPELUNG)
[style] ~52-~52: Der Ausdruck ‚beispielsweise‘ kommt sehr häufig vor. Möchten Sie ihn durch eine Alternative ersetzen, um Ihren Text individueller zu machen?
Context: ...ant sein können: - 1960-33
stellt beispielsweise die Angabe „Erstes Quartal des Jahres 1...
(ZUM_BEISPIEL_STYLE)
[typographical] ~64-~64: Wenn ‚sowie‘ als Ersatz für ‚und‘ verwendet wird, dann wird kein Komma gesetzt.
Context: ...ärfen, komplexen Zeiträumen und offenen Enden, sowie die Angabe von Mengen, Intervallen oder...
(KEIN_KOMMA_VOR_SOWIE)
🔇 Additional comments (1)
pages/data.md (1)
2-3
: LGTM: Front matter changes are consistent
The changes to title, layout, and permalink are properly formatted and align with the PR objectives.
Pull request
Proposed changes
solves #195
Types of changes
Checklist
Summary by CodeRabbit