Skip to main content

Updateable Help

export const frontMatter = { title: 'Updateable Help', description: 'Hosting notes for Keldor PowerShell updateable help metadata and CAB packages.' }; export const contentTitle = 'Updateable Help'; export {default as metadata} from '@site/.docusaurus/docusaurus-plugin-content-docs/powershell/site-docs-powershell-keldor-updateable-help-md-c34.json' export const assets = {

};

import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime"; import {useMDXComponents as _provideComponents} from "@mdx-js/react"; export const toc = []; function _createMdxContent(props) { const _components = { code: "code", h1: "h1", header: "header", li: "li", p: "p", pre: "pre", ul: "ul", ..._provideComponents(), ...props.components }; return _jsxs(_Fragment, { children: [_jsx(_components.header, { children: _jsx(_components.h1, { id: "updateable-help", children: "Updateable Help" }) }), "\n", _jsx(_components.p, { children: "PowerShell online help and updateable help use two different module metadata values:" }), "\n", _jsxs(_components.ul, { children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.code, { children: "HelpUri" }), " is used by ", _jsx(_components.code, { children: "Get-Help -Online" }), " to open a command's web help page."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.code, { children: "HelpInfoURI" }), " is used by ", _jsx(_components.code, { children: "Update-Help" }), " to find the module's updateable help metadata."] }), "\n"] }), "\n", _jsxs(_components.p, { children: ["For Keldor, command help pages live under ", _jsx(_components.code, { children: "/powershell/keldor/" }), ". Updateable help files live in the static site folder:"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-text", children: "static/powershell-help/keldor/\n" }) }), "\n", _jsx(_components.p, { children: "Files placed there are served directly from the published site:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-text", children: "https://docs.keldor.dev/powershell-help/keldor/\n" }) }), "\n", _jsxs(_components.p, { children: ["Host ", _jsx(_components.code, { children: "HelpInfo.xml" }), " and generated locale CAB files, such as ", _jsx(_components.code, { children: "Keldor-help-en-US.cab" }), ", from this static folder when updateable help packages are published."] })] }); } export default function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); }