H5P

Introduction

Bugs & Wishes

Open or Pending

Create Item

1.2. Roadmap

1.2.1. Tiki 12-16

Create wiki syntax embed content from https://h5p.org/

{h5p url=https://h5p.org/h5p/embed/ id=617  allowfullscreen=y frameborder=0, width="1090" height="674"}

Later on, this wiki syntax can be used to embed H5P objects that live in Tiki (by omitting any value in url)

1.2.2. Tiki 17

• Integrate H5P to Tiki as a built-in feature (optional of course) (Fall 2016 for Tiki 17)
  • Submit the library to Packagist (Composer)
  • https://h5p.org/creating-your-own-h5p-plugin might help
  • We should find a way to re-use Tiki features and data
    • Be able to use Wiki Syntax in H5P text areas
    • Use images and videos stored in Tiki
  • Management, sharing and forking data like in https://profiles.tiki.org/CartoGraf and on h5p.org
• Roles (This will be a collaboration between H5P and Tiki)
  • Tiki: Xavier and Jonny
  • H5P: Thomas and Frode (+Svein-Tore)
• Timeline
  • November 2016: brainstorming / planning
  • Dec 2016 -> March 2017: development
  • April 2017: released as part of Tiki17

1.2.2.1. Desired fixes in 17.x branch

• H5P objects don't take on look and feel of Tiki site (which is not surprising as H5P is not using Bootstrap)

1.2.2.2. Fixes in 19.x branch 2019

• Fixed most (all) of the known bugs on loading content types as documented here item6516-H5P-Content-Creation-Bug
• Got the H5P Hub working (which means easier importing/installing of content types)
• To be backported to 18.x when tested

1.2.3. Phases & Milestones

1. Place files on svn
   • Get an experimental branch to play without fear of breaking too much things while learning, etc. done
2. Tiki implements the 2 well-documented H5P interfaces
3. Tiki explains to H5P how are users expected to use the system (=>where to place things, etc)
4. Questions on which part of the code goes
   • (in which folders in Tiki, since Tiki has the code splitted among several folders, compared to Wordpress, where the whole filetree for H5P is inside the plugins directory)
5. Replace H5P html purifier (GPL'd) with the one in Tiki (htmlpurifier library, which has a MIT-compatible license) so that there are no license issues to get H5P in Tiki.
   • http://htmlpurifier.org/
6. add basic feature: create, view upload
7. add next step: edit content
8. Tag system: reuse tiki freetags to expose/use h5p tags
   • https://doc.tiki.org/Tags + https://doc.tiki.org/File+Gallery
9. Document for end users
10. Assess Project

1.2.4. Long term

• Add recording to Tiki and H5P: https://github.com/spite/ccapture.js/ to replace the Java applet in http://doc.tiki.org/Screencast
• Add xAPI -> https://h5p.org/documentation/x-api
  • Tiki should become a Learning Record Store or a FLOSS solution picked for WikiSuite.
• Add animations
• Zoom in and zoom out

1.2.5. Meetings

• Periodicity of joint Tiki-H5P dev & follow up meetings?
  • Next: Dec Tue 20th, 2016. 10h UTC

1.3. FAQ

1.3.1. H5P Questions

• Code Repository:
  • svn repo structure in sourceforge.net
    • https://sourceforge.net/p/tikiwiki/code/HEAD/tree/
    • get access
      See:
      • https://dev.tiki.org/Commit
      • https://dev.tiki.org/How+to+get+commit+access
      • http://webchat.freenode.net/?channels=tikiwiki
  • some experimental branches can live in svn sf.net repo, or in git repos elsewhere, such as github:
    • https://github.com/Tikiorg

• Implement Interfaces, classes, databases (abstraction layer), system messages, etc.
  • Tiki: file Galleries + a few other cases:
    • Vimeo file (video file stored elsewhere which shows in Tiki as a local file)
      https://doc.tiki.org/PluginVimeo
    • Scorm
      https://doc.tiki.org/Scorm
  • Plugins: (shortcodes in wordpress; php class where you add some extra functionality and you can reuse anywhere in Tiki objects)

• How or where H5P should appear: Pages, Nodes, etc.
  • Tiki:
    • Wiki pages, or any other Tiki object with text areas: forums, tracker fields, blog posts, comments, etc.
    • Important libs and folders:
      • headerlib: to include external js jq files to be used within Tiki.
      • lib/core/H5P/index.php
      • lib/mime/mimetypes.php
      • lib/wiki-plugins/wiki-plugin_h5p.php
      • installer/schema/*.sql *.php (for installation and upgrades - patches)
    • Composer autoloader (used by Tiki)
    • Reference pages:
      • https://dev.tiki.org/Overview
      • https://dev.tiki.org/Hello+World
        (dev tutorial, a bit outdated in some sections, but a good starting point, probably)
    • Development Model (why some things in Tiki are how they are): https://tiki.org/Model

• Versioning and Upgrades
  • https://sourceforge.net/p/tikiwiki/code/HEAD/tree/trunk/composer.json
  • Upgrade system: sql patch and php-command patches (in installer/schema/*.sql & *.php)

• H5P will Package manager:
  • new way H5P will be working, to get libraries from h5p internet address.
  • and to reuse content, from a globally shared content repository
  • Maybe there should be an rsync from h5p content repository to composer.tiki.org or similar

• Where to ask questions
  • Realtime sync: IRC.
    • Info: https://tiki.org/Irc
    • Web log: https://irc.tiki.org
  • Async: developers list:
    • https://tiki.org/Lists
    • https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel

1.3.2. Experimental Branch H5P (svn in sf.net)

svn co https://svn.code.sf.net/p/tikiwiki/code/branches/experimental/h5p .

1.3.3. Git and SVN

1.3.4. Other Questions

1.3.4.1. Do we implement create view + upload mode and edit mode

• Yes, editing is essential

1.3.4.2. H5P zip file uploaded to Tiki, that is uncompressed server side, and must be placed somewhere

1. library
2. content: json and multimedia
   • Tiki: temp/ folder for the content
     • temp/h5p/ ? so that H5P can write there the web-writable files? (libraries and content)
     • vendor_custom/h5p/ ? so that H5P can write there the non-web-writable files? (libraries)
     • file gallery (folder on disk or database): images and other media files and content.