Current section
Files
Jump to
Current section
Files
doc/dist/search_items-6C596D24.js
searchNodes=[{"doc":"Readability library for extracting & curating articles. Example @type html :: binary # Just pass url % Readability.Summary { title : title , authors : authors , article_html : article } = Readability . summarize ( url ) # Extract title Readability . title ( html ) # Extract authors. Readability . authors ( html ) # Extract only text from article article = html |> Readability . article |> Readability . readable_text # Extract article with transformed html article = html |> Readability . article |> Readability . raw_html","ref":"Readability.html","title":"Readability","type":"module"},{"doc":"Using a variety of metrics (content score, classname, element types), find the content that is most likely to be the stuff a user wants to read Example iex> article_tree = Redability ( html_str ) # returns article that is tuple","ref":"Readability.html#article/2","title":"Readability.article/2","type":"function"},{"doc":"Extract authors Example iex> authors = Readability . authors ( html_str ) [ "José Valim" , "chrismccord" ]","ref":"Readability.html#authors/1","title":"Readability.authors/1","type":"function"},{"doc":"","ref":"Readability.html#default_options/0","title":"Readability.default_options/0","type":"function"},{"doc":"Return true if Content-Type in provided headers list is a markup type, else false Example iex> Readability . is_response_markup? ( [ { "Content-Type" , "text/html" } ] ) true","ref":"Readability.html#is_response_markup/1","title":"Readability.is_response_markup/1","type":"function"},{"doc":"Extract MIME Type from headers Example iex> mime = Readability . mime ( headers_list ) "text/html"","ref":"Readability.html#mime/1","title":"Readability.mime/1","type":"function"},{"doc":"","ref":"Readability.html#parse/1","title":"Readability.parse/1","type":"function"},{"doc":"return raw html binary from html_tree","ref":"Readability.html#raw_html/1","title":"Readability.raw_html/1","type":"function"},{"doc":"return attributes, tags cleaned html","ref":"Readability.html#readable_html/1","title":"Readability.readable_html/1","type":"function"},{"doc":"return only text binary from html_tree","ref":"Readability.html#readable_text/1","title":"Readability.readable_text/1","type":"function"},{"doc":"","ref":"Readability.html#regexes/1","title":"Readability.regexes/1","type":"function"},{"doc":"summarize the primary readable content of a webpage.","ref":"Readability.html#summarize/2","title":"Readability.summarize/2","type":"function"},{"doc":"Extract title Example iex> title = Readability . title ( html_str ) "Some title in html"","ref":"Readability.html#title/1","title":"Readability.title/1","type":"function"},{"doc":"","ref":"Readability.html#t:headers/0","title":"Readability.headers/0","type":"type"},{"doc":"","ref":"Readability.html#t:html_tree/0","title":"Readability.html_tree/0","type":"type"},{"doc":"","ref":"Readability.html#t:options/0","title":"Readability.options/0","type":"type"},{"doc":"","ref":"Readability.html#t:raw_html/0","title":"Readability.raw_html/0","type":"type"},{"doc":"","ref":"Readability.html#t:url/0","title":"Readability.url/0","type":"type"},{"doc":"Build article for readability","ref":"Readability.ArticleBuilder.html","title":"Readability.ArticleBuilder","type":"module"},{"doc":"Prepare the article node for display. Clean out any inline styles, iframes, forms, strip extraneous <p> tags, etc.","ref":"Readability.ArticleBuilder.html#build/2","title":"Readability.ArticleBuilder.build/2","type":"function"},{"doc":"","ref":"Readability.ArticleBuilder.html#t:html_tree/0","title":"Readability.ArticleBuilder.html_tree/0","type":"type"},{"doc":"","ref":"Readability.ArticleBuilder.html#t:options/0","title":"Readability.ArticleBuilder.options/0","type":"type"},{"doc":"AuthorFinder extracts authors","ref":"Readability.AuthorFinder.html","title":"Readability.AuthorFinder","type":"module"},{"doc":"Extract authors","ref":"Readability.AuthorFinder.html#find/1","title":"Readability.AuthorFinder.find/1","type":"function"},{"doc":"","ref":"Readability.AuthorFinder.html#find_by_meta_tag/1","title":"Readability.AuthorFinder.find_by_meta_tag/1","type":"function"},{"doc":"","ref":"Readability.AuthorFinder.html#t:html_tree/0","title":"Readability.AuthorFinder.html_tree/0","type":"type"},{"doc":"Candidate can be article","ref":"Readability.Candidate.html","title":"Readability.Candidate","type":"module"},{"doc":"Clean html tree for prepare candidates. It transforms misused tags and removes unlikely candidates.","ref":"Readability.Candidate.Cleaner.html","title":"Readability.Candidate.Cleaner","type":"module"},{"doc":"Remove unlikely html tree","ref":"Readability.Candidate.Cleaner.html#remove_unlikely_tree/1","title":"Readability.Candidate.Cleaner.remove_unlikely_tree/1","type":"function"},{"doc":"Transform misused divs <div>s that do not contain other block elements into <p>s","ref":"Readability.Candidate.Cleaner.html#transform_misused_div_to_p/1","title":"Readability.Candidate.Cleaner.transform_misused_div_to_p/1","type":"function"},{"doc":"","ref":"Readability.Candidate.Cleaner.html#t:html_tree/0","title":"Readability.Candidate.Cleaner.html_tree/0","type":"type"},{"doc":"Score html tree","ref":"Readability.Candidate.Scoring.html","title":"Readability.Candidate.Scoring","type":"module"},{"doc":"","ref":"Readability.Candidate.Scoring.html#calc_link_density/1","title":"Readability.Candidate.Scoring.calc_link_density/1","type":"function"},{"doc":"Score html tree by some algorithm that check children nodes, attributes, link densities, etcs.. options -> weight_classes :: boolean, calculate weight class","ref":"Readability.Candidate.Scoring.html#calc_score/2","title":"Readability.Candidate.Scoring.calc_score/2","type":"function"},{"doc":"","ref":"Readability.Candidate.Scoring.html#class_weight/1","title":"Readability.Candidate.Scoring.class_weight/1","type":"function"},{"doc":"","ref":"Readability.Candidate.Scoring.html#t:html_tree/0","title":"Readability.Candidate.Scoring.html_tree/0","type":"type"},{"doc":"","ref":"Readability.Candidate.Scoring.html#t:options/0","title":"Readability.Candidate.Scoring.options/0","type":"type"},{"doc":"The builing and finding candidates engine It traverses the HTML tree searching, removing, socring nodes","ref":"Readability.CandidateFinder.html","title":"Readability.CandidateFinder","type":"module"},{"doc":"Find candidates that shuld be meaningful article by analysing nodes","ref":"Readability.CandidateFinder.html#find/3","title":"Readability.CandidateFinder.find/3","type":"function"},{"doc":"Find the highest score candidate.","ref":"Readability.CandidateFinder.html#find_best_candidate/1","title":"Readability.CandidateFinder.find_best_candidate/1","type":"function"},{"doc":"","ref":"Readability.CandidateFinder.html#t:html_tree/0","title":"Readability.CandidateFinder.html_tree/0","type":"type"},{"doc":"","ref":"Readability.CandidateFinder.html#t:options/0","title":"Readability.CandidateFinder.options/0","type":"type"},{"doc":"Helpers for parsing, updating, removing html tree","ref":"Readability.Helper.html","title":"Readability.Helper","type":"module"},{"doc":"Check html_tree can be candidate or not.","ref":"Readability.Helper.html#candidate_tag?/1","title":"Readability.Helper.candidate_tag?/1","type":"function"},{"doc":"Change existing tags by selector","ref":"Readability.Helper.html#change_tag/3","title":"Readability.Helper.change_tag/3","type":"function"},{"doc":"Normalize and Parse to html tree(tuple or list)) from binary html","ref":"Readability.Helper.html#normalize/2","title":"Readability.Helper.normalize/2","type":"function"},{"doc":"Remove html attributes","ref":"Readability.Helper.html#remove_attrs/2","title":"Readability.Helper.remove_attrs/2","type":"function"},{"doc":"Remove tags","ref":"Readability.Helper.html#remove_tag/2","title":"Readability.Helper.remove_tag/2","type":"function"},{"doc":"Count only text length","ref":"Readability.Helper.html#text_length/1","title":"Readability.Helper.text_length/1","type":"function"},{"doc":"","ref":"Readability.Helper.html#t:html_tree/0","title":"Readability.Helper.html_tree/0","type":"type"},{"doc":"Clean an element of all tags of type "tag" if they look fishy. "Fishy" is an algorithm based on content length, classnames, link density, number of images & embeds, etc.","ref":"Readability.Sanitizer.html","title":"Readability.Sanitizer","type":"module"},{"doc":"Sanitizes article html tree","ref":"Readability.Sanitizer.html#sanitize/3","title":"Readability.Sanitizer.sanitize/3","type":"function"},{"doc":"","ref":"Readability.Sanitizer.html#t:html_tree/0","title":"Readability.Sanitizer.html_tree/0","type":"type"},{"doc":"","ref":"Readability.Summary.html","title":"Readability.Summary","type":"module"},{"doc":"The TitleFinder engine traverses HTML tree searching for finding title.","ref":"Readability.TitleFinder.html","title":"Readability.TitleFinder","type":"module"},{"doc":"Find title from h tag","ref":"Readability.TitleFinder.html#h_tag_title/2","title":"Readability.TitleFinder.h_tag_title/2","type":"function"},{"doc":"Find title from og:title property of meta tag","ref":"Readability.TitleFinder.html#og_title/1","title":"Readability.TitleFinder.og_title/1","type":"function"},{"doc":"Find title from title tag","ref":"Readability.TitleFinder.html#tag_title/1","title":"Readability.TitleFinder.tag_title/1","type":"function"},{"doc":"Find proper title","ref":"Readability.TitleFinder.html#title/1","title":"Readability.TitleFinder.title/1","type":"function"},{"doc":"","ref":"Readability.TitleFinder.html#t:html_tree/0","title":"Readability.TitleFinder.html_tree/0","type":"type"}]