Module Simantics/Help

This module is undocumented. This is a list of its definitions.

clearHelpTocCache :: () -> <Proc> ()

Empties the cached table of contents of the help system, so that the help view rebuilds it from the current database contents.

createHelpLibrary :: Resource -> <WriteGraph,Proc> Resource

Creates a help library named Help Library under the given parent and returns it. The name is not made unique, so calling this twice on the same parent leaves two libraries of the same name.

createHelpLibraryAction :: Resource -> <Proc> ()

The New / Help Library action: creates a help library under the given parent in its own write transaction.

createHelpTutorial :: Resource -> String -> <WriteGraph,Proc> Resource

createHelpTutorial parent name creates an empty tutorial file of that name under the given parent and returns it. The name is not made unique.

createHelpTutorialAction :: Resource -> <Proc> ()

The New / Help Tutorial action: creates a tutorial file under the given parent in its own write transaction. The file is named Tutorial if the parent has none yet, and otherwise Tutorial n where n is the number of tutorial files already there.

getHelpBrowserUrl :: () -> URL

The URL of the running workbench help server, which is where the generated help pages are served from.

markdownToHtml :: Resource -> <ReadGraph,Proc> String

Renders the Markdown source of a tutorial file into an HTML fragment. Fails if the file has no contents.

readHelpFileContents :: Resource -> <ReadGraph,Proc> String

The Markdown source of a help or tutorial file, or an empty string if it has none.

saveHelpFileContents :: Resource -> String -> <WriteGraph,Proc> ()

saveHelpFileContents helpFile text replaces the Markdown source of a help or tutorial file with the given text.