Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mithrandie
mithrandie committed Jun 22, 2017
1 parent aa4b747 commit 766b88c
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 88 deletions.
126 changes: 61 additions & 65 deletions docs/_includes/side_menu.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,75 +2,71 @@
<ul id="slide-out" class="side-nav">
<li class="no-padding map-title">Site Map</li>
<li class="no-padding bold"><a href="{{ '/' | relative_url }}">Home</a></li>
<li class="no-padding">
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Reference Manual<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body">
<ul>
<li><a href="{{ '/reference.html' | relative_url }}">Reference Index</a></li>
<li><a href="{{ '/reference/install.html' | relative_url }}">Install</a></li>
<li><a href="{{ '/reference/command.html' | relative_url }}">Command Usage</a></li>
<li><a href="{{ '/reference/statement.html' | relative_url }}">Statements</a></li>
<li><a href="{{ '/reference/value.html' | relative_url }}">Value Types</a></li>
<li class="no-padding">
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Syntax<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body collapsible-second-class">
<ul>
<li><a href="{{ '/reference/select-query.html' | relative_url }}">Select Query</a></li>
<li><a href="{{ '/reference/insert-query.html' | relative_url }}">Insert Query</a></li>
<li><a href="{{ '/reference/update-query.html' | relative_url }}">Update Query</a></li>
<li><a href="{{ '/reference/delete-query.html' | relative_url }}">Delete Query</a></li>
<li><a href="{{ '/reference/create-table-query.html' | relative_url }}">Create Table Query</a></li>
<li><a href="{{ '/reference/alter-table-query.html' | relative_url }}">Alter Table Query</a></li>
<li><a href="{{ '/reference/variable.html' | relative_url }}">Variable</a></li>
<li><a href="{{ '/reference/cursor.html' | relative_url }}">Cursor</a></li>
<li><a href="{{ '/reference/control-flow.html' | relative_url }}">Control Flow</a></li>
<li><a href="{{ '/reference/transaction.html' | relative_url }}">Transaction Management</a></li>
<li><a href="{{ '/reference/built-in.html' | relative_url }}">Built-in Commands</a></li>
<li><a href="{{ '/reference/flag.html' | relative_url }}">Flag</a></li>
</ul>
</div>
</li>
</ul>
<li class="folder bold">Reference Manual
<div>
<ul>
<li><a href="{{ '/reference.html' | relative_url }}">Reference Index</a></li>
<li><a href="{{ '/reference/install.html' | relative_url }}">Install</a></li>
<li><a href="{{ '/reference/command.html' | relative_url }}">Command Usage</a></li>
<li><a href="{{ '/reference/statement.html' | relative_url }}">Statements</a></li>
<li><a href="{{ '/reference/value.html' | relative_url }}">Value Types</a></li>
<li>
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Syntax<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body">
<ul>
<li><a href="{{ '/reference/select-query.html' | relative_url }}">Select Query</a></li>
<li><a href="{{ '/reference/insert-query.html' | relative_url }}">Insert Query</a></li>
<li><a href="{{ '/reference/update-query.html' | relative_url }}">Update Query</a></li>
<li><a href="{{ '/reference/delete-query.html' | relative_url }}">Delete Query</a></li>
<li><a href="{{ '/reference/create-table-query.html' | relative_url }}">Create Table Query</a></li>
<li><a href="{{ '/reference/alter-table-query.html' | relative_url }}">Alter Table Query</a></li>
<li><a href="{{ '/reference/variable.html' | relative_url }}">Variable</a></li>
<li><a href="{{ '/reference/cursor.html' | relative_url }}">Cursor</a></li>
<li><a href="{{ '/reference/control-flow.html' | relative_url }}">Control Flow</a></li>
<li><a href="{{ '/reference/transaction.html' | relative_url }}">Transaction Management</a></li>
<li><a href="{{ '/reference/built-in.html' | relative_url }}">Built-in Commands</a></li>
<li><a href="{{ '/reference/flag.html' | relative_url }}">Flag</a></li>
</ul>
</div>
</li>
<li class="no-padding">
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Functions<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body collapsible-second-class">
<ul>
<li><a href="{{ '/reference/aggregate-functions.html' | relative_url }}">Aggregate Functions</a></li>
<li><a href="{{ '/reference/logical-functions.html' | relative_url }}">Logical Functions</a></li>
<li><a href="{{ '/reference/string-functions.html' | relative_url }}">String Functions</a></li>
<li><a href="{{ '/reference/numeric-functions.html' | relative_url }}">Numeric Functions</a></li>
<li><a href="{{ '/reference/datetime-functions.html' | relative_url }}">Datetime Functions</a></li>
<li><a href="{{ '/reference/cryptographic-hash-functions.html' | relative_url }}">Cryptographic Hash Functions</a></li>
<li><a href="{{ '/reference/cast-functions.html' | relative_url }}">Cast Functions</a></li>
<li><a href="{{ '/reference/system-functions.html' | relative_url }}">System Functions</a></li>
</ul>
</div>
</li>
</ul>
</ul>
</li>
<li>
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Functions<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body">
<ul>
<li><a href="{{ '/reference/aggregate-functions.html' | relative_url }}">Aggregate Functions</a></li>
<li><a href="{{ '/reference/logical-functions.html' | relative_url }}">Logical Functions</a></li>
<li><a href="{{ '/reference/string-functions.html' | relative_url }}">String Functions</a></li>
<li><a href="{{ '/reference/numeric-functions.html' | relative_url }}">Numeric Functions</a></li>
<li><a href="{{ '/reference/datetime-functions.html' | relative_url }}">Datetime Functions</a></li>
<li><a href="{{ '/reference/cryptographic-hash-functions.html' | relative_url }}">Cryptographic Hash Functions</a></li>
<li><a href="{{ '/reference/cast-functions.html' | relative_url }}">Cast Functions</a></li>
<li><a href="{{ '/reference/system-functions.html' | relative_url }}">System Functions</a></li>
</ul>
</div>
</li>
<li class="no-padding">
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Operators<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body collapsible-second-class">
<ul>
<li><a href="{{ '/reference/operator-precedence.html' | relative_url }}">Operator Precedence</a></li>
<li><a href="{{ '/reference/arithmetic-operators.html' | relative_url }}">Arithmetic Operators</a></li>
<li><a href="{{ '/reference/comparison-operators.html' | relative_url }}">Comparison Operators</a></li>
<li><a href="{{ '/reference/logic-operators.html' | relative_url }}">Logic Operators</a></li>
<li><a href="{{ '/reference/string-operators.html' | relative_url }}">String Operators</a></li>
</ul>
</div>
</li>
</ul>
</ul>
</li>
<li>
<ul class="collapsible">
<li class="bold"><a class="collapsible-header waves-effect waves-light">Operators<i class="material-icons">arrow_drop_down</i></a>
<div class="collapsible-body">
<ul>
<li><a href="{{ '/reference/operator-precedence.html' | relative_url }}">Operator Precedence</a></li>
<li><a href="{{ '/reference/arithmetic-operators.html' | relative_url }}">Arithmetic Operators</a></li>
<li><a href="{{ '/reference/comparison-operators.html' | relative_url }}">Comparison Operators</a></li>
<li><a href="{{ '/reference/logic-operators.html' | relative_url }}">Logic Operators</a></li>
<li><a href="{{ '/reference/string-operators.html' | relative_url }}">String Operators</a></li>
</ul>
</div>
</li>
</ul>
</div>
</li>
</ul>
</li>
</ul>
</div>
</li>
<li class="bold"><a href="{{ '/license.html' | relative_url }}">License</a></li>
</ul>
2 changes: 1 addition & 1 deletion docs/_posts/2006-01-02-comparison-operators.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ value operator value
_value_
: [value]({{ '/reference/value.html' | relative_url }})

At first, a relational operator attempt to convert both of operands to float values, and if convertions is successful then compare them.
At first, a relational operator attempt to convert both of operands to float values, and if both convertions are successful then compare them.
If conversions failed, next a relational operater attempt to convert to datetime, and next to boolean, at last to string.

If either of operands is null or all conversion failed, return UNKNOWN.
Expand Down
4 changes: 2 additions & 2 deletions docs/_posts/2006-01-02-numeric-functions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ Convert a string _bin_ representing a binary number to a integer.
{: #oct_to_dec}

```
BIN_TO_DEC(oct)
OCT_TO_DEC(oct)
```

_oct_
Expand All @@ -428,7 +428,7 @@ Convert a string _hex_ representing a octal number to a integer.
{: #hex_to_dec}

```
BIN_TO_DEC(hex)
HEX_TO_DEC(hex)
```

_hex_
Expand Down
4 changes: 2 additions & 2 deletions docs/_posts/2006-01-02-statement.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ category: reference
## Basics
{: #basics}

You can pass a query or Statements as a csvq command argument or source file.
You can pass a query or statements(it's also called procedure) as a csvq command argument or source file.

Statements are terminated with semicolons.
A statements is terminated with a semicolon.
Stetaments are processed sequentially for each statement.
In statements, character case is ignored.

Expand Down
12 changes: 6 additions & 6 deletions docs/_posts/2006-01-02-string-functions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ _str_
_return_
: [string]({{ '/reference/value.html#string' | relative_url }})

Returns the string _str_ with all leading and trailing white space removed
Returns the string _str_ with all leading and trailing white space removed.

```
TRIM(str, charset)
Expand All @@ -54,7 +54,7 @@ _charset_
_return_
: [string]({{ '/reference/value.html#string' | relative_url }})

Returns the string _str_ with all leading and trailing character contained in _charset_ removed
Returns the string _str_ with all leading and trailing character contained in _charset_ removed.

### LTRIM
{: #ltrim}
Expand All @@ -69,7 +69,7 @@ _str_
_return_
: [string]({{ '/reference/value.html#string' | relative_url }})

Returns the string _str_ with all leading white space removed
Returns the string _str_ with all leading white space removed.

```
LTRIM(str, charset)
Expand All @@ -84,7 +84,7 @@ _charset_
_return_
: [string]({{ '/reference/value.html#string' | relative_url }})

Returns the string _str_ with all leading character contained in _charset_ removed
Returns the string _str_ with all leading character contained in _charset_ removed.


### RTRIM
Expand All @@ -102,7 +102,7 @@ _str_
_return_
: [string]({{ '/reference/value.html#string' | relative_url }})

Returns the string _str_ with all trailing white space removed
Returns the string _str_ with all trailing white space removed.

```
RTRIM(str, charset)
Expand All @@ -117,7 +117,7 @@ _charset_
_return_
: [string]({{ '/reference/value.html#string' | relative_url }})

Returns the string _str_ with all trailing character contained in _charset_ removed
Returns the string _str_ with all trailing character contained in _charset_ removed.

### UPPER
{: #upper}
Expand Down
8 changes: 4 additions & 4 deletions docs/_posts/2006-01-02-transaction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ A transaction is a atomic unit, so you get the result of either all of the chang

### Start Transaction

A transaction is started automatically when the statements execution is started, or after a commit or rollback statement is executed.
A transaction is started automatically when the procedure execution is started, or after a commit or rollback statement is executed.


### Terminate Transaction

A transaction is terminated when a commit or rollback statement is executed.

If the statements execution is normally terminated, commit all of the changes automatically.
If the procedure is normally terminated, then commit all of the changes automatically.

If some errors occurred in the statements execution, roll all of the changes back automatically.
If some errors occurred in the procedure, then roll all of the changes back automatically.

If the statements execution is exited by [EXIT statement]({{ '/reference/control-flow.html#exit' | relative_url }}), roll all of the changes back automatically.
If the procedure is exited by [EXIT statement]({{ '/reference/control-flow.html#exit' | relative_url }}), then roll all of the changes back automatically.

### Commit Statement

Expand Down
15 changes: 7 additions & 8 deletions docs/_sass/csvq.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,13 @@ nav {
line-height: 56px;
}

li.folder{
padding: 0 16px;
color: $text-color;
font-size: $sidenav-font-size;
font-weight: 500;
}

li > a {
padding: 0 16px;
color: $text-color;
Expand All @@ -96,14 +103,6 @@ nav {
li > a > i.low-profile {
color: $secondary-color;
}

.collapsible-body li a {
padding-left: 32px;
}

.collapsible-second-class li a {
padding-left: 48px;
}
}

main {
Expand Down

0 comments on commit 766b88c

Please sign in to comment.