optional_properties
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| optional_properties [2025/09/17 10:07] – [Optional Properties] jsmith | optional_properties [2026/02/09 14:50] (current) – [Project-level Optional Properties] jsmith | ||
|---|---|---|---|
| Line 7: | Line 7: | ||
| Optional properties are added from the right-hand pane in the page editor window, and will apply to that page. Removing an optional property will remove its functionality from that page and/or reset its configuration back to the default setting. | Optional properties are added from the right-hand pane in the page editor window, and will apply to that page. Removing an optional property will remove its functionality from that page and/or reset its configuration back to the default setting. | ||
| - | :!: New in 3.14**, to reduce clutter in the editor, optional property groups are now collapsed by default. Click the group' | + | :!: **New in 3.14**, to reduce clutter in the editor, optional property groups are now collapsed by default. Click the group' |
| There are three types of optional property; | There are three types of optional property; | ||
| Line 14: | Line 14: | ||
| * **General Optional Properties** (added at the page level) | * **General Optional Properties** (added at the page level) | ||
| * **Page-specific Optional Properties** (also added at the page level, and specific to that page or a group of pages) | * **Page-specific Optional Properties** (also added at the page level, and specific to that page or a group of pages) | ||
| - | |||
| ===== Project-level Optional Properties ===== | ===== Project-level Optional Properties ===== | ||
| Line 38: | Line 37: | ||
| | Max Width | %%Provides the option to set the maximum width (e.g. 1400px) at which the page contents will be displayed on larger displays. In 3.12 this now applies to __all pages__.%% | | | Max Width | %%Provides the option to set the maximum width (e.g. 1400px) at which the page contents will be displayed on larger displays. In 3.12 this now applies to __all pages__.%% | | ||
| | Metadata... | Course: Label indicating the course this learning object is part of, used to create meta data in SCORM objects. This is also stored in xAPI events.\\ Module: Label indicating the module/ | | Metadata... | Course: Label indicating the course this learning object is part of, used to create meta data in SCORM objects. This is also stored in xAPI events.\\ Module: Label indicating the module/ | ||
| - | | Navigation Buttons... | This allows you to customise the tooltips and the icons for the navigation buttons (Previous Page, Next Page) and for the Table of Contents. | + | | Navigation Buttons... | This allows you to customise the tooltips and the icons for the navigation buttons (Previous Page, Next Page) and for the Table of Contents. |
| | Notes | Your notes for the project. These are not shown in the live project. | | | Notes | Your notes for the project. These are not shown in the live project. | | ||
| | Page Introduction Button... | On each page of your project, you have the option to add an Introduction, | | Page Introduction Button... | On each page of your project, you have the option to add an Introduction, | ||
| - | | Progress bar | Adds a graphical progress bar (with optional page counter) to the footer of the project. | + | | [[projectresources|Page Resources]] | :!: **New in 3.14** If you have added supplementray resources to any pages in your project, a button will appear in the header, giving learners access to those resources. This optional property allows you to customise this button' |
| + | | [[progressbar|Progress bar]] | Adds a graphical progress bar (with optional page counter) to the footer of the project. | ||
| | [[project_introduction|Project Introduction...]] | Adds a lightbox which can be displayed automatically when the Learning Object is launched by the learner, or opened by clicking on an icon in the footer or sidebar. | | [[project_introduction|Project Introduction...]] | Adds a lightbox which can be displayed automatically when the Learning Object is launched by the learner, or opened by clicking on an icon in the footer or sidebar. | ||
| | Script | Provides the ability to add custom JavaScript to the project. | | | Script | Provides the ability to add custom JavaScript to the project. | | ||
| Line 53: | Line 53: | ||
| | Twitter Card... | Enables a Twitter Card to be created for when a public link to this LO is shared via Twitter. | | | Twitter Card... | Enables a Twitter Card to be created for when a public link to this LO is shared via Twitter. | | ||
| | [[variables|Variables...]] | Provides the ability to add custom variables which can be called in subsequent pages in the project. | | [[variables|Variables...]] | Provides the ability to add custom variables which can be called in subsequent pages in the project. | ||
| - | | Video Splash Screen | **New in 3.14** this allows you to display a video within a lightbox when a project first loads. Splash screens are ideal for short videos used for branding purposes. The video will auto-play and the lightbox will close automatically when the video has played to the end, revealing the first page of the project. Please note that due to common browser restrictions, | + | | Video Splash Screen | :!: **New in 3.14** this allows you to display a video within a lightbox when a project first loads. Splash screens are ideal for short videos used for branding purposes. The video will auto-play and the lightbox will close automatically when the video has played to the end, revealing the first page of the project. Please note that due to common browser restrictions, |
| Line 85: | Line 85: | ||
| | [[op_page_id|Page ID...]] | Create a customised URL to this page by adding descriptive text (e.g. ' | | [[op_page_id|Page ID...]] | Create a customised URL to this page by adding descriptive text (e.g. ' | ||
| | [[op_page_timer|Page Timer...]] | Add a timer to the bottom of the page, counting down to zero. | | | [[op_page_timer|Page Timer...]] | Add a timer to the bottom of the page, counting down to zero. | | ||
| + | | Resources files / links... | Enables a list of resources (e.g. PDFs, Word docs, links) associated with the page to be added so that learners can either download or open them. | | ||
| | [[op_script|Script...]] | Add Javascript to run either on first load or every view of the page. | | | [[op_script|Script...]] | Add Javascript to run either on first load or every view of the page. | | ||
| | [[op_standalone_page|Stand-Alone Page...]] | Remove the page from the page menu so it can only be accessed via Xerte internal project page links. | | | [[op_standalone_page|Stand-Alone Page...]] | Remove the page from the page menu so it can only be accessed via Xerte internal project page links. | | ||
| Line 90: | Line 91: | ||
| | [[op_tracking|Tracking...]] | Set identifier and grouping for tracking with SCORM/xAPI. | | | [[op_tracking|Tracking...]] | Set identifier and grouping for tracking with SCORM/xAPI. | | ||
| | [[op_variables|Variables...]] | Use in conjunction with the project level ' | | [[op_variables|Variables...]] | Use in conjunction with the project level ' | ||
| + | |||
| ===== Page-specific optional properties ===== | ===== Page-specific optional properties ===== | ||
optional_properties.1758103679.txt.gz · Last modified: by jsmith
