The microformats2-parser package

[Tags:library, program, public-domain, test]

A parser for Microformats 2 (http:microformats.orgwikimicroformats2), a simple way to describe structured information in HTML.


[Skip to Readme]

Properties

Versions 0.1.0, 0.1.1, 1.0.0, 1.0.1, 1.0.1.1, 1.0.1.2, 1.0.1.3, 1.0.1.4, 1.0.1.5, 1.0.1.6
Dependencies aeson, aeson-pretty, aeson-qq, attoparsec, base (>=4.7.0.0 && <5), base-compat (>=0.8.0), blaze-html, blaze-markup, bytestring, containers, data-default, either, errors, html-conduit, lens-aeson, microformats2-parser, network, network-uri, options, pcre-heavy, safe, scotty, streaming-commons, tagsoup, text, time, transformers, unordered-containers, vector, wai-extra, warp, xml-lens, xss-sanitize [details]
License PublicDomain
Copyright 2015-2016 Greg V <greg@unrelenting.technology>
Author Greg V
Maintainer greg@unrelenting.technology
Stability Unknown
Category Web
Home page https://github.com/myfreeweb/microformats2-parser
Source repository head: git clone git://github.com/myfreeweb/microformats2-parser.git
Uploaded Sun Sep 18 11:58:52 UTC 2016 by myfreeweb
Distributions LTSHaskell:1.0.1.6, NixOS:1.0.1.6, Stackage:1.0.1.6, Tumbleweed:1.0.1.6
Downloads 672 total (11 in the last 30 days)
Votes
1 []
Status Docs available [build log]
Last success reported on 2016-09-18 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for microformats2-parser

Readme for microformats2-parser-1.0.1.6

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), including inside of html for e-* properties
  • 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

$ stack ghci

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.