interactivity_documentation
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| interactivity_documentation [2024/11/04 09:53] – [Interactivity > Documentation] jsmith | interactivity_documentation [2026/10/02 07:51] (current) – [Top level: Assistants] jsmith | ||
|---|---|---|---|
| Line 4: | Line 4: | ||
| The **Documentation **page provides a " | The **Documentation **page provides a " | ||
| - | |||
| ===== Example demo ===== | ===== Example demo ===== | ||
| Line 14: | 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 25: | 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). | | Panel Width | Dimension of the right panel (which includes the Question, the Check button and the Feedback). | ||
| + | |||
| + | ==== 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). | ||
| + | |||
| + | === 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: | ||
| + | |||
| ==== Top Level: Optional Properties ==== | ==== Top Level: Optional Properties ==== | ||
| Line 31: | 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. | ||
| | File orientation | Determines the orientation of the downloadable Word document {**Portrait**/ | | File orientation | Determines the orientation of the downloadable Word document {**Portrait**/ | ||
| | 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 | ||
| === General === | === General === | ||
| Line 43: | Line 59: | ||
| ^ Property ^ Description ^ Type ^ Additional information ^ | ^ Property ^ Description ^ Type ^ Additional information ^ | ||
| | Download instructions | Text that appears with the Download Button. | | Download instructions | Text that appears with the Download Button. | ||
| + | | 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 - " | | 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 - " | ||
interactivity_documentation.1730714025.txt.gz · Last modified: by jsmith
