LiterateParagraph (FSharp.Formatting) | FSharp.Formatting

FSharp.Formatting

LiterateParagraph Type

Namespace: FSharp.Formatting.Literate
Assembly: FSharp.Formatting.Literate.dll
Base Type: obj
All Interfaces: IEquatable<LiterateParagraph> , IStructuralEquatable , IComparable<LiterateParagraph> , IComparable , IStructuralComparable , MarkdownEmbedParagraphs

Extends MarkdownParagrap using the MarkdownEmbedParagraphs case with additional kinds of paragraphs that can appear in literate F# scripts (such as various special commands to embed output of a snippet etc.)

Union cases

Union case	Description
`CodeReference(ref, paragraphOptions)` Full Usage: `CodeReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include:foo *) - Include formatted snippet from other part of the document here ref : `string` paragraphOptions : `LiterateParagraphOptions`
`FsiMergedOutputReference(ref, paragraphOptions)` Full Usage: `FsiMergedOutputReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include-fsi-merged-output ) - Include output from previous snippet ( include-fsi-merged-output:foo *) - Include output from a named snippet ref : `string` paragraphOptions : `LiterateParagraphOptions`
`FsiOutputReference(ref, paragraphOptions)` Full Usage: `FsiOutputReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include-fsi-output ) - Include output from previous snippet ( include-fsi-output:foo *) - Include output from a named snippet ref : `string` paragraphOptions : `LiterateParagraphOptions`
`ItRawReference(ref, paragraphOptions)` Full Usage: `ItRawReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include-it-raw ) - Include "it" value from the subsequent snippet here as raw text (Not formatted as fsi) ( include-it-raw:foo *) - Include "it" value from a named snippet as raw text (Not formatted as fsi) ref : `string` paragraphOptions : `LiterateParagraphOptions`
`ItValueReference(ref, paragraphOptions)` Full Usage: `ItValueReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include-it ) - Include "it" value from the subsequent snippet here ( include-it:foo *) - Include "it" value from a named snippet ref : `string` paragraphOptions : `LiterateParagraphOptions`
`LanguageTaggedCode(language, code, paragraphOptions)` Full Usage: `LanguageTaggedCode(language, code, paragraphOptions)` Parameters: language : `string` code : `string` paragraphOptions : `LiterateParagraphOptions`	Ordinary formatted code snippet in non-F# language (tagged with language code) language : `string` code : `string` paragraphOptions : `LiterateParagraphOptions`
`LiterateCode(lines, options, paragraphOptions)` Full Usage: `LiterateCode(lines, options, paragraphOptions)` Parameters: lines : `Line list` options : `LiterateCodeOptions` paragraphOptions : `LiterateParagraphOptions`	Embedded literate code snippet. Consists of source lines and options lines : `Line list` options : `LiterateCodeOptions` paragraphOptions : `LiterateParagraphOptions`
`OutputReference(ref, paragraphOptions)` Full Usage: `OutputReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include-fsi-output ) - Include F# Interactive output from previous snippet ( include-fsi-output:foo *) - Include F# Interactive from a named snippet ref : `string` paragraphOptions : `LiterateParagraphOptions`
`RawBlock(lines, paragraphOptions)` Full Usage: `RawBlock(lines, paragraphOptions)` Parameters: lines : `Line list` paragraphOptions : `LiterateParagraphOptions`	Block simply emitted without any formatting equivalent to tag in html lines : `Line list` paragraphOptions : `LiterateParagraphOptions`
`ValueReference(ref, paragraphOptions)` Full Usage: `ValueReference(ref, paragraphOptions)` Parameters: ref : `string` paragraphOptions : `LiterateParagraphOptions`	(* include-value:foo *) - Include the formatting of a specified value here ref : `string` paragraphOptions : `LiterateParagraphOptions`

Instance members

Instance member	Description
`this.ParagraphOptions` Full Usage: `this.ParagraphOptions` Returns: `LiterateParagraphOptions`	Returns: `LiterateParagraphOptions`