Current section
Files
Jump to
Current section
Files
doc/Readability.CandidateFinder.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.12.0">
<title>Readability.CandidateFinder – readability v0.5.1</title>
<link rel="stylesheet" href="dist/app-88251e7c81.css" />
<link rel="canonical" href="https://hexdocs.pm/readability/Readability.CandidateFinder.html" />
<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
<div class="main">
<button class="sidebar-toggle">
<i class="icon-menu"></i>
</button>
<section class="sidebar">
<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
readability
</h1>
<h2 class="sidebar-projectVersion">
v0.5.1
</h2>
</div>
</a>
<div class="sidebar-search">
<i class="icon-search"></i>
<input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<ul id="full-list" class="sidebar-fullList"></ul>
<div class="sidebar-noResults"></div>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">readability v0.5.1</small>
Readability.CandidateFinder
</h1>
<section id="moduledoc" class="docstring">
<p>The builing and finding candidates engine
It traverses the HTML tree searching, removing, socring nodes</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="icon-link"></i>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:html_tree/0">html_tree()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:options/0">options()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#find/3">find(text, opts \\ [], tree_depth \\ 0)</a>
</div>
<div class="summary-synopsis"><p>Find candidates that shuld be meaningful article by analysing nodes</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#find_best_candidate/1">find_best_candidate(candidates)</a>
</div>
<div class="summary-synopsis"><p>Find the highest score candidate</p>
</div>
</div>
</div>
</section>
<section id="types" class="types details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="icon-link"></i>
</a>
Types
</h1>
<div class="types-list">
<div id="t:html_tree/0" class="type-detail">
<pre><code class="elixir"><a href="#t:html_tree/0">html_tree</a> :: tuple | list</code></pre>
</div>
<div id="t:options/0" class="type-detail">
<pre><code class="elixir"><a href="#t:options/0">options</a> :: list</code></pre>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="icon-link"></i>
</a>
Functions
</h1>
<div class="detail" id="find/3">
<div class="detail-header">
<a href="#find/3" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">find(text, opts \\ [], tree_depth \\ 0)</span>
</div>
<div class="specs">
<h4 class="specs-title">Specs</h4>
<div class="specs-list">
<pre><code class="elixir">find(<a href="#t:html_tree/0">html_tree</a>, <a href="#t:options/0">options</a>, number) :: [<a href="Readability.Candidate.html#t:t/0">Readability.Candidate.t</a>]</code></pre>
</div>
</div>
<section class="docstring">
<p>Find candidates that shuld be meaningful article by analysing nodes</p>
</section>
</div>
<div class="detail" id="find_best_candidate/1">
<div class="detail-header">
<a href="#find_best_candidate/1" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">find_best_candidate(candidates)</span>
</div>
<div class="specs">
<h4 class="specs-title">Specs</h4>
<div class="specs-list">
<pre><code class="elixir">find_best_candidate([<a href="Readability.Candidate.html#t:t/0">Readability.Candidate.t</a>]) :: <a href="Readability.Candidate.html#t:t/0">Readability.Candidate.t</a></code></pre>
</div>
</div>
<section class="docstring">
<p>Find the highest score candidate.</p>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.12.0),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<button class="night-mode-toggle" />
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-21f1a20b9e.js"></script>
</body>
</html>