| Portability | portable |
|---|---|
| Stability | alpha |
| Maintainer | John MacFarlane <jgm@berkeley.edu> |
Text.Highlighting.Kate
Description
This helper module exports the main highlighting and formatting functions.
A typical application will combine a highlighter and a formatter:
main = do
code <- getContents
case highlightAs "ruby" code of
Right result -> putStrLn $ renderHtmlFragment $
formatAsXHtml [OptNumberLines] "ruby" result
Left err -> error $ "Could not parse input: " ++ err
- highlightAs :: String -> String -> Either String [SourceLine]
- languages :: [String]
- languagesByExtension :: String -> [String]
- formatAsXHtml :: [FormatOption] -> String -> [SourceLine] -> Html
- data FormatOption
- defaultHighlightingCss :: String
- type SourceLine = [LabeledSource]
- type LabeledSource = ([String], String)
- highlightingKateVersion :: String
Documentation
Arguments
| :: String | Language syntax |
| -> String | Source code to highlight |
| -> Either String [SourceLine] | Either error message or result |
True if extension belongs to language.
Highlight source code using a specified syntax definition.
languagesByExtension :: String -> [String]Source
Returns a list of languages appropriate for the given file extension.
Arguments
| :: [FormatOption] | Options |
| -> String | Language |
| -> [SourceLine] | Source lines to format |
| -> Html |
Format a list of highlighted SourceLines as XHtml.
data FormatOption Source
Options for formatters.
Constructors
| OptNumberLines | Number lines |
| OptNumberFrom Int | Number of first line |
| OptLineAnchors | Anchors on each line number |
| OptTitleAttributes | Include title attributes |
Instances
type SourceLine = [LabeledSource]Source
A line of source, list of labeled source items.
type LabeledSource = ([String], String)Source
A pair consisting of a list of attributes and some text.