Title: Online support for about_... help topics · Issue #13550 · PowerShell/PowerShell · GitHub
Open Graph Title: Online support for about_... help topics · Issue #13550 · PowerShell/PowerShell
X Title: Online support for about_... help topics · Issue #13550 · PowerShell/PowerShell
Description: Get-Help can display both locally cached help files and online resources. Since online resources do not require prerequisites like Update-Help and are always up-to-date, and since online resources are much better formatted and include na...
Open Graph Description: Get-Help can display both locally cached help files and online resources. Since online resources do not require prerequisites like Update-Help and are always up-to-date, and since online resources ...
X Description: Get-Help can display both locally cached help files and online resources. Since online resources do not require prerequisites like Update-Help and are always up-to-date, and since online resources ...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/13550
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Online support for about_... help topics","articleBody":"Get-Help can display both locally cached help files and online resources.\r\nSince online resources do not require prerequisites like Update-Help and are always up-to-date, and since online resources are much better formatted and include navigation to discover related items, a \"Copy\" button to copy&paste sample code, and more, many users default to using online help, i.e. by adding this to their profile:\r\n\r\n```powershell\r\n$PSDefaultParameterValues.Add(\"Get-Help:Online\",$true)\r\n```\r\n\r\nNow, without any prerequisites, users can easily display cmdlet help in an extra window like so:\r\n\r\n```powershell\r\ndir -?\r\nGet-Process -?\r\n```\r\n\r\nHowever, Get-Help -Online can only show help topics with a dedicated URI property. That's why all about_... topics fail to display even though there are online versions available.\r\n\r\n## Steps to reproduce\r\n\r\n```powershell\r\nhelp Get-process -Online # works\r\nhelp about_for -Online #fails\r\n```\r\n\r\n## Expected behavior\r\nWhen Get-Help is used with -Online, it should detect whether the requested help starts with about_ and then construct the appropriate URI rather than fail. This could be done with a hard-coded topic list to include only the MSFT about_ topics, or simply done heuristically with the potential of failing for about topics from 3rd party.\r\n\r\nIf all else fails and there is no match, Get-Help -Online should default to the PowerShell documentation home page: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core This would enable users to try and search there rather than being left with a red exception.\r\n\r\n```PowerShell\r\nGet-Help about_for -Online # should open https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_for\r\nGet-Help about_doesnotexist -Online # should open https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core\r\n```\r\n\r\n## Actual behavior\r\nGet-Help -Online fails for any topic that has no distinct URI property\r\n\r\n\r\n## Environment data\r\n\r\n```none\r\n\r\nName Value\r\n---- -----\r\nPSVersion 7.0.3\r\nPSEdition Core\r\nGitCommitId 7.0.3\r\nOS Microsoft Windows 10.0.18363\r\nPlatform Win32NT\r\nPSCompatibleVersions {1.0, 2.0, 3.0, 4.0}\r\nPSRemotingProtocolVersion 2.3\r\nSerializationVersion 1.1.0.1\r\nWSManStackVersion 3.0\r\n\r\n\r\n```\r\n","author":{"url":"https://github.com/TobiasPSP","@type":"Person","name":"TobiasPSP"},"datePublished":"2020-08-31T08:33:41Z","url":"https://github.com/PowerShell/PowerShell/issues/13550"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:80e6e36f-89ab-41e5-6f7b-1fa57626acc8 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BE9E:35F311:2832AB:38A384:6AFDB1AE |
| html-safe-nonce | 0571fe584a67337ce37ad82bea645bef70fc133e93194dc3608d73a0a779ab8c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCRTlFOjM1RjMxMToyODMyQUI6MzhBMzg0OjZBRkRCMUFFIiwidmlzaXRvcl9pZCI6IjE4NjI4MTM0NzUxMTQxNjg3NTAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 48b6b98d75d1fe6660ff6b7a8dd6bd136615b5db49f6343d2a2d8143e980b3f6 |
| hovercard-subject-tag | issue:689026838 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PowerShell/13550/issue_layout |
| twitter:image | https://opengraph.githubassets.com/bc42ddaa7889521466007bb9dc2db7dc909d73abd0766a314d0842ef66afd3b6/PowerShell/PowerShell/issues/13550 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/bc42ddaa7889521466007bb9dc2db7dc909d73abd0766a314d0842ef66afd3b6/PowerShell/PowerShell/issues/13550 |
| og:image:alt | Get-Help can display both locally cached help files and online resources. Since online resources do not require prerequisites like Update-Help and are always up-to-date, and since online resources ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | TobiasPSP |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3c532f4d069d6fbe9b1837450343d1b9e0619a7d5c4ba0b3b64fd8e0bae67c7e |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 49609581 |
| octolytics-dimension-repository_nwo | PowerShell/PowerShell |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 49609581 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PowerShell |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 5396ad00d1c6d19097aee7fc4d00a2eb03432c8f |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width