[[ Bug 20901 ]] Fix issues with users' extension guides

livecodeali · livecodeali · commit 6e8ece247b33 · 2018-01-24T23:10:31.000Z
- Update name and display name using extension data
- Add 'location' for users' guide images to resolve correctly
diff --git a/Documentation/html_viewer/js/guide_functions.js b/Documentation/html_viewer/js/guide_functions.js
@@ -67,10 +67,17 @@
 			{
 				return '<img src="' + tRepoFolder + '/images/' + image_file + '" />';
 			}
-			else
+			else if (tGuideLocation == 'ide')
 			{
 				return '<img src="' + tIDEFolder + '/images/' + image_file + '" />';
 			}
+			else
+			{
+				var tExtImageFolder = '<img src="';
+				tExtImageFolder += tUserGuideData.guides[pGuideIndex].location;
+				tExtImageFolder += '/images/' + image_file + '" />';
+				return tExtImageFolder;
+			}
 		},
 	
 		renderer.link = function(href, title, text)
diff --git a/Toolset/libraries/revidelibrary.8.livecodescript b/Toolset/libraries/revidelibrary.8.livecodescript
@@ -11017,11 +11017,12 @@ private function revIDEGetDocsGuideData
       put empty into tExtensionGuide
       put tExtensionData["folder"] into tFolder
       put revEnvironmentUserDocsPath() & slash & \ 
-            the last item of tFolder into tCachedDataFolder
+            tExtensionData["name"] into tCachedDataFolder
       put tFolder & slash & "guide.md" into tGuideFile
       if there is not a file tGuideFile then
          -- User widgets have the guide.md in docs/guide/
-         put tFolder & slash & "docs/guide/guide.md" into tGuideFile
+         put "/docs/guide" after tFolder
+         put tFolder & slash & "guide.md" into tGuideFile
       end if
       if there is not a file tGuideFile then next repeat
       revIDEEnsurePath tCachedDataFolder
@@ -11040,8 +11041,10 @@ private function revIDEGetDocsGuideData
          
          if tGuide is not empty then
             put "{" & CR after tExtensionGuide
-            put tab & quote & "name" & quote & ":" && quote & tFolder & quote & comma & CR after tExtensionGuide
-            put tab & quote & "display name" & quote & ":" && quote & tFolder & quote & comma & CR after tExtensionGuide
+            put tab & quote & "name" & quote & ":" && quote & tExtensionData["name"] & quote & comma & CR after tExtensionGuide
+            put tab & quote & "display name" & quote & ":" && quote & tExtensionData["title"] & quote & comma & CR after tExtensionGuide
+            put tab & quote & "group" & quote & ":" && quote & "Extensions" & quote & comma & CR after tExtensionGuide
+            put tab & quote & "location" & quote & ":" && quote & tFolder & quote & comma & CR after tExtensionGuide
             put quote & "data" & quote & ":" & escape(tGuide, true) & CR after tExtensionGuide
             put "}" after tExtensionGuide
             
diff --git a/notes/bugfix-20901.md b/notes/bugfix-20901.md
@@ -0,0 +1 @@
+# Fix issues with users' extension guides

Original file line number	Diff line number	Diff line change
`@@ -67,10 +67,17 @@`
`67`	`67`	`{`
`68`	`68`	`return '<img src="' + tRepoFolder + '/images/' + image_file + '" />';`
`69`	`69`	`}`
`70`		`- else`
	`70`	`+ else if (tGuideLocation == 'ide')`
`71`	`71`	`{`
`72`	`72`	`return '<img src="' + tIDEFolder + '/images/' + image_file + '" />';`
`73`	`73`	`}`
	`74`	`+ else`
	`75`	`+ {`
	`76`	`+ var tExtImageFolder = '<img src="';`
	`77`	`+ tExtImageFolder += tUserGuideData.guides[pGuideIndex].location;`
	`78`	`+ tExtImageFolder += '/images/' + image_file + '" />';`
	`79`	`+ return tExtImageFolder;`
	`80`	`+ }`
`74`	`81`	`},`
`75`	`82`
`76`	`83`	`renderer.link = function(href, title, text)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Fix issues with users' extension guides`