Documentation Tool

Primary tabs

Submitted by H5P Group on Fri, 06/12/2015 - 13:45

A free HTML5 based content type allowing authors to create guides for structured writing processes with H5P in publishing systems like Canvas, Brightspace, Blackboard, Moodle and WordPress.

Would you like to create content like this on your own?

Get started

Register on H5P.com to start creating H5P Interactive content. Your content can be accessed via direct link, embeded, or inserted into any learning management system that supports LTI integration.

Description

The documentation tool aims to make it easy to create assessment wizards for goal driven activities. It can also be used as a form wizard.

While editing, the author can add multiple steps to the wizard. In each step, the author can define which content goes into that step. Content can be plain text, input fields, goal definition and goal assessment. 

Once published, the end user will be taken through the steps of the wizard. On the last step of the wizard, the user can generate a document with all the input that has been submitted. This document can be downloaded.

The Documentation tool is fully responsive and works great on smaller screens as well as on your desktop. 

Learn how to create Documentation tool in this tutorial.

New to H5P? Read the installation guide to get H5P on your own site.

Comments

audraj

Mon, 08/21/2017 - 13:29

Hi fnoks,

So when would it work? Can you point me in the direction to find this? Also can it be added with JS or a shortcode to work with the Documentation Tool? 

I'm trying to create a form that a student could fill out like a workbook and come back to it. Can you make another suggestion to get this done using H5P?

Thanks!

Audra

tim's picture

tim

Tue, 08/22/2017 - 09:18

Hi Audra, the solution has not been developed yet. If you have access to a developer you could ask her to modify the code:

https://github.com/h5p/h5p-documentation-tool

Caro_digital

Tue, 11/14/2017 - 16:26

Thank you so much for all this amazing tools making education progressiv!

The function for "saving content state" would be so necessary. I think it is one of the most important function for a documentation tool to use it gradually beside the porcess. Looking forward to your great work!!!

icc's picture

icc

Wed, 11/15/2017 - 11:23

This seems to be on its way: HFP-1420
Probably in the next release if everything goes OK.

stopbit's picture

stopbit

Wed, 10/04/2017 - 13:52

Hi,

I have been creating a documentation tool activity. I notice the page scroll does not work (or full content is not displayed) in certain conditions.

I created three activities to illustrate this bug.

  1. https://h5p.org/node/123000 - Scroll does not work
  2. https://h5p.org/node/123005 - Scroll does work!
  3. https://h5p.org/node/123006 - Scroll does not work

Starting at 1 above: I created two pages- A standard page with 5 input fields, then a second page with textual content.

The second page is long enough that content is too long for the page, yet no scrolling is offered; or the h5p container does not expand to display the content.

Looking at example 2 above: I changed the order of the pages. Now the h5p container is lengthened to show all page content, yay!

Still problems if I need to add more pages however.....

Looking at example 3 above: I kept the page order which worked in example 2, but then added a new page and positioned this to be the first page.

The problem persists where the second page, which is lengthy does not expand to display the full content; or no page scroll is offered.

I notice this only becomes a problem when using Input Fields before a a page with lengthy content. Behaviour is ok if you don't use the input fields, but the point is I need input fields otherwise this activity doesn't fulfill it function correctly.

So it appears that everything is  fine if you have lengthy content on the first page, but only the first page! IF you have lengthy content on following pages, the container will not expand to  display the full contents.

I would like to request immediate attention to this Bug as it renders the Documentation Tool useless in all but extremely simple use cases.

As I need to make something quite complex I can't do so until this issue is corrected.

I don't mind editing the code on my site whilst we await a  fix, if anyone has a clue how to resolve this?

Many thanks for any help on this one.

 

icc's picture

icc

Wed, 10/04/2017 - 13:28

Thank you for reporting this issue. I've created a ticket to get it fixed as soon as possible: HFP-1566

stopbit's picture

stopbit

Wed, 10/04/2017 - 13:49

Hi ICC, That's great - thank you!

Eagerly awaiting ;-)

 

stopbit's picture

stopbit

Wed, 10/04/2017 - 17:04

Hi,

Version 1.5.2 of Documentational Tool can be fixed with just 1 line of code!

The quick fix is a single line of code that seems to have been removed from the Git years ago and then re-added back in recently, although this line is not in the current release.

The file to edit: wp-content/uploads/h5p/libraries/H5P.DocumentationTool-1.5/documentation-tool.js

Under line no. 178, add this single line of code:

 170.   this.$pagesArray.eq(this.currentPageIndex).removeClass('current');
 171.    this.currentPageIndex = toPageIndex;
 172.    this.$pagesArray.eq(this.currentPageIndex).addClass('current');
 173.
 174.    // Update navigation menu
 175.    this.navigationMenu.updateNavigationMenu(this.currentPageIndex);
 176.
 177.    // Scroll to top
 178.    this.scrollToTop();
 179.    self.trigger('resize');

I had to delete the entire library + my contents, re-zipped the files and renamed to .h5p file extension. I then uploaded the library manually.

Hey Presto! The problem is rectified.

Not sure why this important line of code was ever removed, putting it back fixes the issue.

 

This was very easy to fix, but a nightmare to edit. H5P does not allow you to modify javascript file on the fly. Can we please do something about this as it makes development and code fixes a real pain. Having to delete libraries after content has been made with them causes problems.

thomasmars's picture

thomasmars

Thu, 10/05/2017 - 11:12

Hi,
Thank you for highlighting this, the bug has already been fixed in a previous commit though: 179929. It is just going through regression testing before being released.
The problem with editing javascript on the fly is that you will lose your changes when you update libraries because it will be impossible to reconciliate your local changes with the official code in the new release, so we do not recommend this. If you have to change functionality in a library please first consider providing a pull request, and secondly if you need it locally use a hook to modify the javascript.

Thanks for your feedback :) Hope you'll be happy with the changes to Documentation Tool when we release the next version.

meravjon

Tue, 11/28/2017 - 10:08

Fisrt thanks to great features.

I was thinking to make a complete test which involves free text that student can insert and also other features like: fill the blank, drag and drop atc.

As I understand this is the only feature that alows free text and that a student can fill his answers and send a copy to his taecher. How ever this feature doesn't alow to combine other features (like in the Question set). Is there any way to do so?

BV52's picture

BV52

Wed, 11/29/2017 - 07:31

Hi meravjon,

This is can be done by following the steps in this documentation or you can post a full feature request in the Feature Request forum.

-BV52

jeaniyoung

Tue, 12/05/2017 - 20:11

In this demo the red star is labeled as yes-complete and the green star as not complete but the report shows them as the opposite of that (which is what one would expect) I know you can set it yourself when you make your own but just thought someone might want to fix the demo. :-)

BV52's picture

BV52

Wed, 12/06/2017 - 08:50

Hi jeaniyoung,

Thank you for pointing that out. :-) We will fix it as soon as possible.

-BV52

isratransfer

Wed, 03/07/2018 - 10:24

hello, please forgive me, i'm terribly new to this stuff - i think this tool is amazing and exactly what we need, but not sure how to add it to our "summary" that we are creating.  is there anyway someone may be able to give me a roadmap about how to implement this?

BV52's picture

BV52

Thu, 03/08/2018 - 09:36

Hi isratransfer,

I've sent a reply to your e-mail.

-BV52

brenda.harralso...

Wed, 03/21/2018 - 01:58

We are using the Documentation Tool with LearnDash for a course in which we want to capture learner data to be emailed to the instructor upon completion.  Is print/download the only option for the final document? 

BV52's picture

BV52

Wed, 03/21/2018 - 03:33

Hi Brenda,

H5P emits data in the form of xAPI statements and you will need a plugin or custom code to listen to these statements and a data store such as a learning record store to save them in.

I highly recommend looking through these documentation:

 

https://h5p.org/documentation/x-api

 

https://h5p.org/documentation/for-authors/analyzing-results-and-answers

 

-BV52

petafayc

Tue, 05/01/2018 - 04:38

Hi all, 

I just noticed that this option is not available when creating an interactive object on H5P.org. Is it only available when you install H5P in a Moodle/Drupal/Wordpress site? 

Thanks. 

BV52's picture

BV52

Tue, 05/01/2018 - 04:48

Hi petafayc,

All contents should be available both for this site and the plugins. Can you try going to the Access All Content types site and see if this will resolve the issue.

-BV52

Alliqua

Thu, 08/09/2018 - 14:34

Hello H5P-Team,

great tool, I also have got the same problem, that  "goals" are not listed in the export-document. I use the Chrome-Browser. What am I doing wrong?

Best regards 

Anke 

BV52's picture

BV52

Fri, 08/10/2018 - 03:59

Hi Anke,

This happens when either you do not have a Goals Assessment page or the assessment is blank. Although I think the goals should still be part of the report in the said scenario. There is a bug report that I filed and you follow the progress here.

-BV52

buylov

Sun, 08/26/2018 - 20:39

Hello guys,

I did not find a way to translate words:

  • Possible ratings
  • Goals
  • Rating

Please tell how to translate them?

BV52's picture

BV52

Mon, 08/27/2018 - 07:19

Hi buylov,

Translating the content through the editor is not possible. But you can follow this documentation on how to translate a content.

-BV52

buylov

Mon, 08/27/2018 - 09:43

Hi,

I tried to translate the files in the library, but did not find where the required words are contained. Can you tell me where to find them?

otacke's picture

otacke

Tue, 08/28/2018 - 09:13

Hi buylov!

Are you referring to documentation tool? The language files reside at https://github.com/h5p/h5p-documentation-tool/tree/master/language. For sub content such as the goals page, you'd have to go to the corresponding repository.

If you're looking for the file on your system, this will depend on the host system that you're using:

  • Drupal: <drupal>/sites/default/files/h5p/libraries
  • WordPress: <wordpress>/wp-content/uploads/h5p/libraries
  • moodle: </moodle>/moodledata/filedir (here the moodleAPI hashes the filesnames, so you would need to query the database to figure out the location and filename)

Please note that modifications to the language files will not survive updates of the library, will not appear unless you clear the cache, and will only work for newly created content.

Cheers,

Oliver

buylov

Tue, 08/28/2018 - 09:57

Hi Oliver,

but the translation repository (https://github.com/h5p/h5p-documentation-tool/tree/master/language) does not have the words I need:

  • Possible ratings
  • Goals
  • Rating

I'm familiar with how to translate H5P, but I did not find where these words are contained for translation.

otacke's picture

otacke

Tue, 08/28/2018 - 10:02

Hi buylov!

As I mentioned, the Documentation tool uses other libraries (split for maintainability and reusability elswhere). That's "Standard Page", "Goals Page", "Goals Assessment Page" and "Document Export Page". You will find those on github, too. Note: These might use other libraries themselves as well.

Cheers,
Oliver

buylov

Tue, 08/28/2018 - 10:28

Oliver,

I found these words in the repository: https://github.com/h5p/h5p-goals-assessment-page

in a file: https://github.com/h5p/h5p-goals-assessment-page/blob/master/goals-asses...

But the translation file does not. I have to rewrite the JS-script to translate?

otacke's picture

otacke

Wed, 08/29/2018 - 09:19

Hi buylov!

I've had a look at the Goals Assessment page. It seems the properties legendHeader, goalHeader and ratingHeader have not been added to the semantics, but they are used in the code. You don't have to touch JavaScript, but you'd have to complete semantics.json first (shouldn't be easy to figure out, but you can also look at the documentation), add the missing properties to all the language files (in English), and then you can modify individual languages.

If you do that, why not create a pull request so we can add your changes to the official code?

Best,
Oliver

jimlacey

Wed, 09/26/2018 - 06:21

Hi,

Aside from Questionnaire, are there any other h5p templates that support text input boxes? Ideally, I was hoping this would be an option within Presentation but I've been unable to find them anywhere but Documentation Tool and Questionnaire.

Thanks,

Jim

BV52's picture

BV52

Wed, 09/26/2018 - 07:22

Hi Jim,

The closest you can get for Course Presentation is the "Exportable Text Area" but afaik this does not send data than can be retrieved. A workaround is to use Interactive Video as a container within Course Presentaion and add a Free Text Activity. Here's a simple content that better explains this. Feel free to download it to check how I was able to achieve this.

-BV52

Charly

Mon, 10/01/2018 - 21:46


I installed and configured the application in Moodle of my University. Works correctly. However, it would be excellent if the application recorded the data so that at another time, we could continue with the capture to complete. One question: At this moment, when you finish with the form and you send it to him. Where does that mail go?

BV52's picture

BV52

Tue, 10/02/2018 - 07:35

Hi Charly,

You are correct this content does not save the data partially. I suggest that you head over to the Feature Request forum for this.

For your other question the results are sent to the Moodle Gradebook.

-BV52

Charly

Thu, 10/04/2018 - 18:39

Thanks for the response, I will make my request in that forum. Respect to my question, Indeed, I saw that the shipments are made directly to the Book of Qualifications. Now my question would be: How can I rate the document that each student sends?
BV52's picture

BV52

Fri, 10/05/2018 - 05:27

Hi Charly,

Once the student clicks on the submit button the content generates a report in the form of xAPI statements and you will need a plugin or custom code to listen to these statements and a data store such as a learning record store to save them in.

I highly recommend looking through these documentation:

 

https://h5p.org/documentation/x-api

https://h5p.org/documentation/for-authors/analyzing-results-and-answers

 

Please note though that this specific content only generates a report but will not allow you to manually place a grade on it unlike for example the Essay content type. I would suggest to include grading for this content in your feature request.

-BV52

Charly

Fri, 10/05/2018 - 19:24

Understood ... Thank you very much. Your comment helps me a lot and I will take it into account ... Regards

james-pearce-aerian

Mon, 10/15/2018 - 14:52

A client is using the H5P tool within a Drupal 7 site based on the Opigno LMS. A piece of content has been created using the Documentation tool. After a recent deployment the system is missing the library the documentation tool is requesting is missing. The library requested is 1.5.6, the library that is within the code on the server is 1.4. I have checked the github repo https://github.com/h5p/h5p-documentation-tool/tree/1.5.5 and it looks like there is no 1.5.6 tag. Opigno give the ability to upload new libraries in the h5p format, but I can't find a library in that format. Any suggestions ?

BV52's picture

BV52

Wed, 10/17/2018 - 01:08

Hi James,

Did you are anyone made local changes to the code of this specific content? 

-BV52

james-pearce-aerian

Wed, 10/17/2018 - 13:06

Hi, there have been no changes to the code for the documentation tool. We have made some changes to other modules - Course presentation and single choice question set. I assume those shoudn't affect the Documentation tool.

BV52's picture

BV52

Thu, 10/18/2018 - 10:02

Hi James,

You are correct those changes should not affect this content. I suggest to download the sample above and upload it to your system.

-BV52

james-pearce-aerian

Thu, 10/18/2018 - 12:16

Hi BV52, Sorry not sure which sample you mean, could you add a url that I can download. Thanks

BV52's picture

BV52

Thu, 10/18/2018 - 12:43

Hi James,

Sorry if I wasn't clear. What I mean was the sample at the top of this page.

-BV52

james-pearce-aerian

Mon, 10/22/2018 - 12:05

Hi, the fix you mentioned has resolved to a certain extent. The editor view of the document tool is now working, but when I visit on the front end the h5p document library (version 1.6) is still not available. Do you have any other suggestions for a solution. Thanks

BV52's picture

BV52

Tue, 10/23/2018 - 02:53

Hi James,

The version that you downloaded is version 1.6. I suggest that you refresh Drupal's cache. I'n not sure if it is the same with Opigno but it's located in configuration -> development -> performance.

-BV52

rachelgrz

Tue, 10/23/2018 - 21:40

Hello 

I included a standard page and a goals page but when i include and navigate to the Export Document page it only shows text on the 1st Standard page and not the input goals. What am i doing wrong?

BV52's picture

BV52

Wed, 10/24/2018 - 09:07

Hi rachelgrz,

The Goals page is tied with the Goals assessment page. If one of them is not included in the content the other one will not work completely.

-BV52

carolined

Wed, 01/30/2019 - 12:26

Hi,

I find this tool very interesting . Probably a lot of ways to use it 

My question : I would like to modify the height of the fields that user can fill. So it could be more comfortable for him. In which file can i do that ?

Any tip ?

thanks a lot

BV52's picture

BV52

Thu, 01/31/2019 - 03:01

Hi carolined,

The easiest way is to use a PHP hook, to add your own CSS-file to the content type. Please visit the Visual Changes page for more details.

 

-BV52

yuuca001

Tue, 02/05/2019 - 18:41

Hello, can i download the Document without the text-information and only with the answer ? My Problem is that everthing get´s downloaded that means the text + the answeres but i only want to create and download a document with the headlines and answers ?

 

Thank you!

BV52's picture

BV52

Wed, 02/06/2019 - 06:41

Hi yuuca001,

I'm afraid this is not possible not unless you make changes to the code.

-BV52

Pages

Feedback
Error | H5P – Create and Share Rich HTML5 Content and Applications

Error

The website encountered an unexpected error. Please try again later.