en-US/Documentarian.MicrosoftDocs-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HtmlMetaTags</command:name> <command:verb>Get</command:verb> <command:noun>HtmlMetaTags</command:noun> <maml:description> <maml:para>Gets all of the HTML `<meta>` elements of a web page.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all the HTML `<meta>` elements of a web page. This can be used to see the Docs metadata in the published article.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HtmlMetaTags</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ArticleUrl</maml:name> <maml:description> <maml:para>The URL to the Docs article you want to inspect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowRequiredMetadata</maml:name> <maml:description> <maml:para>Filters the output to show only the metadata require by the OPS publishing system.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ArticleUrl</maml:name> <maml:description> <maml:para>The URL to the Docs article you want to inspect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowRequiredMetadata</maml:name> <maml:description> <maml:para>Filters the output to show only the metadata require by the OPS publishing system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1 - Get the `ms.*` meta tags -------------</maml:title> <dev:code>$url = 'https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows' Get-HtmlMetaTags $url | Select-Object ms.* ms.author : sewhee ms.date : 08/02/2021 ms.devlang : powershell ms.prod : powershell ms.technology : powershell-conceptual ms.tgt_pltfr : windows, macos, linux ms.topic : conceptual</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2 - Show only the require metadata ----------</maml:title> <dev:code>$url = 'https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows' Get-HtmlMetaTags $url -ShowRequiredMetadata title : og:title : Installing PowerShell on Windows - PowerShell description : Information about installing PowerShell on Windows ms.manager : ms.author : sewhee author : sdwheeler ms.service : ms.date : 08/02/2021 ms.topic : conceptual ms.subservice : ms.prod : powershell ms.technology : powershell-conceptual ms.custom : ROBOTS : INDEX, FOLLOW</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/microsoftdocs/reference/cmdlets/get-htmlmetatags</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LocaleFreshness</command:name> <command:verb>Get</command:verb> <command:noun>LocaleFreshness</command:noun> <maml:description> <maml:para>Gets the `ms.date` metadata information of a Docs article for every locale.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the `ms.date` metadata information of a Docs article for every locale. The output includes the locale information and the translation method. This is useful to see that the localization process has picked up the latest changes made to the English version of the article.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LocaleFreshness</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The URL to the article being inspected. The URL must contain a locale.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Locales</maml:name> <maml:description> <maml:para>An array of one or more locale strings. The parameter default defaults to the following array of values:</maml:para> <maml:para>- `en-us`</maml:para> <maml:para>- `cs-cz`</maml:para> <maml:para>- `de-de`</maml:para> <maml:para>- `es-es`</maml:para> <maml:para>- `fr-fr`</maml:para> <maml:para>- `hu-hu`</maml:para> <maml:para>- `id-id`</maml:para> <maml:para>- `it-it`</maml:para> <maml:para>- `ja-jp`</maml:para> <maml:para>- `ko-kr`</maml:para> <maml:para>- `nl-nl`</maml:para> <maml:para>- `pl-pl`</maml:para> <maml:para>- `pt-br`</maml:para> <maml:para>- `pt-pt`</maml:para> <maml:para>- `ru-ru`</maml:para> <maml:para>- `sv-se`</maml:para> <maml:para>- `tr-tr`</maml:para> <maml:para>- `zh-cn`</maml:para> <maml:para>- `zh-tw`</maml:para> <maml:para></maml:para> <maml:para>The value can be any valid locale identifier string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-us, cs-cz, de-de, es-es, fr-fr, hu-hu, id-id, it-it, ja-jp, ko-kr, nl-nl, pl-pl, pt-br, pt-pt, ru-ru, sv-se, tr-tr, zh-cn, zh-tw</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Locales</maml:name> <maml:description> <maml:para>An array of one or more locale strings. The parameter default defaults to the following array of values:</maml:para> <maml:para>- `en-us`</maml:para> <maml:para>- `cs-cz`</maml:para> <maml:para>- `de-de`</maml:para> <maml:para>- `es-es`</maml:para> <maml:para>- `fr-fr`</maml:para> <maml:para>- `hu-hu`</maml:para> <maml:para>- `id-id`</maml:para> <maml:para>- `it-it`</maml:para> <maml:para>- `ja-jp`</maml:para> <maml:para>- `ko-kr`</maml:para> <maml:para>- `nl-nl`</maml:para> <maml:para>- `pl-pl`</maml:para> <maml:para>- `pt-br`</maml:para> <maml:para>- `pt-pt`</maml:para> <maml:para>- `ru-ru`</maml:para> <maml:para>- `sv-se`</maml:para> <maml:para>- `tr-tr`</maml:para> <maml:para>- `zh-cn`</maml:para> <maml:para>- `zh-tw`</maml:para> <maml:para></maml:para> <maml:para>The value can be any valid locale identifier string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-us, cs-cz, de-de, es-es, fr-fr, hu-hu, id-id, it-it, ja-jp, ko-kr, nl-nl, pl-pl, pt-br, pt-pt, ru-ru, sv-se, tr-tr, zh-cn, zh-tw</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The URL to the article being inspected. The URL must contain a locale.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DocumentLocaleInfo</maml:name> </dev:type> <maml:description> <maml:para>The locpath property is the target path in the URL. The values of locpath , locale , and ms.contentlocale should match.</maml:para> <maml:para>The other properties are values of HTML `<meta>` tags in the published articles. The values of these tags are set by the build system when the article is published.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1 - Get the freshness data for an article ------</maml:title> <dev:code>$url = 'https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux' Get-LocaleFreshness $url locpath locale ms.contentlocale ms.translationtype ms.date loc_version updated_at ------- ------ ---------------- ------------------ ------- ----------- ---------- en-us en-us 05/31/2022 2022-05-31 10:03 PM cs-cz cs-cz cs-cz MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM de-de de-de de-de HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM es-es es-es es-es HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM fr-fr fr-fr fr-fr HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM hu-hu hu-hu hu-hu MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM id-id id-id id-id MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM it-it it-it it-it MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM ja-jp ja-jp ja-jp HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM ko-kr ko-kr ko-kr HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM nl-nl nl-nl nl-nl MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM pl-pl pl-pl pl-pl MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM pt-br pt-br pt-br HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM pt-pt pt-pt pt-pt MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM ru-ru ru-ru ru-ru HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM sv-se sv-se sv-se MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM tr-tr tr-tr tr-tr MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM zh-cn zh-cn zh-cn HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM zh-tw zh-tw zh-tw MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2 - Get the freshness data for an article for select languages</maml:title> <dev:code>$url = 'https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux' Get-LocaleFreshness $url pt-br, pt-pt locpath locale ms.contentlocale ms.translationtype ms.date loc_version updated_at ------- ------ ---------------- ------------------ ------- ----------- ---------- pt-br pt-br pt-br HT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM pt-pt pt-pt pt-pt MT 05/31/2022 2022-07-18T20:00:40.4523397Z 2022-08-17 10:12 PM</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3 - Get the full freshness data for an article for select languages</maml:title> <dev:code>$url = 'https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux' Get-LocaleFreshness $url pt-br | Format-List -Property * locpath : pt-br locale : pt-br ms.contentlocale : pt-br ms.translationtype : HT ms.date : 05/31/2022 loc_version : 2022-07-18T20:00:40.4523397Z updated_at : 2022-08-17 10:12 PM loc_source_id : Github-44411511#live loc_file_id : Github-44411511.live.PowerShell.PowerShell_PowerShell-docs_reference.docs-conceptual/install /Installing-PowerShell-on-Linux.md original_content_git_url : https://github.com/MicrosoftDocs/PowerShell-Docs/blob/live/reference/docs-conceptual/install /Installing-PowerShell-on-Linux.md</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/microsoftdocs/reference/cmdlets/get-localefreshness</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Sync-BeyondCompare</command:name> <command:verb>Sync</command:verb> <command:noun>BeyondCompare</command:noun> <maml:description> <maml:para>Provides a simple way to synchronize changes across multiple versions of a Markdown file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many docsets at Microsoft contain multiple versions of the same reference document. For example, we support multiple versions of PowerShell cmdlets. Each version contains the same cmdlet but there may be minor differences between the versions.</maml:para> <maml:para>When you make a change to the documentation for one of these cmdlet, it's often necessary to make the same change across all the supported versions.</maml:para> <maml:para>`Sync-BeyondCompare` reads the `monikerMapping.json` file in your repository to discover the version monikers and the file paths they map to. Using this version information, the cmdlet opens the file passed and one of the other versions of the same file for side-by-side comparison. When you close the application it opens the same file and the next version of the file. This repeats until you have opened and compared all versions.</maml:para> <maml:para>This cmdlet is dependent on the product Beyond Compare by Scooter Software. Beyond Compare is a visual diff tool that makes it easy to compare two files and copy differences from one file to the other. Microsoft has a site license to use this tool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Sync-BeyondCompare</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the updated file to use as the base for your comparison. The path must contain the version part of the path as defined in the `monikerMapping.json`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the updated file to use as the base for your comparison. The path must contain the version part of the path as defined in the `monikerMapping.json`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Sync-BeyondCompare reference/7.3/Microsoft.PowerShell.Core/About/about_Output_Streams.md</dev:code> <dev:remarks> <maml:para>The cmdlet opens the 7.3 and 5.1 versions of the file for comparison. You can copy the appropriate changes to or from either file. When you save and close the file, the cmdlet then opens the 7.3 and 7.2 versions for comparison. This process repeats until you have compared all versions.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/microsoftdocs/reference/cmdlets/sync-beyondcompare</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Beyond Compare</maml:linkText> <maml:uri>https://www.scootersoftware.com/index.php</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Sync-VSCode</command:name> <command:verb>Sync</command:verb> <command:noun>VSCode</command:noun> <maml:description> <maml:para>Provides a simple way to synchronize changes across multiple versions of a Markdown file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many docsets at Microsoft contain multiple versions of the same reference document. For example, we support multiple versions of PowerShell cmdlets. Each version contains the same cmdlet but there may be minor differences between the versions.</maml:para> <maml:para>When you make a change to the documentation for one of these cmdlet, it's often necessary to make the same change across all the supported versions.</maml:para> <maml:para>`Sync-VSCode` reads the `monikerMapping.json` file in your repository to discover the version monikers and the file paths they map to. Using this version information, the cmdlet opens the file passed and one of the other versions of the same file for side-by-side comparison. When you close the application it opens the same file and the next version of the file. This repeats until you have opened and compared all versions.</maml:para> <maml:para>This cmdlet is dependent on the product Visual Studio Code (VS Code) . VS Code has a visual diff mode that makes it easy to compare two files and copy differences from one file to the other.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Sync-VSCode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path the updated file that is the base for your comparison. The file path must contain the version portion of the path as defined in the `monikerMapping.json`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path the updated file that is the base for your comparison. The file path must contain the version portion of the path as defined in the `monikerMapping.json`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Sync-VSCode reference/7.3/Microsoft.PowerShell.Core/About/about_Output_Streams.md</dev:code> <dev:remarks> <maml:para>The cmdlet opens the 7.3 and 5.1 versions of the file for comparison. You can copy the appropriate changes to or from either file. When you save and close the file, the cmdlet then opens the 7.3 and 7.2 versions for comparison. This process repeats until you have compared all versions.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/microsoftdocs/reference/cmdlets/sync-vscode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Visual Studio Code</maml:linkText> <maml:uri>https://code.visualstudio.com</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-YamlTOC</command:name> <command:verb>Test</command:verb> <command:noun>YamlTOC</command:noun> <maml:description> <maml:para>Validates that all entries in the TOC exist and that all files in the repository are in the TOC.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet reads a `TOC.yml` file then verifies that every entry in the TOC exists in the repository. After that, the cmdlet enumerates every `.md` and `.yml` file in the repository and verifies that it exists in the TOC.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-YamlTOC</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the TOC file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the TOC file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1 - Verify a TOC file ----------------</maml:title> <dev:code>Test-YamlTOC -Path .\docs-conceptual\toc.yml File does not exist - /azure/automation/automation-dsc-getting-started File does not exist - /azure/governance/policy/concepts/guest-configuration File does not exist - dsc/tutorials/dscCiCd.md File does not exist - samples/repeating-a-task-for-multiple-objects--foreach-object-.md File not in TOC - developer/format/selectionsetname-element-for-entryselectedby-for-controls-for-configuration-format.md File not in TOC - developer/help/writing-windows-powershell-help.md File not in TOC - developer/scheduling-jobs-with-the-windows-powershell-api.md</dev:code> <dev:remarks> <maml:para>The cmdlet also found three files that need to be added to the TOC.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/Documentarian/modules/microsoftdocs/reference/cmdlets/test-yamltoc</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |