microformats2-parser

A Microformats 2 parser.

https://github.com/myfreeweb/microformats2-parser

Version on this page:1.0.1.3
LTS Haskell 14.27:1.0.1.9
Stackage Nightly 2019-09-21:1.0.1.9
Latest on Hackage:1.0.2.2

See all snapshots microformats2-parser appears in

LicenseRef-PublicDomain licensed by Greg V
Maintained by [email protected]
This version can be pinned in stack with:microformats2-parser-1.0.1.3@sha256:e21462425e553d176642c1c7c6f30410ca253780ec031cfc02be7a1e2a0351dc,2556

Module documentation for 1.0.1.3

Used by 1 package in lts-5.7(full list with versions):
microformats2-parser

microformats2-parser Hackage Build Status unlicense

Microformats 2 parser for Haskell! #IndieWeb

Originally created for sweetroll.

  • parses items, rels, rel-urls
  • resolves relative URLs (with support for the <base> tag)
  • parses the value-class-pattern, including date and time normalization
  • handles malformed HTML (the actual HTML parser is tagstream-conduit)
  • high performance
  • extensively tested

Also check out http-link-header because you often need to read links from the Link header!

DEMO PAGE

Usage

Look at the API docs on Hackage for more info, here’s a quick overview:

{-# LANGUAGE OverloadedStrings #-}

import Data.Microformats2.Parser
import Data.Default
import Network.URI

parseMf2 def $ documentRoot $ parseLBS "<body><p class=h-entry><h1 class=p-name>Yay!</h1></p></body>"

parseMf2 (def { baseUri = parseURI "https://where.i.got/that/page/from/" }) $ documentRoot $ parseLBS "<body><base href=\"base/\"><link rel=micropub href='micropub'><p class=h-entry><h1 class=p-name>Yay!</h1></p></body>"

The def is the default configuration.

The configuration includes:

  • htmlMode, an HTML parsing mode (Unsafe | Escape | Sanitize)
  • baseUri, the Maybe URI that represents the address you retrieved the HTML from, used for resolving relative addresses – you should set it

parseMf2 will return an Aeson Value structured like canonical microformats2 JSON. lens-aeson is a good way to navigate it.

Development

Use stack to build.
Use ghci to run tests quickly with :test (see the .ghci file).

$ stack build

$ stack test && rm tests.tix

$ stack ghci --ghc-options="-fno-hpc"

Contributing

Please feel free to submit pull requests! Bugfixes and simple non-breaking improvements will be accepted without any questions :-)

By participating in this project you agree to follow the Contributor Code of Conduct.

The list of contributors is available on GitHub.

License

This is free and unencumbered software released into the public domain.
For more information, please refer to the UNLICENSE file or unlicense.org.