" + HttpUtility.HtmlEncode(code) + ""
+ else sprintf "\\begin{lstlisting}\n%s\n\\end{lstlisting}" <| HttpUtility.HtmlDecode(code)
+ HtmlBlock(content) |> Some
+ else
+ let content : string = codeLookup.[code]
+ HtmlBlock(content) |> Some
+
+ // Recursively process nested paragraphs, other nodes return without change
+ | Matching.ParagraphNested(pn, nested) ->
+ let pars = List.map (List.choose (replaceCodeSnippets outputKind codeLookup)) nested
+ Matching.ParagraphNested(pn, pars) |> Some
+ | other -> Some other
+
+ /// Try find first-level heading in the paragraph collection
+ let findHeadings paragraphs (outputKind:OutputKind) =
+ paragraphs |> Seq.tryPick (function
+ | (Heading(1, text)) ->
+ let doc = MarkdownDocument([Span(text)], dict [])
+ Some(outputKind.Format(doc))
+ | _ -> None)
+ (*[/omit]*)
+
+(**
+### CodeBlockUtils module
+
+Parsing of F# Script files with Markdown commands. Given a parsed script file, we
+split it into a sequence of comments, snippets and commands (comment starts with
+`(**` and ending with `*)` are translated to Markdown, snippet is all other F# code
+and command looks like `(*** key1:value, key2:value ***)` (and should be single line).
+*)
+module internal CodeBlockUtils =
+ (*[omit:(Implementation omitted)]*)
+ open CommandUtils
+
+ type Block =
+ | BlockComment of string
+ | BlockSnippet of Line list
+ | BlockCommand of IDictionary%s
\n%s" s.Title s.Content ] |> String.concat "" + [ "source", content ], formatted.ToolTip + else [], "" + | OutputKind.Latex -> + if ctx.IncludeSource then + let formatted = CodeFormat.FormatLatex(sourceSnippets) + let content = + match formatted.Snippets with + | [| snip |] -> snip.Content + | snips -> [ for s in snips -> sprintf "\subsubsection{%s}\n%s" s.Title s.Content ] |> String.concat "" + [ "source", content ], formatted.ToolTip + else [], "" + + // Replace all parameters in the template & write to output + let parameters = + ctx.Replacements @ sourceReplacement @ + [ "page-title", defaultArg heading name + ctx.OutputKind.ContentTag, sb.ToString() + "tooltips", formatted.ToolTip + formattedDefns.ToolTip + sourceTips ] + File.WriteAllText(output, replaceParameters parameters ctx.Template) + + // ------------------------------------------------------------------------------------ + + /// Process Markdown document + let processMarkdown ctx file output = + // Read file & parse Markdown document + let name = Path.GetFileNameWithoutExtension(file) + let originalSource = File.ReadAllText(file) + let doc = Markdown.Parse(originalSource) + + // Turn all indirect links into a references & add paragraph to the document + let refParagraph, refLookup = + if ctx.GenerateReferences then + // Union link definitions & collect all indirect links + let refs = Seq.collect collectReferences doc.Paragraphs + let pars, refLookup = generateReferences doc.DefinedLinks refs ctx.OutputKind + Some pars, refLookup + else None, dict [] + + // Extract all CodeBlocks and pass them to F# snippets + let codes = doc.Paragraphs |> Seq.collect collectCodeSnippets |> Array.ofSeq + let codeLookup, tipsHtml = + if codes.Length = 0 then dict [], "" + else + // If there are some F# snippets, we build an F# source file + let blocks = codes |> Seq.mapi (fun index (modul, code) -> + match modul with + | Some modul -> + // generate module & add indentation + "module " + modul + " =\n" + + "// [snippet:" + (string index) + "]\n" + + " " + code.Replace("\n", "\n ") + "\n" + + "// [/snippet]" + | None -> + "// [snippet:" + (string index) + "]\n" + + code + "\n" + + "// [/snippet]" ) + + // Process F# script file, report errors & build lookup table for replacement + let modul = "module " + (new String(name |> Seq.filter Char.IsLetter |> Seq.toArray)) + let source = modul + "\r\n" + (String.concat "\n\n" blocks) + let snippets, errors = ctx.FormatAgent.ParseSource(output + ".fs", source, ctx.Options) + reportErrors ctx file errors + let formatted = + match ctx.OutputKind with + | OutputKind.Html -> CodeFormat.FormatHtml(snippets, ctx.Prefix, ctx.GenerateLineNumbers, false) + | OutputKind.Latex -> CodeFormat.FormatLatex(snippets, ctx.GenerateLineNumbers) + let snippetLookup = + [ for (_, code), fs in Array.zip codes formatted.Snippets -> code, fs.Content ] + dict snippetLookup, formatted.ToolTip + + // Process all paragraphs in two steps (replace F# snippets & references) + let paragraphs = + doc.Paragraphs |> List.choose (fun par -> + par |> replaceCodeSnippets ctx.OutputKind codeLookup + |> Option.bind (replaceReferences refLookup)) + + // If we want to include the source code of the script, then process + // the entire source and generate replacement {source} => ...some html... + let sourceReplacements = + if ctx.IncludeSource then + let doc = MarkdownDocument([CodeBlock originalSource], dict []) + let content = ctx.OutputKind.Format(doc) + [ "source", content ] + else [] + + // Construct new Markdown document and write it + let parameters = + ctx.Replacements @ sourceReplacements @ + [ "page-title", defaultArg (findHeadings paragraphs ctx.OutputKind) name + ctx.OutputKind.ContentTag, ctx.OutputKind.Format(MarkdownDocument(paragraphs, doc.DefinedLinks)) + "tooltips", tipsHtml ] + File.WriteAllText(output, replaceParameters parameters ctx.Template) + (*[/omit]*) + + +(** + +## Public API + +The following type provides three simple methods for calling the literate programming tool. +The `ProcessMarkdown` and `ProcessScriptFile` methods process a single Markdown document +and F# script, respectively. The `ProcessDirectory` method handles an entire directory tree +(looking for `*.fsx` and `*.md` files). +*) +open SourceProcessors + +type Literate = + (*[omit:(Helper methdods omitted)]*) + /// Provides default values for all optional parameters + static member private DefaultArguments + ( input, templateFile, output,format, fsharpCompiler, prefix, compilerOptions, + lineNumbers, references, replacements, includeSource, errorHandler) = + let defaultArg v f = match v with Some v -> v | _ -> f() + + let outputKind = defaultArg format (fun _ -> OutputKind.Html) + + let output = defaultArg output (fun () -> + let dir = Path.GetDirectoryName(input) + let file = Path.GetFileNameWithoutExtension(input) + Path.Combine(dir, sprintf "%s.%O" file outputKind)) + let fsharpCompiler = defaultArg fsharpCompiler (fun () -> + Assembly.Load("FSharp.Compiler")) + + // Build & return processing context + let ctx = + { FormatAgent = CodeFormat.CreateAgent(fsharpCompiler) + Template = templateFile |> Option.map (fun file -> File.ReadAllText(file)) + Prefix = defaultArg prefix (fun () -> "fs") + Options = defaultArg compilerOptions (fun () -> "") + GenerateLineNumbers = defaultArg lineNumbers (fun () -> true) + GenerateReferences = defaultArg references (fun () -> false) + Replacements = defaultArg replacements (fun () -> []) + IncludeSource = defaultArg includeSource (fun () -> false) + OutputKind = outputKind + ErrorHandler = errorHandler } + output, ctx(*[/omit]*) + + /// Process Markdown document + static member ProcessMarkdown + ( input, ?templateFile, ?output, ?format, ?fsharpCompiler, ?prefix, ?compilerOptions, + ?lineNumbers, ?references, ?replacements, ?includeSource, ?errorHandler ) = (*[omit:(...)]*) + let output, ctx = + Literate.DefaultArguments + ( input, templateFile, output, format, fsharpCompiler, prefix, compilerOptions, + lineNumbers, references, replacements, includeSource, errorHandler ) + processMarkdown ctx input output (*[/omit]*) + + /// Process F# Script file + static member ProcessScriptFile + ( input, ?templateFile, ?output, ?format, ?fsharpCompiler, ?prefix, ?compilerOptions, + ?lineNumbers, ?references, ?replacements, ?includeSource, ?errorHandler ) = (*[omit:(...)]*) + let output, ctx = + Literate.DefaultArguments + ( input, templateFile, output, format, fsharpCompiler, prefix, compilerOptions, + lineNumbers, references, replacements, includeSource, errorHandler ) + processScriptFile ctx input output (*[/omit]*) + + /// Process directory containing a mix of Markdown documents and F# Script files + static member ProcessDirectory + ( inputDirectory, ?templateFile, ?outputDirectory, ?format, ?fsharpCompiler, ?prefix, ?compilerOptions, + ?lineNumbers, ?references, ?replacements, ?includeSource, ?errorHandler ) = (*[omit:(...)]*) + let _, ctx = + Literate.DefaultArguments + ( "", templateFile, Some "", format, fsharpCompiler, prefix, compilerOptions, + lineNumbers, references, replacements, includeSource, errorHandler ) + + /// Recursively process all files in the directory tree + let rec processDirectory indir outdir = + // Create output directory if it does not exist + if Directory.Exists(outdir) |> not then + try Directory.CreateDirectory(outdir) |> ignore + with _ -> failwithf "Cannot create directory '%s'" outdir + + let fsx = [ for f in Directory.GetFiles(indir, "*.fsx") -> processScriptFile, f ] + let mds = [ for f in Directory.GetFiles(indir, "*.md") -> processMarkdown, f ] + for func, file in fsx @ mds do + let name = Path.GetFileNameWithoutExtension(file) + let output = Path.Combine(outdir, sprintf "%s.%O" name ctx.OutputKind) + + // Update only when needed + let changeTime = File.GetLastWriteTime(file) + let generateTime = File.GetLastWriteTime(output) + if changeTime > generateTime then + printfn "Generating '%s.%O'" name ctx.OutputKind + func ctx file output + + let outputDirectory = defaultArg outputDirectory inputDirectory + processDirectory inputDirectory outputDirectory (*[/omit]*) \ No newline at end of file diff --git a/packages/FSharp.Formatting.1.0.15/literate/templates/template-file.html b/packages/FSharp.Formatting.1.0.15/literate/templates/template-file.html new file mode 100644 index 00000000..c1a7e77c --- /dev/null +++ b/packages/FSharp.Formatting.1.0.15/literate/templates/template-file.html @@ -0,0 +1,35 @@ + + + + + +
+
+
+
\ No newline at end of file
diff --git a/packages/FSharp.Formatting.1.0.15/literate/templates/template-project.html b/packages/FSharp.Formatting.1.0.15/literate/templates/template-project.html
new file mode 100644
index 00000000..f6803c9a
--- /dev/null
+++ b/packages/FSharp.Formatting.1.0.15/literate/templates/template-project.html
@@ -0,0 +1,62 @@
+
+
+
+
+
+
+
+
+
+ {document}
+ {tooltips}
+
+
+
+
+
+
+
+
+ {project-name}
++
+
+
+ {document}
+ {tooltips}
+
+
+
+
+
+ 
+
+
\ No newline at end of file
diff --git a/packages/repositories.config b/packages/repositories.config
index dc9d9a50..f7c3c813 100644
--- a/packages/repositories.config
+++ b/packages/repositories.config
@@ -1,5 +1,6 @@