Right now, there are at least four ways to mark up tours, some of which can be combined.
- (Extension-defined only) Use messages, and rely on jqueryMsg to parse them. The problem is this only supports certain features, notably excluding things like bold and italics. I have a patch in to support wikilinks. See https://bugzilla.wikimedia.org/show_bug.cgi?id=43498 and https://bugzilla.wikimedia.org/show_bug.cgi?id=43512 .
- Use raw HTML. E.g. the guidedtour-tour-test-test-description does this. As a message, it goes through jqueryMsg, but that just preserves the existing bold.
This can also be used for on-wiki tours.
- Use parseDescription. This does an API call to the server for each step that uses it, which is a performance hit. However, it allows on-wiki tours (which can not currently use messages) to pass in wikitext and have it parsed.
- Use getPageAsDescription. This also does an API call to the server, which may also require a database access. It allows embedding a separate page. However, given that each step is generally short, I don't know how useful this is.
We should consider trying to simplify this picture as part of improving the API (https://bugzilla.wikimedia.org/show_bug.cgi?id=43530)
Version: master
Severity: normal
See Also:
https://bugzilla.wikimedia.org/show_bug.cgi?id=43498
https://bugzilla.wikimedia.org/show_bug.cgi?id=43512
https://bugzilla.wikimedia.org/show_bug.cgi?id=43530