Readme update - use of course/@course

[tomallpress]

_routeToLocation (string): When set to a valid Adapt element, the logo image will link to the specified location. Valid values include a page (e.g. co-100) or a menu (e.g. course). @Course can be used to always return to the main menu of the course.

In the 2nd sentence above, what's the difference between the use of 'course' and '@Course' here? is this an error in the readme? or does course and @Course do 2 seperate things when added to _routeToLocation? if so, could that be expanded upon please.

[oliverfoster]

_routeToLocation searches by _id, the course.json _id does not have to be "course" (I don't think the course.json is "course" in the AAT), @course is independent of _id, so instead of needing to find the course.json _id you can just specify @course

[tomallpress]

this could just be me being dim but i'm struggling to understand this sorry. are you saying "course" is used by the AAT? or just saying you could use either approach and it does the same thing? i.e. inserting a course ID (for example "m05") or you could just put in @course in which case that bypasses any need to enter a specific course ID as it's targeting the whole course the json is sitting within?

[oliverfoster]

@course [...] bypasses any need to enter a specific course ID as it's targeting the whole course the json is sitting within

Yes.

[tomallpress]

ok so could this be expanded upon in the readme a bit please? it's thrown me a bit. I'm still not clear in what situation you'd just put 'course' into the routeToLocation, rather than either using a co ID to navigate to a specific page or submenu, or just use @course to navigate to the top of the course.

[oliverfoster]

You could only use course to navigate to the main menu if the _id in the course.json was course.

[tomallpress]

in which case then I wonder then whether it would be worth removing the reference to course in the readme (given the confusion this has clearly caused me!) and instead say:

"Valid values include any content object ID (e.g. co-100) or if you wish to just navigate to the main menu, either enter the overall course ID, or just enter @course, which bypasses any need to enter a specific course ID."