Merge pull request #10939 from keymanapp/docs/developer/10550-ldml-wi…

…ndow-help-links

docs(developer): add help site links

developer/src/tike/child/Keyman.Developer.UI.UfrmLdmlKeyboardEditor.pas

@@ -32,6 +32,7 @@   TfrmLdmlKeyboardEditor = class(TfrmEditor)
   protected
     procedure LoadSettings; override;
     procedure SaveSettings(SaveProject: Boolean); override;
+    function GetHelpTopic: string; override;
   public
     procedure StartDebugging;
     procedure StopDebugging;
@@ -45,6 +46,7 @@ implementation
 uses
   keymanstrings,
   KeymanDeveloperOptions,
+  Keyman.Developer.System.HelpTopics,
   Keyman.System.Debug.DebugUIStatus,
   Keyman.Developer.System.Project.xmlLdmlProjectFile,
   Keyman.Developer.UI.Project.ProjectFileUI,
@@ -65,6 +67,11 @@ procedure TfrmLdmlKeyboardEditor.FormCreate(Sender: TObject);
   SetupDebugForm;
 end;
 
+function TfrmLdmlKeyboardEditor.GetHelpTopic: string;
+begin
+  Result := SHelpTopic_Context_LdmlEditor;
+end;
+
 function TfrmLdmlKeyboardEditor.GetIsDebugVisible: Boolean;
 begin
   Result := panDebugHost.Visible;

developer/src/tike/help/Keyman.Developer.System.HelpTopics.pas

@@ -8,6 +8,8 @@ interface
   SHelpTopic_Context_CharacterMap = 'context/character-map';
   SHelpTopic_Context_CharacterIdentifier = 'context/character-identifier';
   SHelpTopic_Context_Debug = 'context/debug';
+  SHelpTopic_Context_LdmlDebug = 'context/ldml-debug';
+  SHelpTopic_Context_LdmlEditor = 'context/ldml-editor';
   SHelpTopic_Context_DebugStatus = 'context/debug#toc-state';
   SHelpTopic_Context_DebugStatus_CallStack = 'context/debug#toc-call-stack';
   SHelpTopic_Context_DebugStatus_DeadKeys = 'context/debug#toc-deadkeys';
@@ -25,6 +27,7 @@ interface
   SHelpTopic_Context_NewProject = 'context/new-project';
   SHelpTopic_Context_NewProjectParameters = 'context/new-project-parameters';
   SHelpTopic_Context_NewModelProjectParameters = 'context/new-model-project-parameters';
+  SHelpTopic_Context_NewLdmlProjectParameters = 'context/new-ldml-project-parameters';
   SHelpTopic_Context_NewFileDetails = 'context/new-file-details';
   SHelpTopic_Context_OnScreenKeyboardEditor = 'context/keyboard-editor#toc-on-screen-tab';
   SHelpTopic_Context_Options = 'context/options';

developer/src/tike/main/UframeTextEditor.pas

@@ -105,6 +105,7 @@   TframeTextEditor = class(TTIKEForm, IKMDEditActions, IKMDSearchActions, IKMDTe
       State: TDragState; var Accept: Boolean);
     procedure DelayedFindError;
     procedure DoOpenLinkIfExternal(const url: string; var handled: Boolean);
+    procedure cefHelpTopic(Sender: TObject);
 
   protected
     function GetHelpTopic: string; override;
@@ -349,6 +350,7 @@ procedure TframeTextEditor.FormCreate(Sender: TObject);
   cef.OnCommand := cefCommand;
   cef.OnLoadEnd := cefLoadEnd;
   cef.OnBeforeBrowseSync := cefBeforeBrowseSync;
+  cef.OnHelpTopic := cefHelpTopic;
 
   cef.cef.OnBeforeContextMenu := cefBeforeContextMenu;
   cef.cef.OnContextMenuCommand := cefContextMenuCommand;
@@ -364,6 +366,11 @@ procedure TframeTextEditor.SetupCharMapDrop;
   GetCharMapDropTool.Handle(cef, cmimDefault, CharMapDragOver, CharMapDragDrop);
 end;
 
+procedure TframeTextEditor.cefHelpTopic(Sender: TObject);
+begin
+  frmKeymanDeveloper.HelpTopic(Self);
+end;
+
 procedure TframeTextEditor.cefLoadEnd(Sender: TObject);
 begin
   FHasBeenLoaded := True;
@@ -1126,7 +1133,11 @@ procedure TframeTextEditor.UpdateToken(command: string);
 function TframeTextEditor.GetHelpTopic: string;
 begin
   if FEditorFormat <> efKMN then
+  begin
+    if Parent is TTIKEForm then
+      Exit((Parent as TTIKEForm).HelpTopic);
     Exit(SHelpTopic_Context_TextEditor);
+  end;
 
   Result := HelpKeyword;
 end;

developer/src/tike/project/Keyman.Developer.UI.Project.UfrmNewLDMLKeyboardProjectParameters.pas

@@ -293,7 +293,7 @@ function TfrmNewLDMLKeyboardProjectParameters.GetFullCopyright: string;
 
 function TfrmNewLDMLKeyboardProjectParameters.GetHelpTopic: string;
 begin
-  Result := SHelpTopic_Context_NewProjectParameters;
+  Result := SHelpTopic_Context_NewLdmlProjectParameters;
 end;
 
 function TfrmNewLDMLKeyboardProjectParameters.GetKeyboardID: string;