Get-OfficeAsciiDoc

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.AsciiDoc.AsciiDocDocument OfficeIMO.AsciiDoc.AsciiDocParseResult

Source

Sources/PSWriteOffice/Cmdlets/AsciiDoc/GetOfficeAsciiDocCommand.cs:8 Edit on GitHub

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

Remarks

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

Examples

Authored help example

EXAMPLE 1


Get-OfficeAsciiDoc -Path 'C:\Path'

EXAMPLE 2


Get-OfficeAsciiDoc -Text 'Value'

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.

Syntax

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

Parameter set: Path

Parameters

AsResult SwitchParameter optionalposition: namedpipeline: False: Return the parse result with diagnostics instead of only the document.
Options AsciiDocParseOptions optionalposition: namedpipeline: False: Optional parser settings.
Path String requiredposition: 0pipeline: Falsealiases: FilePath: Path to an AsciiDoc file.

Outputs

OfficeIMO.AsciiDoc.AsciiDocDocument OfficeIMO.AsciiDoc.AsciiDocParseResult

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

Parameter set: Text

Parameters

AsResult SwitchParameter optionalposition: namedpipeline: False: Return the parse result with diagnostics instead of only the document.
Options AsciiDocParseOptions optionalposition: namedpipeline: False: Optional parser settings.
Text String requiredposition: namedpipeline: False: AsciiDoc source text.

Outputs

OfficeIMO.AsciiDoc.AsciiDocDocument OfficeIMO.AsciiDoc.AsciiDocParseResult