Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Singular definitions defined at course level #8

Open
guywillis opened this issue Nov 21, 2024 · 3 comments
Open

Feature request: Singular definitions defined at course level #8

guywillis opened this issue Nov 21, 2024 · 3 comments

Comments

@guywillis
Copy link
Contributor

Subject of the enhancement

Add a configuration option to the definition items to allow for course (global) level definition without the definition applying to every instance of the word.

This would be useful for the Authoring Tool to remove the need for inline styling to apply a definition to a term that is used throughout the course.

e.g.

{
    "words": [
        "Adapt Framework"
    ],
    "definition": "This is a piece of software which</br>allows you to create e-learning.",
    "_applyToFirstWordOnly": true
},
{
    "words": [
        "the",
        "a"
    ],
    "definition": "Excellent word this one",
    "_applyToFirstWordOnly": false
}

The definition for Adapt Framework would only appear the first time this word is used in the course content whereas the definition for the and a would appear throughout the course whenever those words are used.

Your environment

  • Master
@guywillis guywillis changed the title Feature request: Feature request: Singular definitions defined at course level Nov 21, 2024
@oliverfoster
Copy link
Member

First as in: the first time it's rendered or the first menu/page it appears on in the content order?

:: user initially visits page 2
:: user initially visits page 1

@guywillis
Copy link
Contributor Author

Good question and point.

I had initially thought first instance sequentially via the JSON but that, as you have quite rightly identified, leaves a potential issue if the course is consumed in a non-sequential order.

Ideally, it would be first instance it's rendered on screen to the user.

@oliverfoster
Copy link
Member

oliverfoster commented Dec 2, 2024

If it is rendered/displayed would it stay at its first position (very difficult) or would it never be displayed again (easy)?
If it is rendered/displayed but not clicked, does it get rendered again later?

So that it's very explicitly designed to be in one place, rather than trying to get the automatic renderer to decide, could we not just use the manual markup for this?

To make it easier it could just do the first occurance of the word for each content object?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants