FSharp.Formatting


LiterateDocument Type

Representation of a literate document - the representation of Paragraphs uses an F# discriminated union type and so is best used from F#.

Constructors

Constructor Description

LiterateDocument(paragraphs, formattedTips, links, source, sourceFile, rootInputFolder, diagnostics)

Full Usage: LiterateDocument(paragraphs, formattedTips, links, source, sourceFile, rootInputFolder, diagnostics)

Parameters:
Returns: LiterateDocument
paragraphs : MarkdownParagraphs
formattedTips : string
links : IDictionary<string, (string * string option)>
source : LiterateSource
sourceFile : string
rootInputFolder : string option
diagnostics : SourceError[]
Returns: LiterateDocument

Instance members

Instance member Description

this.DefinedLinks

Full Usage: this.DefinedLinks

Returns: IDictionary<string, (string * string option)>

Returns a dictionary containing explicitly defined links

Returns: IDictionary<string, (string * string option)>

this.Diagnostics

Full Usage: this.Diagnostics

Returns: SourceError[]

Errors

Returns: SourceError[]

this.FormattedTips

Full Usage: this.FormattedTips

Returns: string

Formatted tool tips

Returns: string

this.MarkdownDocument

Full Usage: this.MarkdownDocument

Returns: MarkdownDocument

Return as markdown document, throwing away additional stuff

Returns: MarkdownDocument

this.Paragraphs

Full Usage: this.Paragraphs

Returns: MarkdownParagraphs

Returns a list of paragraphs in the document

Returns: MarkdownParagraphs

this.RootInputFolder

Full Usage: this.RootInputFolder

Returns: string option

Root for computing relative paths

Returns: string option

this.Source

Full Usage: this.Source

Returns: LiterateSource

Original document source code

Returns: LiterateSource

this.SourceFile

Full Usage: this.SourceFile

Returns: string

Location where the file was loaded from

Returns: string

this.With

Full Usage: this.With

Parameters:
Returns: LiterateDocument

Clone the document and change some of its properties

?paragraphs : MarkdownParagraphs
?formattedTips : string
?definedLinks : IDictionary<string, (string * string option)>
?source : LiterateSource
?sourceFile : string
?rootInputFolder : string option
?diagnostics : SourceError[]
Returns: LiterateDocument