Skip to content

Localized Help Script

Roman Kuzmin edited this page Dec 3, 2023 · 4 revisions

These commands

. Helps.ps1
New-Helps -Provider FileSystem -LocalizedData data

create the template hashtable to be used in several localized .psd1 files and the help script with references to the localized data

### FileSystem
$data = @{
    FileSystemSynopsis = ''
    FileSystemDescription = ''
    FileSystemTasksTitle1 = ''
    FileSystemTasksDescription1 = ''
    FileSystemTasksExamplesIntroduction1 = ''
    FileSystemTasksExamplesRemarks1 = ''
    FileSystemParametersDescription1 = ''
    FileSystemParametersValuesDescription1 = ''
}

### FileSystem
@{
    provider = 'FileSystem'
    drives = ''
    synopsis = $data.FileSystemSynopsis
    description = $data.FileSystemDescription
    capabilities = 'Filter, ShouldProcess'
    tasks = @(
        @{
            title = $data.FileSystemTasksTitle1
            description = $data.FileSystemTasksDescription1
            examples = @(
                @{
                    #title = ''
                    introduction = $data.FileSystemTasksExamplesIntroduction1
                    code = {
                    }
                    remarks = $data.FileSystemTasksExamplesRemarks1
                    test = { . $args[0] }
                }
            )
        }
    )
    parameters = @(
        @{
            name = ''
            type = ''
            description = $data.FileSystemParametersDescription1
            cmdlets = ''
            values = @(
                @{
                    value = ''
                    description = $data.FileSystemParametersValuesDescription1
                }
            )
        }
    )
    links = @(
        @{ text = ''; URI = '' }
    )
}
Clone this wiki locally