elog2labfolder/import_export.rst
author weiher
Thu, 11 Jan 2018 12:10:42 +0100
changeset 3 b71be85a294c
child 13 a21f3604f1db
permissions -rw-r--r--
Initial commit of labfolder at FHI documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     1
Import and export of projects and entries
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     2
=========================================
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     3
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     4
Import
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     5
------
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     6
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     7
The import of projects (from another labfolder instance or from another logbook software) is only possible via the labfolder API. An import of labfolder-own projects via webinterface is not possible to date. You can find the API documentation here:
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     8
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
     9
| Version 1: http://labfolder.rz-berlin.mpg.de:9091/api/v1
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    10
| Version 2: https://labfolder.rz-berlin.mpg.de/api/v2/docs/development.html
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    11
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    12
Version 2 is still in the development phase.
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    13
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    14
Export
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    15
------
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    16
Exporting projects (or just single entries) is possible in three different formats: PDF, XHTML and JSON. The export as PDF can be done from within a project ...
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    17
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    18
.. image:: _static/export_of_projects.png
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    19
   :width: 70 %
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    20
   :align: center
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    21
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    22
... or from the project overview (*Manage > Projects*):
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    23
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    24
.. image:: _static/export_of_projects2.png
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    25
   :width: 70 %
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    26
   :align: center
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    27
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    28
The XHTML export can be done via the settings:
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    29
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    30
.. image:: _static/export_xhtml.png
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    31
   :width: 70 %
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    32
   :align: center
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    33
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    34
However, to use this type of export it has to be installed first in the *Manage > Apps* section. By means of the XHTML export all projects that one owns will be exported. A detailled selection of projects or entries to be exported is not possible. As soon as the export process is finished a download link appears in the settings in *Data exports*. The downloadable ZIP file contains all images and files along with an index.html file that contains information about all entries. You could open and view the index.html file in a browser similar to the view in labfolder.
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    35
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    36
The JSON export is only useable via the API endpoint ``GET /entries``. However, at the moment the response only contains useful information such as dates and tags. The author name is hidden behind the author ID and the entry text content is completely missing.
b71be85a294c Initial commit of labfolder at FHI documentation
weiher
parents:
diff changeset
    37