alpmestan/taggy
1
1
Fork 0
mirror of https://github.com/alpmestan/taggy.git synced 2024-08-16 18:30:30 +03:00
Code Issues Projects Releases Wiki Activity

readme update

Browse Source
This commit is contained in:
Alp Mestanogullari 2014-06-12 14:13:14 +02:00
parent af8e70bdd6
commit 9cbb261583
1 changed files with 49 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -3,6 +3,54 @@ taggy
An attoparsec based html parser.
Currently very WIP. It even chokes on some HTML, although it already supports a fairly decent range of common websites.
Currently very WIP but already supports a fairly decent range of common websites. I haven't managed to find a website with which it chokes, using the current parser.
The performance is quite promising for now, but we don't do a lof of things that tagsoup does, like converting `&` to `&`, etc.
Using `taggy`
=============
_taggy_ has a `linksIn` function to work on HTML à la _tagsoup_.
``` haskell
tagsIn :: LT.Text -> [Tag]
```
Or you can use the raw `run` function, which returns a good old `Result` from _attoparsec_.
``` haskell
run :: LT.Text -> AttoLT.Result [Tag]
```
For example, if you want to read the html code from a file, and print one tag per line, you could do:
``` haskell
import Data.Attoparsec.Text.Lazy (eitherResult)
import qualified Data.Text.Lazy.IO as T
import Text.Taggy (run)
taggy :: FilePath -> IO ()
taggy fp = do
content <- T.readFile fp
either (\s -> putStrLn $ "couldn't parse: " ++ s)
(mapM_ print)
(eitherResult $ run content)
```
But _taggy_ also started providing support for DOM-syle documents. This is computed from the list of tags gained by using `tagsIn`.
If you fire up ghci with _taggy_ loaded:
``` bash
$ cabal repl # if working with a copy of this repo
```
You can see this `domify` in action.
``` haskell
λ> :set -XOverloadedStrings
λ> head . domify . tagsIn $ "<html><head></head><body>yo</body></html>"
NodeElement (Element {eltName = "html", eltAttrs = fromList [], eltChildren = [NodeElement (Element {eltName = "head", eltAttrs = fromList [], eltChildren = []}),NodeElement (Element {eltName = "body", eltAttrs = fromList [], eltChildren = [NodeContent "yo"]})]})
```
I'm already working on a companion `taggy-lens` library.