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

major

Thu, 10/15/2015 - 14:06

Problems with exporting

Hi,
I was just testing this example of Documentation Tool and filled out all the fields. When I'm trying to export the field data to text/docx with "Create Document"-button, I'm only receiving the data from the fields "Evalutation" and "Goal Assesment". Is this working as desired or is there a bug? (I noticed the same problem in my Drupal-environment which is using H5P)

falcon

Tue, 10/20/2015 - 10:47

Thanks a lot for reporting.

Thanks a lot for reporting. We're aware of this problem. It will either be fixed in the next release or in an upcoming hotfix.

dgonzales1986

Mon, 05/22/2017 - 19:01

Any Update?

Hi I'm experiencing the same problem and the demo here still has this problem. Any idea of when this will be fixed, so that goals will be exported to the document as well? Thanks in advance.

Tue, 05/23/2017 - 12:49

I tried it now in Chrome and

I tried it now in Chrome and it works. What browser are you using?

sbarab

Sat, 02/24/2018 - 15:51

Save Work

is there any hope of the documentation tool saving one's work? Currently, it doesn't save one's work when i return. It would make it much more useful.

BV52

Mon, 02/26/2018 - 06:22

Hi sbarab,hanks a lot for

Hi sbarab,

hanks a lot for contributing your ideas on how to make H5P better! We’re now working on something called the H5P supporter program allowing the H5P community to vote for and fund the top voted H5P features. Also there are developers in the community who every now and then works on a feature they find interesting or useful. 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.

-BV52

ts-surselva

Sun, 05/27/2018 - 07:04

I agree with sbarab: having

I agree with sbarab: having the posibility to save text right in h5p (or moodle...) and continouing working with it later instead of downloading it would turn this GREAT tool into an even GREATER tool!

mattjar

Mon, 03/07/2022 - 13:54

Saving work

Just to echo others' comments. Given that a student will always return to assess against their goals after completing a task, never at the same time as setting them, I can't see any use case in which this can work in real life without content saving. What should be one of the most useful H5P tools is sadly rendered pointless by this omission. Sorry to be negative - I think you guys are awesome - but I can't understand the reluctance to resolve this.

mktmeke

Fri, 03/09/2018 - 02:28

Same Problem

Nothing happens when I click on 'Create Document' button. so thanks for writing a comment.

Fri, 03/09/2018 - 07:26

Hi mktmeke,I think this is a

Hi mktmeke,

I think this is a different issue. Do you mind posting this in the Bugs in Content types forum and include the following information:

Detailed steps to reproduce the bug (exactly how and when did it happen)
Platform and version number. E.g. Drupal, Wordpress, Moodle.
Mobile or Desktop
Browser: Chrome, Firefox, Safari etc
H5P plugin version
H5P content type and version (if a content type was used), and a sample URL or attached H5P.
Any browser console errors
Any PHP errors
Screenshots if it's a visual problem

The more information you provide, the quicker the community will be able to fix it and the quicker you'll have a working solution!

RaybanM

Tue, 02/09/2016 - 02:06

saved where on wordpress?

If I deploy this tool on WordPress for users, where /how can this documentation be retrieved by the user if on a mobile device? Would storage be user defined automatically? If so how can we link the file to the student? Shortcode?

Tue, 02/09/2016 - 11:43

I think the user should be

I think the user should be able to copy the text and paste it into a text editor on mobile. It currently isn't possible to make WordPress store the text I'm afraid. To achieve that the best way is probably to add xAPI integration for this content type, and a learning record store for storing the statements.

Tor Einar Haugv...

Sat, 03/05/2016 - 17:43

Doc.Tool width on wordpress site

How do I increase the Doc.tool width? I wouldl like dok.tool to use the intire width of the site.

Have a look here: http://aakravgs.no/verkstedguiden/planlegging/267-2/

Mon, 03/07/2016 - 15:07

It is already set up to use

It is already set up to use the full width, the problem is that your site has a very narrow content width. You could try a different WordPress theme that allows the content to be wider.

ctli

Thu, 07/28/2016 - 00:09

problem with export

Hi, I'm having issues with the export document showing style tags such as <strong></strong><h3></h3> between text. Is this a known issue? What can we do to bypass it or would it be considered for the next upgrade?

Thanks in advance!

fnoks

Thu, 07/28/2016 - 10:41

Hi,This is a known problem,

Hi,

This is a known problem, but the issue is not scheduled for any release yet. I will see what I can do about it ;) The only way to bypass it now is to avoid adding formatting to fields beeing part of the exported document!

Thank you for reporting this.

Thu, 07/28/2016 - 17:56

thanks

Ok, thanks for the reply. Hopefully it can be resolved soon. :)

Wed, 10/05/2016 - 13:37

known problem with export

Please put this fix on high priority. We are using this tool a lot in our college and need things to be proper.

saman2

Fri, 02/09/2018 - 11:18

please solve this

hi fnoks and thank you for H5P

this problem not resolve until now...we must use rtl language and we need to use persian language and it is RLT, when we use RTL in that,style printed in the exported file...can you advise me about how to fix that?

Mon, 02/12/2018 - 04:11

Hi saman2,I'm afraid RTL is

Hi saman2,

I'm afraid RTL is not yet supported. The good thing about H5P is that it is open source so you or anyone in the community can make the changes.

yang1018

Wed, 03/14/2018 - 21:17

Similar issue with seeing HTML markup

When I "Export text," the Microsoft Word file shows extra HTML markup: <p dir="ltr" id="docs-internal-guid-8b604374-9a38-d89b-5cee-53f3b45eceaf">

I have cleared the formatting while in editing mode. Any insight would be great! Thanks!

Thu, 03/15/2018 - 13:28

Hi yang1018,Would you mind

Hi yang1018,

Would you mind posting a separate thread for this so that we can attach files and also in order to give your bug report the best chance of getting answered, please include the following information:

smartasc

Wed, 08/31/2016 - 12:12

View specific page of documentation tool

Hi,
I've created a documentation tool component that requires user to fill out the first few pages of the documentation tool and then return to it to complete the rest of it after they have recived further instruction. Is it possible to direct users straight to the page they were asked not to complete rather than having to navigate to that page again once they arrive at the tool again?

thomasmars

Thu, 09/01/2016 - 09:28

Depends on how you want to achieve this. It is not normally possible to link to a page. If you mean through code it should be possible by calling the DocumentationTool instance's movePage(indexOfPage) function.

Thomas

Tue, 10/04/2016 - 20:03

Thanks!

Thanks for the info. Sadly, I don't feel sufficiently comfortable to take that approach. Is there any way for me to request consideration as a future feature?

Adarsh

Wed, 10/05/2016 - 11:31

Hi Adarsh

I suppose what you really want is a way to "resume" your work, which there already exists functionality for in H5P core. This must be implemented inside of Documentation Tool. I think the best place to request this as a new feature would be in the "feature request" forum, together with a thorough specification.

bgardner

Tue, 09/13/2016 - 15:22

users on Moodle platform

we are trying to use the Documentation Tool for learners to create individual learning plans. Learners complete some of the form and return later to add more. We cannot seem to be able to make the content the learner added originally available aon return to the Moodle course. can you help?

icc

Wed, 09/14/2016 - 09:43

Hello! Unfortunately, this

Hello! Unfortunately, this feature currently doesn't exists for the Documentation Tool.

lxd_1979

Thu, 11/17/2016 - 17:20

This would be useful. I've

This would be useful. I've raised it as a feature request.

djakew

Wed, 10/05/2016 - 21:04

next/previous buttons lack an arrow

Hi!

next/previous buttons lack an arrow. it's just a blue circle, without the > inside. Is there something I can do about that?

Thu, 10/06/2016 - 09:42

Make sure you have the latest library pack from H5P.org.

You can also see if you have any errors in your browser console (open with ctrl + shift + j).

NickVarney

Tue, 11/15/2016 - 13:07

Grade output?

First off, I really like this tool. The potential uses are limitless for us (UK secondary) in terms of student scaffolding.

I'm using the Moodle library version of this tool. What I would like to do is track which users have completed a document export. I can only get from Moodle which users have viewed the form (using Moodle's Course Participation report). From testing am I right in thinking there is no output from this tool to the Gradebook i.e. an arbitrary mark of 1 for exporting? Would this be a worthwhile feature request?

tim

Wed, 11/16/2016 - 08:15

Grade output

Thanks for the feedback!

I don't believe that there's any output for exporting, but that would be a great idea.

Perhaps you could create a topic under 'Feature Requests' in the forum and flesh out an idea of how you would like it to work.

From there, it can hopefully be picked up by community developers or the Core Team.

Wed, 11/16/2016 - 11:23

Done!

Thank you Tim.

I've added this as a feature request.

Thu, 11/17/2016 - 08:57

Great, thanks!The Core Team

Great, thanks!

The Core Team has their hands full for the next couple of releases so I'm not sure when it will be picked up but I'm hoping that community contributors will see it and jump on it.

rudler

Wed, 01/25/2017 - 23:12

Not on my dropdown list...

of content types???? Is it under a different name?

Thu, 01/26/2017 - 09:30

You should have access now.

You should have access now. By default, new users don't have access to the more advanced content types :-)

Transpro

Wed, 03/01/2017 - 10:01

Not showing options in Goal assessment page

Since this tool is not in my content types dropdown list, I tried making it from my website plugin. But the content on the Goals assessment page (specifically the options) is not being shown even though I have entered text in all required fields. How to fix this? Also, could you pl. enable all content types for my account? Thanks!

Thu, 03/02/2017 - 09:29

You should have access to

You should have access to everything now. I suggest trying it on H5P.org first to see if it works for you – this way we can determine if it's a local issue.

drasparagus

Fri, 03/03/2017 - 00:37

Character Limit for Text Fields

Hey guys, is there a way to limit characters on input to a field with the Documentation tool?

Thanks so much for your awesome tools!

-Steve

tomaj

Fri, 03/03/2017 - 08:22

Sorry no

Hey Steve,

No, there isn't any way to limit characters trough Documentation tool.

- Tom

zhinio

Tue, 04/04/2017 - 23:28

form wizard (submissions)

Thank you for an awesome content type. I m using drupal and i like to use doumentation tool for submissions.

In description you mention form wizard. is there a way to actually submit the filled form?

Thanks alot

Wed, 04/05/2017 - 10:13

Hi, there is currently no way

Hi, there is currently no way for a user to submit a filled form.
They would have to export it and submit it through some other process to your site.

iainharnish

Tue, 05/09/2017 - 13:12

Hard returns

Thanks for this great tool!

I noticed when I export the file, any hard returns between paragraphs are removed. Is there a way to compensate for this?

Thanks,

Iain

Wed, 05/10/2017 - 09:39

Hi Iain, your best bet is to

Hi Iain, your best bet is to create new feature request in the feature request forum. I think it would be a good improvement.

Wed, 05/10/2017 - 12:59

Thanks, Tim. Posted!

gcakad

Tue, 05/16/2017 - 10:48

pdf

great tool! A few suggestions/questions:

is there any way to export the output directly to PDF?
It would be nice if you could specify the required input type (string, numbers etc.)
customizable templates for the output also seem like a helpful improvement (arrange where/how output shows up, maybe include images etc)

best regards!

Thu, 05/18/2017 - 09:32

Hi, these are great

Hi, these are great suggestions.
You should consider creating a post for them in the "feature request" forum, where it will be more visible to developers.

audraj

Fri, 08/18/2017 - 20:28

Question about Persistent Content

Found you guys from listening to an interview yesterday with Chris and Dennis. So excited! H5P is just what I was looking for for a new site I'm building.

Question... if we used the document form example above and someone filled out some of the questions... then want to save it and come back to it... is that possible?

Meaning almost like a live working document for them.

Thanks a bunch!

Audra

Mon, 08/21/2017 - 09:43

Hi,H5P has a function for

H5P has a function for "saving content state", which makes it possible for content types to resume where it left off. Currently, that is not implemented for Documentation Tool.

You are here

Documentation Tool

Primary tabs

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

Description

Comments

Pages