User Tools

Site Tools


interactivity_documentation

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
interactivity_documentation [2024/11/14 14:35] – yvonne_mooreinteractivity_documentation [2026/10/02 07:51] (current) – [Top level: Assistants] jsmith
Line 13: Line 13:
 ===== Editor Interface ===== ===== Editor Interface =====
  
-{{:xerte-inter-documentation-editor.jpg?direct}}+{{:documentation_interface_313.png|Documentation page editing interface.}}
  
 ==== Top Level: Core Properties ==== ==== Top Level: Core Properties ====
Line 24: 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.  | | 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.  | | 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. |
 +
  
 ==== Top Level: Optional Properties ==== ==== Top Level: Optional Properties ====
Line 30: Line 45:
  
 ^ Property ^ Description ^ Type ^ Additional information ^ ^ 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 |   | | 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.  | | 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 === === General ===
Line 42: Line 59:
 ^ Property ^ Description ^ Type ^ Additional information ^ ^ 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" | | 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" | | 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" | | 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" |
interactivity_documentation.1731594905.txt.gz · Last modified: by yvonne_moore