Clark C. Evans avatar Clark C. Evans committed 8590d6b

starting->handbook

Comments (0)

Files changed (5)

+*******************
+  HTSQL Handbook
+*******************
+
+.. contents:: Table of Contents
+   :depth: 1
+   :local:
+
+.. note:: 
+
+    This document will be linked from the front page and
+    provide initial bootstrap including installation, 
+    configuration, usage, and basic queries.
+
    :maxdepth: 2
 
    overview
-   starting
+   handbook
    tutorial
    ref/index
    admin/index
 things done.  HTSQL handles routine data processing needs in an
 accessible, transparent, rigorous and embeddable manner.
 
-**Accessible**
+Accessible
+----------
 
-  We want HTSQL to be broadly usable.  Our query language should provide
-  business analysts, information scientists, and data curators
-  self-service access and control over their database.  Not only should
-  these *accidental programmers* be able able to answer complex business
-  inquiries themselves, they should be able to share the queries they
-  create with their colleagues.  HTSQL must be a productive tool for
-  problem solving with a small learning curve.
+We want HTSQL to be broadly usable.  Our query language should provide
+business analysts, information scientists, and data curators
+self-service access and control over their database.  Not only should
+these *accidental programmers* be able able to answer complex business
+inquiries themselves, they should be able to share the queries they
+create with their colleagues.  HTSQL must be a productive tool for
+problem solving with a small learning curve.
 
-**Transparent**
+Transparent
+-----------
 
-  We think aesthetics matter.  When a data analyst is focusing on a domain 
-  specific problem, the HTSQL query language should do the heavy lifting
-  but otherwise stay in the background.  Translation of a business inquiry 
-  into the HTSQL query language must be natural and obvious.  Initial query 
-  authoring is just the beginning.  A database query is often the only human 
-  readable expression of a business rule, so each and every query must be a 
-  pleasure to review, share and maintain.
+We think aesthetics matter.  When a data analyst is focusing on a domain 
+specific problem, the HTSQL query language should do the heavy lifting
+but otherwise stay in the background.  Translation of a business inquiry 
+into the HTSQL query language must be natural and obvious.  Initial query 
+authoring is just the beginning.  A database query is often the only human 
+readable expression of a business rule, so each and every query must be a 
+pleasure to review, share and maintain.
 
-**Rigorous**
+Rigorous
+--------
 
-  We know correctness is critical.  The HTSQL query language is based upon
-  a navigational data linking and flow processing model having consistent
-  semantics that are independent of the underlying database architecture.
-  The language designed to be composable so that query fragments can be
-  independently tested and combined.  HTSQL's syntax is regular enough
-  that syntax highlighting and context sensitive name lookup is possible.
+We know correctness is critical.  The HTSQL query language is based upon
+a navigational data linking and flow processing model having consistent
+semantics that are independent of the underlying database architecture.
+The language designed to be composable so that query fragments can be
+independently tested and combined.  HTSQL's syntax is regular enough
+that syntax highlighting and context sensitive name lookup is possible.
 
-**Embeddable**
+Embeddable
+----------
 
-  We realize a query language is not a product.  Instead, HTSQL is a tool
-  used as part of a workflow solution or embedded into an application.
-  Our public application program interface is be simple and stable.
-  Further, since *accidental programmers* might require features which
-  other software developers could build, we have an extensive plug-in
-  interface for those who wish to add features to HTSQL itself.  Between
-  web service wrappers or plug-ins, it should be possible to customize
-  almost every aspect of HTSQL without requiring a code fork.
+We realize a query language is not a product.  Instead, HTSQL is a tool
+used as part of a workflow solution or embedded into an application.
+Our public application program interface is be simple and stable.
+Further, since *accidental programmers* might require features which
+other software developers could build, we have an extensive plug-in
+interface for those who wish to add features to HTSQL itself.  Between
+web service wrappers or plug-ins, it should be possible to customize
+almost every aspect of HTSQL without requiring a code fork.
 
 
 HTSQL in a Nutshell

doc/starting.rst

-*******************
-  Getting Started
-*******************
-
-.. contents:: Table of Contents
-   :depth: 1
-   :local:
-
-.. note:: 
-
-    This document will be linked from the front page and
-    provide initial bootstrap including installation, 
-    configuration, usage, and basic queries.
 We hope you like it.
 
 
-First Steps
-===========
+Getting Started
+===============
 
 The following examples show output from the HTSQL command-line system,
 which is plain text.  HTSQL can output HTML, CSV, XML and many other
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.