Commit fe6cf851 authored by malzer's avatar malzer
Browse files

Update documentation

parent 6d24d445
......@@ -11,38 +11,7 @@ The Datasheet Editor
The DARIAH-DE Datasheet Editor is accessible at https://geobrowser.de.dariah.eu/edit or by clicking “Datasheet Editor” on Geo-Browser. The Geo-Browser is documented in the tutorial :doc:`DARIAH-DE Geo-Browser <geobrowser>`.
Further information on the Geo-Browser and Datasheet Editor you can find at `DARIAH-DE Portal <https://de.dariah.eu/geobrowser>`__.
What's new in version 3.6?
--------------------------
.. note::
With the current version 3.6 of the DARIAH-DE Geo-Browser and Datasheet Editor some changes took place mainly affecting authentication, authorization, and accessibility:
**AAI (Authentication & Authorization)**: With version 3.6 of Geo-Browser and Datasheet Editor the DARIAH-DE OwnStorage is used to store your datasets! That makes the usage of the Geo-Browser and Datasheet Editor more secure, and you can work on your datasets privately until your dataset is complete and working, and then you can share it with the world. To store your datasets to the DARIAH-DE OwnStorage, you will have to log in (authenticate) via the DARIAH AAI using your DARIAH account or an eduGAIN federation account. Internally the Geo-Browser and Datasheet Editor are using the DARIAH-DE PDP and OAuth2 tokens for authorization.
**Accessibility**: The datasets stored in the OwnStorage are only accessible to the owners at first. Only they can read, write, delete, and share each of the datasets.
**Sharing and unsharing**: If you want to share your datasets, you can do so using the Datasheet Editor's “Manage your data“ box. The dataset shown in the table view will then become available for everyone to read. You can unshare the dataset any time you like. Sharing to and editing with a specific group of people is not yet possible.
**Identifiers and references**: The look of the dataset's IDs have slightly been changed: instead of *721203* the IDs now look like *EAEA0-7A23-E68F-EBC2-0*. The storages URL host and path of “old“ datasets stays https://geobrowser.de.dariah.eu/storage/. The new host and path of datasets will now be https://cdstar.de.dariah.eu/dariah/.
**URLs**: With the ID of your dataset and depending on the dataset's shared status you now can
1. directly access your shared datasets in the DARIAH-DE OwnStorage: https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0. This URL is used for storing and sharing a dataset. Please note: Only shared datasets can be downloaded using this URL!
2. access and edit your datasets in the Datasheet Editor: https://geobrowser.de.dariah.eu/edit?id=EAEA0-8BAC-F1F7-FB43-0. This is the link to the Datasheet Editor and your dataset to be edited.
3. view your dataset in the Geo-Browser if you are the owner of a private dataset or dataset has been shared: https://geobrowser.de.dariah.eu?csv1=https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0.
**Old dataset references**: All your „old“ dataset references will still be readable via their old URLs, such as https://geobrowser.de.dariah.eu/storage/721203. If you want to edit an old dataset, you could just migrate it to the OwnStorage and then edit it and share it if you want it to be publicly available:
1. Just call an old URL for editing with the Datasheet Editor including an old dataset storage ID, such as https://geobrowser.de.dariah.eu/edit?id=721203.
2. The old dataset is loaded and displayed read-only in the table view. You now can (i) download the old dataset as a CSV file using the download button, or (ii) create a new dataset automatically in the DARIAH-DE OwnStorage by clicking “Create new datasheet“. The newly created dataset will contain your old data and you then can edit and share it. The old dataset will not be touched.
Further information on the Geo-Browser and Datasheet Editor can be found at `DARIAH-DE Portal <https://de.dariah.eu/geobrowser>`__.
GUI documentation
-----------------
......@@ -266,14 +235,41 @@ Open with Geo-Browser
With this action the data from the datasheet can be opened in Geo-Browser. The entered locations are shown as points on the world map. The data is also shown below the world map in a list. If you shared your data, everyone is able to see it in the Geo-Browser. Otherwise, only you can see it.
The Geo-Browser documentation you can find here: :doc:`DARIAH-DE Geo-Browser <geobrowser>`.
The Geo-Browser documentation can be found here: :doc:`DARIAH-DE Geo-Browser <geobrowser>`.
Versions and Releases
---------------------
The current version of the DARIAH-DE Datasheet Editor is always accessible at https://geobrowser.de.dariah.eu/edit. The current version is Release version 3.6. We try to keep new versions compatible with older ones.
The current version of the DARIAH-DE Datasheet Editor is always accessible at https://geobrowser.de.dariah.eu/edit. We try to keep new versions compatible with older ones. Please note that there have been major changes in version 3.6.
.. note::
With version 3.6 of the DARIAH-DE Geo-Browser and Datasheet Editor some changes took place mainly affecting authentication, authorization, and accessibility:
**AAI (Authentication & Authorization)**: With version 3.6 of Geo-Browser and Datasheet Editor the DARIAH-DE OwnStorage is used to store your datasets! That makes the usage of the Geo-Browser and Datasheet Editor more secure, and you can work on your datasets privately until your dataset is complete and working, and then you can share it with the world. To store your datasets to the DARIAH-DE OwnStorage, you will have to log in (authenticate) via the DARIAH AAI using your DARIAH account or an eduGAIN federation account. Internally the Geo-Browser and Datasheet Editor are using the DARIAH-DE PDP and OAuth2 tokens for authorization.
**Accessibility**: The datasets stored in the OwnStorage are only accessible to the owners at first. Only they can read, write, delete, and share each of the datasets.
**Sharing and unsharing**: If you want to share your datasets, you can do so using the Datasheet Editor's “Manage your data“ box. The dataset shown in the table view will then become available for everyone to read. You can unshare the dataset any time you like. Sharing to and editing with a specific group of people is not yet possible.
**Identifiers and references**: The look of the dataset's IDs have slightly been changed: instead of *721203* the IDs now look like *EAEA0-7A23-E68F-EBC2-0*. The storages URL host and path of “old“ datasets stays https://geobrowser.de.dariah.eu/storage/. The new host and path of datasets will now be https://cdstar.de.dariah.eu/dariah/.
**URLs**: With the ID of your dataset and depending on the dataset's shared status you now can
1. directly access your shared datasets in the DARIAH-DE OwnStorage: https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0. This URL is used for storing and sharing a dataset. Please note: Only shared datasets can be downloaded using this URL!
2. access and edit your datasets in the Datasheet Editor: https://geobrowser.de.dariah.eu/edit?id=EAEA0-8BAC-F1F7-FB43-0. This is the link to the Datasheet Editor and your dataset to be edited.
3. view your dataset in the Geo-Browser if you are the owner of a private dataset or dataset has been shared: https://geobrowser.de.dariah.eu?csv1=https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0.
**Old dataset references**: All your „old“ dataset references will still be readable via their old URLs, such as https://geobrowser.de.dariah.eu/storage/721203. If you want to edit an old dataset, you could just migrate it to the OwnStorage and then edit it and share it if you want it to be publicly available:
1. Just call an old URL for editing with the Datasheet Editor including an old dataset storage ID, such as https://geobrowser.de.dariah.eu/edit?id=721203.
2. The old dataset is loaded and displayed read-only in the table view. You now can (i) download the old dataset as a CSV file using the download button, or (ii) create a new dataset automatically in the DARIAH-DE OwnStorage by clicking “Create new datasheet“. The newly created dataset will contain your old data and you then can edit and share it. The old dataset will not be touched.
GIT Repository
......
......@@ -13,38 +13,7 @@ Der DARIAH-DE Datasheet Editor kann unter https://geobrowser.de.dariah.eu/edit o
Weitere Infos zu Geo-Browser und Datasheet Editor gibt es im `DARIAH-DE Portal <https://de.dariah.eu/geobrowser>`__.
Was ist neu in Version 3.6?
---------------------------
.. note::
Mit der vorliegenden Version 3.6 des DARIAH-DE Geo-Browsers und Datasheet Editors haben sich einige Dinge geändert, hauptsächlich betreffen diese Änderungen Authentifizierung, Autorisierung und den Zugriff auf die Daten.
**AAI (Authentifizierung & Autorisierung)**: In der kommenden Version 3.6 von Geo-Browser und Datasheet Editor wird der DARIAH-DE OwnStorage für die Speicherung der Datensätze genutzt. Dadurch wird die Nutzung von Geo-Browser und Datasheet Editor sicherer, und das Arbeiten an privaten Datensätzen wird so ermöglicht, bis diese bereit sind für ein Teilen mit der Welt. Um Datensätze im DARIAH-DE OwnStorage zu speichern, ist ein Login mit der DARIAH AAI nötig, entweder per DARIAH- oder eduGAIN-Föderations-Account. Intern benutzen Geo-Browser und Datasheet Editor den DARIAH-DE PDP und OAuth2 für die Autorisierung.
**Zugreifbarkeit**: Die Datensätze im OwnStorage sind zunächst nur für die Besitzer zugreifbar. Nur diese können ihre Datensätze lesen, schreiben, löschen und teilen.
**Sharing and unsharing**: Wenn Sie Ihre Datensätze mit andern teilen wollen, können Sie dies über die Box „Manage your data“ tun. Der Datensatz, der gerade in der Tabelle angezeigt wird, wird dann für jede und jeden zum Lesen freigegeben. Der Datensatz kann jederzeit von Ihnen mit der „unshare“-Funktion wieder privat geschaltet werden. Das Teilen eines Datensatzes zum gemeinsamen Bearbeiten ist zur Zeit nicht möglich.
**Identifier und URLs**: Das Format der IDs der Datensätze hat sich leicht geändert, anstatt *721203* haben die IDs nun das Format *EAEA0-7A23-E68F-EBC2-0*. Der Hostname und Pfad von „alten“ Datensätzen bleibt https://geobrowser.de.dariah.eu/storage/. Der neue Hostname und Pfad von Datensätzen ist nun https://cdstar.de.dariah.eu/dariah/.
**URLs**: Mit dem Identifier Ihrer Datensätze und abhängig vom Status derselben (privat oder geteilt), können Sie nun
1. direkt auf Ihre geteilten Datensätze im DARIAH-DE OwnStorage zugreifen: https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0. Diese URL wird zum Speichern und Teilen eines Datensatzes genutzt. Merke: Nur geteilte Datensätze können über diese URL heruntergeladen werden!
2. Ihre Datensätze im Datasheet Editor anzeigen und editieren: https://geobrowser.de.dariah.eu/edit?id=EAEA0-8BAC-F1F7-FB43-0. Dies ist der Link zum Datasheet Editor mit geladenem Datensatz.
3. Ihre Datensätze im Geo-Browser anzeigen, sofern Sie die Eigentümerin eines privaten Datensatzes sind oder der Datensatz geteilt wurde: https://geobrowser.de.dariah.eu?csv1=https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0.
**Referenzen auf alte Datensätze**: Alle „alten“ Datensatzreferenzen bleiben erhalten, wie etwa https://geobrowser.de.dariah.eu/storage/721203 und sind ab sofort nur noch lesbar und nicht mehr editierbar. Sollten Sie einen alten Datensatz editieren wollen, können Sie diesen in den neuen OwnStorage migrieren und dann dort editieren und teilen:
1. Rufen Sie einfach eine alte Storage ID mit dem Datasheet Editor: https://geobrowser.de.dariah.eu/edit?id=721203.
2. Der alte Datensatz wird nun nur lesbar in die Tabelle geladen und dort angezeigt. Sie können diesen nun (i) mit dem Download-Button als CSV-Datei herunterladen oder (ii) daraus einen Datensatz im OwnStorage durch Klicken von „Create new dataset“ erzeugen. Der neu erzeugte Datensatz enthält nun eine Kopie der Daten des alten Datensatzes und kann von Ihnen bearbeitet und geteilt werden. Der alte Datensatz wird nicht geändert.
GUI Dokumentation
GUI-Dokumentation
-----------------
......@@ -267,7 +236,34 @@ Die Geo-Browser-Dokumentation finden Sie hier: :doc:`DARIAH-DE Geo-Browser <geob
Versionen und Releases
----------------------
Die aktuelle Version des DARIAH-DE Datasheet Editors ist immer zu erreichen unter https://geobrowser.de.dariah.eu/edit. Die aktuelle Version ist Release Version 3.6. Wir versuchen, neue Versionen abwärtskompatibel zu halten.
Die aktuelle Version des DARIAH-DE Datasheet Editors ist immer zu erreichen unter https://geobrowser.de.dariah.eu/edit. Wir versuchen, neue Versionen abwärtskompatibel zu halten. Bitte beachten Sie, dass mit Version 3.6 einige größere Änderungen eingeführt wurden.
.. note::
Mit der Version 3.6 des DARIAH-DE Geo-Browsers und Datasheet Editors haben sich einige Dinge geändert, die hauptsächlich die Authentifizierung, Autorisierung und den Zugriff auf die Daten betreffen.
**AAI (Authentifizierung & Autorisierung)**: Ab Version 3.6 von Geo-Browser und Datasheet Editor wird der DARIAH-DE OwnStorage für die Speicherung der Datensätze genutzt. Dadurch wird die Nutzung von Geo-Browser und Datasheet Editor sicherer, und das Arbeiten an privaten Datensätzen wird so ermöglicht, bis diese bereit sind für ein Teilen mit der Welt. Um Datensätze im DARIAH-DE OwnStorage zu speichern, ist ein Login mit der DARIAH AAI nötig, entweder per DARIAH- oder eduGAIN-Föderations-Account. Intern benutzen Geo-Browser und Datasheet Editor den DARIAH-DE PDP und OAuth2 für die Autorisierung.
**Zugreifbarkeit**: Die Datensätze im OwnStorage sind zunächst nur für die Besitzer zugreifbar. Nur diese können ihre Datensätze lesen, schreiben, löschen und teilen.
**Sharing and unsharing**: Wenn Sie Ihre Datensätze mit andern teilen wollen, können Sie dies über die Box „Manage your data“ tun. Der Datensatz, der gerade in der Tabelle angezeigt wird, wird dann für jede und jeden zum Lesen freigegeben. Der Datensatz kann jederzeit von Ihnen mit der „unshare“-Funktion wieder privat geschaltet werden. Das Teilen eines Datensatzes zum gemeinsamen Bearbeiten ist zur Zeit nicht möglich.
**Identifier und URLs**: Das Format der IDs der Datensätze hat sich leicht geändert, anstatt *721203* haben die IDs nun das Format *EAEA0-7A23-E68F-EBC2-0*. Der Hostname und Pfad von „alten“ Datensätzen bleibt https://geobrowser.de.dariah.eu/storage/. Der neue Hostname und Pfad von Datensätzen ist nun https://cdstar.de.dariah.eu/dariah/.
**URLs**: Mit dem Identifier Ihrer Datensätze und abhängig vom Status derselben (privat oder geteilt), können Sie nun
1. direkt auf Ihre geteilten Datensätze im DARIAH-DE OwnStorage zugreifen: https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0. Diese URL wird zum Speichern und Teilen eines Datensatzes genutzt. Merke: Nur geteilte Datensätze können über diese URL heruntergeladen werden!
2. Ihre Datensätze im Datasheet Editor anzeigen und editieren: https://geobrowser.de.dariah.eu/edit?id=EAEA0-8BAC-F1F7-FB43-0. Dies ist der Link zum Datasheet Editor mit geladenem Datensatz.
3. Ihre Datensätze im Geo-Browser anzeigen, sofern Sie die Eigentümerin eines privaten Datensatzes sind oder der Datensatz geteilt wurde: https://geobrowser.de.dariah.eu?csv1=https://cdstar.de.dariah.eu/dariah/EAEA0-8BAC-F1F7-FB43-0.
**Referenzen auf alte Datensätze**: Alle „alten“ Datensatzreferenzen bleiben erhalten, wie etwa https://geobrowser.de.dariah.eu/storage/721203 und sind ab sofort nur noch lesbar und nicht mehr editierbar. Sollten Sie einen alten Datensatz editieren wollen, können Sie diesen in den neuen OwnStorage migrieren und dann dort editieren und teilen:
1. Rufen Sie einfach eine alte Storage ID mit dem Datasheet Editor: https://geobrowser.de.dariah.eu/edit?id=721203.
2. Der alte Datensatz wird nun nur lesbar in die Tabelle geladen und dort angezeigt. Sie können diesen nun (i) mit dem Download-Button als CSV-Datei herunterladen oder (ii) daraus einen Datensatz im OwnStorage durch Klicken von „Create new dataset“ erzeugen. Der neu erzeugte Datensatz enthält nun eine Kopie der Daten des alten Datensatzes und kann von Ihnen bearbeitet und geteilt werden. Der alte Datensatz wird nicht geändert.
GIT Repository
......
......@@ -204,9 +204,9 @@ Die Karte der Römischen Imperiums (`Digital Atlas of the Roman Empire <https://
Versionierung and Release
-------------------------
Die aktuelle Version des DARIAH-DE Geo-Browsers ist zu erreichen unter https://geobrowser.de.dariah.eu. Seit November 2020 ist das die Release Version 3.6.
Die aktuelle Version des DARIAH-DE Geo-Browsers ist zu erreichen unter https://geobrowser.de.dariah.eu.
Die Änderungen in neuen Versionen sind im `CHANGELOD <https://projects.gwdg.de/projects/geo-browser/repository/revisions/master/entry/CHANGELOG.md>`_ verfügbar, das direkt im `GIT Repository des Geo-Browsers <https://projects.gwdg.de/projects/geo-browser/repository>`_ vorliegt.
Die Änderungen in neuen Versionen sind im CHANGELOG verfügbar, das direkt im `GIT Repository des Geo-Browsers <https://projects.gwdg.de/projects/geo-browser/repository>`_ vorliegt.
Spezifizierungen für die Nutzung
......
......@@ -207,9 +207,9 @@ The map of the Roman Empire (`Digital Atlas of the Roman Empire <https://dh.gu.s
Versions and Releases
---------------------
You can find the current version of the Geo-Browser here: https://geobrowser.de.dariah.eu. As of November 2020 we arrived at version 3.6.
You can find the current version of the Geo-Browser here: https://geobrowser.de.dariah.eu.
The `CHANGELOG <https://projects.gwdg.de/projects/geo-browser/repository/revisions/master/entry/CHANGELOG.md>`_ is available in the `GIT repository of the Geo-Browser <https://projects.gwdg.de/projects/geo-browser/repository>`_.
The CHANGELOG is available in the `GIT repository of the Geo-Browser <https://projects.gwdg.de/projects/geo-browser/repository>`_.
Specification for Use
......
......@@ -111,7 +111,7 @@
<div id="contentInner">
<p>Use the Datasheet Editor to prepare and setup your data to be visualized within the <a href="../index.html">DARIAH-DE Geo-Browser</a>. <strong>Create a new datasheet</strong> and add your data using copy'n'paste from Excel, Calc, and Numbers or <strong>Import a local CSV file</strong> from your drive. Then extract geocoordinates from your place names, and share datasets with the world. You data will be stored in the DARIAH-DE Storage and will only be available to everyone if explicitly shared by you.</p>
<div class="alert alert-info alert-block">
<p><strong><a href="https://geobrowser.de.dariah.eu/doc/datasheet.html" target="_blank">What's new in version 3.6?</a></strong> &nbsp; ...more: <strong><a href="https://geobrowser.de.dariah.eu/doc/datasheet.html#gui-documentation" target="_blank">GUI documentation – how does it work?</a></strong></p>
<p><strong><a href="https://geobrowser.de.dariah.eu/doc/datasheet.html#gui-documentation" target="_blank">GUI documentation – how does it work?</a></strong></p>
</div>
<div id="alertArea">
<p>
......
......@@ -13,7 +13,7 @@ module.exports = merge(baseConfig, {
DARIAH_STATUS_URL: JSON.stringify('https://dariah-de.github.io/status/dariah/embed.html'),
}),
new webpack.BannerPlugin({
version: version
banner: version
}),
new HtmlWebpackPlugin({
template: './index.html',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment