Docs Integration: Several in-built variables do not open their own manual page if clicked in Code Editor 2

[gm-bug-reporter]

Description

Pressing F1 or using a middle mouse button click on cursor_sprite built-in variable doesn't open the related manual page, but instead opens up manual home page.

Manual Link

https://manual.gamemaker.io/monthly/en/#t=GameMaker_Language%2FGML_Reference%2FGeneral_Game_Control%2Fcursor_sprite.htm&rhsearch=cursor_sprite&rhhlterm=cursor_sprite

Steps To Reproduce

Anywhere in the code write:
cursor_sprite
and try middle clicking it or use F1 while mouse is hovering over the name.

Which version of GameMaker are you reporting this issue for?

IDE v2024.4.1.152 Runtime v2024.4.1.201

Which operating system(s) are you seeing the problem on?

Windows 10.0.19045.0

bd7c0583-30b8-41b0-b42e-46e28308d0cf

[YYBartT]

Changed the keyword and tag value to cursor_sprite. This should fix things, once a new (beta) manual version is released.

[mgeddesGM]

this fails in CE2 as of Beta IDE v2024.800.0.593 Runtime v2024.800.0.617

[yyalansavage]

The manual page/lookup is all present and correct, this is a CE2 specific issue. Document.RequestDefinitionLink returns no link for this from Language Server.
There are a number of other similar asset-type variables which have the issue in CE2 only - path_index, timeline_index, mask_index, sprite_index, room_first, room_last

[zreedy]

Fixed with #7150

[alicemoretti]

@YYBartT @zreedy
Has the Beta Manual been published now?

On IDE v2024.1100.0.681 Runtime v2024.1100.0.703, when trying to open the manual for any of the built-in variables above, nothing happens. I'm not sure if this is because the pages for these variables are not online yet or if there's another issue here.

[YYBartT]

@alicemoretti There hasn't been a new release of the Beta Manual, though the manual should have all pages tagged with the right keywords and none were added/changed since the last beta manual release. Clicking the variable names and keywords listed in this ticket and the linked ticket in IDE v2024.1100.0.681 Runtime v2024.1100.0.703 opens the correct page in CE1 (except macro, which opens the home page), though in CE2 the manual doesn't open for all of them.
Not sure if the changes made for this are in the beta releases?

[zreedy]

@YYBartT Can you list what specifically doesn't open? Otherwise I will close this ticket again.

[YYBartT]

@zreedy In IDE v2024.1100.0.685 Runtime v2024.1100.0.707 the correct manual page opens for cursor_sprite and all the variable names in #6249 (comment), both in CE1 and CE2. Though clicking macro opens the manual's start page in CE1 and doesn't open the manual in CE2.

[zreedy]

If there's no symbol to navigate to then not opening the manual is the preferred behavior. MMB in CE1 on the symbol #macro opens the Home page of the Manual which is not useful.

[YYBartT]

Indeed, that makes sense. Though macros are on the Constants page, which enums are also on, and the page also has keywords and tags for both (enum and macro). When you click the enum keyword the Constants page is opened, though the same doesn't happen for macro for some reason. Perhaps it's the difference between #macro and macro?

[zreedy]

The functionality can only open a single page and the mapping is provided by RoboHelp in the helpdocs_tags.json file which is rooted in the manual .zip artifact.
I looked into it more and the server reports back help:#macro instead of help://macro as it's also capturing the preceding # which clobbers the URI. The keyword macro without the # appears in the helpdocs_tags.json and can be discovered. The server just has to strip the leading #.

[stuckie]

One variable that has come up that does not seem to jump to a manual page is
GM_build_type which should point to https://manual.gamemaker.io/monthly/en/#t=GameMaker_Language%2FGML_Reference%2FOS_And_Compiler%2FGM_build_type.htm

[YYBartT]

The manual page had gm_build_type instead of GM_build_type as the tag and keyword, so GM_build_type would not be in the list. Changed this on the manual page.

[gurpreetsinghmatharoo]

Pending a beta release before setting this to Ready for QA

[YYBartT]

The beta manual has been updated and this can be tested now.