Skip to content

Commit b1448ed

Browse files
committed
Misc grammar/typo fixes in docs
1 parent 1f4f320 commit b1448ed

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

demo.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h1 id="widgets" class="page-header">
3333
Widgets
3434
</h1>
3535

36-
<p>This demo shows how to integrates widgets into QueryBuilder rules. Widgets used are <a
36+
<p>This demo shows how to integrate widgets into QueryBuilder rules. Widgets used are <a
3737
href="https://github.com/eternicode/bootstrap-datepicker">Bootstrap Datepicker</a>,
3838
<a href="https://github.com/seiyria/bootstrap-slider">Bootstrap Slider</a> and <a
3939
href="https://github.com/brianreavis/selectize.js">Selectize</a>.<br>

dev/events.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ <h1 id="intro" class="page-header">
1212
when a validation error happens. The events system is also used by plugins.</p>
1313

1414
<p>There are two types of events: <b>triggers</b> are used to identify a point in the code and <b>changers</b> are
15-
used to modify a value before it used (eg: template, output rules). Both types are used the same way with the jQuery
15+
used to modify a value before it is used (eg: template, output rules). Both types are used the same way with the jQuery
1616
<code>on</code> method on the builder container.</p>
1717

1818
<div class="bs-callout bs-callout-info">

dev/plugins.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ <h1 id="intro" class="page-header">
1212
to offer a plugins system.</p>
1313
<p>Plugins can simply add public methods or make use of events to change the behavior of the builder.</p>
1414

15-
<p>Each plugin is a folder in <code>plugins</code> directory, it contains at least a <code>plugin.js</code> file and
16-
optionally a <code>plugin.scss</code> file and a <code>i18n</code> folder. Everything needed to the plugin operation
15+
<p>Each plugin is a folder in the <code>plugins</code> directory, which contains at least a <code>plugin.js</code> file and
16+
optionally a <code>plugin.scss</code> file and a <code>i18n</code> folder. Everything needed for the plugin to operate
1717
must be contained in these two files (but third-party dependencies of course).</p>
1818

1919
<p>Plugins are included in the <code>dist</code> files by the Grunt task (depending on <b>plugins</b> build option)
@@ -140,7 +140,7 @@ <h1 id="javascript" class="page-header">
140140

141141
<p>The plugins' SCSS files are imported at the end of the core SCSS, allowing you to use all defined variable. One
142142
interesting variable is <code>$theme-name</code> which contains... the theme name (currently "default" or "dark")
143-
you can use to make conditionnal formating.</p>
143+
you can use to make conditional formatting.</p>
144144

145145
<b>Basic SCSS from Filter Description plugin :</b>
146146
<!-- @formatter:off -->

index.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -628,12 +628,12 @@ <h3 id="methods">Methods</h3>
628628
{% endhighlight %}
629629
<!-- @formatter:on -->
630630

631-
<p>Only main methods are described are.</p>
631+
<p>Only main methods are described.</p>
632632

633633
<div class="bs-callout">
634634
<h4><code>.validate()</code></h4>
635635

636-
<p>Returns a boolean whereas the builder is valid or not. Use the <code>validationError</code> event to catch
636+
<p>Returns a boolean indicating whether the builder is valid or not. Use the <code>validationError</code> event to catch
637637
per-rule validation errors. If <code>display_errors</code> is enabled the invalid rules will turn red.</p>
638638
</div>
639639

@@ -688,7 +688,7 @@ <h4>Other formats</h4>
688688
<div class="bs-callout">
689689
<h4><code>.setRules(rules)</code></h4>
690690

691-
<p>Clears the builder and set new rules. The parameters must have the same structure has the output of <code>getRules</code>.
691+
<p>Clears the builder and sets new rules. The parameters must have the same structure as the output of <code>getRules</code>.
692692
<a data-bootbox="rules_format"> <i class="glyphicon glyphicon-info-sign"></i> See an example</a></p>
693693
<!-- @formatter:off -->
694694
{% highlight javascript %}
@@ -884,8 +884,8 @@ <h3 id="themes">Themes</h3>
884884
<p>QueryBuilder comes with two colors-schemes: <a href="{{site.rawUrl}}/dist/css/query-builder.default.min.css"
885885
target="_blank"><i class="glyphicon glyphicon-file"></i> default</a>
886886
(clear) and <a href="{{site.rawUrl}}/dist/css/query-builder.dark.min.css" target="_blank"><i
887-
class="glyphicon glyphicon-file"></i> dark</a>. Change the active theme by switching stylesheet, you cannot use
888-
the two colors-schemes on the same page.</p>
887+
class="glyphicon glyphicon-file"></i> dark</a>. Change the active theme by switching stylesheets. You cannot use
888+
both color-schemes on the same page.</p>
889889
</section>
890890

891891
<section class="bs-docs-section">
@@ -895,7 +895,7 @@ <h1 id="advanced" class="page-header">
895895

896896
<h3 id="operators">Operators</h3>
897897

898-
<p>QueryBuilder is bundle with an <a data-bootbox="default_operators"><i class="glyphicon glyphicon-info-sign"></i>
898+
<p>QueryBuilder is bundled with an <a data-bootbox="default_operators"><i class="glyphicon glyphicon-info-sign"></i>
899899
extensive list of operators</a>. You can change which operators are available for each filter (see <a
900900
href="#filters">filters</a> configuration) but you can also modify/reorder the operators globally and even add new
901901
custom operators.</p>
@@ -916,7 +916,7 @@ <h3 id="operators">Operators</h3>
916916
<tr>
917917
<td>type</td>
918918
<td>string</td>
919-
<td>Identifier of the operator, use the <code>lang.operators</code> to translate give a human readable name to
919+
<td>Identifier of the operator, use the <code>lang.operators</code> to translate or give a human readable name to
920920
your operator.
921921
</td>
922922
</tr>
@@ -1072,15 +1072,15 @@ <h3 id="icons">Icons</h3>
10721072

10731073
<h3 id="templates">Templates</h3>
10741074

1075-
<p>For very custom customizations, QueryBuilder provides a way to completely overwrite de HTML templates used to
1076-
display rules and groups. It uses the <a href="http://olado.github.io/doT">doT.js</a> template engine by default but
1075+
<p>For very custom customizations, QueryBuilder provides a way to completely overwrite the HTML templates used to
1076+
display rules and groups. It uses the <a href="http://olado.github.io/doT">doT.js</a> template engine by default, but
10771077
can be used with most JS template engines, like <i>underscore.js</i> one.</p>
10781078

10791079
<div class="bs-callout bs-callout-danger">
10801080
<h4>Very advanced feature</h4>
10811081

1082-
<p>Modifying templates can leads to a not functionnal builder if the general layout differs too much. Particularly
1083-
you should keep all CSS classes which are not part of Bootstrap.</p>
1082+
<p>Modifying templates can lead to a non-functionnal builder if the general layout differs too much. In particular,
1083+
non-Bootstrap CSS classes should not be removed.</p>
10841084
</div>
10851085

10861086
<p>Templates can be provided as a <a href="http://olado.github.io/doT/#samples">doT.js template string</a> or as a
@@ -1140,8 +1140,8 @@ <h4>operatorSelect</h4>
11401140

11411141
<h3 id="inside_the_box">Inside the box</h3>
11421142

1143-
<p>You might have noticed that callbacks and events reffer to two objects <b>Rule</b> and <b>Group</b>. These objects
1144-
are part of the data model with partial data-binding used internally by QueryBuilder. Here the structure of these
1143+
<p>You might have noticed that callbacks and events refer to two objects <b>Rule</b> and <b>Group</b>. These objects
1144+
are part of the data model with partial data-binding used internally by QueryBuilder. Here are the structures of these
11451145
two objects. Most attributes will live-update the builder when modified.</p>
11461146

11471147
<div class="container-fluid">

plugins.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ <h1 id="presentation" class="page-header">
2626
{% endhighlight %}
2727
<!-- @formatter:on -->
2828

29-
<p>You can find bellow the plugins shipped by default with QueryBuilder, with their identifiers.</p>
29+
<p>Below you can find the plugins shipped by default with QueryBuilder, with their identifiers.</p>
3030

3131
<p><b>Want to create a new plugin ?</b> Check our <a href="{{site.github.url}}/dev/plugins.html">developer doc</a>.
3232
</p>

0 commit comments

Comments
 (0)