dzr

DZReadability

Adoption of Readability algorithm which works on iOS and OSX and is capable of clearing the messy HTML document (e.g. site) into nice and readable page. Rework of GGReadabilityParser found here: https://github.com/curthard89/COCOA-Stuff/tree/master/GGReadabilityParser

Showing:

Popularity

Downloads/wk

0

GitHub Stars

90

Maintenance

Last Commit

6yrs ago

Contributors

4

Package

Dependencies

1

License

MIT

Categories

Readme

DZReadability

Build Status Version License Platform

About

The main idea is all about making webpage readable on a mobile device. The parser has enough options to provide you, given an ordinary webpage URL or contents, HTML document with clear markup which contains only the main article contents. There is also an option to download and embed images so you can use the document fully offline, loading it into WebView.

The basic concept was found in Curtis Hard`s repo (https://github.com/curthard89/COCOA-Stuff/tree/master/GGReadabilityParser) and it was greatly improved with new features: iOS compatibility (thanks to HTMLReader project), new clearing options, image download option, CSS selectors instead of XPath, ARC, performance optimizations.

Please feel free to submit bugs and pull requests.

I've found no similiar projects, so pm me if you know some.

It's also nice to know the projects which use this code so please let me know if you do so.

Usage

To run the example project, clone the repo, and run pod install from the Example directory first.

The use is simple, you have to create a new DZReadability object like this (with URL of the document which then will be downloaded and parsed):

self.readability = [[DZReadability alloc] initWithURLToDownload:docUrl options:nil completionHandler:^(DZReadability *sender, NSString *content, NSError *error) {
    if (!error) {
        NSLog(@"result content:\n%@", content);
        // handle returned content
    }
    else {
        // handle error
    }
}];
[self.readability start];

If you already got the contents which you want to parse you can call

NSString *html = [webView stringByEvaluatingJavaScriptFromString:@"document.documentElement.outerHTML"]; // or any other html as string
readability = [[DZReadability alloc] initWithURL:docUrl rawDocumentContent:html options:nil completionHandler:^(DZReadability *sender, NSString *content, NSError *error) {
    if (!error) {
        NSLog(@"result content:\n%@", content);
        // handle returned content
    }
    else {
        // handle error
    }
}];
[readability start];

Requirements

ARC
OSX >= 10.7
iOS >= 5.0

dependency 'HTMLReader'

Installation

DZReadability is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "DZReadability"

Attention

You would probably need CSS styles to make the document look good. Basically CSS style should make images fit the webview, assign good fonts and also deal with tables markup and their width. You should prepare the template containing CSS style in a header section of the document and then insert what the parser gives you into the body section of your HTML template. It's necessery if you plan to present the cleared and readable document to the user using UIWebView.

Unfortunately i cannot provide you the exact CSS styles and my HTML template yet cuz they are not my own IP. Have to figure it out yourself. Consider pull requesting. Thanks!

Screenshots

screenshot01-iOS

Author

Denis Zamataev, denis.zamataev@gmail.com

Curtis Hard, https://github.com/curthard89 (https://github.com/curthard89/COCOA-Stuff/tree/master/GGReadabilityParser)

License

DZReadability s available under the MIT license. See the LICENSE file for more info.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100