Added explicit anchors to section headings in the user guide.#7762
Merged
Conversation
Collaborator
|
Though it would make your pr way more huge, personally I'd also add anchors to the several options (e.g. ==== Language ====, ==== Show exit options when exiting NVDA ==== . That would really improve things if something like context sensitive help would be implemented. |
Contributor
|
@ThomasStivers could you please split out the work on context separate help into a new PR. |
9f825f5 to
cf35b0c
Compare
ThomasStivers
added a commit
to ThomasStivers/nvda
that referenced
this pull request
Nov 28, 2017
feerrenrut
approved these changes
Dec 11, 2017
Member
|
@feerrenrut: As this only changes the user guide, can this be merged to master as soon as possible? Recent merges to master have now made this out of date with conflicts that need to be resolved. Merging current master to next is also currently very tricky. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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:
Part of #7757.
Summary of the issue:
The user guide contains automatically generated anchors for many sections. These cannot be consistently linked to because the guide may be reorganized.
Description of how this pull request fixes the issue:
Instead of letting anchor names for section headings be generated here they are specified so they can be used by a context sensitive help system.
Testing performed:
Used
scons user_guideand verified that the links in the table of contents and the anchors at section headings work as expected.Known issues with pull request:
This makes the source of the user guide slightly less pretty.
Change log entry:
No user visible changes.