Differences

This shows you the differences between two versions of the page.

--- interactivity_documentation [2024/11/04 07:10] – [Interactivity > Documentation] idonkervoort
+++ interactivity_documentation [2026/10/02 07:51] (current) – [Top level: Assistants] jsmith
@@ Line 1: / Line 1: @@
 ====== Interactivity > Documentation ======
-xxxA page that allows you to present content (text, images, audio, video) with form fields (e.g. text boxes, tick boxes, tables) into which learners type responses. All the content, including both the content provided and the learner responses, can be downloaded as a Word document, but you can also opt to exclude specific content from the download. In the demo below you will see there are two nested pages, each with examples of different form fields, which are available as one download after the learner has filled them in.
+A page that allows you to present content (text, images, audio, video) with form fields (e.g. text boxes, tick boxes, tables) into which learners type responses. All the content, including both the content provided and the learner responses, can be downloaded as a Word document, but you can also opt to exclude specific content from the download. In the demo below you will see there are two nested pages, each with examples of different form fields, which are available as one download after the learner has filled them in.
 The **Documentation **page provides a "takeaway", and an opportunity for learners to reconfigure learning content to meet their own needs, for example if they are revising for an exam, or need to edit content to upload into a portfolio.
@@ Line 10: / Line 10: @@
 or view at [[https://xot.xerte.org.uk/xapi_launch.php?template_id=116&group=xertepagetypes#documentation| Xerte Page Types > Interactivity: Documentation]] (opens in new tab).
 ===== Editor Interface =====
-{{:xerte-inter-documentation-editor.jpg?direct}}
+{{:documentation_interface_313.png|Documentation page editing interface.}}
 ==== Top Level: Core Properties ====
@@ Line 26: / Line 24: @@
 | Show Download Button | {**On last page**/On additional page}. | Drop- down | If you choose **On additional page** here, this adds a nested page at the end, with the Download button on it.  |
 | Panel Width | Dimension of the right panel (which includes the Question, the Check button and the Feedback).  | Drop- down | Choose from {Small/**Medium**/Large/Full}.  **Full** puts all the content in one pane.  Experiment with this setting to take account of dimensions of content in each panel.  |
+==== Top level: Assistants and AI ====
+=== Page-specific ===
+^ Property ^ Description ^ Type ^
+| **Quick Fill** | Creates multiple documentation sub-pages at once using default values. | Non-AI Assistant |
+There is** no AI Assistant **at the **top level** or at the** nested-page level**. However, there is an AI Assistant for each of the form fields (e.g. Text Box, Text  Area, Checkbox).  See the links at the bottom of the page for more information.
+=== General ===
+^ Property ^ Description ^ Type ^ Additional information ^
+| **Image Search and Help Tool** | Supports royalty-free image search and AI image generation. | AI / Non-AI | See [[playground:3.15 Image Search and Help Tool DRAFT|Image Search and Help Tool]] for a full overview. |
@@ Line 33: / Line 45: @@
 ^ Property ^ Description ^ Type ^ Additional information ^
+| Download Button | A download button will be shown by default. Uncheck this option to remove the download button.  | Checkbox  | **New in 3.13**  |
 | File orientation | Determines the orientation of the downloadable Word document {**Portrait**/Landscape}.  | Drop-down |   |
 | Filename (without extension) | Gives the download a filename. | Text  | It is recommended that you add this Optional Property, because it gives the download a unique identifier, which will help learners with file management. They can, of course, rename the file after download.  |
-| Font Size | Allows you to set the document font sizes for headings at 3 levels of headings (h1, h2, h3) and for paragraph text (p). | Text |   |
+| Font Size | Allows you to set the document font sizes for headings at 3 levels of headings (h1, h2, h3) and for paragraph text (p). | Text | ..  |
+| Submit Button | Include a button that submits answers to the results page.  | Checkbox  | **New in 3.13**  |
 === General ===
 See [[:optional_properties#General optional properties|General Optional Properties]]
 ==== Top Level: Language Options ====
@@ Line 46: / Line 59: @@
 ^ Property ^ Description ^ Type ^ Additional information ^
 | Download instructions | Text that appears with the Download Button.  | Text | Default - "Click the download button to save a copy of your answers" |
+| Submitted Text | Text that appears after answers have been submitted. | Text | **New in 3.13** |
 | Not Answered Text | Text that appears in the Word document for form fields the learner has not completed. | Text  | Default - "Not answered" |
 | Incomplete Error Text | If you have selected **Required Field** as an Optional Property for a specific form field, this text is displayed if the learner has not completed that field. | Text | Default - "Please complete all required fields" |
@@ Line 53: / Line 67: @@
 Click on **New Nested Page... **to add the content and the form entry fields.
 ==== Nested Page: Core Properties ====
@@ Line 73: / Line 86: @@
 | [[doc_newhorizontalrule|New Horizontal Rule...]] | Adds a horizonal line across the pane. |
 | [[doc_newsection|New Section...]] | Adds a new section, which can then include any of the types of form field listed above.  A new section appears on the same page but is enclosed with a border. |
 ===== Further information =====
@@ Line 80: / Line 92: @@
 {{tag>pagetype interactivity}}