Cmdlet

Get-OfficeAsciiDoc

Module PSWriteOffice

Inputs

None

Outputs

OfficeIMO.AsciiDoc.AsciiDocDocument OfficeIMO.AsciiDoc.AsciiDocParseResult

Source

GetOfficeAsciiDocCommand.cs:10 Edit on GitHub

Parses an AsciiDoc file or source string into OfficeIMO's native document model.

Syntax

Get-OfficeAsciiDoc [-AsResult] [-Options <AsciiDocParseOptions>] [-Path] <String> [<CommonParameters>]

Parameter set: Path

Get-OfficeAsciiDoc [-AsResult] [-Options <AsciiDocParseOptions>] -Text <String> [<CommonParameters>]

Parameter set: Text

Examples

Authored help example

EXAMPLE 1

Get-OfficeAsciiDoc -Path 'C:\Path'

EXAMPLE 2

Get-OfficeAsciiDoc -Text 'Value'

Parameters

-AsResult SwitchParameter optional: Return the parse result with diagnostics instead of only the document.
-Options AsciiDocParseOptions optional: Optional parser settings.
-Path String requiredposition: 0aliases: FilePathsets: Path: Path to an AsciiDoc file.
-Text String requiredsets: Text: AsciiDoc source text.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.