User Tools

Site Tools


optional_properties

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
optional_properties [2025/09/17 10:14] – [Project-level Optional Properties] jsmithoptional_properties [2026/02/09 14:50] (current) – [Project-level Optional Properties] jsmith
Line 37: 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/subject of this learning object, used to create meta data in SCORM objects. This is also stored in xAPI events. | | 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/subject of this learning object, used to create meta data in SCORM objects. This is also stored in xAPI events. |
-| 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.  Icons can be chosen from those available as Font Awesome characters. \\ **New in 3.14**, it is possible to hide the page counter that is normally shown between the next and previous page buttons. This new property is only available when the project's navigation setting is 'linear' or 'linear with historic back button'. The page counter is already automatically not shown when other navigation settings are used. |+| 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.  Icons can be chosen from those available as Font Awesome characters. \\ :!: **New in 3.14**, it is possible to hide the page counter that is normally shown between the next and previous page buttons. This new property is only available when the project's navigation setting is 'linear' or 'linear with historic back button'. The page counter is already automatically not shown when other navigation settings are used. |
 | 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, which displays as a lightbox, when you click on an icon in either the footer or the sidebar.  The icon can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited. | | Page Introduction Button... | On each page of your project, you have the option to add an Introduction, which displays as a lightbox, when you click on an icon in either the footer or the sidebar.  The icon can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited. |
-| Progress bar | Adds a graphical progress bar (with optional page counter) to the footer of the project.  This shows the percentage of the project completed as the user clicks through 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's appearance, and the content of the resources lightbox it opens. | 
 +| [[progressbar|Progress bar]] | Adds a graphical progress bar (with optional page counter) to the footer of the project.  This shows the percentage of the project completed as the user clicks through the project. :!:** New in 3.14** This optional property was improved to provide greater control over the appearance, position and enhanced functionality of the progress bar. |
 | [[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.   The icon can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited.  This lightbox can be used to provide an introduction to the Learning Object. | | [[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.   The icon can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited.  This lightbox can be used to provide an introduction to the Learning Object. |
 | Script | Provides the ability to add custom JavaScript to the project. | | Script | Provides the ability to add custom JavaScript to the project. |
Line 52: 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.  A linked guide is provided with instructions and examples. | | [[variables|Variables...]] | Provides the ability to add custom variables which can be called in subsequent pages in the project.  A linked guide is provided with instructions and examples. |
-| 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, the video will be muted by default. You can decide whether the splash screen is shown everytime the project loads (even if the first page shown is not page one) or only when the first page shown is page one. |+| 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, the video will be muted by default. You can decide whether the splash screen is shown everytime the project loads (even if the first page shown is not page one) or only when the first page shown is page one. | 
  
 ===== Deprecated Project-level Optional Properties ===== ===== Deprecated Project-level Optional Properties =====
Line 83: Line 85:
 | [[op_page_id|Page ID...]] | Create a customised URL to this page by adding descriptive text (e.g. 'instructions' or 'quiz').  This will be added to the end of the projects URL, so others can be directed to that specific page. | | [[op_page_id|Page ID...]] | Create a customised URL to this page by adding descriptive text (e.g. 'instructions' or 'quiz').  This will be added to the end of the projects URL, so others can be directed to that specific page. |
 | [[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 88: 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 'Variables' optional property, this provides the option to update variable values on that page. | | [[op_variables|Variables...]] | Use in conjunction with the project level 'Variables' optional property, this provides the option to update variable values on that page. |
 +
  
 ===== Page-specific optional properties ===== ===== Page-specific optional properties =====
optional_properties.1758104045.txt.gz · Last modified: by jsmith