Xerte Community Documentation

User Tools

Site Tools

Trace:
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 [2023/07/31 15:19] – [Project-level Optional Properties] jsmithoptional_properties [2025/08/07 15:35] (current) – yvonne_moore
Line 6: Line 6:
  
 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's name to expand it and view all the properties within that group. A new **Expand groups **check box is also available at the bottom of the editor which will open all optional property groups by default. When a new optional property is added to the project/page, the group will be expanded by default so that you can see all the properties within it.
  
 There are three types of optional property; There are three types of optional property;
Line 18: Line 20:
  
 ^ Property ^ Tooltip ^ ^ Property ^ Tooltip ^
-| Accessibility... | Hide the accessibility logo and link or change the link to an alternative statement. |+| [[accessibility_project_properties|Accessibility...]] | Hide the accessibility logo and link or change the link to an alternative statement. |
 | Author Support | Enabled, this property adds support comments (in red text) to help authors design pages.  These support comments only show in the Preview and not in the published project, and include unique IDs and Labels. Helpful for complex page setup such as with the Inventory page (where answers are matched to categories) or the Decision tree page. | | Author Support | Enabled, this property adds support comments (in red text) to help authors design pages.  These support comments only show in the Preview and not in the published project, and include unique IDs and Labels. Helpful for complex page setup such as with the Inventory page (where answers are matched to categories) or the Decision tree page. |
-| Background... | Add a background image to all pages in this project. |+| [[background_images|Background...]] | Add a background image to all pages in this project. |
 | Decimal Separator | Select the appropriate symbol for numbers with decimal points.  The default is period (fullstop) with comma as the alternative. (E.g. £5.10 or €5,10). | | Decimal Separator | Select the appropriate symbol for numbers with decimal points.  The default is period (fullstop) with comma as the alternative. (E.g. £5.10 or €5,10). |
 | Disable Theme url | If you set access to Public in the Project Properties a Learning Object's theme can be overridden __in the browser__ by adding a url parameter (i.e. a string of characters) to the url.  For example, this url parameter, //&theme=flatblue// , changes the theme to the Flat Blue theme. The theme can only be changed to one of those available in the host installation. The theme url parameter to use, when changing a theme by this method, is shown in each theme's description in the Project Settings, and is often shorter and not the same as the display name of the theme. However, as an author you can tick this optional property, if you wish, to disable this feature. This stops learners and other users changing the theme you have chosen. | | Disable Theme url | If you set access to Public in the Project Properties a Learning Object's theme can be overridden __in the browser__ by adding a url parameter (i.e. a string of characters) to the url.  For example, this url parameter, //&theme=flatblue// , changes the theme to the Flat Blue theme. The theme can only be changed to one of those available in the host installation. The theme url parameter to use, when changing a theme by this method, is shown in each theme's description in the Project Settings, and is often shorter and not the same as the display name of the theme. However, as an author you can tick this optional property, if you wish, to disable this feature. This stops learners and other users changing the theme you have chosen. |
 | Force First Page | Enabled, forces the project to open on the first page of the project, even if the URL includes specific page information. %%Useful when creating projects, such as escape rooms, where you don't want users to be able to jump ahead.%% | | Force First Page | Enabled, forces the project to open on the first page of the project, even if the URL includes specific page information. %%Useful when creating projects, such as escape rooms, where you don't want users to be able to jump ahead.%% |
-| Full Screen Button... | This property is only visible if you have selected **Fixed Size** from the **Display Mode** drop-down in the core properties for the project (%%the toolbar button that toggles between full screen and fixed size is now hidden by default and will only be shown if the **Display Mode** is set to **Fixed Size**).  You can customise the icon and the text displayed on mouseover for both **Fixed Size **and **Full Screen**.%% | +| Full Screen Button... | This property is only visible if you have selected **Fixed Size** from the **Display Mode** drop-down in the core properties for the project (the toolbar button that toggles between full screen and fixed size is now hidden by default and will only be shown if the **Display Mode** is set to **Fixed Size**).  You can customise the icon and the text displayed on mouseover for both **Fixed Size** and **Full Screen**. | 
-| Glossary... | Adds a table to the root page of the project, where terms and definitions can be added. Wherever these terms are used in the project they will be highlighted by a dashed underline. Hovering the mouse over the term will reveal a tooltip with the definition.  An icon will also be added to the footer of the project.   The icon can be customised, and the text of the tooltip can be edited.  Individual page types have the optional property to 'Disable Glossary' where this support would interfere with student activity. |+| [[xot_glossary|Glossary...]] | Adds a table to the root page of the project, where terms and definitions can be added. Wherever these terms are used in the project they will be highlighted by a dashed underline. Hovering the mouse over the term will reveal a tooltip with the definition.  An icon will also be added to the footer of the project.   The icon can be customised, and the text of the tooltip can be edited.  Individual page types have the optional property to 'Disable Glossary' where this support would interfere with student activity. |
 | Header Icon/Logo... | Provides the ability to upload an image to display (for example as a logo) in the project header.  The image dimensions should be small.  The image can be hidden/unhidden and positioned left or right in the header. | | Header Icon/Logo... | Provides the ability to upload an image to display (for example as a logo) in the project header.  The image dimensions should be small.  The image can be hidden/unhidden and positioned left or right in the header. |
-| Help File... | Provides the ability to upload a file (e.g. PDF) or add a URL, to contain instructions or support material.  An icon link will be added to the project's footer to make access to the file/link available on all pages.   The icon can be customised, and  the text of the tooltip displayed on mouseover of the icon can be edited. |+| [[xot_help_file|Help File...]] | Provides the ability to upload a file (e.g. PDF) or add a URL, to contain instructions or support material.  An icon link will be added to the project's footer to make access to the file/link available on all pages.   The icon can be customised, and  the text of the tooltip displayed on mouseover of the icon can be edited. |
 | Hide Footer | Enabled, this will hide the footer of your project. | | Hide Footer | Enabled, this will hide the footer of your project. |
 | Hide Header | Enabled, this will hide the header of your project. | | Hide Header | Enabled, this will hide the header of your project. |
 | Home Page ... | Makes the LO Title in the header a clickable link to the Home Page.  By default, the home page is the first page in the project; if you want a different home page, select a page from the drop-down which appears when you add this optional property. | | Home Page ... | Makes the LO Title in the header a clickable link to the Home Page.  By default, the home page is the first page in the project; if you want a different home page, select a page from the drop-down which appears when you add this optional property. |
 | Keyboard Language | Provides the ability to give the user keyboard language support when they are required to enter text on an interactive page.  E.g., if a language other than English is selected, a pop-up dialog of special characters (appropriate to the chosen language) will appear when the user enters a text box. | | Keyboard Language | Provides the ability to give the user keyboard language support when they are required to enter text on an interactive page.  E.g., if a language other than English is selected, a pop-up dialog of special characters (appropriate to the chosen language) will appear when the user enters a text box. |
-| Lightbox... | By default, clicked images will open in a lightbox (i.e. a pop up that overlays the main page). Use these properties to turn the lightbox functionality on/off for the whole project. A lightbox property is also available on each page. |+| [[lightbox|Lightbox...]] | By default, clicked images will open in a lightbox (i.e. a pop up that overlays the main page). Use these properties to turn the lightbox functionality on/off for the whole project. A lightbox property is also available on each page. |
 | 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. |+| 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. | | 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. |
-| 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. |
 | Show/Hide Footer Tools... | This provides options for showing or hiding the footer icons for tools such as the Accessibility Options, Full Screen, Glossary etc.  The icon can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited. | | Show/Hide Footer Tools... | This provides options for showing or hiding the footer icons for tools such as the Accessibility Options, Full Screen, Glossary etc.  The icon can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited. |
-| Side Bar... | Adds a collapsible side bar to the Learning Object containing buttons which would normally be found in the footer. |+| [[xot_side_bar|Side Bar...]] | Adds a collapsible side bar to the Learning Object containing buttons which would normally be found in the footer. |
 | Styles | Provides the ability to add custom CSS to change the appearance of HTML elements in the project.  At root level the CSS will affect all pages, or it can be added to individual pages to just affect that one. | | Styles | Provides the ability to add custom CSS to change the appearance of HTML elements in the project.  At root level the CSS will affect all pages, or it can be added to individual pages to just affect that one. |
 | Stylesheet | Provides the ability to upload and apply a separate CSS stylesheet file to change the appearance of HTML elements of the whole project. | | Stylesheet | Provides the ability to upload and apply a separate CSS stylesheet file to change the appearance of HTML elements of the whole project. |
Line 49: Line 51:
 | Tracking... | Passing Score: Passing score as a decimal fraction or percentage when tracking\\ Page timeout for completion: The number of seconds a page as to be viewed to count as completed\\ Force tracking mode behaviour: Force tracking mode behaviour, even in non-tracking LO's. This changes the behaviour of some page types, i.e. in Quiz the restart button will be disabled and in drag/drop exercises, the labels will stick, even if the answer is wrong\\ Tracking Category: Label indicating the category of this learning object, stored in xAPI events, to be used for categorising in xAPI reports. The icon for the Save Session button can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited. | | Tracking... | Passing Score: Passing score as a decimal fraction or percentage when tracking\\ Page timeout for completion: The number of seconds a page as to be viewed to count as completed\\ Force tracking mode behaviour: Force tracking mode behaviour, even in non-tracking LO's. This changes the behaviour of some page types, i.e. in Quiz the restart button will be disabled and in drag/drop exercises, the labels will stick, even if the answer is wrong\\ Tracking Category: Label indicating the category of this learning object, stored in xAPI events, to be used for categorising in xAPI reports. The icon for the Save Session button can be customised, and the text of the tooltip displayed on mouseover of the icon can be edited. |
 | 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. |
  
 ===== Deprecated Project-level Optional Properties ===== ===== Deprecated Project-level Optional Properties =====
Line 69: Line 71:
  
 ^ Property ^ Tooltip ^ ^ Property ^ Tooltip ^
-| Access Code... | %%Allows individual pages to be hidden until an access code is entered. The access code field should contain a comma separated list of all valid access codes. When a page or section is hidden behind an access code, a password box will be shown until a correct code is entered. A padlock icon will display against any page (in the page tree) which includes an access code.%%  |+| Access Code... | %%Allows individual pages to be hidden until an access code is entered. The access code field should contain a comma separated list of all valid access codes. When a page or section is hidden behind an access code, a password box will be shown until a correct code is entered. A padlock icon will display against any page (in the page tree) which includes an access code. %%**New in 3.13**. The Access code optional property group is available on every page, and there are four types available: Standard (default), Standard (centred), Vault and Keypad. [[https://xot.xerte.org.uk/play.php?template_id=81#v313|See release notes]].  |
 | [[op_background|Background...]] | Add a background image to this page. | | [[op_background|Background...]] | Add a background image to this page. |
 | [[op_completion_not_required|Completion Not Required]] | Remove the page from project tracking data.  | | [[op_completion_not_required|Completion Not Required]] | Remove the page from project tracking data.  |
optional_properties.1690816753.txt.gz · Last modified: 2023/07/31 15:19 by jsmith