Permalink
Browse files

grammar and spelling

  • Loading branch information...
wkeese committed Dec 12, 2011
1 parent 0fbc94a commit cdc391709ae6027ab5387ac89ee44da7d650e5a3
View
@@ -214,7 +214,7 @@ They can be specified in the plugins parameter (in addition to actual editor plu
+------------------------------+-----------------------------------------------------------------------------------------------------+
| removeFormat |Remove formatting on current block. |
+------------------------------+-----------------------------------------------------------------------------------------------------+
-| insertOrderedList |Insert an ordered list (1, 2, 3, etc) |
+| insertOrderedList |Insert an ordered list (1, 2, 3, etc.) |
+------------------------------+-----------------------------------------------------------------------------------------------------+
| insertUnorderedList |Insert an unordered list (bullets) |
+------------------------------+-----------------------------------------------------------------------------------------------------+
View
@@ -85,7 +85,7 @@ Please see the following for an example:
<style type="text/css">
</style>
-To programatically size a textbox you would do:
+To programmatically size a textbox you would do:
.. js ::
View
@@ -26,7 +26,7 @@ Simply require the module, and then :
require(["dijit/hccss"]);
-And then reference the class name from CSS rules, etc:
+And then reference the class name from CSS rules, etc.:
.. css ::
View
@@ -241,7 +241,7 @@ Note about programmatic instantiation
=====================================
For most of the dijit widgets, you can provide a ``refNode`` which is a placeholder to position your node.
-Beware that any attribute set on it (form action, input value, `etc`.) won't be taken into account.
+Beware that any attribute set on it (form action, input value, etc.) won't be taken into account.
If you want to degrade nicely and have a non-JS compatible version of your site and avoid duplicating attributes
on controls and on instantiation, you should use ``dojo.parser``:
@@ -29,7 +29,8 @@ Each child element must have an attribute "region" which indicates where it shou
* right
* left
* center
- * leading: used have flexible layout in left-to-right/right-to-left environments.In ltr, it will be equivalent to left, in rtl equivalent to right
+ * leading: used have flexible layout in left-to-right/right-to-left environments.
+ In ltr, it will be equivalent to left, in rtl equivalent to right.
* trailing: opposite of 'leading': right in ltr, left in rtl
There can be multiple widgets for each region, in which case their order (i.e.
@@ -48,7 +49,7 @@ Besides setting the size of the BorderContainer itself, you generally need to se
You shouldn't need to set the height of the top/bottom panes as that can be determined automatically.
-``note:`` In order to set the overall size of a BorderContainer to the full size of the viewport, the `<body>` element needs an explicit size set as well as a size on the BorderContainer itself:
+``Note:`` In order to set the overall size of a BorderContainer to the full size of the viewport, the `<body>` element needs an explicit size set as well as a size on the BorderContainer itself:
.. html ::
@@ -98,7 +99,7 @@ Declarative example
<div data-dojo-type="dijit.layout.ContentPane" data-dojo-props="splitter:true, region:'center'">Hi, I'm center</div>
</div>
- A simple set of css rules
+ A simple set of CSS rules
.. css::
@@ -213,7 +214,7 @@ Let's take a look at a more advanced example of using BorderContainer and other
</div><!-- end TabContainer -->
</div><!-- end BorderContainer -->
- A few simple css rules
+ A few simple CSS rules
.. css::
@@ -235,7 +236,8 @@ Let's take a look at a more advanced example of using BorderContainer and other
BorderContainer Inside A Dijit Template
---------------------------------------
-You can use a BorderContainer inside your own dijit template with a bit of care to call startup() on your dijit after it has been added to the DOM, so that its contained BorderContainer can lay itself out.
+You can use a BorderContainer inside your own dijit template with a bit of care to call startup() on your dijit
+after it has been added to the DOM, so that its contained BorderContainer can lay itself out.
.. code-example::
:djConfig: parseOnLoad: true
@@ -334,4 +336,4 @@ Change the size of a horizontal region down / up arrows to decrease and
Note: The children of BorderContainer must be created in the source code in their natural tab order.
Header regions should be first and footer regions last.
-In Left to right locales, left regions before center and right ones.
+In Left to right locales, left regions should be before center and right ones.
@@ -36,7 +36,8 @@ Loading Message
---------------
The loading message that's displayed while content is being fetched can be changed by changing the loadingMessage attribute of the ContentPane.
-The default value of the loadingMessage attribute is "<span class='dijitContentPaneLoading'>${loadingState}</span>" so, you can change the look of the message by applying css to the .dijitContentPaneLoading class.
+The default value of the loadingMessage attribute is "<span class='dijitContentPaneLoading'>${loadingState}</span>",
+so you can change the look of the message by applying CSS to the .dijitContentPaneLoading class.
Callbacks
@@ -113,7 +114,7 @@ Programmatic example
.. code-example ::
- Create an entirely new ContentPane from no DOM, and place in Some node byID:
+ Create an entirely new ContentPane from no DOM, and place inside another node (specified by id):
.. js ::
@@ -123,13 +124,13 @@ Programmatic example
new dijit.layout.ContentPane({
content:"<p>I am initial content</p>",
style:"height:125px"
- }).placeAt("targetIDtoo");
+ }).placeAt("targetID2");
});
</script>
.. html ::
- <div id="targetIDtoo">
+ <div id="targetID2">
A contentPane will appear here:
</div>
@@ -7,12 +7,14 @@ dijit.layout.LinkPane
.. contents ::
:depth: 2
-A simple widget which acts similarly to a :ref:`ContentPane <dijit/layout/ContentPane>` with the subtle difference being the innerHTML of the widget is used as the title, and works exclusively with remote html (by way of a href="" attribute)
+A simple widget which acts similarly to a :ref:`ContentPane <dijit/layout/ContentPane>` with the subtle difference being
+the innerHTML of the widget is used as the title, and works exclusively with remote HTML (by way of a href="" attribute).
Example
=======
-When the parser runs and sees this node, a content pane will be generated with the title "Hello", and the content will be pulled from "foo.html"
+When the parser runs and sees this node, a content pane will be generated with the title "Hello",
+and the content will be pulled from "foo.html"
.. html ::
@@ -40,8 +40,8 @@ Set the current pane
--------------------
StackContainer's current pane can be set via the selectChild() method, or it can be controlled from a StackController.
-StackController is a controller not in the MVC send of the word, but like a TV remote control...
-it's sets which page the StackController is tuned to.
+StackController is a controller not in the MVC send of the word, but like a TV remote control:
+it sets which page the StackController is tuned to.
Retrieving the currently selected Container
-------------------------------------------
@@ -75,7 +75,7 @@ Examples
Programmatic example
--------------------
-Here's an example of a programatically created StackContainer, and associated StackController:
+Here's an example of a programmatically created StackContainer, and associated StackController:
.. code-example ::
@@ -109,7 +109,7 @@ Here's an example of a programatically created StackContainer, and associated St
});
</script>
- The html is very simple
+ The HTML is very simple
.. html ::
@@ -20,7 +20,7 @@ The tabstrip is especially useful when the TabContainer is child of a BorderCont
dojo.require("dijit.layout.TabContainer");
dojo.require("dijit.layout.ContentPane");
- The html is very simple
+ The HTML is very simple
.. html ::
@@ -38,7 +38,7 @@ The tabstrip is especially useful when the TabContainer is child of a BorderCont
The doLayout attribute currently only works for top tabs, left/bottom/right tabs don't support it.
You can set a tab strip on every tab type though.
-Following a few examples with left/bottom/right tabs using tabStrip here and there.
+The following examples show left/bottom/right tabs, some using tabstrips.
Right Tabs
@@ -190,7 +190,7 @@ similar to what the parser does:
tc.startup();
});
- The html is very simple
+ The HTML is very simple
.. html ::
@@ -222,7 +222,7 @@ Remember that although a TabContainer's children are often ContentPanes, they ca
dojo.require("dijit.layout.ContentPane");
</script>
- The html is very simple
+ The HTML is very simple
.. html ::
@@ -253,10 +253,10 @@ Remember that although a TabContainer's children are often ContentPanes, they ca
When you have nested tabs you should set the nested parameter to true, to make the formatting distinctive from the outer TabContainer.
-Nested tabs programatically
-===========================
+Programmatic Nested tabs
+========================
-This an example of nested tabs created programatically.
+This an example of nested tabs created programmatically.
If there is no nested tab in a tab, content pane is inserted instead.
.. code-example ::
@@ -62,7 +62,7 @@ Note that the tabs all have a fixed height.
});
</script>
- The html is very simple
+ The HTML is very simple
.. html::
@@ -90,7 +90,7 @@ Here are some markup examples:
dojo.require("dijit.layout.ContentPane");
</script>
- The html is very simple
+ The HTML is very simple
.. html::
@@ -127,7 +127,7 @@ The second tab is closable.
dojo.require("dijit.layout.ContentPane");
</script>
- The html is very simple
+ The HTML is very simple
.. html::
@@ -201,7 +201,7 @@ true (if programmatically created) or the attribute selected="true" (if declarat
});
</script>
- The html is very simple
+ The HTML is very simple
.. html::
@@ -313,8 +313,10 @@ To monitor when children are added/deleted, use dojo/aspect or dojo.connect:
-It is worth noting: If you need a function to be called *absolutely every* time a child is added to a TabContainer (or StackContainer), you need to listen to the :ref:``setupChild`` function to ensure you are notified of the children already existing in markup.
-This is only relevant if you are subclassing for reason:
+It is worth noting: if you need a function to be called *absolutely every* time a child is added to a TabContainer
+(or StackContainer), you need to listen to the :ref:``setupChild`` function
+to ensure you are notified of the children already existing in markup.
+This is only relevant if you are subclassing, for example:
.. js ::
@@ -34,9 +34,9 @@ layout()
--------
When the widget is started or resized, layout() is called.
-layout()'s job is to arrange the contents of the widget according to it's [new] size.
+layout()'s job is to arrange the contents of the widget according to its [new] size.
For example, BorderContainer will set the size of the center pane to whatever space is left over after placing the top, bottom, left and right panes.
-layout() can (and should) reference this._contentBox to get the size available for laying out it's children.
+layout() can (and should) reference this._contentBox to get the size available for laying out its children.
_setupChild()
-------------
@@ -69,7 +69,7 @@ The lifecycle of layout widgets is particularly complex because they
* do sizing in javascript
* are hierarchical: there's a relationship between parent and children widgets.
-At the time that postCreate() etc is called, the child widgets do not yet exist, and also the widget may not be connected to the document yet, so neither sizing nor parent/child related processing can be done.
+At the time that postCreate() etc. is called, the child widgets do not yet exist, and also the widget may not be connected to the document yet, so neither sizing nor parent/child related processing can be done.
Thus, some/most setup has to occur in startup().
*Lifecycle:*
@@ -81,14 +81,14 @@ Thus, some/most setup has to occur in startup().
5. widget's children are initialized
6. widget.domNode into the document's DOM tree (by the user)
7. user calls startup()
- 8. layout() is called (widget should position it's children correctly, and do other initialization that depends on calls to marginBox() etc here)
+ 8. layout() is called (widget should position its children correctly, and do other initialization that depends on calls to marginBox() etc. here)
See also the lifecycle of a standard widget in :ref:`dijit._Widget <dijit/_Widget>`.
addChild()
----------
-Children can be added to a layout widget before or after it's been started (via the startup() call on it, or an ancestor in it's hierarchy).
+Children can be added to a layout widget before or after its been started (via the startup() call on it, or an ancestor in its hierarchy).
Thus, addChild() and removeChild() must work before or after the widget has been started.
They can reference the this._started field to detect this state.
@@ -100,7 +100,7 @@ Consider SplitContainer's lifecycle:
3. up to this point no sizing processing has been done
4. SplitContainer domNode is added to the document
5. startup() is called
- 6. SplitContainer sizes all it's children, to fit in the available space.
+ 6. SplitContainer sizes all its children, to fit in the available space.
Note that split container only did sizing once, thus avoiding an n^2 computation that would occur if it processed the initial children one by one, recalculating sizes each time.
View
@@ -12,7 +12,7 @@ Themes and Theming
Dijit Themes lend a consistent look and feel to widgets.
Themes are collections of images (icons and background images) and CSS files
-that bring a common visual style (font, color, texture, layout, animation, etc) to all the widgets.
+that bring a common visual style (font, color, texture, layout, animation, etc.) to all the widgets.
Dijit comes bundled with four themes which can be used as is, modified, and users can write their own themes too.
Both global theming (such as at a container level) and widget-specific theming is doable.
@@ -584,9 +584,9 @@ Typical images in themes are icons, background images, and accent graphics.
Dojo 1.5 supports:
- - 8–bit and 24-bit PNG and GIFs(exception for loading animation)
- - ‘Sprite’image (contains all images for one widget) e.g. dijit.Editor. Sprite images can be vertical or horizontal sprites help improve overall Dojo performance, however there is no header in the sprite file to label the list of images in the sprite file.
- - Specific ‘/images’folders (forms/images, layout/images; etc)
+ - 8–bit and 24-bit PNG and GIFs (exception for loading animation)
+ - ‘Sprite’ image (contains all images for one widget) e.g. dijit.Editor. Sprite images can be vertical or horizontal sprites help improve overall Dojo performance, however there is no header in the sprite file to label the list of images in the sprite file.
+ - Specific ‘/images’folders (forms/images, layout/images, etc.)
See *Common and theme-specific images* above.
@@ -670,7 +670,7 @@ Sample of CSS3 animation styling in .claro .dijitAccordionInnerContainer {
margin-bottom:1px;
-webkit-transition-property:background-color,border; /* "property" describes what styling you want to animate */
-webkit-transition-duration:.3s; /* "duration" describes the timing of your animation */
- -webkit-transition-timing-function:linear; /* "timing-function" allow an animation to change speed over its duration (ease-in, ease-out, etc) */
+ -webkit-transition-timing-function:linear; /* "timing-function" allow an animation to change speed over its duration (ease-in, ease-out, etc.) */
}
View
@@ -138,7 +138,7 @@ Introduced in Dojo 1.6, the dojo.store.JsonRest is a good an efficient implement
The :ref:`dojo.store.JsonRest <dojo/store/JsonRest>` defaults to assuming the identifier property of each element is ``id``, therefore if your provider returns an elements identifier in that field, most developers simply need to specify the target URI for the collection.
-An example of programatically creating a full featured store would be:
+An example of programmatically creating a full featured store would be:
.. js ::

0 comments on commit cdc3917

Please sign in to comment.