Merge pull request #315 from gsvgit/StructuredFormatDocumentation

Short documentation for Text.StructuredFormat is added.

Author: panesofglass

docs/content/StructuredFormatSample.fsx

@@ -0,0 +1,46 @@
+// ----------------------------------------------------------------------------
+// F# structured format example. 
+// (c) Semyon Grigorev, 2014, Available under Apache 2.0 license.
+// ----------------------------------------------------------------------------
+
+// This example demonstrates how to use printer combinator library.
+
+#r @"../../bin/v4.0/FSharpx.Core.dll"
+#r @"..\..\bin\v4.0\FSharpx.Text.StructuredFormat.dll"
+
+open Microsoft.FSharp.Text.StructuredFormat
+open Microsoft.FSharp.Text.StructuredFormat.LayoutOps
+
+let stmt i = wordL <| "stmt_" + string i
+
+let stmtBlock k =
+    [for i in 0 .. k -> stmt i]
+    |> List.reduce (@@)
+
+let layout =
+   let condBlock = wordL "if" ^^ bracketL (wordL "cond")
+   let thenBlock = wordL "then" @@- (stmtBlock 2)
+   let elseBlock = wordL "else" @@- (stmtBlock 3)
+   condBlock
+   @@ thenBlock
+   @@ elseBlock
+
+let str = Display.layout_to_string FormatOptions.Default layout
+
+printfn "%s" str
+
+(*
+Expectesd result:
+
+if (cond)
+then
+ stmt_0
+ stmt_1
+ stmt_2
+else
+ stmt_0
+ stmt_1
+ stmt_2
+ stmt_3
+
+*)

docs/content/index.fsx

@@ -29,7 +29,7 @@ These are some adhoc components which are now rarely used:
 
 * FSharpx.Http provides a few features for working with HTTP applications.
 * FSharpx.Observable implements a mini-Reactive Extensions (MiniRx) and was authored by Phil Trelford.
-* FSharpx.Text.StructuredFormat provides data structures and functoins for pretty printers.
+* FSharpx.Text.StructuredFormat provides data structures and functoins for pretty printers. Combinators description: https://github.com/fsprojects/fsharpx/blob/master/src/FSharpx.Text.StructuredFormat/StructuredFormat.fsi
 
 
 *)
@@ -63,6 +63,7 @@ FSharpx.Collections.List.monoid
 * [Santa](Santa.html)
 * [StmSample](StmSample.html)
 * [StockStream](StockStream.html)
+* [StructuredFormatSample](StructuredFormatSample.html)
 * [UndoSample](UndoSample.html)
 * [WebProxy](WebProxy.html)