Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.89 KB

README-en.md

File metadata and controls

81 lines (55 loc) · 2.89 KB
Raw

Logo do Ceweb

Connected Didactic ePub

Area for the experiment development

GitHub license HTML5 CSS ECMAScript EPUB xAPI

Connected Didactic ePub is an experiment using Web standards, semantics, metadata, digital accessibility and APIs for data communication.

To use this model

For a quick and safe result, we recommend using the open code editor for ePub Sigil:

https://sigil-ebook.com/sigil/download/

To test the connection of educational data with xAPI

To share educational data, we use xAPI Standard API REST

https://xapi.com/overview/

As a repository of xAPI data, we use the open code LRS Learning Locker

https://github.com/LearningLocker/learninglocker

To test ePub accessibility

According to the recommendation on the DAISY consortium

https://daisy.org/activities/software/ace/

Publication credits

The ePub developed in this project derives from the PDF version of the publication Livro de Frações, developed by Projeto Livro Aberto de Matemática (OBMEP/IMPA).

What do I need to do to make it work?

The file .epub is ready to work in any electronic book reader that supports EPUB3 of W3C.

Some suggestions:

Thorium Reader https://www.edrlab.org/software/thorium-reader/

Lithium: Lithium: ePub reader https://play.google.com/store/apps/details?id=com.faultexception.reader&hl=pt_BR&gl=US

What should I edit to record the questions on the remote database?

In the file misc/credenciais.js you can edit students’ and teachers’ data, and the xAPI endpoint, provided by the LRS repository of your preference.

var aluno =   {
    "nome": "Student’s name",
    "email": "[email protected]"
}

var professor =   {
    "nome": "Teacher’s name",
    "email": "[email protected]"
}

var xapi ={
    headers: {
        "Content-Type": "application/json",
        "X-Experience-API-Version": "1.0.3",
        "Authorization": "Basic M2QzYTZiNWJkY2UyOWQ",
      },
      endpoint: "https://xapi.xyz/data/xAPI/statements"
}

Each of the chapters on the book has a script related to its interactivity. In this project, the credentials are already related to each script, but it is important to highlight that, for new books, you will also need to alter the .js files inside the folder misc/

Documentation about the project and a step-by-step of the installation process are available here