adapt_framework icon indicating copy to clipboard operation
adapt_framework copied to clipboard

Published 20 hours ago • verified publisher icon adaptlearning

Core + Plugins - Move instruction text to core schema

Open guywillis opened this issue 7 years ago • 5 comments

At present, the instruction text schema property is self contained in each individual component rather than housed globally in the core component.model.schema

This issue will affect all core component schemas.

  • [ ] adapt-contrib-accordion

  • [ ] adapt-contrib-assessmentResults

  • [ ] adapt-contrib-gmcq

  • [ ] adapt-contrib-graphic

  • [ ] adapt-contrib-hotgraphic

  • [ ] adapt-contrib-matching

  • [ ] adapt-contrib-mcq

  • [ ] adapt-contrib-media

  • [ ] adapt-contrib-narrative

  • [ ] adapt-contrib-slider

  • [ ] adapt-contrib-text

  • [ ] adapt-contrib-textInput

  • [ ] adapt-contrib-confidenceSlider

Core schema that needs updating:

  • [ ] component.model.schema

guywillis avatar Aug 18 '17 14:08 guywillis

@guywillis is the proposal to remove instruction from each of the core plugins schema and move to the component schema? If so will this cause issues for authoring tool users who have existing courses?

We will need to make sure it's backward compatible in the AT with existing courses.

dancgray avatar Aug 29 '17 16:08 dancgray

Apologies if my intentions were not clear.

That is indeed the aim, and yes, it is highly likely to cause issues with existing courses if users update.

I see this ticket more of a future development amend rather than an immediate fix.

guywillis avatar Aug 30 '17 09:08 guywillis

So, component model.schema in the authoring tool's develop branch now has its own instruction property. Is there something we need to do on the framework side to make sure authoring tool users don't have problems?

moloko avatar Mar 12 '18 17:03 moloko

@moloko, I think we need the framework's component schema updated if not just for the grunt translate tasks?

We're looking into writing a migration script on the authoring tool side before work begins on the plugins.

@guywillis, can you confirm there are no other changes apart from schema?

tomgreenfield avatar Jul 09 '18 14:07 tomgreenfield

@tomgreenfield That's correct, no other changes.

guywillis avatar Jul 10 '18 08:07 guywillis

@guywillis @taylortom is this issue still relevant? I see instruction is still absent from component.model.schema and is present in each plugin schema so nothing seems to have changed in 4 years!

chris-steele avatar Dec 01 '22 16:12 chris-steele

For me, yes. It's confusing that instruction text appears in a different section within the authoring tool.

guywillis avatar Dec 02 '22 10:12 guywillis

We've got better schema inheritance in the v1.0.0 authoring tool, and this has been fixed in the new schema.json files.

It's very unlikely that we'll be making any changes like this in the old schemas, so happy for this one to be closed.

@guywillis is your comment referring to inconsistencies in the order of the instruction text field in different schemas?

taylortom avatar Dec 06 '22 22:12 taylortom

It is, @taylortom. In my mind the instruction text is an integral part of core and should be placed alongside the body property.

guywillis avatar Dec 07 '22 09:12 guywillis