Skip to content

Getting Started

Jump to bottom Edit New page
HeinrichHartmann edited this page Oct 21, 2014 · 2 revisions

Customer Max has a simple plain HTML website hosted on GitHub. He wants to add a auto-completion to a search box which allows users to browse to all subpages.

<html>
<h1>Max's Website</h1>
<form><input type="text" name="searchbox" value="Find content"><input type="submit"></form>
</html>

Process using Completionary

  1. Signup. Max visits the Completionary webpage (http://completionary.org/) and signs up for an account. He is then referred to the Dashboard.

  2. The Dashboard shows (on first login) the "Getting Started" information (digest of this doc).

  3. Max clicks on the Index tab where he finds a form to upload a CSV file with the contents of the AC index.

    Open Ends:

    • Format specification: query string, URL, image (url/bas64)
    • Bootsrapping Crawler (e.g. take a URL and parse all links from the HTML)
    • Links to Plugins (fill index from DB)

  4. Max is presented (on Dashboard start page? or in Index tab?) with a js code snippet, that he pasts into his HTML form:

    <script src="http://completionary.org/js/MAX.js">

    He edits the js to link the search box to the auto completion service. Options:

    • Insert CSS selector into js file
    • Add new CSS selector to the serach box
    • Plugin should take care/help with this step

  5. Now, Max homepage has a working auto completion index!

  6. To see how Max visitors like the search box, he uses the Analytics tab, where real-time statistics of queries is presented to him.

Open Ends: Privacy of visitors: Log files of AC index should not be disclosed to our customers.

Add a custom footer
Add a custom sidebar
Clone this wiki locally