Permalink
Browse files

Updated docs

  • Loading branch information...
rudyl313 committed Apr 24, 2012
1 parent 37dfeed commit f6ba7f0941e1675be5659f9285b5d08ff21adb93
Showing with 217 additions and 106 deletions.
  1. +4 −4 docs/{Data-Factual-CrosswalkQuery.html → Data-Factual-Query-CrosswalkQuery.html}
  2. +10 −0 docs/Data-Factual-Query-FacetsQuery.html
  3. +13 −0 docs/Data-Factual-Query-ReadQuery.html
  4. +6 −6 docs/{Data-Factual-ResolveQuery.html → Data-Factual-Query-ResolveQuery.html}
  5. +9 −0 docs/Data-Factual-Query-SchemaQuery.html
  6. +1 −1 docs/Data-Factual-Query.html
  7. +0 −44 docs/Data-Factual-ReadQuery.html
  8. +0 −9 docs/Data-Factual-SchemaQuery.html
  9. +27 −0 docs/Data-Factual-Shared-Filter.html
  10. +15 −0 docs/Data-Factual-Shared-Geo.html
  11. +10 −0 docs/Data-Factual-Shared-Search.html
  12. +5 −5 docs/{Data-Factual-Table.html → Data-Factual-Shared-Table.html}
  13. +2 −2 docs/Data-Factual-Utils.html
  14. +11 −0 docs/Data-Factual-Write-Contribute.html
  15. +15 −0 docs/Data-Factual-Write-Flag.html
  16. +10 −0 docs/Data-Factual-Write.html
  17. +14 −8 docs/Network-Factual-API.html
  18. +1 −1 docs/doc-index.html
  19. +1 −1 docs/index-frames.html
  20. +1 −1 docs/index.html
  21. +5 −0 docs/mini_Data-Factual-Query-CrosswalkQuery.html
  22. +3 −3 docs/{mini_Data-Factual-CrosswalkQuery.html → mini_Data-Factual-Query-FacetsQuery.html}
  23. +3 −3 docs/{mini_Data-Factual-SchemaQuery.html → mini_Data-Factual-Query-ReadQuery.html}
  24. +6 −0 docs/mini_Data-Factual-Query-ResolveQuery.html
  25. +5 −0 docs/mini_Data-Factual-Query-SchemaQuery.html
  26. +0 −8 docs/mini_Data-Factual-ReadQuery.html
  27. +6 −0 docs/mini_Data-Factual-Shared-Filter.html
  28. +6 −0 docs/mini_Data-Factual-Shared-Geo.html
  29. +6 −0 docs/mini_Data-Factual-Shared-Search.html
  30. +3 −4 docs/{mini_Data-Factual-ResolveQuery.html → mini_Data-Factual-Shared-Table.html}
  31. +1 −1 docs/mini_Data-Factual-Utils.html
  32. +5 −0 docs/mini_Data-Factual-Write-Contribute.html
  33. +6 −0 docs/mini_Data-Factual-Write-Flag.html
  34. +3 −3 docs/{mini_Data-Factual-Table.html → mini_Data-Factual-Write.html}
  35. +4 −2 docs/mini_Network-Factual-API.html
@@ -1,11 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Factual.CrosswalkQuery</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
-window.onload = function () {pageLoad();setSynopsis("mini_Data-Factual-CrosswalkQuery.html");};
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Factual.Query.CrosswalkQuery</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
+window.onload = function () {pageLoad();setSynopsis("mini_Data-Factual-Query-CrosswalkQuery.html");};
//]]>
-</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption" class="empty">&nbsp;</p></div><div id="content"><div id="module-header"><p class="caption">Data.Factual.CrosswalkQuery</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">CrosswalkQuery type
+</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption" class="empty">&nbsp;</p></div><div id="content"><div id="module-header"><p class="caption">Data.Factual.Query.CrosswalkQuery</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">CrosswalkQuery type
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module exports the type used to create crosswalk queries.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:CrosswalkQuery">CrosswalkQuery</a> = <a href="#v:CrosswalkQuery">CrosswalkQuery</a> {<ul class="subs"><li><a href="#v:factualId">factualId</a> :: Maybe String</li><li><a href="#v:limit">limit</a> :: Maybe Int</li><li><a href="#v:namespace">namespace</a> :: Maybe String</li><li><a href="#v:namespaceId">namespaceId</a> :: Maybe String</li><li><a href="#v:only">only</a> :: [String]</li></ul>}</li></ul></div><div id="interface"><h1 id="g:1">CrosswalkQuery type
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CrosswalkQuery" class="def">CrosswalkQuery</a> </p><div class="doc"><p>A crosswalk query can be formed by specifying a factual id and
(optionally) a list of namespaces to only include when attempting to find
the ids for various namespaces, or by specifying a namespace and namespace
id in order to find the factual id. An optional limit can be set as well.
-</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CrosswalkQuery" class="def">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:factualId" class="def">factualId</a> :: Maybe String</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:limit" class="def">limit</a> :: Maybe Int</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:namespace" class="def">namespace</a> :: Maybe String</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:namespaceId" class="def">namespaceId</a> :: Maybe String</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:only" class="def">only</a> :: [String]</dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:CrosswalkQuery" class="caption collapser" onclick="toggleSection('i:CrosswalkQuery')">Instances</p><div id="section.i:CrosswalkQuery" class="show"><table><tr><td class="src">Eq <a href="Data-Factual-CrosswalkQuery.html#t:CrosswalkQuery">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Show <a href="Data-Factual-CrosswalkQuery.html#t:CrosswalkQuery">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="Data-Factual-Query.html#t:Query">Query</a> <a href="Data-Factual-CrosswalkQuery.html#t:CrosswalkQuery">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
+</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CrosswalkQuery" class="def">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:factualId" class="def">factualId</a> :: Maybe String</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:limit" class="def">limit</a> :: Maybe Int</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:namespace" class="def">namespace</a> :: Maybe String</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:namespaceId" class="def">namespaceId</a> :: Maybe String</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:only" class="def">only</a> :: [String]</dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:CrosswalkQuery" class="caption collapser" onclick="toggleSection('i:CrosswalkQuery')">Instances</p><div id="section.i:CrosswalkQuery" class="show"><table><tr><td class="src">Eq <a href="Data-Factual-Query-CrosswalkQuery.html#t:CrosswalkQuery">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Show <a href="Data-Factual-Query-CrosswalkQuery.html#t:CrosswalkQuery">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="Data-Factual-Query.html#t:Query">Query</a> <a href="Data-Factual-Query-CrosswalkQuery.html#t:CrosswalkQuery">CrosswalkQuery</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Factual.Query.FacetsQuery</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
+window.onload = function () {pageLoad();setSynopsis("mini_Data-Factual-Query-FacetsQuery.html");};
+//]]>
+</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption" class="empty">&nbsp;</p></div><div id="content"><div id="module-header"><p class="caption">Data.Factual.Query.FacetsQuery</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">FacetsQuery type
+</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module exports the types used to create facets queries.
+</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:FacetsQuery">FacetsQuery</a> = <a href="#v:FacetsQuery">FacetsQuery</a> {<ul class="subs"><li><a href="#v:table">table</a> :: <a href="Data-Factual-Shared-Table.html#t:Table">Table</a></li><li><a href="#v:search">search</a> :: <a href="Data-Factual-Shared-Search.html#t:Search">Search</a></li><li><a href="#v:select">select</a> :: [String]</li><li><a href="#v:filters">filters</a> :: [<a href="Data-Factual-Shared-Filter.html#t:Filter">Filter</a>]</li><li><a href="#v:geo">geo</a> :: Maybe <a href="Data-Factual-Shared-Geo.html#t:Geo">Geo</a></li><li><a href="#v:limit">limit</a> :: Maybe Int</li><li><a href="#v:minCount">minCount</a> :: Maybe Int</li><li><a href="#v:includeCount">includeCount</a> :: Bool</li></ul>}</li><li class="src short">module <a href="Data-Factual-Shared-Table.html">Data.Factual.Shared.Table</a></li><li class="src short">module <a href="Data-Factual-Shared-Search.html">Data.Factual.Shared.Search</a></li><li class="src short">module <a href="Data-Factual-Shared-Filter.html">Data.Factual.Shared.Filter</a></li><li class="src short">module <a href="Data-Factual-Shared-Geo.html">Data.Factual.Shared.Geo</a></li></ul></div><div id="interface"><h1 id="g:1">FacetsQuery type
+</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:FacetsQuery" class="def">FacetsQuery</a> </p><div class="doc"><p>The FacetsQuery type is used to construct facets queries. A table and search
+ should be specified, but the rest of the query options are essentially
+ optional.
+</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:FacetsQuery" class="def">FacetsQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:table" class="def">table</a> :: <a href="Data-Factual-Shared-Table.html#t:Table">Table</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:search" class="def">search</a> :: <a href="Data-Factual-Shared-Search.html#t:Search">Search</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:select" class="def">select</a> :: [String]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:filters" class="def">filters</a> :: [<a href="Data-Factual-Shared-Filter.html#t:Filter">Filter</a>]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:geo" class="def">geo</a> :: Maybe <a href="Data-Factual-Shared-Geo.html#t:Geo">Geo</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:limit" class="def">limit</a> :: Maybe Int</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:minCount" class="def">minCount</a> :: Maybe Int</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:includeCount" class="def">includeCount</a> :: Bool</dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:FacetsQuery" class="caption collapser" onclick="toggleSection('i:FacetsQuery')">Instances</p><div id="section.i:FacetsQuery" class="show"><table><tr><td class="src">Eq <a href="Data-Factual-Query-FacetsQuery.html#t:FacetsQuery">FacetsQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Show <a href="Data-Factual-Query-FacetsQuery.html#t:FacetsQuery">FacetsQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="Data-Factual-Query.html#t:Query">Query</a> <a href="Data-Factual-Query-FacetsQuery.html#t:FacetsQuery">FacetsQuery</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Table.html">Data.Factual.Shared.Table</a></p></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Search.html">Data.Factual.Shared.Search</a></p></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Filter.html">Data.Factual.Shared.Filter</a></p></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Geo.html">Data.Factual.Shared.Geo</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Factual.Query.ReadQuery</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
+window.onload = function () {pageLoad();setSynopsis("mini_Data-Factual-Query-ReadQuery.html");};
+//]]>
+</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption" class="empty">&nbsp;</p></div><div id="content"><div id="module-header"><p class="caption">Data.Factual.Query.ReadQuery</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">ReadQuery type
+</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module exports the types used to create read queries.
+</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:ReadQuery">ReadQuery</a> = <a href="#v:ReadQuery">ReadQuery</a> {<ul class="subs"><li><a href="#v:table">table</a> :: <a href="Data-Factual-Shared-Table.html#t:Table">Table</a></li><li><a href="#v:search">search</a> :: <a href="Data-Factual-Shared-Search.html#t:Search">Search</a></li><li><a href="#v:select">select</a> :: [String]</li><li><a href="#v:limit">limit</a> :: Maybe Int</li><li><a href="#v:offset">offset</a> :: Maybe Int</li><li><a href="#v:filters">filters</a> :: [<a href="Data-Factual-Shared-Filter.html#t:Filter">Filter</a>]</li><li><a href="#v:geo">geo</a> :: Maybe <a href="Data-Factual-Shared-Geo.html#t:Geo">Geo</a></li><li><a href="#v:includeCount">includeCount</a> :: Bool</li></ul>}</li><li class="src short">module <a href="Data-Factual-Shared-Table.html">Data.Factual.Shared.Table</a></li><li class="src short">module <a href="Data-Factual-Shared-Search.html">Data.Factual.Shared.Search</a></li><li class="src short">module <a href="Data-Factual-Shared-Filter.html">Data.Factual.Shared.Filter</a></li><li class="src short">module <a href="Data-Factual-Shared-Geo.html">Data.Factual.Shared.Geo</a></li></ul></div><div id="interface"><h1 id="g:1">ReadQuery type
+</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ReadQuery" class="def">ReadQuery</a> </p><div class="doc"><p>The ReadQuery type is used to construct read queries. A table should be
+ specified, but the rest of the query options are essentially optional
+ (you opt out using Nothing or an empty List for the value). The select is
+ a list of field names to include in the results. The limit and offset are
+ used to request a specific range of rows and includeCount will include the
+ count of returned rows if it is set to True.
+</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ReadQuery" class="def">ReadQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:table" class="def">table</a> :: <a href="Data-Factual-Shared-Table.html#t:Table">Table</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:search" class="def">search</a> :: <a href="Data-Factual-Shared-Search.html#t:Search">Search</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:select" class="def">select</a> :: [String]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:limit" class="def">limit</a> :: Maybe Int</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:offset" class="def">offset</a> :: Maybe Int</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:filters" class="def">filters</a> :: [<a href="Data-Factual-Shared-Filter.html#t:Filter">Filter</a>]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:geo" class="def">geo</a> :: Maybe <a href="Data-Factual-Shared-Geo.html#t:Geo">Geo</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:includeCount" class="def">includeCount</a> :: Bool</dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:ReadQuery" class="caption collapser" onclick="toggleSection('i:ReadQuery')">Instances</p><div id="section.i:ReadQuery" class="show"><table><tr><td class="src">Eq <a href="Data-Factual-Query-ReadQuery.html#t:ReadQuery">ReadQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Show <a href="Data-Factual-Query-ReadQuery.html#t:ReadQuery">ReadQuery</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="Data-Factual-Query.html#t:Query">Query</a> <a href="Data-Factual-Query-ReadQuery.html#t:ReadQuery">ReadQuery</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Table.html">Data.Factual.Shared.Table</a></p></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Search.html">Data.Factual.Shared.Search</a></p></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Filter.html">Data.Factual.Shared.Filter</a></p></div><div class="top"><p class="src">module <a href="Data-Factual-Shared-Geo.html">Data.Factual.Shared.Geo</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
Oops, something went wrong.

0 comments on commit f6ba7f0

Please sign in to comment.