Cmdlet

Open-OfficeAsciiDoc

Module: PSWriteOffice
Inputs: System.String
Outputs: OfficeIMO.AsciiDoc.AsciiDocDocument OfficeIMO.AsciiDoc.AsciiDocParseResult
Source: OpenOfficeAsciiDocCommand.cs:11 Edit on GitHub

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

Syntax

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

Parameter set: Path

Open-OfficeAsciiDoc
[-AsResult]
-LiteralPath <String>
[-Options <AsciiDocParseOptions>]
[<CommonParameters>]

Parameter set: LiteralPath

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

Parameter set: Text

Examples

Example 1

Open-OfficeAsciiDoc -Path 'C:\Path'

Example 2

Open-OfficeAsciiDoc -LiteralPath 'C:\Path'

Example 3

Open-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: 0pipeline: True (ByValue)sets: Path: Path to an AsciiDoc file.
-LiteralPath String requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Exact input path without wildcard expansion.
-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.