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.

And more

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

derekbryan

Sat, 02/09/2019 - 15:15

first time user

getting used to this very interesting tool

BV52

Mon, 02/11/2019 - 05:26

Hi derekbryan,Welcome to H5P

Hi derekbryan,

Welcome to H5P!

If you have any questions feel free to post in the forums.

-BV52

Paul Quicke

Thu, 02/21/2019 - 10:22

Hi Paul,I'm afraid this is

Hi Paul,

I'm afraid this is not possible. However you can post this as a feature request. In order for your feature request to attract as much interest as possible make sure it follows the below guidelines:

It is clear from every perspective how the feature will work. We recommend describing the feature with one or more user stories, for instance “As an author I want it to be possible to pick between different effects for the check answer animation so that the learners will see a variety of effects and also I can adapt the effects to my target audience(I’ll be using pink unicorns which works really well for both my target audience which are 4 year old girls and venture capitalists)”
If the feature can be illustrated with images or videos it always helps
Make it clear what content types this is relevant for, and or if this is a new content type

Make sure you post the feature in the Feature Request forum.

miriamr

Fri, 03/22/2019 - 02:37

Can't export a downloadable document

Hi, I've created a documentation tool in Moodle, and the 'export text' button isn't doing anything - i.e. I can't download a copy of the user input. Is there a setting I need to adjust?

Fri, 03/22/2019 - 21:18

Only the text and answers in

Only the text and answers in the text input field is exported. Does that help?

Emanuel Quim

Tue, 03/26/2019 - 02:58

Problemas con el boton enviar

Buenas noches, el boton de enviar en el documetation Tool funciona? o hay que configurarlo desde el codigo fuente? agradeceria su ayuda.

Wed, 03/27/2019 - 07:10

Hi Emanuel,The send button

Hi Emanuel,

The send button works all you need to do is to make sure that something catches the data. This would be in the form of an LRS. You can read more about scoring and analytics in the following documents:

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

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

CharlesElliott

Wed, 04/03/2019 - 14:34

"Submit" button

Where does the document go when you click on the Submit button? It says that it has been submitted but I can't tell where the document goes after that?

Thu, 04/04/2019 - 05:29

Hi CharlesElliott,The submit

Hi CharlesElliott,

The submit button sends the answers as xAPI statements which needs an LRS to capture them. If you are creating your contents in H5P.org I'm afraid it doesn't go anywhere. To capture the results you need to use one of the three supported frameworks. You can also read more about analizing results in the documentation below:

dmix

Mon, 01/25/2021 - 17:06

H5P Documentation Tool Submit Button Missing

Can you tell me how to enable the submit button in Moodle 3.9? I see the export button but no submit button.

Tue, 01/26/2021 - 18:03

Hi dmix,Would you mind

Hi dmix,

Would you mind reposting your question in the forums. When posting please uploa content so that we can check. Afaik there is no way of diabling the export button within the settings of the documentation tool.

-BV

frankofem

Sat, 05/18/2019 - 15:36

Unable to save "Document Export Page"

Hi,
I use WordPress for my website and am able to use the documentation tool for "Standard page", "Goals page" and "Goals assessment page" . These 3 pages update easily and are responsive when previewed. But when I add "Documentation Export Page", and update it returns "404 / Page not found error".
Please, how can this be corrected?

Cheers
Frank

Mon, 05/20/2019 - 06:19

Hi Frank,Could you please

Hi Frank,

Could you please check for errors in browser console.

Harrold

Tue, 11/12/2019 - 10:38

Can this tool store the feed by different people on wordpress?

Hello,

I want to know if the Documentation tool can store the inputs from different users on wordpress, which can later be reviewed and evaluated by the author.

Tue, 11/12/2019 - 17:39

Hi Harrold,Yes it can, H5P

Hi Harrold,

Yes it can, 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:

abderrazek

Wed, 12/25/2019 - 23:29

clarifications

The problem is still there

When When downloading the file into .docx

some data it disappears, especially related to the goals / Objectives

Wed, 12/25/2019 - 23:33

Hi abderrazek,Would you mind

Hi abderrazek,

Would you mind posting this in the Bugs in content types forum. Please provide as much information from the suggested template and attach a sample content.

SallyID

Thu, 02/20/2020 - 15:07

submit in moodle

Hello, I have added this as an HP activity in Moodle. I am liking it so far except I am not sure where the Form goes when the user hits submit? Who has access to it and where is it stored now? Can I have the submit button basically email the form to the user? Thank you.

Thu, 02/20/2020 - 17:53

Hi SallyID,You should see

Hi SallyID,

You should see them in Moodle's Gradebook, teachers, authors and admins should have access to those information. In regards to the submit button trigerring an e-mail with the results to be sent to users, there needs to be some changes/additions to the code for this to happen.

elihardiehowes

Thu, 02/27/2020 - 20:36

Doesn't allow apostrophe.

Hey, when I use an apostrophe in the 'Placeholder text' field it comes out strange. E.g. wouldn't = would't

How would I insert an apostrophe here?

Thu, 02/27/2020 - 23:42

Hi elihardiehowes,There is an

Hi elihardiehowes,

There is an existing bug report for this issue.

Fri, 02/28/2020 - 21:06

Thank you. Am I right in

Thank you. Am I right in thinking this bug was flagged March 20, 2018? In that case it looks like it has been forgotten. Is there actually a chance of it being fixed or should I look for an alternative?

Fri, 02/28/2020 - 23:26

Hi elihardiehowes,You are

You are correct with the date. I don't think it has been forgotten, the core team is quite small and cannot get to all the bugs and feature requests. They usually prioritize bugs that affect the main functionalities of the contents.

Sat, 02/29/2020 - 18:23

I understand. Thank you

kennethpf

Sun, 07/05/2020 - 19:11

Evaluation

Two questions:

1. For Goal Assessment Page - i can create two of them. But it seems like the latest entry would erase the previous entry. Is that preventable? e.g., if you want students to rate "how well you did your goal" and "how happy you are with your efforts"?

2. If the students hit "submit" twice using the same form,it seems that the latest entry as a report automatically erase the previous entry under the gradebook. Is that also preventable?

Mon, 07/06/2020 - 18:32

Hi kennethpf,No this is not

Hi kennethpf,

No this is not possible, the Documentation Tool was not designed to have 2 goal assessment page. But I can see the use case from your description. I would suggest that you post this as a feature request.
In order for your feature request to attract as much interest as possible make sure it follows the below guidelines:
1. It is clear from every perspective how the feature will work. We recommend describing the feature with one or more user stories, for instance “As an author, I want it to be possible to pick between different effects for the check answer animation so that the learner will see a variety of effects and also I can adapt the effects to my target audience(I’ll be using pink unicorns which works really well for both my target audience which are 4 year old girls and venture capitalists)”
2. If the feature can be illustrated with images or videos it always helps
3. Make it clear what content types this is relevant for, and or if this is a new content type
Make sure you post the feature in the Feature Request forum.
I'm afraid this is not possible as well.

scil_iwp

Mon, 07/06/2020 - 07:44

Saving

Hi,

Is there a posibility to save text right in h5p ( or even better in moodle...) and continouing working with it later? Is this a problem with our settings in Moodle?Have there been any further developments on this issue?

Thanks for your help

mattjar

Tue, 06/07/2022 - 13:58

Saving content state is now working if you use the H5P Interactive Content plugin, just not in the native Moodle implementation.

Mon, 07/06/2020 - 07:50

saving text

Is there a the posibility to save text right in h5p (or even better to save it in moodle...) and continouing working with it later? Is this a problem with our settings in Moodle?

Have there been any further developments on this issue?

Thanks for your help

Mon, 07/06/2020 - 18:57

Hi scil_iwp,Documentation

Hi scil_iwp,

Documentation Tool does not support save content state yet and I do not have a timeline on when this will be supported.

hahieuit

Fri, 07/10/2020 - 05:36

Could you help me customize a little tool?

Dear H5P,I want to customize a little tool. Cou you assign a developer support me? I will pay for it.I hope hear your response as soon as possible.Thank and best regards,Ha

Fri, 07/10/2020 - 18:08

Hi hahieuit,I think it would

Hi hahieuit,

I think it would be better if you get in touck with H5P service providers to assist you with your project.

Sun, 07/12/2020 - 04:39

Thank you! Let me contact

Thank you! Let me contact with them :)

Thu, 08/13/2020 - 03:59

How to insert html code to text field on Documentation tool?

Dear H5P,

I want to insert html code to text field. I've try inserted html code. But text field shown html code same as text. How to i can do that? Could you give me guideline for about that? I hope hear your response as soon as possible.

Thank and best regards,Ha

Vera Suzui

Mon, 09/21/2020 - 08:52

standardized choices

This is an excellent tool. I'd like to see one more thing added to the options: standardized choices through "Check all that apply" or radio buttons.

This way, the "wizard" can go even faster without students typing out the same things over and over again.

Example:

This document is :
o a query
o an FYI
◉ a request
o a report

Final document:
This document is a request

Language goals I want to improve:

◻ pronunciation
◻ syntax
⊠ reading
◻ listening
⊠ grammar

Final document:
I want to improve my
●reading
●grammar

Mon, 09/21/2020 - 19:23

Hi Vera,These are awesome

Hi Vera,

These are awesome suggestions! Would you mind posting this in the feature request forum. In order for your feature request to attract as much interest as possible make sure it follows the below guidelines:

It is clear from every perspective how the feature will work. We recommend describing the feature with one or more user stories, for instance “As an author, I want it to be possible to pick between different effects for the check answer animation so that the learner will see a variety of effects and also I can adapt the effects to my target audience(I’ll be using pink unicorns which works really well for both my target audience which are 4 year old girls and venture capitalists)”
If the feature can be illustrated with images or videos it always helps
Make it clear what content types this is relevant for, and or if this is a new content type

egretagbo

Wed, 01/27/2021 - 12:13

Document Export to Word format

By clicking the Export button, this is not a .docx document that is generated, but an compressed file (.zip). When extracting that zip file, I get a bunch of .xml files stored in various folders. Trying to open one of those in Word doesn't work.

My question : how can I get my generated file exported in a format readable by Word or any other wordprocessor application ?

Thanks !

Wed, 01/27/2021 - 17:59

Hi egretagbo,There is a

Hi egretagbo,

There is a lengthy discussion regarding this on this thread.

FCIT-PD

Wed, 09/15/2021 - 19:43

Adding Images to Export

Hello!

Is there any way to add an image to the export file when you "create document?"

Thank you in advanace!

Thu, 09/16/2021 - 18:57

Hi FCIT-PD,I'm afraid it is

Hi FCIT-PD,

I'm afraid it is not possible to add an image to the exported document. However you can post this in the Feature request forum.

In order for your feature request to attract as much interest as possible make sure it follows the below guidelines:

carolined

Sat, 01/15/2022 - 12:01

Traduction of "Goals", "Ratings" and "Assessment"

I know this question has been asked before, but no clear and complete solution has been proposed.

The words don't appear in .po so it's impossible to complete the traduction in french.

I'm trying to localize the file and change it directly within the code but can't find which one it is.

Could you please tell me which file must be changed and please send that fix this could be an appreciable improvement to be realized in a next update ;-)

Caroline

Eduard182

Wed, 08/10/2022 - 10:20

Hello everyone, I want to use

Hello everyone,

I want to use the Documentation Tool as a learning log. User will come back to it to keep adding content. It's great that progress is now saved and users can just come back to it to add more info.

What I am struggling with is a way to see those entries.

Whenever this is asked around the forums the following link is offered as a solution. While step one is easy and involves just installing a plugin, step two goes beyond my abilities and I am not sure how to apply it.

Has anyone implemented this and could point me to some sort of tutorial please? I am using Wordpress.

Thank you!

telugu

Mon, 08/29/2022 - 07:50

How to see user submitted docs

I recently used this content type in Moodle 4.0 from Content bank. And when user submitted the report and as a teacher when trying to see the report I can not see anything and it displays error as This interaction (fill-in) does not provide tracking information or the tracking provided is not compatible with the current activity version. How to overcome this? Thanks in advance.

Mon, 08/29/2022 - 17:51

Hi telugu,The version of H5P

Hi telugu,

The version of H5P that you are using was not created by the core it is best that you post a similar question in the Moodle forums.

chantalforssman

Mon, 04/08/2024 - 14:19

Adding an image to the export file

Hi, I need to add a company logo image to the file that is exported, can you please direct me to the file path where the file is located whcih I can edit (in Wordpress) to include this - is there a template file being used for the exported documents? I can't seem to find it. Thanks!

icc

Tue, 04/09/2024 - 09:59

Currently, there is no way of

Currently, there is no way of doing this besides having a developer editing the content type function: https://github.com/h5p/h5p-document-export-page/blob/master/src/scripts/export-page.js#L310

This would have to be added as a new feature to the content type.

Bas Roggeveen

Thu, 09/26/2024 - 13:11

Name export filename

Hello Developer of this great tool,

I am a frequent user of the Documentation Tool, and I am very satisfied with it! It has been immensely helpful in my e-learning build in Moodle lms. However, I have a small request that I believe would further enhance its functionality.

Currently, the exported documents are named by default as "exported-text (1)", which is not very convenient when managing multiple documents. Would it be possible to develop a feature that allows users to name exported documents based on the activity name? This would make it much easier to organize and locate documents.

I would greatly appreciate this modification, and it would make the application even more useful for me and likely for other users as well. Thank you for considering this addition!

Best regards, Bas Roggeveen

Thu, 09/26/2024 - 14:36

You are here

Documentation Tool

Primary tabs

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

Description

Comments

Hello Developer of this great tool,

Hello Developer of this great tool,

Pages