Commit f9969746 authored by Mathias Goebel's avatar Mathias Goebel 🎠
Browse files

Merge branch 'feature/extend-publish-docs-#5' into 'develop'

Extend publisher docs (closes #5)

Closes #5

See merge request !50
parents 18c0c556 fd150941
# Publish via the TextGridLab
Within the TextGridLab the SADE Publish-Plugin is needed for tranferring data to SADE easly. It is available via the [Marketplace](https://wiki.de.dariah.eu/display/TextGrid/Marketplace).
Within the TextGridLab the SADE Publish-Plugin is needed for tranferring data to
SADE easly. It is available via the [Marketplace](https://wiki.de.dariah.eu/display/TextGrid/Marketplace).
## Installation
![Marketplace Screenshot](~assets/docs/marketplace.png)
......@@ -11,15 +12,17 @@ server. Add the configuration via menu "Window" -> "Preferences"
![Preferences Screenshot](~assets/docs/preferences.png)
* __SADE Url:__ http://localhost:8080/exist/apps/textgrid-connect/publish/tutorial/
* __Authorized User:__ sade
* __SADE Url:__ http://localhost:8080/exist/apps/sade/publish.html
* __Authorized User:__ admin
* __Password:__
(leave the password empty)
(Leave the password empty for now, but keep in mind that any software not
secured with a proper password is a risk for the internet at large.)
## Usage
To publish data from the Lab to a SADE instance the SADE server must be up and
running.
running. If this is not the case so far, please start the server with `start.jar`
(Windows) or `bash bin/startup.sh`.
### Start the Publish tool
To start the SADE publisher use on of the following options:
......@@ -31,11 +34,12 @@ To start the SADE publisher use on of the following options:
The view should change to something like this:
![SADE-Publish Perspective Screenshot](~assets/docs/sade-publish2.png)
When using the [Navigator's](TGMANUAL on Navigator) context menu entry `Publish to SADE` when the tool is not active,
the item to be published will not be recognized by the Publisher.
When using the [Navigator's](https://wiki.de.dariah.eu/display/TextGrid/Navigator)
context menu entry `Publish to SADE` when the tool is not active, the item to be
published will not be recognized by the Publisher. You have to repeat the selection.
### Add items to publish
A context menu entry is added to the [Navigator](TGMANUAL on Navigator). So you
A context menu entry is added to the [Navigator](https://wiki.de.dariah.eu/display/TextGrid/Navigator). So you
can right-click on the item you want to publish and select `Publish to SADE`.
By holding `[CTRL]` or `[Shift]` you can select multiple items.
......@@ -48,3 +52,8 @@ will be sent to SADE.
### Starting the process
Click on the "Publish" button. Successfully transferred items will be highlighted
green. The "Log" contains all information to the process.
### Where to find your data
All published items can be found in the database at `/db/apps/sade/textgrid/`,
depending on which kind of object you have published. Published XML files are
available at `http://your-server/exist/apps/sade/textgrid:$URI`.
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