Documentation Tab

If your are the owner of the prototype or if the prototype owner gave you access to it, the Documentation panel will be available. This is where you add, edit or view documentation and where you can generate a report. When you select a component in the prototype structure on the left, it displays the written documentation on the right.

There are two buttons, a group selector, a text field for a subject and a search field on the Documentation panel toolbar.

Icon	Action	Description	Keyboard keys
	Delete Documentation	Only the owner of the prototype can delete a documentation.
	Show documentation report	If you are the owner of the prototype, this 'Documentation Report' window displays, otherwise you will see this report window. This option will generate and display a pdf report of all the documentations if there is no error.
	Group Selector	Select the group who will see this documentation. The 'Common to All' selection allows you to enter documentation that is generic to all groups.
	Subject field	Let you enter a subject for this documentation item.
	Search field	Below the documentation window, a table displays all the available documentation items. To search a specific text in the documentations table, enter it in the search field and press Enter.

Filters list
By clicking the button, a contextual menu list displays the possible filter options. Select on which columns the search will apply.

All	Search text on all columns
Item	Search text in the Item column
Group	Search text in the Group column
Subject	Search text in the Subject column
Text	Search text in the Text column
Case sensitive	Search text with respect to its case
Case insensitive	Search text without respecting the case
Use wild cards	Search using wild cards (i.e. tool* will return tool, tools and toolbar)
Match from start	Match the search text from start
Match anywhere	Match the search text anywhere

'Documentation Report' (Owner)

This is the Documentation Report screen where you choose the kind of report you want. A different screen displays when you are not the owner of the prototype.

Documentation Report	Description
Group(s)	List of availables group(s). These groups are created in the Contacts tab.
Report(s)	List of availables report(s). The first time, there is no report available. You need to press the Generate Report button to have a report.
Text and screenshots	The report will include for all the documentation items, the text and screenshots of any visual component.
Text and forms only	The report will include for all the documentation items, the text and an image only if the documentation item is a form.
Text only	The report will include only the text for all the documentation items without any screenshot.
Generate Report	Select this button to generate the report(s) using the specified criteria.
View Report	Select a report in the 'Report(s)' list and press this button to view a Pdf Report.
Close	Select this button to close this window.

'Documentation Report' (Viewer)

Documentation Report	Description
Text and screenshots	The report will include for all the documentation items, the text and screenshots of any visual component.
Text and forms only	The report will include for all the documentation items, the text and an image only if the documentation item is a form.
Text only	The report will include only the text for all the documentation items without any screenshot.
View Report	Select this button to generate the report using the specified criteria and view a Pdf Report.
Cancel	Select this button to close this window.

Report Error

Create Report	Description
OK	Make sure that the report you want to generate and view is not already opened in Acrobat Reader. Close the file in Acrobat Reader and generate the report again.

Add documentation text
	Select the item to write documentation to in the tree inside the Documentation tab or in the structure-tree of Structure or in the Composer.
	Select the group for which you want to add documentation. The 'Common to All' pseudo group is used to enter documentation that all groups will see. If you have two groups, then you can add three documentation items. One with the 'Common to All' pseudo group and a specific documentation item for the two groups.
	The subject and text are blank by default. Enter the text for the subject in the 'Subject' field and the documentation in the large text area.
	Text entered as documentation is updated and saved automatically.

Note: There is no undo/redo function on the text.

Edit documentation text
	Select the item with the documentation to edit in the table.
	The documentation subject and text display in the upper window. Edit the subject and text as needed.
	Text entered as documentation is updated and saved automatically.

Edit documentation text

Select the item with the documentation to edit in the table.

The documentation subject and text display in the upper window. Edit the subject and text as needed.

Text entered as documentation is updated and saved automatically.

Note: There is no undo/redo function on the text.

Delete documentation text

Select the item with the documentation to delete in the table.

Press the Delete () icon on the toolbar

A confirmation screen will display.

Delete documentation text
	Select the item with the documentation to delete in the table.
	Press the Delete () icon on the toolbar
	A confirmation screen will display.

Note: There is no undo/redo function on the text.

Delete Documentation Confirmation

Confirm Delete	Description
Yes	Select this button to delete this documentation.
No	Select this button to keep the selected documentation.