help menu

Author: meganrogge

src/vs/editor/common/standaloneStrings.ts

@@ -7,7 +7,7 @@ import * as nls from 'vs/nls';
 
 export namespace AccessibilityHelpNLS {
 	export const accessibilityHelpTitle = nls.localize('accessibilityHelpTitle', "Accessibility Help");
-	export const openingDocs = nls.localize("openingDocs", "Now opening the Editor Accessibility documentation page.");
+	export const openingDocs = nls.localize("openingDocs", "Now opening the Accessibility documentation page.");
 	export const readonlyDiffEditor = nls.localize("readonlyDiffEditor", "You are in a read-only pane of a diff editor.");
 	export const editableDiffEditor = nls.localize("editableDiffEditor", "You are in a pane of a diff editor.");
 	export const readonlyEditor = nls.localize("readonlyEditor", "You are in a read-only code editor");
@@ -20,7 +20,6 @@ export namespace AccessibilityHelpNLS {
 	export const tabFocusModeOnMsgNoKb = nls.localize("tabFocusModeOnMsgNoKb", "Pressing Tab in the current editor will move focus to the next focusable element. The command {0} is currently not triggerable by a keybinding.");
 	export const tabFocusModeOffMsg = nls.localize("tabFocusModeOffMsg", "Pressing Tab in the current editor will insert the tab character. Toggle this behavior by pressing {0}.");
 	export const tabFocusModeOffMsgNoKb = nls.localize("tabFocusModeOffMsgNoKb", "Pressing Tab in the current editor will insert the tab character. The command {0} is currently not triggerable by a keybinding.");
-	export const openDoc = nls.localize("openDoc", "Press H now to open a browser window with more information related to editor accessibility.");
 	export const showAccessibilityHelpAction = nls.localize("showAccessibilityHelpAction", "Show Accessibility Help");
 }
 

src/vs/workbench/contrib/accessibility/browser/accessibility.contribution.ts

@@ -23,9 +23,6 @@ import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle
 import { Registry } from 'vs/platform/registry/common/platform';
 import { ICommandService } from 'vs/platform/commands/common/commands';
 import { NEW_UNTITLED_FILE_COMMAND_ID } from 'vs/workbench/contrib/files/browser/fileConstants';
-import { KeyCode } from 'vs/base/common/keyCodes';
-import { URI } from 'vs/base/common/uri';
-import { IOpenerService } from 'vs/platform/opener/common/opener';
 import { ModesHoverController } from 'vs/editor/contrib/hover/browser/hover';
 import { withNullAsUndefined } from 'vs/base/common/types';
 
@@ -39,23 +36,16 @@ class AccessibilityHelpProvider extends Disposable implements IAccessibleContent
 	}
 	options: IAccessibleViewOptions = { isHelpMenu: true, ariaLabel: localize('terminal-help-label', "terminal accessibility help") };
 	id: string = 'editor';
-	onKeyDown(e: IKeyboardEvent): void {
-		if (e.keyCode === KeyCode.KeyH) {
-			alert(AccessibilityHelpNLS.openingDocs);
-
-			let url = (this._editor.getRawOptions() as any).accessibilityHelpUrl;
-			if (typeof url === 'undefined') {
-				url = 'https://go.microsoft.com/fwlink/?linkid=852450';
-			}
-			this._openerService.open(URI.parse(url));
-		}
-	}
 	constructor(
 		private readonly _editor: ICodeEditor,
-		@IKeybindingService private readonly _keybindingService: IKeybindingService,
-		@IOpenerService private readonly _openerService: IOpenerService
+		@IKeybindingService private readonly _keybindingService: IKeybindingService
 	) {
 		super();
+		let url = (this._editor.getRawOptions() as any).accessibilityHelpUrl;
+		if (typeof url === 'undefined') {
+			url = 'https://go.microsoft.com/fwlink/?linkid=852450';
+		}
+		this.options.readMoreUrl = url;
 	}
 
 	private _descriptionForCommand(commandId: string, msg: string, noKbMsg: string): string {
@@ -107,7 +97,6 @@ class AccessibilityHelpProvider extends Disposable implements IAccessibleContent
 		} else {
 			content.push(this._descriptionForCommand(ToggleTabFocusModeAction.ID, AccessibilityHelpNLS.tabFocusModeOffMsg, AccessibilityHelpNLS.tabFocusModeOffMsgNoKb));
 		}
-		content.push(AccessibilityHelpNLS.openDoc);
 		return content.join('\n');
 	}
 }

src/vs/workbench/contrib/accessibility/browser/accessibleView.ts

@@ -12,11 +12,13 @@ import { EditorExtensionsRegistry } from 'vs/editor/browser/editorExtensions';
 import { CodeEditorWidget, ICodeEditorWidgetOptions } from 'vs/editor/browser/widget/codeEditorWidget';
 import { ITextModel } from 'vs/editor/common/model';
 import { IModelService } from 'vs/editor/common/services/model';
+import { AccessibilityHelpNLS } from 'vs/editor/common/standaloneStrings';
 import { LinkDetector } from 'vs/editor/contrib/links/browser/links';
 import { localize } from 'vs/nls';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { IContextViewDelegate, IContextViewService } from 'vs/platform/contextview/browser/contextView';
 import { IInstantiationService, createDecorator } from 'vs/platform/instantiation/common/instantiation';
+import { IOpenerService } from 'vs/platform/opener/common/opener';
 import { SelectionClipboardContributionID } from 'vs/workbench/contrib/codeEditor/browser/selectionClipboard';
 import { getSimpleEditorOptions } from 'vs/workbench/contrib/codeEditor/browser/simpleEditorOptions';
 import { IDisposable } from 'xterm';
@@ -45,6 +47,7 @@ export interface IAccessibleViewService {
 export interface IAccessibleViewOptions {
 	ariaLabel: string;
 	isHelpMenu?: boolean;
+	readMoreUrl?: string;
 }
 
 
@@ -54,6 +57,7 @@ class AccessibleView extends Disposable {
 	private _editorContainer: HTMLElement;
 
 	constructor(
+		@IOpenerService private readonly _openerService: IOpenerService,
 		@IInstantiationService private readonly _instantiationService: IInstantiationService,
 		@IConfigurationService private readonly _configurationService: IConfigurationService,
 		@IModelService private readonly _modelService: IModelService,
@@ -99,9 +103,9 @@ class AccessibleView extends Disposable {
 	private _render(provider: IAccessibleContentProvider, container: HTMLElement): IDisposable {
 		const settingKey = `accessibility.verbosity.${provider.id}`;
 		const value = this._configurationService.getValue(settingKey);
-
+		const readMoreLink = provider.options.readMoreUrl ? localize("openDoc", "\nPress H now to open a browser window with more information related to accessibility.\n") : '';
 		const disableHelpHint = provider.options.isHelpMenu && value ? localize('disable-help-hint', '\nTo disable the `accessibility.verbosity` hint for this feature, press D now.\n') : '\n';
-		const fragment = provider.provideContent() + disableHelpHint + localize('exit-tip', 'Exit this menu via the Escape key.');
+		const fragment = provider.provideContent() + readMoreLink + disableHelpHint + localize('exit-tip', 'Exit this menu via the Escape key.');
 
 		this._getTextModel(URI.from({ path: `accessible-view-${provider.id}`, scheme: 'accessible-view', fragment })).then((model) => {
 			if (!model) {
@@ -119,6 +123,10 @@ class AccessibleView extends Disposable {
 					this._contextViewService.hideContextView();
 				} else if (e.keyCode === KeyCode.KeyD) {
 					this._configurationService.updateValue(settingKey, false);
+				} else if (e.keyCode === KeyCode.KeyH && provider.options.readMoreUrl) {
+					const url: string = provider.options.readMoreUrl!;
+					alert(AccessibilityHelpNLS.openingDocs);
+					this._openerService.open(URI.parse(url));
 				}
 				e.stopPropagation();
 				provider.onKeyDown?.(e);

src/vs/workbench/contrib/terminalContrib/accessibility/browser/terminalAccessibilityHelp.ts

@@ -29,7 +29,11 @@ export class TerminalAccessibleContentProvider extends Disposable implements IAc
 		this._instance.focus();
 		this.dispose();
 	}
-	options: IAccessibleViewOptions = { isHelpMenu: true, ariaLabel: localize('terminal-help-label', "terminal accessibility help") };
+	options: IAccessibleViewOptions = {
+		isHelpMenu: true,
+		ariaLabel: localize('terminal-help-label', "terminal accessibility help"),
+		readMoreUrl: 'https://code.visualstudio.com/docs/editor/accessibility#_terminal-accessibility'
+	};
 	id: string = 'terminal';
 
 	constructor(
@@ -75,7 +79,6 @@ export class TerminalAccessibleContentProvider extends Disposable implements IAc
 		content.push(this._descriptionForCommand(TerminalCommandId.OpenDetectedLink, localize('openDetectedLink', 'The Open Detected Link ({0}) command enables screen readers to easily open links found in the terminal.'), localize('openDetectedLinkNoKb', 'The Open Detected Link command enables screen readers to easily open links found in the terminal and is currently not triggerable by a keybinding.')));
 		content.push(this._descriptionForCommand(TerminalCommandId.NewWithProfile, localize('newWithProfile', 'The Create New Terminal (With Profile) ({0}) command allows for easy terminal creation using a specific profile.'), localize('newWithProfileNoKb', 'The Create New Terminal (With Profile) command allows for easy terminal creation using a specific profile and is currently not triggerable by a keybinding.')));
 		content.push(localize('accessibilitySettings', 'Access accessibility settings such as `terminal.integrated.tabFocusMode` via the Preferences: Open Accessibility Settings command.'));
-		content.push(localize('readMore', 'Read more about terminal accessibility https://code.visualstudio.com/docs/editor/accessibility#_terminal-accessibility'));
 		return content.join('\n');
 	}
 }