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 [2024/12/07 14:31] – old revision restored (2024/11/29 13:40) 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 24: Line 26:
 | 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**. |
 | [[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. | | [[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. |
Line 35: 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. |+| 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. |
Line 50: Line 52:
 | 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 =====
optional_properties.1733581915.txt.gz · Last modified: 2024/12/07 14:31 by jsmith