Skip to content

Commit

Permalink
documentation edited
Browse files Browse the repository at this point in the history
  • Loading branch information
vkiryukhin committed Feb 29, 2012
1 parent 3dc9563 commit ff7d2b2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 16 deletions.
2 changes: 1 addition & 1 deletion html/basicsql.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>
<p>Click on "<b>Pretty Print</b>" button to beatify the text. </p>
<p>Click on "<b>Minify</b>" button to minify the text (not sure if anybody needs it, but I keep it for consistency :)<br/><br/>
<span style="font-size:80%">"Preserve Comments" is not implemented for SQL part or the application. </span>
<span style="font-size:80%">"Preserve Comments" is not implemented for SQL part of the application. </span>
</p>
<p>

Expand Down
20 changes: 11 additions & 9 deletions html/doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

<li>Usage:
<ul>
<li>Pretty print: <code>vkbeautify.xml|json|css(text);</code></li>
<li>Minify: <code>vkbeautify.xmlmin|jsonmin|cssmin(text [,preserveComments]);</code></li>
<li>Pretty print: <code>vkbeautify.xml|json|css|sql(text);</code></li>
<li>Minify: <code>vkbeautify.xmlmin|jsonmin|cssmin|sqlmin(text [,preserveComments]);</code></li>
</ul>
</li>
<li>Parameters:
<ul>
<li><code>@text</code> - String; XML, JSON or CSS text to beatufy;</li>
<li><code>@text</code> - String; XML, JSON, CSS or SQL text to beatufy;</li>
<li><code>@preserveComments</code> - Bool; [optional] flag, which is used in minxml and mincss functions only. <br/>
Set this flag to true to prevent removing comments from <code>@text</code>;
<li><code>Return</code> - String</li>
Expand All @@ -31,12 +31,14 @@

<li>Usage Examples:<br/>
<ul>
<li><code>vkbeautify.xml(text);</code> // pretty print XML</li>
<li><code>vkbeautify.json(text);</code> // pretty print JSON </li>
<li><code>vkbeautify.css(text);</code> // pretty print CSS <br/><br/></li>
<li><code>vkbeautify.xmlmin(text [, true]);</code>// minify XML </li>
<li><code>vkbeautify.jsonmin(text);</code>// minify JSON </li>
<li><code>vkbeautify.cssmin(text[, true]);</code>// minify CSS </li>
<li><code>vkbeautify.xml(text);</code> // pretty print <b>XML</b></li>
<li><code>vkbeautify.json(text);</code> // pretty print <b>JSON</b> </li>
<li><code>vkbeautify.css(text);</code> // pretty print <b>CSS</b> </li>
<li><code>vkbeautify.sql(text);</code> // pretty print <b>SQL</b> <br/><br/></li>
<li><code>vkbeautify.xmlmin(text [, true]);</code>// minify <b>XML</b> </li>
<li><code>vkbeautify.jsonmin(text);</code>// minify <b>JSON</b> </li>
<li><code>vkbeautify.cssmin(text[, true]);</code>// minify <b>CSS</b> </li>
<li><code>vkbeautify.sqlmin(text);</code>// minify <b>SQL</b> </li>
</ul>
</li>
</ul>
Expand Down
20 changes: 14 additions & 6 deletions html/overview.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
<table>
<tr><td>
<div class="h6">Overview</div>
<p>vkBeautify is a small, simple and powerfull javascript plugin to beautify ( pretty print ) or minify <b>XML</b>, <b>JSON</b> or <b>CSS</b> text.<br/>
This script works either as a client-side javascript or as a <b>nodeJS</b> plagin.
<p>vkBeautify is a small, simple and powerfull javascript plugin to beautify ( pretty print )
or minify text in following formats:<b><ul>
<li>XML</li>
<li>JSON</li>
<li>CSS</li>
<li>SQL</li>
</ul>
</b>
.<br/>
This script is also implemented for <b>nodeJS</b> platform as <b>"pretty-data"</b> module.
</p>
<p><b>Consider to use it if you:</b></p>
<ul>
<li>create XML / JSON / CSS text manually at client side</li>
<li>create XML / JSON / CSS with tool, but let user to check or edit the result manually</li>
<li>get XML / JSON / CSS data from web service and check or edit it before or after processing the data </li>
<li>other cases when you need to create, edit or check content of an XML, JSON or CSS file.</li>
<li>create XML / JSON / CSS / SQL text manually at client side</li>
<li>create XML / JSON / CSS/ SQL with tool, but let user to check or edit the result manually</li>
<li>get XML / JSON / CSS/ SQL data from web service and check or edit it before or after processing the data </li>
<li>other cases when you need to create, edit or check content of an XML, JSON, CSS or SQL file.</li>
</ul>

<p><b>This plugin:</b></p>
Expand Down

0 comments on commit ff7d2b2

Please sign in to comment.