documon
Version:
A documentation system for mortals. Use with any language.
181 lines (101 loc) • 4.85 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>searchPrep</title>
<meta name="description" content="Clean text so it has:">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "documon.searchPrep",
name: "searchPrep"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="main-method">
<a name="methods"></a>
<div class="part-methods">
<a name="documon.searchPrep"></a><a name="searchPrep"></a>
<div class="member" data-access="private" >
<div class="member-name clearfix">
<span class="member-name-left">
searchPrep (<span class="method-arguments">text</span>)
<span class="flag private">private</span> <!-- public private protected -->
</span>
<span class="member-name-right">
<span class="member-file">documon/src/searchPrep.js</span>
<span class="member-line-number">21</span>
</span>
</div>
<div class="member-description">
<div class="meta-block meta-block-klass">
<div class="meta-line"><span class="meta-label" >xpath</span> <span class="meta-target">documon.searchPrep<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/src/searchPrep.js<span></div>
</div>
<p>Clean text so it has:</p>
<ul>
<li>only alpha numeric characters</li>
<li>strips newlines and tabs.</li>
<li>single word results ignored</li>
</ul>
<p>Used by <a href="root.documon.tag">tag.js</a> and <a href="root.documon.more">more.js</a></p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">text</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>text</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">string</span>
</div>
<div class="member"><p>The clean text</p></div>
</div>
</div>
</div>
</div>
<div class="parts">
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>