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:32] – [General Optional Properties] jsmithoptional_properties [2025/01/18 10:16] (current) – [Project-level Optional Properties] jsmith
Line 24: Line 24:
 | 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 50: Line 50:
 | 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. |
 +
  
 ===== Deprecated Project-level Optional Properties ===== ===== Deprecated Project-level Optional Properties =====
Line 68: Line 69:
  
 ^ 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. :!: %%**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]].  |+| 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.1733581965.txt.gz · Last modified: 2024/12/07 14:32 by jsmith