UncommonSense.DocSetBuilder

PowerShell module for generating Dash docsets.

Requirements

Requires sqlite3.

Index

Command	Synopsis
Add-DashDocsetIndexEntry	Add-DashDocsetIndexEntry [-DocsetPath] [-Name] [-Type] [-Path] []
New-DashDocsetFolder	New-DashDocsetFolder [-Path] [-Name] []
New-DashDocsetIndex	New-DashDocsetIndex [-DocsetPath] []
New-DashDocsetPList	New-DashDocsetPList [-DocsetPath] -CFBundleIdentifier -CFBundleName -DocSetPlatformFamily [-IndexFilePath ] []

Add-DashDocsetIndexEntry

Synopsis

Add-DashDocsetIndexEntry [-DocsetPath] [-Name] [-Type] [-Path] []

Syntax

Add-DashDocsetIndexEntry [-DocsetPath] <string> [-Name] <string> [-Type] <string> [-Path] <string> [<CommonParameters>]

Parameters

DocsetPath <string>

Required?                    true
Position?                    0
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

Name <string>

Required?                    true
Position?                    1
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

Path <string>

Required?                    true
Position?                    3
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

Type <string>

Required?                    true
Position?                    2
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

New-DashDocsetFolder

Synopsis

New-DashDocsetFolder [-Path] [-Name] []

Syntax

New-DashDocsetFolder [-Path] <string> [-Name] <string> [<CommonParameters>]

Parameters

Name <string>

Required?                    true
Position?                    1
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

Path <string>

Required?                    true
Position?                    0
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

New-DashDocsetIndex

Synopsis

New-DashDocsetIndex [-DocsetPath] []

Syntax

New-DashDocsetIndex [-DocsetPath] <string> [<CommonParameters>]

Parameters

DocsetPath <string>

Required?                    true
Position?                    0
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

New-DashDocsetPList

Synopsis

New-DashDocsetPList [-DocsetPath] -CFBundleIdentifier -CFBundleName -DocSetPlatformFamily [-IndexFilePath ] []

Syntax

New-DashDocsetPList [-DocsetPath] <string> -CFBundleIdentifier <string> -CFBundleName <string> -DocSetPlatformFamily <string> [-IndexFilePath <string>] [<CommonParameters>]

Parameters

CFBundleIdentifier <string>

Required?                    true
Position?                    Named
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

CFBundleName <string>

Required?                    true
Position?                    Named
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

DocSetPlatformFamily <string>

Required?                    true
Position?                    Named
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

DocsetPath <string>

Required?                    true
Position?                    0
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

IndexFilePath <string>

Required?                    false
Position?                    Named
Accept pipeline input?       false
Parameter set name           (All)
Aliases                      None
Dynamic?                     false
Accept wildcard characters?  false

Generated 30-04-2024 15:56