Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

regex change of level 1 headers to ====\nTEXT\n==== and level 2 heade…

…rs to TEXT\n====
  • Loading branch information...
commit f89feb8236f14bcdc8483074d6cc516e39c3bbbb 1 parent b9aa5c8
@wkeese wkeese authored
Showing with 342 additions and 1,057 deletions.
  1. +1 −5 build/buildScript.rst
  2. +9 −21 build/buildSystem.rst
  3. +1 −8 build/customBase.rst
  4. +1 −2  build/directoryLayout.rst
  5. +1 −6 build/exclude.rst
  6. +1 −2  build/expand-provide.rst
  7. +1 −3 build/index.rst
  8. +1 −3 build/keepRequires.rst
  9. +1 −8 build/localizationExample.rst
  10. +1 −18 build/profileQRef.rst
  11. +1 −7 build/profiles.rst
  12. +0 −19 build/qref.rst
  13. +1 −0  build/scenario-base.rst
  14. +1 −0  build/scenario-micro.rst
  15. +1 −0  build/scenario-release.rst
  16. +1 −0  build/scenario-xDomain.rst
  17. +1 −4 build/simpleExample.rst
  18. +1 −4 build/transforms/copy.rst
  19. +1 −4 build/transforms/depsDump.rst
  20. +1 −4 build/transforms/depsScan.rst
  21. +1 −4 build/transforms/dojoPragmas.rst
  22. +1 −4 build/transforms/hasFindAll.rst
  23. +1 −4 build/transforms/hasFixup.rst
  24. +1 −4 build/transforms/write.rst
  25. +1 −4 build/transforms/writeAmd.rst
  26. +1 −4 build/transforms/writeDojo.rst
  27. +1 −4 build/transforms/writeOptimized.rst
  28. +1 −0  build/webkit-mobile.rst
  29. +1 −1  build/xDomain.rst
  30. +1 −3 developer/a11y-requirements.rst
  31. +1 −6 developer/bugs.rst
  32. +1 −2  developer/contributors.rst
  33. +1 −0  developer/index.rst
  34. +1 −0  developer/projects.rst
  35. +1 −5 developer/rules.rst
  36. +1 −8 developer/styleguide.rst
  37. +1 −8 developer/svn.rst
  38. +2 −6 dijit/Calendar.rst
  39. +1 −2  dijit/CalendarLite.rst
  40. +1 −2  dijit/CheckedMenuItem.rst
  41. +2 −6 dijit/ColorPalette.rst
  42. +1 −3 dijit/Declaration.rst
  43. +1 −2  dijit/Dialog.rst
  44. +3 −12 dijit/Editor.rst
  45. +2 −8 dijit/InlineEditBox.rst
  46. +2 −6 dijit/Menu.rst
  47. +2 −6 dijit/MenuBar.rst
  48. +1 −2  dijit/MenuBarItem.rst
  49. +1 −2  dijit/MenuItem.rst
  50. +1 −2  dijit/ProgressBar.rst
  51. +3 −8 dijit/TitlePane.rst
  52. +3 −9 dijit/Toolbar.rst
  53. +2 −8 dijit/Tooltip.rst
  54. +2 −5 dijit/TooltipDialog.rst
  55. +1 −0  dijit/Tree-examples.rst
  56. +2 −14 dijit/Tree.rst
  57. +1 −4 dijit/WidgetSet.rst
  58. +1 −3 dijit/_CssStateMixin.rst
  59. +1 −2  dijit/_FocusMixin.rst
  60. +1 −4 dijit/_HasDropDown.rst
  61. +1 −1  dijit/_OnDijitClickMixin.rst
  62. +1 −2  dijit/_Templated.rst
  63. +1 −5 dijit/_TemplatedMixin.rst
  64. +1 −0  dijit/_Widget.rst
  65. +1 −3 dijit/_WidgetsInTemplateMixin.rst
  66. +1 −2  dijit/_editor/plugins.rst
  67. +1 −5 dijit/_editor/plugins/FontChoice.rst
  68. +1 −7 dijit/_editor/plugins/FullScreen.rst
  69. +1 −6 dijit/_editor/plugins/LinkDialog.rst
  70. +1 −4 dijit/_editor/plugins/NewPage.rst
  71. +1 −4 dijit/_editor/plugins/Print.rst
  72. +1 −4 dijit/_editor/plugins/TextColor.rst
  73. +1 −5 dijit/_editor/plugins/ToggleDir.rst
  74. +1 −8 dijit/_editor/plugins/ViewSource.rst
  75. +1 −1  dijit/a11y/index.rst
  76. +1 −0  dijit/a11y/resources.rst
  77. +1 −5 dijit/a11y/statement.rst
  78. +1 −0  dijit/a11y/strategy.rst
  79. +1 −3 dijit/focus.rst
  80. +1 −6 dijit/form.rst
  81. +2 −6 dijit/form/Button.rst
  82. +1 −3 dijit/form/CheckBox.rst
  83. +1 −3 dijit/form/ComboBox.rst
  84. +2 −4 dijit/form/ComboButton.rst
  85. +1 −3 dijit/form/CurrencyTextBox.rst
  86. +1 −1  dijit/form/DataList.rst
  87. +1 −3 dijit/form/DateTextBox.rst
  88. +2 −4 dijit/form/DropDownButton.rst
  89. +1 −4 dijit/form/FilteringSelect.rst
  90. +1 −2  dijit/form/Form.rst
  91. +1 −0  dijit/form/HorizontalRuleLabels.rst
  92. +1 −0  dijit/form/HorizontalSlider.rst
  93. +1 −1  dijit/form/MappedTextBox.rst
  94. +1 −3 dijit/form/MultiSelect.rst
  95. +1 −3 dijit/form/NumberSpinner.rst
  96. +1 −3 dijit/form/NumberTextBox.rst
  97. +1 −3 dijit/form/RadioButton.rst
  98. +1 −1  dijit/form/RangeBoundTextBox.rst
  99. +1 −4 dijit/form/Select.rst
  100. +1 −2  dijit/form/SimpleTextarea.rst
  101. +2 −6 dijit/form/Slider.rst
  102. +1 −3 dijit/form/TextBox.rst
  103. +1 −3 dijit/form/Textarea.rst
  104. +1 −4 dijit/form/TimeTextBox.rst
  105. +1 −2  dijit/form/ToggleButton.rst
  106. +2 −7 dijit/form/ValidationTextBox.rst
  107. +1 −0  dijit/form/VerticalRuleLabels.rst
  108. +1 −0  dijit/form/VerticalSlider.rst
  109. +1 −2  dijit/form/_FormSelectWidget.rst
  110. +1 −0  dijit/form/_FormValueWidget.rst
  111. +1 −2  dijit/form/_FormWidget.rst
  112. +1 −8 dijit/info.rst
  113. +1 −7 dijit/layout.rst
  114. +2 −5 dijit/layout/AccordionContainer.rst
  115. +2 −5 dijit/layout/BorderContainer.rst
  116. +1 −3 dijit/layout/ContentPane.rst
  117. +2 −6 dijit/layout/StackContainer.rst
  118. +2 −6 dijit/layout/TabContainer.rst
  119. +1 −3 dijit/layout/_LayoutWidget.rst
  120. +1 −3 dijit/place.rst
  121. +1 −7 dijit/popup.rst
  122. +1 −3 dijit/registry.rst
  123. +1 −9 dijit/themes.rst
  124. +1 −0  dijit/tree/ForestStoreModel.rst
  125. +1 −0  dijit/tree/Model.rst
  126. +1 −0  dijit/tree/TreeStoreModel.rst
  127. +1 −2  dijit/typematic.rst
  128. +1 −2  dojo/Color.rst
  129. +1 −5 dojo/Deferred.rst
  130. +1 −0  dojo/DeferredList.rst
  131. +1 −2  dojo/Evented.rst
  132. +1 −5 dojo/NodeList-data.rst
  133. +1 −0  dojo/NodeList-dom.rst
  134. +1 −4 dojo/NodeList-manipulate.rst
  135. +1 −3 dojo/NodeList-traverse.rst
  136. +1 −6 dojo/NodeList.rst
  137. +1 −4 dojo/NodeList/attr.rst
  138. +1 −4 dojo/NodeList/removeAttr.rst
  139. +1 −5 dojo/Stateful.rst
  140. +1 −0  dojo/Url.rst
  141. +1 −3 dojo/_base/Color.rst
  142. +1 −1  dojo/_base/Deferred.rst
  143. +1 −1  dojo/_base/NodeList.rst
  144. +1 −1  dojo/_base/connect.rst
  145. +1 −1  dojo/_base/declare.rst
  146. +1 −2  dojo/_base/fx.rst
  147. +1 −2  dojo/_base/html.rst
  148. +1 −1  dojo/_base/json.rst
  149. +1 −2  dojo/_base/lang.rst
  150. +1 −1  dojo/_base/query.rst
  151. +1 −1  dojo/_base/window.rst
  152. +1 −3 dojo/addClass.rst
  153. +1 −2  dojo/addOnLoad.rst
  154. +1 −4 dojo/addOnUnload.rst
  155. +1 −2  dojo/addOnWindowUnload.rst
  156. +2 −6 dojo/anim.rst
  157. +1 −3 dojo/animateProperty.rst
  158. +1 −1  dojo/aspect.rst
  159. +1 −4 dojo/attr.rst
  160. +1 −2  dojo/back.rst
  161. +1 −0  dojo/base.rst
  162. +1 −1  dojo/base/loader.rst
  163. +1 −3 dojo/behavior.rst
  164. +1 −2  dojo/body.rst
  165. +1 −0  dojo/browser.rst
  166. +1 −2  dojo/byId.rst
  167. +2 −6 dojo/cache.rst
  168. +1 −4 dojo/cldr.rst
  169. +1 −1  dojo/clone.rst
  170. +1 −3 dojo/config.rst
  171. +2 −7 dojo/connect.rst
  172. +1 −2  dojo/connectPublisher.rst
  173. +1 −3 dojo/contentHandlers.rst
  174. +2 −4 dojo/cookie.rst
  175. +1 −4 dojo/coords.rst
  176. +2 −7 dojo/create.rst
  177. +1 −3 dojo/currency.rst
  178. +1 −3 dojo/data.rst
  179. +1 −11 dojo/data/ItemFileReadStore.rst
  180. +1 −8 dojo/data/ItemFileWriteStore.rst
  181. +1 −3 dojo/data/ObjectStore.rst
  182. +1 −2  dojo/data/api/Read.rst
  183. +1 −3 dojo/date.rst
  184. +1 −3 dojo/date/locale.rst
  185. +1 −4 dojo/date/locale/format.rst
  186. +1 −4 dojo/date/locale/parse.rst
  187. +1 −3 dojo/date/stamp.rst
  188. +2 −9 dojo/declare.rst
  189. +2 −5 dojo/delegate.rst
  190. +1 −0  dojo/deprecated.rst
  191. +3 −8 dojo/destroy.rst
  192. +1 −2  dojo/disconnect.rst
  193. +1 −11 dojo/dnd.rst
  194. +1 −4 dojo/dnd/Moveable.rst
  195. +1 −4 dojo/doc.rst
  196. +1 −2  dojo/domReady.rst
  197. +3 −8 dojo/empty.rst
  198. +1 −2  dojo/eval.rst
  199. +1 −1  dojo/every.rst
  200. +1 −3 dojo/exists.rst
  201. +1 −2  dojo/extend.rst
  202. +1 −4 dojo/fadeIn.rst
  203. +1 −4 dojo/fadeOut.rst
  204. +1 −4 dojo/fieldToObject.rst
  205. +1 −1  dojo/filter.rst
  206. +1 −4 dojo/formToJson.rst
  207. +1 −4 dojo/formToObject.rst
  208. +1 −4 dojo/formToQuery.rst
  209. +1 −3 dojo/fromJson.rst
  210. +1 −2  dojo/fx.rst
  211. +1 −3 dojo/fx/Toggler.rst
  212. +1 −3 dojo/fx/easing.rst
  213. +1 −4 dojo/fx/slideTo.rst
  214. +1 −0  dojo/fx/wipeIn-examples.rst
  215. +1 −4 dojo/fx/wipeIn.rst
  216. +1 −4 dojo/fx/wipeOut.rst
  217. +1 −0  dojo/gears.rst
  218. +1 −4 dojo/getAttr.rst
  219. +1 −4 dojo/getComputedStyle.rst
  220. +1 −2  dojo/getContentBox.rst
  221. +1 −2  dojo/getMarginBox.rst
  222. +1 −4 dojo/getNodeProp.rst
  223. +1 −2  dojo/getObject.rst
  224. +1 −4 dojo/getProp.rst
  225. +1 −4 dojo/getStyle.rst
  226. +1 −3 dojo/global.rst
  227. +1 −4 dojo/hasAttr.rst
  228. +1 −2  dojo/hasClass.rst
  229. +1 −0  dojo/hitch.rst
  230. +1 −2  dojo/i18n.rst
  231. +1 −4 dojo/index.rst
  232. +1 −0  dojo/indexOf.rst
  233. +0 −1  dojo/io-query.rst
  234. +1 −0  dojo/io.rst
  235. +1 −4 dojo/io/iframe.rst
  236. +1 −5 dojo/io/script.rst
  237. +1 −3 dojo/ioPipelineTopics.rst
  238. +1 −3 dojo/isAlien.rst
  239. +1 −5 dojo/isArray.rst
  240. +1 −3 dojo/isArrayLike.rst
  241. +1 −3 dojo/isFunction.rst
  242. +1 −3 dojo/isString.rst
  243. +1 −2  dojo/json.rst
  244. +1 −0  dojo/lastIndexOf.rst
  245. +1 −3 dojo/locale.rst
  246. +1 −3 dojo/map.rst
  247. +1 −4 dojo/marginBox.rst
  248. +1 −5 dojo/mixin.rst
  249. +1 −2  dojo/moduleUrl.rst
  250. +1 −3 dojo/mouse.rst
  251. +1 −0  dojo/node.rst
  252. +1 −4 dojo/number.rst
  253. +1 −4 dojo/objectToQuery.rst
  254. +1 −2  dojo/on.rst
  255. +1 −9 dojo/parser.rst
  256. +1 −1  dojo/partial.rst
  257. +1 −5 dojo/place.rst
  258. +1 −4 dojo/position.rst
  259. +1 −4 dojo/prop.rst
  260. +1 −3 dojo/provide.rst
  261. +1 −3 dojo/publish.rst
  262. +1 −2  dojo/query.rst
  263. +1 −4 dojo/queryToObject.rst
  264. +1 −1  dojo/rawXhrPost.rst
  265. +1 −1  dojo/rawXhrPut.rst
  266. +1 −1  dojo/ready.rst
  267. +1 −4 dojo/registerModulePath.rst
  268. +1 −4 dojo/removeAttr.rst
  269. +1 −4 dojo/removeClass.rst
  270. +1 −3 dojo/replace.rst
  271. +1 −4 dojo/replaceClass.rst
  272. +1 −4 dojo/require.rst
  273. +1 −3 dojo/requireLocalization.rst
  274. +0 −1  dojo/robot.rst
  275. +0 −1  dojo/robotx.rst
  276. +1 −2  dojo/rpc.rst
  277. +1 −4 dojo/rpc/JsonService.rst
  278. +1 −4 dojo/rpc/JsonpService.rst
  279. +3 −9 dojo/rpc/RpcService.rst
  280. +1 −2  dojo/safeMixin.rst
  281. +1 −4 dojo/setAttr.rst
  282. +1 −2  dojo/setContentSize.rst
  283. +1 −3 dojo/setContext.rst
  284. +1 −2  dojo/setMarginBox.rst
  285. +1 −3 dojo/setObject.rst
  286. +1 −4 dojo/setProp.rst
  287. +1 −4 dojo/setStyle.rst
  288. +1 −1  dojo/some.rst
  289. +1 −1  dojo/stopEvent.rst
  290. +4 −12 dojo/store.rst
  291. +1 −3 dojo/store/Cache.rst
  292. +1 −2  dojo/store/DataStore.rst
  293. +1 −7 dojo/store/JsonRest.rst
  294. +1 −3 dojo/store/Memory.rst
  295. +0 −2  dojo/store/Observable.rst
  296. +1 −1  dojo/string.rst
  297. +1 −0  dojo/string/trim.rst
  298. +1 −5 dojo/style.rst
  299. +1 −2  dojo/subscribe.rst
  300. +1 −3 dojo/toJson.rst
Sorry, we could not display the entire diff because too many files (741) changed.
View
6 build/buildScript.rst
@@ -1,7 +1,6 @@
.. _build/buildScript:
-build system build script (build.sh or build.bat)
-=================================================
+=================================================build system build script (build.sh or build.bat)=================================================
:Status: Draft
:Version: 1.0
@@ -11,7 +10,6 @@ build system build script (build.sh or build.bat)
.. contents::
:depth: 2
-============
Introduction
============
@@ -23,7 +21,6 @@ The ``build.sh`` (unix) or ``build.bat`` (Windows) script located in the Dojo so
* Any of the following parameters can be set directly in the profile file as part of the overall `dependencies` Object
-=====
Usage
=====
@@ -145,7 +142,6 @@ xdDojoScopeName=dojo
buildLayers=
A comma-separated list of layer names to build. Using this option means that only those layers will be built. This helps if you are doing quick development and test cycles with layers. If you have problems using this option, try removing it and doing a full build with action=clean,release. This build option assumes you have done at least one full build first.
-========
Examples
========
View
30 build/buildSystem.rst
@@ -1,7 +1,6 @@
.. _build/buildSystem:
-The Dojo Build System
-=====================
+=====================The Dojo Build System=====================
:Status: Draft
:Version: 1.7+
@@ -15,9 +14,8 @@ version 1.7 is available* :ref:`here <build/pre17/build>`.
*See* :ref:`The Dojo Build System <build/index>` *for a complete list of build system documentation resources.*
-============
-Introduction
-============
+Command Line Switches
+=====================
The Dojo build system is a general-purpose program for transforming a set of resources. It was built to solve the
problem of transforming a set of resources that comprise an application in order to improve the performance of that
@@ -48,9 +46,8 @@ processes can be executed as well.
This document describes using the build system for deployment optimizations. See xxx for information about writing your
own custom transforms and configuring the build system for other uses.
-========
-Overview
-========
+Command Line Switches
+=====================
The design of the system is simple. It "discovers" a set of resources and then applies a synchronized, ordered set of
resource-dependent transforms to those resources. Both the discovery process and the transforms are controlled by a
@@ -105,9 +102,8 @@ These are discussed in separate documents as follows:
* For a description of backward compatibility features see :ref:`Processing Legacy Build Profiles <build/legacyBackCompat>`.
-========================
-Assumptions for Examples
-========================
+Command Line Switches
+=====================
This document contains several examples. It assumes the source distribution of the Dojo Toolkit, version 1.7 or greater,
is installed at ~/dev/dtk/. If you are a Windows user, "~" is shorthand for the user's home directory; substitute
@@ -118,9 +114,8 @@ Unless specifically stated otherwise, all examples assume the current working di
~/dev/dtk/util/buildscripts. As we'll see, this is not a requirement of the the build system, both rather a convenience
so you don't have to path to the build system executable.
-=========================
-Invoking the Build System
-=========================
+Command Line Switches
+=====================
The build system is a Javascript program comprised of a set of AMD modules that may be executed by node.js or Rhino. The
program is distributed with the source version of the Dojo Toolkit. The source tree resides at util/build/. Dojo can be
@@ -173,7 +168,6 @@ Although the legacy build system could be executed when /util/buildscripts/ was
do so required a carefully constructed profile. Indeed, many profiles provided with Dojo source distributions won't work
unless /util/buildscripts/ is the current working directory. The current build system has no such restriction.
-=====================
Command Line Switches
=====================
@@ -234,7 +228,6 @@ understanding and debugging how a particular build system invocation is consumin
This example points out that number, true, false, and null values are not stored as strings but rather are converted to
Javascript numbers, booleans, and null.
-==============
Profile Basics
==============
@@ -447,7 +440,6 @@ represents. Also notice that the property :ref:``selfFilename`` is set the the a
resides and is added to the package.Json object. This gives the reference path for any relative paths found in the
package.json object, the ``directories.lib`` path in particular.
-====================
Specifying Resources
====================
@@ -889,7 +881,6 @@ Don't be concerned about the need to download an extra resource to configure the
the writeDojo transform allows a customized configuration to be embedded in the loader resource and the replacements
transform allows chunks of resources, like the configuration script element, to be replaced--perhaps with nothing.
-=============
Resource Tags
=============
@@ -917,7 +908,6 @@ tags:
``miniExclude``
The resource should not be copied to the destination if the profile property "mini" is truthy.
-==========
Transforms
==========
@@ -956,7 +946,6 @@ for complete documentation.
* :ref:`writeOptimized <build/transforms/writeOptimized>`: Processes a resource with shrinksafe or the closure compiler and writes the result to the file system.
-===================
Applying Transforms
===================
@@ -1047,7 +1036,6 @@ below, in the order listed. The first test that passes indicates the transforms
* Copy resource from source location to destination location (copy).
-===========================================
Command Line and Profile Property Reference
===========================================
View
9 build/customBase.rst
@@ -1,7 +1,6 @@
.. _build/customBase:
-build customBase
-================
+================build customBase================
:Author: Scott Jenkins
:Project owner: ?
@@ -13,7 +12,6 @@ build customBase
Custom base is used to make an extremely small file size version of dojo.js.
-============
Introduction
============
@@ -24,7 +22,6 @@ However, in some cases, such as creating web applications intended for use on sm
This is a very advanced feature, and if you think you need to use it, you should think carefully first. If after careful consideration, you still want to use this feature, be very, very careful and document it thoroughly for your own understanding.
-===============================
dojo.require for base functions
===============================
@@ -35,7 +32,6 @@ Instead, a ``dojo.require`` statement is generated for each base resource that t
This allows you to still use the entire base API, but at the cost of additional an additional round trip to the server *at the time a function not in base is first called*.
-=====
Usage
=====
@@ -70,7 +66,6 @@ You just end up with the following from ``dojo/_base/_loader``, basically, just
* ``loader.js``
-============================
Including Specific Resources
============================
@@ -92,7 +87,6 @@ look like this:
}
-===================
Caveats
===================
@@ -113,7 +107,6 @@ finds "indexOf" in the module, it will add in a
have been a String method call.
-================
Known Bugs
================
View
3  build/directoryLayout.rst
@@ -1,5 +1,6 @@
.. _build/directoryLayout:
+==================================
Sample Directory Layout for Builds
==================================
@@ -14,7 +15,6 @@ Sample Directory Layout for Builds
This document summarizes an effective layout for managing Dojo directories for the build process.
-============
Introduction
============
@@ -28,7 +28,6 @@ This directory layout (which is used in each of the scenario examples) facilitat
2. No additional build files are mixed into any private namespace directory trees.
3. The build files (profiles and other support files) do not need to be moved into new specific directories each time a new version of Dojo is released, or a new version of a custom namespace is created.
-================
Directory Layout
================
View
7 build/exclude.rst
@@ -1,5 +1,6 @@
.. _build/exclude:
+==========================================
Dojo build system: conditional exclusions
==========================================
@@ -12,7 +13,6 @@ Dojo build system: conditional exclusions
:depth: 3
-============
Introduction
============
@@ -24,7 +24,6 @@ This is somewhat analogous to the use of ``#ifdef`` pragmas within the C pre-pro
For example, you might wish to strip a profiling module from a release build but include it in a development build.
-======
Syntax
======
@@ -55,7 +54,6 @@ where
Note: the tag for the excludeStart pragma must be equal to the tag for the excludeEnd pragma.
-=========
Condition
=========
@@ -65,13 +63,11 @@ This parameter is actually JavaScript code which is evaluated by the builder at
The object you most commonly will evaluate against is ``kwArgs`` which is where the builder stores its profile (it actually stores all of its parameters there, whether they originate in the profile, on the build command line, or from the builders' built in defaults).
-===============
Builder Objects
===============
TODOC: Document builder objects of interest
-============================
Nesting conditional excludes
============================
@@ -94,7 +90,6 @@ If you do nest, the exclusion regions must be fully and properly nested. Thus,
because the named regions overlap.
-========
See also
========
View
3  build/expand-provide.rst
@@ -1,5 +1,6 @@
.. _build/expand-provide:
+============================
Expanding dojo.provide calls
============================
@@ -12,13 +13,11 @@ Expanding dojo.provide calls
Expands dojo.provide calls with faster calls at the expense of a larger file size in built layers.
-============
Introduction
============
The Dojo Build provides a mechanism for expanding :ref:`dojo.provide <dojo/provide>` calls within your code into faster javascript equivalents, avoiding expensive lookups through :ref:`dojo.getObject <dojo/getObject>` when it is otherwise safe to assume. This is a simple toggle on a build command line or profile called "expandProvide", and defaults to 'false'.
-=====
Usage
=====
View
4 build/index.rst
@@ -1,5 +1,6 @@
.. _build/index:
+=====================
The Dojo Build System
=====================
@@ -7,7 +8,6 @@ The Dojo Build System
:Version: 1.7+
:Author: Rawld Gill
-=====================
The Dojo Build System
=====================
@@ -33,7 +33,6 @@ All historical documentation for that system is listed at
:ref:`Quick Reference for Optimization Build Program <build/qref>`
A quick reference manual for all build system switches and knobs.
-==================================
Deployment Optimization Transforms
==================================
@@ -88,7 +87,6 @@ for complete documentation.
:ref:`writeOptimized <build/transforms/writeOptimized>`
Processes a resource with shrinksafe or the closure compiler and writes the result to the file system.
-==========================================
The Dojo Build System Prior to version 1.7
==========================================
View
4 build/keepRequires.rst
@@ -1,5 +1,6 @@
.. _build/keepRequires:
+==================================
Dojo build system: keepRequires
==================================
@@ -11,7 +12,6 @@ Dojo build system: keepRequires
.. contents::
:depth: 3
-============
Introduction
============
@@ -37,7 +37,6 @@ However, the penalty for doing so is that the module would be downloaded at runt
Note: The builder uses a regular expression to locate ``dojo.require`` statements within the code it is building. If you specify dojo require using the notation ``dojo["require"]("module name")``, the builder will not try to include that resource, which has the same affect as excluding it your build file via the layer's ``keepRequires`` property. This technique is obscure and inelegant and may not be obvious later, so use it with caution.
-======
Syntax
======
@@ -45,7 +44,6 @@ Syntax
TODOC: Make an example profile, but people who would use this feature shouldn't need !
-========
See also
========
View
9 build/localizationExample.rst
@@ -1,5 +1,6 @@
.. _build/localizationExample:
+=======================
Localized Build Example
=======================
@@ -11,7 +12,6 @@ Localized Build Example
This page attempts to describe how to include localized strings bundles in your custom build.
-============
Introduction
============
@@ -27,7 +27,6 @@ There are several pages of existing documentation that describe the background a
Here we provide a practical walkthrough of applying localisation to actual dijits and an actual build profile.
-======================================================
Starting Point - A Simple Test Dijit And Build Profile
======================================================
@@ -73,7 +72,6 @@ The build will also produce a localized strings bundle for the "testdijits.js" l
A 'real world' build will contain many dijits (testdijits.Foo, testdijits.Bar, testdijits.App etc.), each with their own strings bundle. Our aim is to make those individual strings bundles build to a single file for efficient download to the client at runtime, rather than a single network request per file.
-=======================
Adding A Strings Bundle
=======================
@@ -178,7 +176,6 @@ An important distinction to make here is that the original source of yours (slig
When you come to actually use your compiled layer, you'll be using the files from ``dojo/testdijits.js`` and ``dojo/nls/testdijits_*.js``, _not_ the copy of your original code, in ``testdijits/*``.
-==============================================
Optimising Performance - Using the Built Layer
==============================================
@@ -241,7 +238,6 @@ Important points to note here:
* ``test/dojo/testdijits.js`` contains the javascript implementation and inlined templates of all dijits mentioned in the profile .js file for that layer.
* ``test/dojo/nls/testdijits_en-us.js`` contains the strings bundles for all those dijits.
-================================================
The Build Bakes Available Locales Into Your Code
================================================
@@ -273,7 +269,6 @@ When you simply include a ``fr`` localized strings bundle in your source directo
You don't need to change any code for this to happen. If fact it you create a directory called ``pumpkins``, the requireLocalization call will then tell dojo that there is a ``pumpkins`` locale available. This is how the loader knows to directly fetch ``test/testdijits/nls/fr/Foo.js`` when you specify a locale of ``fr``, and the base resource ``test/testdijits/nls/Foo.js`` when any other locale is requested.
-=========================
Providing Other Languages
=========================
@@ -331,7 +326,6 @@ If you visit the page with no ``locale`` specified in the djConfig, and a browse
then dojo will automatically serve the page with the ``fr`` string resources, and the dijits will automatically appear correctly to the user.
-================
Trees of Locales
================
@@ -377,7 +371,6 @@ The important points here are:
- The ``fr`` bundle contains the FRENCH version of ``test``.
- The ``fr-fr`` bundle contains both ``test`` and ``fr_fr_test``.
-======================
Multiple Custom Dijits
======================
View
19 build/profileQRef.rst
@@ -1,5 +1,6 @@
.. _build/profileQRef:
+========================================================================
Quick Reference of all Profile Properties for Optimization Build Program
========================================================================
@@ -7,7 +8,6 @@ Quick Reference of all Profile Properties for Optimization Build Program
:Author: Rawld Gill
-==============================
Command Line Switch Reference
==============================
@@ -43,7 +43,6 @@ specify the switch.
written, a mistake in a profile could result in cleaning your hard drive. We'll let you do that yourself with the
rm/rmdir commands. (We also note that deleting file trees is not the typical function of a compiler program).
-============================
Discovery Profile Properties
============================
@@ -84,7 +83,6 @@ mini
If truthy ignore all resources tagged as excludeMini; if copyTests is falsy or missing, also ignore all resources
tagged as tests.
-===============
Transform: copy
===============
@@ -92,7 +90,6 @@ Transform: copy
None.
-===================
Transform: depsDump
===================
@@ -114,7 +111,6 @@ Transform: depsDump
dependency trees will be included in the output)
* [*falsy*] all modules are included
-===================
Transform: depsScan
===================
@@ -155,7 +151,6 @@ Transform: depsScan
**Warning**: All knobs mentioned above support legacy features which are deprecated. It is strongly encouraged to convert
legacy modules to properly-expressed AMD modules.
-======================
Transform: dojoPragmas
======================
@@ -164,7 +159,6 @@ Transform: dojoPragmas
The entire profile object is placed in the lexical variable ``kwargs`` when thea condition associated with the pragmas
``includeStart`` and ``excludeEnd`` is evaluated. Any property in the profile may be used to affect these conditions.
-=====================
Transform: dojoReport
=====================
@@ -172,7 +166,6 @@ Transform: dojoReport
This section not complete; please consult source at util/build/transforms/dojoReport.js
-=====================
Transform: hasFindAll
=====================
@@ -183,7 +176,6 @@ Transform: hasFindAll
* [*falsy*] No has location report is written.
-===================
Transform: hasFixup
===================
@@ -196,7 +188,6 @@ Transform: hasFixup
``staticHasFeatures`` maps may be provided from multiple profile resources. If more than one ``staticHasFeatures``
property value is provided, then they are mixed on a per-has-feature basis in the order they appear on the command line.
-========================
Transform: insertSymbols
========================
@@ -204,7 +195,6 @@ Transform: insertSymbols
This section not complete; please consult source at util/build/transforms/insertSymbols.js
-======================
Transform: optimizeCss
======================
@@ -212,7 +202,6 @@ Transform: optimizeCss
This section not complete; please consult source at util/build/transforms/optimizeCss.js
-===============
Transform: read
===============
@@ -220,7 +209,6 @@ Transform: read
This section not complete; please consult source at util/build/transforms/read.js
-================
Transform: write
================
@@ -228,7 +216,6 @@ Transform: write
None.
-===================
Transform: writeAmd
===================
@@ -271,7 +258,6 @@ Layer items are Javascript objects with the following properties
layer item. If a string that does not give an existing filename, the string it interpreted as an explicit copyright
message. If no string value is given, then no copyright text is output.
-====================
Transform: writeDojo
====================
@@ -308,7 +294,6 @@ Transform: writeDojo
boot:true
}
-=========================
Transform: writeOptimized
=========================
@@ -369,13 +354,11 @@ Transform: writeOptimized
* ["all"] All console applications are stripped.
-=============================
Deprecated Profile Properties
=============================
The action clean is no longer supported. Use ``rm`` on Unix/Linux/OS X or ``rmdir`` on Windows.
-==========================
Removed Profile Properties
==========================
View
8 build/profiles.rst
@@ -1,5 +1,6 @@
.. _build/profiles:
+==============
build profiles
==============
@@ -13,7 +14,6 @@ build profiles
The build profile is a simple JavaScript file containing an object which provides the parameters driving the build.
-============
Introduction
============
@@ -23,13 +23,11 @@ The builder automatically appends ``.profile.js`` to the name of the profile spe
Note: throughout the various options described below, file system paths are often specified. Even on Windows based hosts, use forward slashes (akin to Unix) as directory separators, instead of the Windows native backslash.
-==============
Empty Profiles
==============
If you specify an empty profile containing no ``dependencies`` object (such as the ``base.profile.js`` file shipped with the Dojo distribution), all defaults will be applied to the build. In this case, the builder will create a single layer, ``dojo.js``, which contains only Dojo Base. All other resources will be loaded from the distribution on demand via ``dojo.require``.
-===================
Dependencies Object
===================
@@ -55,7 +53,6 @@ layers
prefixes
Optional. An array of individual prefix objects, describing where relative to the source directory tree, a particular top-level module's source is found.
-======
Layers
======
@@ -128,7 +125,6 @@ customBase
See the :ref:`customBase detailed description <build/customBase>`.
-========
Prefixes
========
@@ -169,7 +165,6 @@ This permits you to build into your distribution private namespace resources whi
-========
Examples
========
@@ -184,7 +179,6 @@ Declarative example
TODO: example
-========
See also
========
View
19 build/qref.rst
@@ -7,7 +7,6 @@ Quick Reference for Optimization Build Program
:Version: 1.7
:Author: Rawld Gill
-=======================
Reference Documentation
=======================
@@ -16,7 +15,6 @@ Reference Documentation
* :ref:`Build Document Catalog <build/index>`: A complete list of build system documentation resources.
-==============================
Command Line Switch Reference
==============================
@@ -77,7 +75,6 @@ specify the switch.
written, a mistake in a profile could result in cleaning your hard drive. We'll let you do that yourself with the
rm/rmdir commands. (We also note that deleting file trees is not the typical function of a compiler program).
-============================
Discovery Profile Properties
============================
@@ -118,7 +115,6 @@ mini
If truthy ignore all resources tagged as excludeMini; if copyTests is falsy or missing, also ignore all resources
tagged as tests.
-===============
Transform: copy
===============
@@ -126,7 +122,6 @@ Transform: copy
None.
-===================
Transform: depsDump
===================
@@ -148,7 +143,6 @@ Transform: depsDump
dependency trees will be included in the output)
* [*falsy*] all modules are included
-===================
Transform: depsScan
===================
@@ -189,7 +183,6 @@ Transform: depsScan
**Warning**: All knobs mentioned above support legacy features which are deprecated. It is strongly encouraged to convert
legacy modules to properly-expressed AMD modules.
-======================
Transform: dojoPragmas
======================
@@ -198,7 +191,6 @@ Transform: dojoPragmas
The entire profile object is placed in the lexical variable ``kwargs`` when thea condition associated with the pragmas
``includeStart`` and ``excludeEnd`` is evaluated. Any property in the profile may be used to affect these conditions.
-=====================
Transform: dojoReport
=====================
@@ -206,7 +198,6 @@ Transform: dojoReport
This section not complete; please consult source at util/build/transforms/dojoReport.js
-=====================
Transform: hasFindAll
=====================
@@ -217,7 +208,6 @@ Transform: hasFindAll
* [*falsy*] No has location report is written.
-===================
Transform: hasFixup
===================
@@ -230,7 +220,6 @@ Transform: hasFixup
``staticHasFeatures`` maps may be provided from multiple profile resources. If more than one ``staticHasFeatures``
property value is provided, then they are mixed on a per-has-feature basis in the order they appear on the command line.
-========================
Transform: insertSymbols
========================
@@ -238,7 +227,6 @@ Transform: insertSymbols
This section not complete; please consult source at util/build/transforms/insertSymbols.js
-======================
Transform: optimizeCss
======================
@@ -246,7 +234,6 @@ Transform: optimizeCss
This section not complete; please consult source at util/build/transforms/optimizeCss.js
-===============
Transform: read
===============
@@ -254,7 +241,6 @@ Transform: read
This section not complete; please consult source at util/build/transforms/read.js
-================
Transform: write
================
@@ -262,7 +248,6 @@ Transform: write
None.
-===================
Transform: writeAmd
===================
@@ -305,7 +290,6 @@ Layer items are Javascript objects with the following properties
layer item. If a string that does not give an existing filename, the string it interpreted as an explicit copyright
message. If no string value is given, then no copyright text is output.
-====================
Transform: writeDojo
====================
@@ -342,7 +326,6 @@ Transform: writeDojo
boot:true
}
-=========================
Transform: writeOptimized
=========================
@@ -403,13 +386,11 @@ Transform: writeOptimized
* ["all"] All console applications are stripped.
-=============================
Deprecated Profile Properties
=============================
The action clean is no longer supported. Use ``rm`` on Unix/Linux/OS X or ``rmdir`` on Windows.
-==========================
Removed Profile Properties
==========================
View
1  build/scenario-base.rst
@@ -1,5 +1,6 @@
.. _build/scenario-base:
+============================
Building a Base-only dojo.js
============================
View
1  build/scenario-micro.rst
@@ -1,5 +1,6 @@
.. _build/scenario-micro:
+=======================
A CustomBase Dojo Build
=======================
View
1  build/scenario-release.rst
@@ -1,5 +1,6 @@
.. _build/scenario-release:
+===========================
Building a standard release
===========================
View
1  build/scenario-xDomain.rst
@@ -1,5 +1,6 @@
.. _build/scenario-xDomain:
+=========================
Building an x-domain Dojo
=========================
View
5 build/simpleExample.rst
@@ -1,5 +1,6 @@
.. _build/simpleExample:
+===========================
Simple Buildsystem Examples
===========================
@@ -15,7 +16,6 @@ This document provides some simple examples of using the Dojo build system, how
.. warning: This is old, the download is 1.4.1 dojo.
-============
Introduction
============
@@ -23,7 +23,6 @@ For an introduction to the build system, see :ref:`the overview <build/index>`.
Like most parts of Dojo the build system has been designed to be both powerful and flexible. There are a lot of different options available to tweak your system but, for the majority of first-time users, sticking to the defaults in this example will do you just fine.
-=========
Example 1
=========
@@ -49,7 +48,6 @@ The zip file basically contains a very simple Dojo build setup for a simple page
(Obviously in the real world you don't make two copies of every page - I've done it that way here for simplicity. In most large projects you'd have your source being generated by some server side process which would swap in the correct version during deployment. If this is a blocker for you, see example 2).
-===========================
Definitions - A quick recap
===========================
@@ -84,7 +82,6 @@ Cons of this approach
* Obviously you are not going to keep two copies of your HTML files kicking around, so you have to change the contents of the file on the server side depending on if you are in a live or development environment.
-========
See also
========
View
5 build/transforms/copy.rst
@@ -1,5 +1,6 @@
.. _build/transforms/copy:
+====================
Build Transform copy
====================
@@ -9,26 +10,22 @@ Build Transform copy
.. contents::
:depth: 2
-=======
Summary
=======
Copies a resource from a source location to a destination location.
-===========
Description
===========
This transform copies a resource from the discovered source location to the discovered destination location. On Windows,
the build-in command processor ``copy`` command is used; ``cp`` is used in all other environments.
-=============
Profile Knobs
=============
None.
-===============
Source Location
===============
View
5 build/transforms/depsDump.rst
@@ -1,5 +1,6 @@
.. _build/transforms/depsDump:
+========================
Build Transform depsDump
========================
@@ -9,13 +10,11 @@ Build Transform depsDump
.. contents::
:depth: 2
-=======
Summary
=======
Optionally dumps the dependency graph of all discovered modules and/or a basic GraphViz dot digraph program.
-===========
Description
===========
@@ -90,7 +89,6 @@ The resulting image should look something like this:
.. image :: dojo-base-json.png
-=============
Profile Knobs
=============
@@ -110,7 +108,6 @@ Profile Knobs
dependency trees will be included in the output)
* [*falsy*] all modules are included
-===============
Source Location
===============
View
5 build/transforms/depsScan.rst
@@ -1,5 +1,6 @@
.. _build/transforms/depsScan:
+========================
Build Transform depsScan
========================
@@ -9,14 +10,12 @@ Build Transform depsScan
.. contents::
:depth: 2
-=======
Summary
=======
Scans AMD and legacy module for dependencies; automatically convert legacy modules to AMD modules (both normal code
modules and NLS modules); interns strings for legacy modules.
-===========
Description
===========
@@ -96,7 +95,6 @@ In summary, the transform process discovers any module dependencies through one
Once all dependencies are found, the transform ensures all dependencies exist in the discovered modules. Missing
dependencies result in an error being logged to the console and the build report.
-=============
Profile Knobs
=============
@@ -135,7 +133,6 @@ Profile Knobs
**Warning**: All knobs mentioned above support legacy features which are deprecated. It is strongly encouraged to convert
legacy modules to properly-expressed AMD modules.
-===============
Source Location
===============
View
5 build/transforms/dojoPragmas.rst
@@ -1,5 +1,6 @@
.. _build/transforms/dojoPragmas:
+===========================
Build Transform dojoPragmas
===========================
@@ -9,13 +10,11 @@ Build Transform dojoPragmas
.. contents::
:depth: 2
-=======
Summary
=======
Applies dojo pragmas to a resource.
-===========
Description
===========
@@ -107,14 +106,12 @@ Notice that this example simply used the value of the profile property ``myBlock
text between the comma and the last parenthesis is evaluated and this text may be arbitrarily simple or complex so long as
it remains on the single line that contains the pragma and is legal Javascript that returns a booleanish value.
-=============
Profile Knobs
=============
The entire profile object is placed in the lexical variable ``kwargs`` when thea condition associated with the pragmas
``includeStart`` and ``excludeEnd`` is evaluated. Any property in the profile may be used to affect these conditions.
-===============
Source Location
===============
View
5 build/transforms/hasFindAll.rst
@@ -1,5 +1,6 @@
.. _build/transforms/hasFindAll:
+==========================
Build Transform hasFindAll
==========================
@@ -9,13 +10,11 @@ Build Transform hasFindAll
.. contents::
:depth: 2
-=======
Summary
=======
Finds all has.js tests and optionally reports feature test usage as part of the build report.
-===========
Description
===========
@@ -29,7 +28,6 @@ either single- or double-quotes. The character preceding the "has" function name
As feature tests are discovered, the module in which they reside is memorized. If the profile property ``hasReport`` is
truthy, then a map from has feature test to the list of modules that use each test is written to the build report.
-=============
Profile Knobs
=============
@@ -38,7 +36,6 @@ Profile Knobs
* [*falsy*] No has location report is written.
-===============
Source Location
===============
View
5 build/transforms/hasFixup.rst
@@ -1,5 +1,6 @@
.. _build/transforms/hasFixup:
+========================
Build Transform hasFixup
========================
@@ -9,14 +10,12 @@ Build Transform hasFixup
.. contents::
:depth: 2
-=======
Summary
=======
Transforms has.js expressions that reference static has feature values as presented in a profile into expressions that
facilitate dead code removal by the Google Closure Compiler.
-===========
Description
===========
@@ -169,7 +168,6 @@ Which would be reduced to
By the Google Closure Compiler in simple mode.
-=============
Profile Knobs
=============
@@ -180,7 +178,6 @@ Profile Knobs
``staticHasFeatures`` maps may be provided from multiple profile resources. If more than one ``staticHasFeatures``
property value is provided, then they are mixed on a per-has-feature basis in the order they appear on the command line.
-===============
Source Location
===============
View
5 build/transforms/write.rst
@@ -1,5 +1,6 @@
.. _build/transforms/write:
+=====================
Build Transform write
=====================
@@ -9,13 +10,11 @@ Build Transform write
.. contents::
:depth: 2
-=======
Summary
=======
Writes a resource a destination location.
-===========
Description
===========
@@ -26,13 +25,11 @@ Note: typically a noWrite tag is added during some other transform that contains
resource is not needed. If a noWrite decision can be made during discovery, then the resource should not be scheduled
for the write transform to begin with.
-=============
Profile Knobs
=============
None.
-===============
Source Location
===============
View
5 build/transforms/writeAmd.rst
@@ -1,5 +1,6 @@
.. _build/transforms/writeAmd:
+========================
Build Transform writeAmd
========================
@@ -9,13 +10,11 @@ Build Transform writeAmd
.. contents::
:depth: 2
-=======
Summary
=======
Writes a transformed AMD module to a destination location.
-===========
Description
===========
@@ -131,7 +130,6 @@ that defines each AMD module includes a module identifier argument. This is a ba
construct modules that can be loaded with a script tag in the context of the dojo loader operating in a legacy
mode. Normally, this feature should be avoided.
-=============
Profile Knobs
=============
@@ -173,7 +171,6 @@ Layer items are Javascript objects with the following properties
layer item. If a string that does not give an existing filename, the string it interpreted as an explicit copyright
message. If no string value is given, then no copyright text is output.
-===============
Source Location
===============
View
5 build/transforms/writeDojo.rst
@@ -1,5 +1,6 @@
.. _build/transforms/writeDojo:
+=========================
Build Transform writeDojo
=========================
@@ -9,13 +10,11 @@ Build Transform writeDojo
.. contents::
:depth: 2
-=======
Summary
=======
Writes the dojo loader and any layers that are designated as boot layers to destination locations.
-===========
Description
===========
@@ -180,7 +179,6 @@ The transform writes the dojo/dojo resource text, after transforming as describe
location. Additionally, the resource text for all bootable layers (see xxx) is written to their destination locations
after prefixing that text with the dojo/dojo resource text.
-=============
Profile Knobs
=============
@@ -216,7 +214,6 @@ Profile Knobs
boot:true
}
-===============
Source Location
===============
View
5 build/transforms/writeOptimized.rst
@@ -1,5 +1,6 @@
.. _build/transforms/writeOptimized:
+==============================
Build Transform writeOptimized
==============================
@@ -9,13 +10,11 @@ Build Transform writeOptimized
.. contents::
:depth: 2
-=======
Summary
=======
Submits transformed resource text to either Shrinksafe or the Google Closure Compiler.
-===========
Description
===========
@@ -33,7 +32,6 @@ When the build application is executed in the node.js environment, multiple chil
resources may be optimized concurrently, thereby decreasing build times. This feature is not available in the Rhino
environment.
-=============
Profile Knobs
=============
@@ -93,7 +91,6 @@ Profile Knobs
* ["all"] All console applications are stripped.
-===============
Source Location
===============
View
1  build/webkit-mobile.rst
@@ -1,5 +1,6 @@
.. _build/webkit-mobile:
+===================================
Special Dojo Build: WebKit Mobile
===================================
View
2  build/xDomain.rst
@@ -1,5 +1,6 @@
.. _build/xDomain:
+============================================
Build System: Cross-Domain (xDomain) Builds
============================================
@@ -72,7 +73,6 @@ XDomain Example
`Here is an example <http://jburke.dojotoolkit.org/demos/xdlocal/LocalAndXd.html>`_ showing how to load local modules along with an xdomain-loaded Dojo and Dijit. You can `download this example <http://jburke.dojotoolkit.org/demos/xdlocal/xdlocal.zip>`_.
-========
See also
========
View
4 developer/a11y-requirements.rst
@@ -1,5 +1,6 @@
.. _developer/a11y-requirements:
+=================
A11y Requirements
=================
@@ -9,7 +10,6 @@ A11y Requirements
:depth: 2
-===================
5 A11y Requirements
===================
@@ -33,7 +33,6 @@ Note that this is not a comprehensive list of Web Accessibility requirements, ju
+ `W3C provided list of accessibility policies around the world <http://www.w3.org/WAI/Policy/>`_
-======
Visual
======
@@ -157,7 +156,6 @@ More Details
This requirement comes from WCAG 2.0 Resize text: `Text (but not images of text) can be resized without assistive technology up to 200 percent without loss of content or functionality <http://www.w3.org/TR/WCAG20/#visual-audio-contrast-scale>`_. This is not a top level requirement but is important in order to properly support IE 6. The advent of the Zoom feature in IE 7, Firefox 3 and Opera negate the need for ensuring that font sizes are relative since the entire page gets uniformly scaled. But as long as IE 6 is supported fixed font sizes can be an issue.
-==========
Functional
==========
View
7 developer/bugs.rst
@@ -1,5 +1,6 @@
.. _developer/bugs:
+================================
Notes on how to use bug tracking
================================
@@ -11,13 +12,11 @@ Notes on how to use bug tracking
At the Dojo Project we use Trac for issue tracking. These are some notes about the conventions we use when filing, closing, updating, and triaging issues (tickets).
-==========
Logging In
==========
The `bug tracker <http://bugs.dojotoolkit.org>`_ uses the LDAP information from the overall `Dojo Foundation <http://dojofoundation.org>`_. `Register for a Dojo Foundation account <http://my.dojofoundation.org>`_ and login to Trac via the auth dialog using those credentials. **note** this username/password combination will work on all Dojo Sites, eg: http://livedocs.dojotoolkit.org
-================
Getting Notified
================
@@ -27,7 +26,6 @@ You are notified if you are the a) owner of a ticket b) filer of a ticket or c)
Alternative, you can subscribe to the ``dojo-checkins`` mailing list, and be alerted for every change. (can be noisy some days)
-==============
Filing Tickets
==============
@@ -81,7 +79,6 @@ Dijit prefers the module name be included in the summary, when in the "component
[regression] TabContainer: Title Heights collapse when ...
-===============
Owning a ticket
===============
@@ -101,7 +98,6 @@ Tickets assigned but not "accepted" are considered fair game. A patch submission
When you "accept" a ticket for a given milestone, you are indicating you are or will be focused on that item. Unless the ticket requests further contribution, it is likely you will receive none. It is your duty to ensure all your "accepted" tickets are marked in an appropriate milestone prior to every major release.
-=======
Patches
=======
@@ -144,7 +140,6 @@ Many IDE's have SVN integration and can easily apply patches from this format.
``TODOC:`` anyone use an IDE to do this?
-===============
Commit Messages
===============
View
3  developer/contributors.rst
@@ -1,9 +1,9 @@
.. _developer/contributors:
+===================
Contributor Listing
===================
-=====================================
Individuals who have signed Dojo CLAs
=====================================
@@ -601,7 +601,6 @@ Individuals who have signed Dojo CLAs
* Zou, Ran
* Zyp, Kris
-=================================================
Corporations or Organizations with a CCLA on file
=================================================
View
1  developer/index.rst
@@ -1,5 +1,6 @@
.. _developer/index:
+=======================
Dojo Developer Notebook
=======================
View
1  developer/projects.rst
@@ -1,5 +1,6 @@
.. _developer/projects:
+===============
Future Projects
===============
View
6 developer/rules.rst
@@ -1,14 +1,13 @@
.. _developer/rules:
+===============================================
So You've Been Offered A Spot As A Committer...
===============================================
-=============================
committer community licensing
=============================
First, congratulations! Being offered a spot as a committer is a sign that we (the Dojo team) think highly of your contributions, value your insights, and believe that you have made significant efforts to improve the toolkit and community. Offers to join the project a committer aren't extended lightly, and we hope you'll take the decision to accept seriously. Before you say "yes", there are some things you should know.
-=======
Process
=======
**IP policy**: as you know, Dojo is one of the few OSS JavaScript projects which uses a CLA process to ensure that contributions to the toolkit are "clean" from an IP perspective. The policies which we follow are outlined in the IP policies (TODO: add link) and as a committer you are expected to help us observe them. Long story short, if you didn't write it or are unsure of the CLA status of the contribution, don't commit it. The list of people and companies with CLAs on file :ref:`is public <developer/contributors>`, so be sure to consult it when in doubt. Artwork can be particularly problematic from an IP cleanliness perspective, and difficult to judge. There are also times when integrating some chunk of code which you find out on the net somewhere seems a reasonable thing to do. In each of these cases, it's best to ask the Project Lead for guidance.
@@ -17,7 +16,6 @@ Process
**Getting Along**: most decisions in the project arise out of consensus in one way or another. When things are contentious, we try to find data, common ground, or expert opinions to settle things. Despite this, decisions get made which not everyone agrees with, and as a result it's possible for tensions to flare. You've been offered a spot as a committer in part because you've demonstrated that you work well with others to resolve issues, find data to support arguments or theories, and avoid personal attacks when disagreeing. These are important traits for a distributed project and we expect that you'll work to embody them. Remember: the person on the other end of The Tubes is, like you, trying to make things better.
-=========
Community
=========
**Voting**: As a committer on Dojo you will have a vote in both project-level and Foundation-level issues. Every project at the Dojo Foundation is potentially run differently, but most have some sort of "Benevolent Dictator For Live" or "Project Lead" who sets the agenda. Dojo as a project is organized in this style, but most decision making is made by consensus. That said, voting is part of the Dojo culture and your participation as a committer is required.
@@ -30,7 +28,6 @@ Votes may be started by any committer on any matter at any time. This may sound
**New Committers**: in order for you to have been considered for committer status, someone in the community had to champion you to the Board of Directors of the Foundation, noting some of your large contributions and your positive impact on the project. To make code changes as a non-committer contributor, you also had to work with committers to get your patches approved and merged. The people who have helped you earn your committer stripes are just like you and if you accept the role of committer on Dojo, we'd ask that you pay the same attention to others who are filing good patches, showing up with bright ideas and contributions on IRC and the forums, and looking for help in making Dojo better. Eventually, you should consider proposing those people for committer status...that's how you got here and how the Dojo community grows organically. Keep an eye out for promising contributors and do everything you can to help them succeed. The project depends on you to do this and our long-term success is in many ways dependent on it.
-=======
Systems
=======
**Shell accounts**: we make shell accounts available to all committers. Don't do anything illegal with them, please. Also, note that while your shell account is provided on a system which isn't a production host, it would be great if you'd ask around before running huge jobs or starting large daemons (think Java servers). When in doubt, ask.
@@ -39,7 +36,6 @@ Systems
**Lists**: if you're not already subscribed to dojo-contributors and the foundation list, you will be subscribed to them when your email accounts are created. Please monitor these lists for votes and other important traffic as many decisions are made there which may impact you and your interests in the project.
-======
Ready?
======
If, after reading and considering all of this, you still want to accept a spot as a committer on Dojo, we'd be honored to have you join us. Don't hesitate to ask questions or get clarifications on anything in this document before or after you make your decision, and don't feel rushed. Whichever way you chose, we want to keep working with you in the future to make Dojo better. Thanks for your hard work so far and congratulations on your accomplishments to-date.
View
9 developer/styleguide.rst
@@ -1,5 +1,6 @@
.. _developer/styleguide:
+================
Dojo Style Guide
================
@@ -10,7 +11,6 @@ This document follows the basic outline of the `Java Programming Conventions Gui
Widget authors are expected to adhere to this style guide and also to the :ref:`Dojo Accessibility Design Requirements <developer/a11y-requirements>` guidelines.
-=======
General
=======
@@ -18,7 +18,6 @@ Any violation to this guide is allowed if it enhances readability.
Guidelines in this document are informed by discussions carried out among the Dojo core developers. The most weight has been given to considerations that impact external developer interaction with Dojo code and APIs. Rules such as whitespace placement are of a much lower order importance for Dojo developers, but should be followed in the main in order to improve developer coordination.
-===============
Quick Reference
===============
@@ -56,7 +55,6 @@ Table of constructs that are not visible in the API, and therefore carry less we
| local vars | _mixedCase, mixedCase |
+-----------------------+---------------------------+
-==================
Naming Conventions
==================
@@ -147,7 +145,6 @@ Naming Conventions
dojo.attr(node, "tabIndex", -1); // setter
-===========================
Specific Naming Conventions
===========================
@@ -179,7 +176,6 @@ Specific Naming Conventions
# Methods returning an object MAY be named after what they return, and methods returning void after what they do.
-=====
Files
=====
@@ -211,7 +207,6 @@ Files
Note also the position of the parenthesis in the method call; positioning SHOULD be similar to the use of block notation.
-=========
Variables
=========
@@ -249,7 +244,6 @@ Variables
#. Floating point constants SHOULD ALWAYS be written with a digit before the decimal point.
-======
Layout
======
@@ -412,7 +406,6 @@ Layout
#. Comments SHOULD NOT be included for every single line of code.
-=============
Documentation
=============
View
9 developer/svn.rst
@@ -1,5 +1,6 @@
.. _developer/svn:
+====================================
Getting the Code from Source Control
====================================
@@ -9,12 +10,10 @@ Authoritative documentation on Subversion is available `here <http://svnbook.red
.. contents ::
-===================
Why Source Control?
===================
Source control is one of those things that one rarely notices they need until it's far too late, usually when you accidentally delete part of your source tree instead of simply moving it to a different location, or when you make a set of complex changes that leave you worse off than were you started (but you can't go back). A source control system solves these problems by keeping copies of each revision of a set of files on a server, while giving you access to a local copy of those files to make changes on. Good source control systems allow multiple people to modify a single file at once, and will try to automatically merge changes between differing sets of modifications. A good source control system will also let you browse the history of a file or set of files (allowing you to "go back in time") and allow you to have access to your code from as many systems as you like. Subversion is one of those good source control systems.
-===================
General Information
===================
Across the gamut of source control systems, there is quite a bit of confusing (and non-portable) nomenclature surrounding the common actions that you as a developer will preform with the source control system. We will use the terms here that are commonly accepted by CVS and Subversion users and administrators. So what are those terms?
@@ -28,12 +27,10 @@ Across the gamut of source control systems, there is quite a bit of confusing (a
Unlike some other source control systems, Subversion manages files on your disk without interjecting itself obtrusively into your workflow. You can change large sets of files without worrying if anyone else is also modifying those files.
-=======================
Browsing the repository
=======================
You may browser our subversion repository (http://svn.dojotoolkit.org/src/) directly using a web browser or browse using the `Bug tracker <http://bugs.dojotoolkit.org/browser>`_.
-===================
Directory structure
===================
The code is structured with each subproject (dojo, dijit, dojox, util) as a separate directory. Within each subproject you will find the "trunk" as well as "branches" and "tags". You may pull these subprojects separately, or use a special svn "view" which links the subprojects and checks them out with a single command.
@@ -53,12 +50,10 @@ Or, to pull a particular release, such as Dojo 1.0.2:
svn co http://svn.dojotoolkit.org/src/tags/release-1.0.2 dojo102
-===============================
Branches in the Dojo repository
===============================
Most Dojo development takes place on the trunk. Branches may be used for development of experimental features or for code migration before being merged back into the trunk. Branches are also used to stabilize major releases.
-================================
Making changes to the repository
================================
Anyone may access the Dojo Subversion server. Contributors are encouraged to access code directly from the repository and submit patches using the bug tracker. To submit changes, however, you must have committer status and have already received a system account from the administrator.
@@ -70,7 +65,6 @@ To access the repository as a committer, use this URL with subversion:
svn co --username=YOURUSERNAME
https://svn.dojotoolkit.org/src/view/committer/all/trunk dojotoolkit
-=======================
Using Development Tools
=======================
@@ -153,7 +147,6 @@ The third magic string is **"!strict"** --- We lint on commit to try to detect p
If you forget to include these strings, you can still manually close the ticket using trac, but make sure to add a comment, like "[12345] fixes this ticket." where 12345 is the changeset number, so that trac adds a hyperlink to the commits for the ticket properly.
-===================
SVN Config Settings
===================
You'll need to add a couple config settings to your SVN config file. If you are on Windows, that's located at:
View
8 dijit/Calendar.rst
@@ -1,5 +1,6 @@
.. _dijit/Calendar:
+===============
dijit.Cale