VISH Integration (Prototype)

Last modified by Caleb James DeLisle on 2016/10/19 15:47

cogDisplay data from XWiki in VISH and export VISH excursions to XWiki
TypeXAR
CategoryApplication
Developed by

Yann Flory

Rating
Rate!
1 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

VISH Integration

ViSH is a social and collaborative platform for creating and sharing knowledge resources for the realization of educational activities.

The VISH Integration application enables communication between a VISH instance and an XWiki instance.

What can be achieved with the application

The major part of this application is to add the ability to use images from XWiki (attachments) in a VISH excursion. You just have to click on the "XWiki" tabs in the VISH image selector, and use the search bar.
An empty search returns all the images available in XWiki, otherwise the results contains all the image whose name, wiki page or wiki space corresponds to the keywords used.

xwikitab.png

It is highly recommended to use a public XWiki if you want to use images from XWiki in VISH. If your wiki is private, you'll be able to use images as long as you are logged in in XWiki, but other people won't be able to see the images!

Depending on the VISH version used, it is also possible to export VISH excursions in XWiki. The result is stored as an attachment using the selected format (JSON or SCORM package), and multiple versions of the same project can be stored.
You can then see the list of all the exported packages for a specific excursion.

xwikiexport.png

In XWiki, you can also use the MOOC application to display your excursions and the exported documents in wiki pages and sorted with a livetable

xwikivish.png

How to use

VISH Installation

In order to be able to use all the features discribed above, you have to install our custom VISH platform available here (use the xwiki-config branch). The installation instruction are available in the VISH wiki.

Before starting VISH, you also have to enable the XWiki plugin by editing the VISH configuration at /config/application_config.yml
You just have to add the property xwiki_url in the mode you want to use (development, production or test), and set it to your wiki URL (e.g. "http://localhost:8080/xwiki/bin/view/")

You also have to install our Vish Editor with the XWiki plugin (use the xwiki-export branch) following the vish editor installation instruction.

Be careful to clone our custom repositories from Github (located in https://github.com/xwiki-labs ) and not the official repositories like explained in the VISH wiki!

XWiki configuration

In XWiki, you can install this application with the extension manager. You also have to configure some fields.
To do so, just go to the MOOC Editor section in the wiki administration and configure the two fields :

  • VISH server url : the domain and port used by your VISH instance. (e.g. http://vishub.org or http://localhost:3000)
  • Allowed spaces : the list of spaces where VISH is allowed to search for images. You probably don't want to see icons or technical images use in XWiki from your VISH Editor. If a space is selected, all its subspaces will also be used.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.1

Fix an issue with the avatars which were imported from a wrong excursion

Tags:
Created by Yann Flory on 2016/08/23 11:55
    

Get Connected