Add-on Store: replace old user guide "AddonsManager" anchor with "AddonStore". Embed hidden HTML to enable the former to still work #14981
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link to issue number:
Implements #14961 (comment)
Summary of the issue:
Even though the Add-ons Manager has been replaced by the Add-on Store, the anchor used for jumping to the appropriate section of the User Guide was still "
AddonsManager
".The original intent was to leave it that way, because of links to this section which might exist outside of NV Access's control.
The comment proposed a solution that both changes the anchor to be appropriate to the store, and provides a mechanism for the older anchor to continue to bring readers to the new store chapter.
Description of user facing changes
Readers will be able to reach the Add-on Store chapter of the User Guide via either
#AddonStore
or#AddonsManager
, in the HTML version of the User Guide.Description of development approach
Because we use Txt2Tags 2.5 instead of 2.6, it is not possible to use the
'''
method of including raw HTML, as suggested in the original comment. An alternative method has been used.AddonsManager
" to "AddonStore
".#AddonsManager
" to "#AddonStore
".<a name...>
elements--one for the new anchor, and one for the old.userGuide.t2tconf
to enable inclusion of HTML by converting<
to{{
, and>
to}}
. This is done using the T2T procedure outlined here.userGuideStandards.md
file.Testing strategy:
Manual testing that the anchors both work.
Known issues with pull request:
AddonStore
". Should we switch this to "Addons
"? The chapter could reasonably be either, and "#Addons
" is shorter.Code Review Checklist: