From f89feb8236f14bcdc8483074d6cc516e39c3bbbb Mon Sep 17 00:00:00 2001 From: Bill Keese Date: Mon, 28 Nov 2011 20:50:49 +0900 Subject: [PATCH] regex change of level 1 headers to ====\nTEXT\n==== and level 2 headers to TEXT\n==== --- build/buildScript.rst | 6 +- build/buildSystem.rst | 30 ++--- build/customBase.rst | 9 +- build/directoryLayout.rst | 3 +- build/exclude.rst | 7 +- build/expand-provide.rst | 3 +- build/index.rst | 4 +- build/keepRequires.rst | 4 +- build/localizationExample.rst | 9 +- build/profileQRef.rst | 19 +-- build/profiles.rst | 8 +- build/qref.rst | 19 --- build/scenario-base.rst | 1 + build/scenario-micro.rst | 1 + build/scenario-release.rst | 1 + build/scenario-xDomain.rst | 1 + build/simpleExample.rst | 5 +- build/transforms/copy.rst | 5 +- build/transforms/depsDump.rst | 5 +- build/transforms/depsScan.rst | 5 +- build/transforms/dojoPragmas.rst | 5 +- build/transforms/hasFindAll.rst | 5 +- build/transforms/hasFixup.rst | 5 +- build/transforms/write.rst | 5 +- build/transforms/writeAmd.rst | 5 +- build/transforms/writeDojo.rst | 5 +- build/transforms/writeOptimized.rst | 5 +- build/webkit-mobile.rst | 1 + build/xDomain.rst | 2 +- developer/a11y-requirements.rst | 4 +- developer/bugs.rst | 7 +- developer/contributors.rst | 3 +- developer/index.rst | 1 + developer/projects.rst | 1 + developer/rules.rst | 6 +- developer/styleguide.rst | 9 +- developer/svn.rst | 9 +- dijit/Calendar.rst | 8 +- dijit/CalendarLite.rst | 3 +- dijit/CheckedMenuItem.rst | 3 +- dijit/ColorPalette.rst | 8 +- dijit/Declaration.rst | 4 +- dijit/Dialog.rst | 3 +- dijit/Editor.rst | 15 +-- dijit/InlineEditBox.rst | 10 +- dijit/Menu.rst | 8 +- dijit/MenuBar.rst | 8 +- dijit/MenuBarItem.rst | 3 +- dijit/MenuItem.rst | 3 +- dijit/ProgressBar.rst | 3 +- dijit/TitlePane.rst | 11 +- dijit/Toolbar.rst | 12 +- dijit/Tooltip.rst | 10 +- dijit/TooltipDialog.rst | 7 +- dijit/Tree-examples.rst | 1 + dijit/Tree.rst | 16 +-- dijit/WidgetSet.rst | 5 +- dijit/_CssStateMixin.rst | 4 +- dijit/_FocusMixin.rst | 3 +- dijit/_HasDropDown.rst | 5 +- dijit/_OnDijitClickMixin.rst | 2 +- dijit/_Templated.rst | 3 +- dijit/_TemplatedMixin.rst | 6 +- dijit/_Widget.rst | 1 + dijit/_WidgetsInTemplateMixin.rst | 4 +- dijit/_editor/plugins.rst | 3 +- dijit/_editor/plugins/FontChoice.rst | 6 +- dijit/_editor/plugins/FullScreen.rst | 8 +- dijit/_editor/plugins/LinkDialog.rst | 7 +- dijit/_editor/plugins/NewPage.rst | 5 +- dijit/_editor/plugins/Print.rst | 5 +- dijit/_editor/plugins/TextColor.rst | 5 +- dijit/_editor/plugins/ToggleDir.rst | 6 +- dijit/_editor/plugins/ViewSource.rst | 9 +- dijit/a11y/index.rst | 2 +- dijit/a11y/resources.rst | 1 + dijit/a11y/statement.rst | 6 +- dijit/a11y/strategy.rst | 1 + dijit/focus.rst | 4 +- dijit/form.rst | 7 +- dijit/form/Button.rst | 8 +- dijit/form/CheckBox.rst | 4 +- dijit/form/ComboBox.rst | 4 +- dijit/form/ComboButton.rst | 6 +- dijit/form/CurrencyTextBox.rst | 4 +- dijit/form/DataList.rst | 2 +- dijit/form/DateTextBox.rst | 4 +- dijit/form/DropDownButton.rst | 6 +- dijit/form/FilteringSelect.rst | 5 +- dijit/form/Form.rst | 3 +- dijit/form/HorizontalRuleLabels.rst | 1 + dijit/form/HorizontalSlider.rst | 1 + dijit/form/MappedTextBox.rst | 2 +- dijit/form/MultiSelect.rst | 4 +- dijit/form/NumberSpinner.rst | 4 +- dijit/form/NumberTextBox.rst | 4 +- dijit/form/RadioButton.rst | 4 +- dijit/form/RangeBoundTextBox.rst | 2 +- dijit/form/Select.rst | 5 +- dijit/form/SimpleTextarea.rst | 3 +- dijit/form/Slider.rst | 8 +- dijit/form/TextBox.rst | 4 +- dijit/form/Textarea.rst | 4 +- dijit/form/TimeTextBox.rst | 5 +- dijit/form/ToggleButton.rst | 3 +- dijit/form/ValidationTextBox.rst | 9 +- dijit/form/VerticalRuleLabels.rst | 1 + dijit/form/VerticalSlider.rst | 1 + dijit/form/_FormSelectWidget.rst | 3 +- dijit/form/_FormValueWidget.rst | 1 + dijit/form/_FormWidget.rst | 3 +- dijit/info.rst | 9 +- dijit/layout.rst | 8 +- dijit/layout/AccordionContainer.rst | 7 +- dijit/layout/BorderContainer.rst | 7 +- dijit/layout/ContentPane.rst | 4 +- dijit/layout/StackContainer.rst | 8 +- dijit/layout/TabContainer.rst | 8 +- dijit/layout/_LayoutWidget.rst | 4 +- dijit/place.rst | 4 +- dijit/popup.rst | 8 +- dijit/registry.rst | 4 +- dijit/themes.rst | 10 +- dijit/tree/ForestStoreModel.rst | 1 + dijit/tree/Model.rst | 1 + dijit/tree/TreeStoreModel.rst | 1 + dijit/typematic.rst | 3 +- dojo/Color.rst | 3 +- dojo/Deferred.rst | 6 +- dojo/DeferredList.rst | 1 + dojo/Evented.rst | 3 +- dojo/NodeList-data.rst | 6 +- dojo/NodeList-dom.rst | 1 + dojo/NodeList-manipulate.rst | 5 +- dojo/NodeList-traverse.rst | 4 +- dojo/NodeList.rst | 7 +- dojo/NodeList/attr.rst | 5 +- dojo/NodeList/removeAttr.rst | 5 +- dojo/Stateful.rst | 6 +- dojo/Url.rst | 1 + dojo/_base/Color.rst | 4 +- dojo/_base/Deferred.rst | 2 +- dojo/_base/NodeList.rst | 2 +- dojo/_base/connect.rst | 2 +- dojo/_base/declare.rst | 2 +- dojo/_base/fx.rst | 3 +- dojo/_base/html.rst | 3 +- dojo/_base/json.rst | 2 +- dojo/_base/lang.rst | 3 +- dojo/_base/query.rst | 2 +- dojo/_base/window.rst | 2 +- dojo/addClass.rst | 4 +- dojo/addOnLoad.rst | 3 +- dojo/addOnUnload.rst | 5 +- dojo/addOnWindowUnload.rst | 3 +- dojo/anim.rst | 8 +- dojo/animateProperty.rst | 4 +- dojo/aspect.rst | 2 +- dojo/attr.rst | 5 +- dojo/back.rst | 3 +- dojo/base.rst | 1 + dojo/base/loader.rst | 2 +- dojo/behavior.rst | 4 +- dojo/body.rst | 3 +- dojo/browser.rst | 1 + dojo/byId.rst | 3 +- dojo/cache.rst | 8 +- dojo/cldr.rst | 5 +- dojo/clone.rst | 2 +- dojo/config.rst | 4 +- dojo/connect.rst | 9 +- dojo/connectPublisher.rst | 3 +- dojo/contentHandlers.rst | 4 +- dojo/cookie.rst | 6 +- dojo/coords.rst | 5 +- dojo/create.rst | 9 +- dojo/currency.rst | 4 +- dojo/data.rst | 4 +- dojo/data/ItemFileReadStore.rst | 12 +- dojo/data/ItemFileWriteStore.rst | 9 +- dojo/data/ObjectStore.rst | 4 +- dojo/data/api/Read.rst | 3 +- dojo/date.rst | 4 +- dojo/date/locale.rst | 4 +- dojo/date/locale/format.rst | 5 +- dojo/date/locale/parse.rst | 5 +- dojo/date/stamp.rst | 4 +- dojo/declare.rst | 11 +- dojo/delegate.rst | 7 +- dojo/deprecated.rst | 1 + dojo/destroy.rst | 11 +- dojo/disconnect.rst | 3 +- dojo/dnd.rst | 12 +- dojo/dnd/Moveable.rst | 5 +- dojo/doc.rst | 5 +- dojo/domReady.rst | 3 +- dojo/empty.rst | 11 +- dojo/eval.rst | 3 +- dojo/every.rst | 2 +- dojo/exists.rst | 4 +- dojo/extend.rst | 3 +- dojo/fadeIn.rst | 5 +- dojo/fadeOut.rst | 5 +- dojo/fieldToObject.rst | 5 +- dojo/filter.rst | 2 +- dojo/formToJson.rst | 5 +- dojo/formToObject.rst | 5 +- dojo/formToQuery.rst | 5 +- dojo/fromJson.rst | 4 +- dojo/fx.rst | 3 +- dojo/fx/Toggler.rst | 4 +- dojo/fx/easing.rst | 4 +- dojo/fx/slideTo.rst | 5 +- dojo/fx/wipeIn-examples.rst | 1 + dojo/fx/wipeIn.rst | 5 +- dojo/fx/wipeOut.rst | 5 +- dojo/gears.rst | 1 + dojo/getAttr.rst | 5 +- dojo/getComputedStyle.rst | 5 +- dojo/getContentBox.rst | 3 +- dojo/getMarginBox.rst | 3 +- dojo/getNodeProp.rst | 5 +- dojo/getObject.rst | 3 +- dojo/getProp.rst | 5 +- dojo/getStyle.rst | 5 +- dojo/global.rst | 4 +- dojo/hasAttr.rst | 5 +- dojo/hasClass.rst | 3 +- dojo/hitch.rst | 1 + dojo/i18n.rst | 3 +- dojo/index.rst | 5 +- dojo/indexOf.rst | 1 + dojo/io-query.rst | 1 - dojo/io.rst | 1 + dojo/io/iframe.rst | 5 +- dojo/io/script.rst | 6 +- dojo/ioPipelineTopics.rst | 4 +- dojo/isAlien.rst | 4 +- dojo/isArray.rst | 6 +- dojo/isArrayLike.rst | 4 +- dojo/isFunction.rst | 4 +- dojo/isString.rst | 4 +- dojo/json.rst | 3 +- dojo/lastIndexOf.rst | 1 + dojo/locale.rst | 4 +- dojo/map.rst | 4 +- dojo/marginBox.rst | 5 +- dojo/mixin.rst | 6 +- dojo/moduleUrl.rst | 3 +- dojo/mouse.rst | 4 +- dojo/node.rst | 1 + dojo/number.rst | 5 +- dojo/objectToQuery.rst | 5 +- dojo/on.rst | 3 +- dojo/parser.rst | 10 +- dojo/partial.rst | 2 +- dojo/place.rst | 6 +- dojo/position.rst | 5 +- dojo/prop.rst | 5 +- dojo/provide.rst | 4 +- dojo/publish.rst | 4 +- dojo/query.rst | 3 +- dojo/queryToObject.rst | 5 +- dojo/rawXhrPost.rst | 2 +- dojo/rawXhrPut.rst | 2 +- dojo/ready.rst | 2 +- dojo/registerModulePath.rst | 5 +- dojo/removeAttr.rst | 5 +- dojo/removeClass.rst | 5 +- dojo/replace.rst | 4 +- dojo/replaceClass.rst | 5 +- dojo/require.rst | 5 +- dojo/requireLocalization.rst | 4 +- dojo/robot.rst | 1 - dojo/robotx.rst | 1 - dojo/rpc.rst | 3 +- dojo/rpc/JsonService.rst | 5 +- dojo/rpc/JsonpService.rst | 5 +- dojo/rpc/RpcService.rst | 12 +- dojo/safeMixin.rst | 3 +- dojo/setAttr.rst | 5 +- dojo/setContentSize.rst | 3 +- dojo/setContext.rst | 4 +- dojo/setMarginBox.rst | 3 +- dojo/setObject.rst | 4 +- dojo/setProp.rst | 5 +- dojo/setStyle.rst | 5 +- dojo/some.rst | 2 +- dojo/stopEvent.rst | 2 +- dojo/store.rst | 16 +-- dojo/store/Cache.rst | 4 +- dojo/store/DataStore.rst | 3 +- dojo/store/JsonRest.rst | 8 +- dojo/store/Memory.rst | 4 +- dojo/store/Observable.rst | 2 - dojo/string.rst | 2 +- dojo/string/trim.rst | 1 + dojo/style.rst | 6 +- dojo/subscribe.rst | 3 +- dojo/toJson.rst | 4 +- dojo/toggleClass.rst | 6 +- dojo/topic.rst | 3 +- dojo/touch.rst | 5 +- dojo/trim.rst | 3 +- dojo/uacss.rst | 3 +- dojo/unsubscribe.rst | 2 +- dojo/version.rst | 2 +- dojo/when.rst | 3 +- dojo/window.rst | 2 - dojo/window/get.rst | 3 +- dojo/window/getBox.rst | 4 +- dojo/window/scrollIntoView.rst | 2 +- dojo/windowUnloaded.rst | 2 +- dojo/withDoc.rst | 5 +- dojo/withGlobal.rst | 4 +- dojo/xhr.rst | 5 +- dojo/xhrDelete.rst | 6 +- dojo/xhrGet.rst | 6 +- dojo/xhrPost.rst | 6 +- dojo/xhrPut.rst | 6 +- dojox/NodeList.rst | 3 +- dojox/NodeList/delegate.rst | 4 +- dojox/app.rst | 6 +- dojox/app/bind.rst | 3 +- dojox/app/main.rst | 1 + dojox/app/model.rst | 2 +- dojox/app/module/history.rst | 3 +- dojox/app/scene.rst | 3 +- dojox/app/view.rst | 2 +- dojox/atom.rst | 5 +- dojox/atom/io/Connection.rst | 7 +- dojox/atom/io/model.rst | 7 +- dojox/atom/io/model/Collection.rst | 4 +- dojox/atom/io/model/Generator.rst | 4 +- dojox/atom/io/model/Service.rst | 4 +- dojox/atom/io/model/Workspace.rst | 4 +- dojox/atom/widget.rst | 3 +- dojox/av.rst | 2 +- dojox/av/FLAudio.rst | 4 +- dojox/av/FLVideo.rst | 4 +- dojox/av/widget.rst | 4 +- dojox/charting.rst | 27 +--- dojox/charting/DataChart.rst | 1 + dojox/collections.rst | 5 +- dojox/color.rst | 1 + dojox/color/Palette.rst | 1 + dojox/cometd.rst | 1 + dojox/data.rst | 3 +- dojox/data/AndOrReadStore.rst | 5 +- dojox/data/AndOrWriteStore.rst | 2 +- dojox/data/AppStore.rst | 11 +- dojox/data/AtomReadStore.rst | 7 +- dojox/data/ClientFilter.rst | 5 +- dojox/data/CouchDBRestStore.rst | 4 +- dojox/data/CssClassStore.rst | 6 +- dojox/data/CssRuleStore.rst | 6 +- dojox/data/CsvStore.rst | 6 +- dojox/data/FileStore.rst | 6 +- dojox/data/FileStore/protocol.rst | 2 +- dojox/data/FlickrRestStore.rst | 9 +- dojox/data/FlickrStore.rst | 4 +- dojox/data/GoogleBlogSearchStore.rst | 5 +- dojox/data/GoogleBookSearchStore.rst | 5 +- dojox/data/GoogleFeedStore.rst | 6 +- dojox/data/GoogleImageSearchStore.rst | 5 +- dojox/data/GoogleLocalSearchStore.rst | 5 +- dojox/data/GoogleNewsSearchStore.rst | 5 +- dojox/data/GoogleSearchStore.rst | 6 +- dojox/data/GoogleVideoSearchStore.rst | 5 +- dojox/data/GoogleWebSearchStore.rst | 5 +- dojox/data/HtmlStore.rst | 7 +- dojox/data/HtmlTableStore.rst | 5 +- dojox/data/JsonRestStore.rst | 10 +- dojox/data/KeyValueStore.rst | 5 +- dojox/data/OpenSearchStore.rst | 7 +- dojox/data/OpmlStore.rst | 5 +- dojox/data/PersevereStore.rst | 4 +- dojox/data/PicasaStore.rst | 4 +- dojox/data/QueryReadStore.rst | 6 +- dojox/data/QueryReadStore/example.rst | 1 + dojox/data/RailsStore.rst | 5 +- dojox/data/S3Store.rst | 3 +- dojox/data/ServiceStore.rst | 3 +- dojox/data/WikipediaStore.rst | 5 +- dojox/data/XmlStore-examples.rst | 1 + dojox/data/XmlStore.rst | 10 +- dojox/data/dom.rst | 3 +- dojox/data/google-stores.rst | 2 +- dojox/data/jsonPathStore.rst | 5 +- dojox/date.rst | 5 +- dojox/date/hebrew.rst | 5 +- dojox/date/islamic.rst | 5 +- dojox/date/relative.rst | 1 + dojox/drawing.rst | 1 + dojox/dtl.rst | 8 +- dojox/editor.rst | 3 +- dojox/editor/plugins.rst | 3 +- dojox/editor/plugins/AutoSave.rst | 11 +- dojox/editor/plugins/AutoUrlLink.rst | 7 +- dojox/editor/plugins/Blockquote.rst | 5 +- dojox/editor/plugins/Breadcrumb.rst | 6 +- dojox/editor/plugins/CollapsibleToolbar.rst | 6 +- dojox/editor/plugins/ColorTableCell.rst | 8 +- dojox/editor/plugins/FindReplace.rst | 8 +- dojox/editor/plugins/InsertAnchor.rst | 5 +- dojox/editor/plugins/InsertEntity.rst | 6 +- dojox/editor/plugins/LocalImage.rst | 11 +- .../editor/plugins/NormalizeIndentOutdent.rst | 5 +- dojox/editor/plugins/NormalizeStyle.rst | 5 +- dojox/editor/plugins/PageBreak.rst | 6 +- dojox/editor/plugins/PasteFromWord.rst | 5 +- dojox/editor/plugins/PrettyPrint.rst | 5 +- dojox/editor/plugins/Preview.rst | 6 +- dojox/editor/plugins/ResizeTableColumn.rst | 7 +- dojox/editor/plugins/SafePaste.rst | 5 +- dojox/editor/plugins/Save.rst | 6 +- dojox/editor/plugins/ShowBlockNodes.rst | 5 +- dojox/editor/plugins/SpellCheck.rst | 11 +- dojox/editor/plugins/StatusBar.rst | 5 +- dojox/editor/plugins/TablePlugins.rst | 2 +- dojox/editor/plugins/TextColor.rst | 6 +- dojox/editor/plugins/ToolbarLineBreak.rst | 7 +- dojox/embed.rst | 1 + dojox/embed/Flash.rst | 5 +- dojox/embed/Object.rst | 5 +- dojox/embed/Quicktime.rst | 5 +- dojox/encoding.rst | 1 + dojox/encoding/ascii85.rst | 5 +- dojox/encoding/base64.rst | 1 + dojox/encoding/bits.rst | 5 +- dojox/encoding/compression.rst | 5 +- dojox/encoding/crypto.rst | 1 + dojox/encoding/crypto/SimpleAES.rst | 1 + dojox/encoding/digests.rst | 1 + dojox/encoding/easy64.rst | 5 +- dojox/flash.rst | 5 +- dojox/form.rst | 2 +- dojox/form/BusyButton.rst | 4 +- dojox/form/CheckedMultiSelect.rst | 4 +- dojox/form/DateTextBox.rst | 6 +- dojox/form/DropDownSelect.rst | 5 +- dojox/form/DropDownStack.rst | 1 + dojox/form/FileInput.rst | 3 +- dojox/form/FilePickerTextBox.rst | 4 +- dojox/form/FileUploader.rst | 7 +- dojox/form/ListInput.rst | 4 +- dojox/form/Manager.rst | 4 +- dojox/form/MultiComboBox.rst | 4 +- dojox/form/PasswordValidator.rst | 4 +- dojox/form/RangeSlider.rst | 9 +- dojox/form/Rating.rst | 3 +- dojox/form/TimeSpinner.rst | 4 +- dojox/form/Uploader.rst | 6 +- dojox/form/ValidationTextarea.rst | 1 + dojox/form/manager/_ClassMixin.rst | 4 +- dojox/form/manager/_DisplayMixin.rst | 4 +- dojox/form/manager/_EnableMixin.rst | 4 +- dojox/form/manager/_FormMixin.rst | 4 +- dojox/form/manager/_Mixin.rst | 5 +- dojox/form/manager/_NodeMixin.rst | 4 +- dojox/form/manager/_ValueMixin.rst | 4 +- dojox/form/manager/index.rst | 4 +- dojox/form/uploader/FileList.rst | 2 +- dojox/fx/Timeline.rst | 1 + dojox/fx/ext-dojo/NodeList.rst | 1 + dojox/fx/ext-dojo/complex.rst | 1 + dojox/fx/ext-dojo/reverse.rst | 1 + dojox/fx/style.rst | 3 +- dojox/fx/wipeTo.rst | 1 + dojox/gantt.rst | 3 +- dojox/gauges.rst | 3 +- dojox/gauges/AnalogGauge.rst | 5 +- dojox/gauges/BarGauge.rst | 5 +- dojox/gauges/GlossyCircularGauge.rst | 4 +- dojox/gauges/GlossySemiCircularGauge.rst | 4 +- dojox/geo.rst | 1 + dojox/gesture.rst | 18 +-- dojox/gfx-geometric-properties.rst | 7 +- dojox/gfx-visual-properties.rst | 6 +- dojox/gfx.rst | 12 +- dojox/gfx/index.rst | 4 +- dojox/gfx/matrix-tutorial.rst | 1 + dojox/gfx/utils.rst | 2 +- dojox/gfx/utils/fromJson.rst | 4 +- dojox/gfx/utils/serialize.rst | 5 +- dojox/gfx/utils/toJson.rst | 4 +- dojox/gfx/utils/toSvg.rst | 4 +- dojox/gfx3d.rst | 1 + dojox/grid/DataGrid.rst | 11 +- dojox/grid/EnhancedGrid.rst | 8 +- dojox/grid/EnhancedGrid/plugins.rst | 3 +- dojox/grid/EnhancedGrid/plugins/CellMerge.rst | 14 +- dojox/grid/EnhancedGrid/plugins/Cookie.rst | 17 +-- dojox/grid/EnhancedGrid/plugins/DnD.rst | 30 ++--- dojox/grid/EnhancedGrid/plugins/Exporter.rst | 48 +++---- dojox/grid/EnhancedGrid/plugins/Filter.rst | 27 ++-- .../plugins/IndirectSelection.rst | 4 +- dojox/grid/EnhancedGrid/plugins/Menus.rst | 3 +- .../EnhancedGrid/plugins/NestedSorting.rst | 3 +- .../grid/EnhancedGrid/plugins/Pagination.rst | 15 +-- dojox/grid/EnhancedGrid/plugins/Printer.rst | 33 ++--- dojox/grid/EnhancedGrid/plugins/Search.rst | 14 +- dojox/grid/EnhancedGrid/plugins/Selector.rst | 36 ++--- dojox/grid/LazyTreeGrid.rst | 13 +- dojox/grid/TreeGrid.rst | 7 +- dojox/grid/griddate.rst | 6 +- dojox/grid/index.rst | 3 +- dojox/grid/pluginAPI.rst | 3 +- dojox/help.rst | 1 + dojox/highlight.rst | 1 + dojox/html/ellipsis.rst | 4 +- dojox/html/entities.rst | 5 +- dojox/html/entities/decode.rst | 3 +- dojox/html/entities/encode.rst | 3 +- dojox/html/format.rst | 5 +- dojox/html/set.rst | 8 +- dojox/image.rst | 3 +- dojox/image/Badge.rst | 5 +- dojox/image/FlickrBadge.rst | 8 +- dojox/image/Gallery.rst | 3 +- dojox/image/Lightbox.rst | 8 +- dojox/image/LightboxNano.rst | 12 +- dojox/image/Magnifier.rst | 4 +- dojox/image/MagnifierLite.rst | 11 +- dojox/image/SlideShow.rst | 4 +- dojox/image/ThumbnailPicker.rst | 4 +- dojox/index.rst | 1 + dojox/info.rst | 1 + dojox/io.rst | 2 +- dojox/io/OAuth.rst | 5 +- dojox/io/httpParse.rst | 5 +- dojox/io/scriptFrame.rst | 5 +- dojox/io/windowName.rst | 5 +- dojox/io/xhrMultiPart.rst | 5 +- dojox/io/xhrPlugins.rst | 5 +- dojox/io/xhrWindowNamePlugin.rst | 5 +- dojox/json.rst | 2 +- dojox/json/query.rst | 6 +- dojox/json/ref.rst | 4 +- dojox/json/schema.rst | 3 +- dojox/lang/aspect.rst | 2 +- dojox/lang/async.rst | 1 + dojox/lang/docs.rst | 4 +- dojox/lang/functional.rst | 2 +- dojox/lang/functional/object.rst | 2 +- dojox/lang/index.rst | 3 +- dojox/lang/observable.rst | 1 + dojox/lang/oo.rst | 1 + dojox/lang/typed.rst | 4 +- dojox/lang/utils.rst | 1 + dojox/layout.rst | 2 +- dojox/layout/ContentPane.rst | 5 +- dojox/layout/DragPane.rst | 5 +- dojox/layout/ExpandoPane.rst | 5 +- dojox/layout/FloatingPane.rst | 6 +- dojox/layout/GridContainer.rst | 5 +- dojox/layout/RadioGroup.rst | 5 +- dojox/layout/ResizeHandle.rst | 5 +- dojox/layout/RotatorContainer.rst | 8 +- dojox/layout/ScrollPane.rst | 5 +- dojox/layout/TableContainer.rst | 4 +- dojox/layout/ToggleSplitter.rst | 5 +- dojox/math.rst | 5 +- dojox/mdnd.rst | 4 +- dojox/mobile.rst | 6 +- dojox/mobile/Button.rst | 3 +- dojox/mobile/Carousel.rst | 4 +- dojox/mobile/CheckBox.rst | 3 +- dojox/mobile/ComboBox.rst | 3 +- dojox/mobile/ContentPane.rst | 2 +- dojox/mobile/EdgeToEdgeCategory.rst | 3 +- dojox/mobile/EdgeToEdgeDataList.rst | 3 +- dojox/mobile/EdgeToEdgeList.rst | 3 +- dojox/mobile/ExpandingTextArea.rst | 3 +- dojox/mobile/FixedSplitter.rst | 4 +- dojox/mobile/FixedSplitterPane.rst | 4 +- dojox/mobile/FlippableView.rst | 4 +- dojox/mobile/Heading.rst | 3 +- dojox/mobile/IconContainer.rst | 5 +- dojox/mobile/IconItem.rst | 3 +- dojox/mobile/ListItem.rst | 3 +- dojox/mobile/Opener.rst | 3 +- dojox/mobile/Overlay.rst | 3 +- dojox/mobile/PageIndicator.rst | 4 +- dojox/mobile/ProgressIndicator.rst | 5 +- dojox/mobile/RadioButton.rst | 3 +- dojox/mobile/RoundRect.rst | 3 +- dojox/mobile/RoundRectCategory.rst | 3 +- dojox/mobile/RoundRectDataList.rst | 3 +- dojox/mobile/RoundRectList.rst | 3 +- dojox/mobile/ScrollableView.rst | 4 +- dojox/mobile/Slider.rst | 3 +- dojox/mobile/SpinWheel.rst | 4 +- dojox/mobile/SpinWheelDatePicker.rst | 3 +- dojox/mobile/SpinWheelSlot.rst | 4 +- dojox/mobile/SpinWheelTimePicker.rst | 3 +- dojox/mobile/SwapView.rst | 4 +- dojox/mobile/Switch.rst | 3 +- dojox/mobile/TabBar.rst | 4 +- dojox/mobile/TabBarButton.rst | 4 +- dojox/mobile/TextArea.rst | 3 +- dojox/mobile/TextBox.rst | 3 +- dojox/mobile/ToggleButton.rst | 3 +- dojox/mobile/ToolBarButton.rst | 4 +- dojox/mobile/Tooltip.rst | 3 +- dojox/mobile/View.rst | 4 +- dojox/mobile/app.rst | 7 +- dojox/mobile/build.rst | 1 + dojox/mobile/cross-browser-support.rst | 2 +- dojox/mobile/differences-16-17.rst | 3 +- dojox/mobile/dynamic-content-loading.rst | 3 +- dojox/mobile/faq.rst | 4 +- dojox/mobile/internationalization.rst | 5 +- dojox/mobile/transition-events.rst | 3 +- dojox/mvc.rst | 5 +- dojox/mvc/Bind.rst | 5 +- dojox/mvc/Generate.rst | 3 +- dojox/mvc/Group.rst | 3 +- dojox/mvc/Output.rst | 4 +- dojox/mvc/Repeat.rst | 3 +- dojox/mvc/StatefulModel.rst | 4 +- dojox/mvc/_DataBindingMixin.rst | 4 +- dojox/off.rst | 1 + dojox/presentation.rst | 1 + dojox/resources.rst | 5 +- dojox/robot.rst | 1 + dojox/rpc.rst | 1 + dojox/rpc/OfflineRest.rst | 3 +- dojox/rpc/Rest.rst | 4 +- dojox/rpc/SMDLibrary.rst | 1 + dojox/rpc/Service.rst | 4 +- dojox/secure.rst | 3 +- dojox/secure/DOM.rst | 1 + dojox/secure/capability.rst | 1 + dojox/secure/index.rst | 3 +- dojox/secure/sandbox.rst | 1 + dojox/sql.rst | 5 +- dojox/storage.rst | 5 +- dojox/string.rst | 1 + dojox/string/Builder.rst | 1 + dojox/testing.rst | 5 +- dojox/timing.rst | 3 +- dojox/timing/doLater.rst | 2 +- dojox/uuid.rst | 1 + dojox/validate.rst | 1 + dojox/validate/br.rst | 5 +- dojox/widget/AnalogGauge.rst | 5 +- dojox/widget/AutoRotator.rst | 8 +- dojox/widget/BarGauge.rst | 5 +- dojox/widget/Calendar.rst | 6 +- dojox/widget/ColorPicker.rst | 5 +- dojox/widget/Dialog.rst | 6 +- dojox/widget/DialogSimple.rst | 3 +- dojox/widget/DynamicTooltip.rst | 5 +- dojox/widget/FilePicker.rst | 5 +- dojox/widget/FisheyeList.rst | 5 +- dojox/widget/FisheyeLite.rst | 5 +- dojox/widget/Loader.rst | 2 +- dojox/widget/Pager.rst | 5 +- dojox/widget/Portlet.rst | 5 +- dojox/widget/Rotator.rst | 9 +- dojox/widget/rotator/Controller.rst | 11 +- dojox/widget/rotator/Fade.rst | 4 +- dojox/widget/rotator/Pan.rst | 4 +- dojox/widget/rotator/Slide.rst | 4 +- dojox/widget/rotator/ThumbnailController.rst | 11 +- dojox/widget/rotator/Wipe.rst | 4 +- dojox/widget/rotator/index.rst | 2 +- dojox/wire.rst | 1 + dojox/xml.rst | 3 +- key-links.rst | 14 +- loader/legacy.rst | 4 +- quickstart/ajax.rst | 7 +- quickstart/arrays.rst | 8 +- quickstart/back.rst | 1 + quickstart/browser-sniffing.rst | 4 +- quickstart/cross-domain.rst | 5 +- quickstart/custom-builds.rst | 2 +- quickstart/data.rst | 2 +- quickstart/data/usingdatastores.rst | 2 +- quickstart/data/usingdatastores/faq.rst | 11 +- .../data/usingdatastores/fetchmultiple.rst | 5 +- .../data/usingdatastores/fetchsingle.rst | 2 +- .../data/usingdatastores/filteringitems.rst | 5 +- .../data/usingdatastores/lazyloading.rst | 4 +- .../data/usingdatastores/pagination.rst | 3 +- quickstart/data/usingdatastores/simple.rst | 2 +- quickstart/data/usingdatastores/sorting.rst | 3 +- .../data/usingdatastores/terminology.rst | 2 +- quickstart/debugging.rst | 1 + quickstart/doh.rst | 1 + quickstart/dojo-basics.rst | 9 +- quickstart/dom.rst | 9 +- quickstart/events.rst | 6 +- quickstart/gettingstarted.rst | 3 +- quickstart/helloworld.rst | 1 + quickstart/index.rst | 11 +- quickstart/install.rst | 4 +- quickstart/interfacedesign.rst | 4 +- .../bi-directional-text.rst | 1 + .../encoding-considerations.rst | 4 +- .../encoding-guidelines.rst | 5 +- .../globalization-guidelines/index.rst | 7 +- .../locale-and-resource-bundle-guidelines.rst | 9 +- quickstart/internationalization/index.rst | 1 + .../number-and-currency-formatting.rst | 4 +- .../resource-bundling.rst | 4 +- .../specifying-locale.rst | 5 +- quickstart/introduction/history.rst | 1 + quickstart/introduction/licensing.rst | 1 + quickstart/introduction/whydojo.rst | 1 + quickstart/layoutWidgetHierarchies.rst | 6 +- quickstart/module-returns.rst | 124 +++++------------- quickstart/multiversion.rst | 2 +- quickstart/numbersDates.rst | 1 + quickstart/oop.rst | 1 + quickstart/rest.rst | 5 +- quickstart/topics.rst | 1 + quickstart/widgetHierarchies.rst | 3 +- quickstart/writingWidgets.rst | 10 +- quickstart/writingWidgets/a11y.rst | 1 + quickstart/writingWidgets/a11yTesting.rst | 1 + quickstart/writingWidgets/example.rst | 1 + releasenotes/1.1.rst | 7 +- releasenotes/1.2.rst | 12 +- releasenotes/1.3.rst | 8 +- releasenotes/1.4.rst | 8 +- releasenotes/1.5.rst | 43 ++---- releasenotes/1.5_ja.rst | 42 ++---- releasenotes/1.6.rst | 8 +- releasenotes/1.7.rst | 9 +- releasenotes/1.8.rst | 8 +- todo.rst | 5 +- util/checkstyle.rst | 4 +- util/doctools.rst | 2 +- util/doctools/generate.rst | 6 +- util/doctools/markup.rst | 20 +-- util/doctools/viewer.rst | 8 +- util/doh.rst | 5 +- util/dohrobot.rst | 9 +- util/shrinksafe/index.rst | 6 +- 741 files changed, 926 insertions(+), 2791 deletions(-) diff --git a/build/buildScript.rst b/build/buildScript.rst index 80336152c..5cdd529e2 100644 --- a/build/buildScript.rst +++ b/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 ======== diff --git a/build/buildSystem.rst b/build/buildSystem.rst index 57902fcba..e64cc0836 100644 --- a/build/buildSystem.rst +++ b/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 `. *See* :ref:`The Dojo Build System ` *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 `. -======================== -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 `: 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 =========================================== diff --git a/build/customBase.rst b/build/customBase.rst index 598f2f112..55f49168c 100644 --- a/build/customBase.rst +++ b/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 ================ diff --git a/build/directoryLayout.rst b/build/directoryLayout.rst index 95b700213..37073269e 100644 --- a/build/directoryLayout.rst +++ b/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 ================ diff --git a/build/exclude.rst b/build/exclude.rst index e05696750..963dc0cf9 100644 --- a/build/exclude.rst +++ b/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 ======== diff --git a/build/expand-provide.rst b/build/expand-provide.rst index 3e766136b..17cdc89c2 100644 --- a/build/expand-provide.rst +++ b/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 ` calls within your code into faster javascript equivalents, avoiding expensive lookups through :ref:`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 ===== diff --git a/build/index.rst b/build/index.rst index 249444eb2..07d234ca3 100644 --- a/build/index.rst +++ b/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 ` A quick reference manual for all build system switches and knobs. -================================== Deployment Optimization Transforms ================================== @@ -88,7 +87,6 @@ for complete documentation. :ref:`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 ========================================== diff --git a/build/keepRequires.rst b/build/keepRequires.rst index f0bf4e771..24c1dbc3a 100644 --- a/build/keepRequires.rst +++ b/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 ======== diff --git a/build/localizationExample.rst b/build/localizationExample.rst index f683f464c..922cba90b 100644 --- a/build/localizationExample.rst +++ b/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 ====================== diff --git a/build/profileQRef.rst b/build/profileQRef.rst index 9aefa6b4f..df325cbb6 100644 --- a/build/profileQRef.rst +++ b/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 ========================== diff --git a/build/profiles.rst b/build/profiles.rst index 1df81544c..771bd8ac6 100644 --- a/build/profiles.rst +++ b/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 `. -======== 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 ======== diff --git a/build/qref.rst b/build/qref.rst index 210b1b53a..7f3b3535f 100644 --- a/build/qref.rst +++ b/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 `: 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 ========================== diff --git a/build/scenario-base.rst b/build/scenario-base.rst index 62d689fee..0c4fe7afc 100644 --- a/build/scenario-base.rst +++ b/build/scenario-base.rst @@ -1,5 +1,6 @@ .. _build/scenario-base: +============================ Building a Base-only dojo.js ============================ diff --git a/build/scenario-micro.rst b/build/scenario-micro.rst index 36f5f464f..bfcdb1bd9 100644 --- a/build/scenario-micro.rst +++ b/build/scenario-micro.rst @@ -1,5 +1,6 @@ .. _build/scenario-micro: +======================= A CustomBase Dojo Build ======================= diff --git a/build/scenario-release.rst b/build/scenario-release.rst index 2782c39ad..43b9b218f 100644 --- a/build/scenario-release.rst +++ b/build/scenario-release.rst @@ -1,5 +1,6 @@ .. _build/scenario-release: +=========================== Building a standard release =========================== diff --git a/build/scenario-xDomain.rst b/build/scenario-xDomain.rst index a03059bdd..15385f0aa 100644 --- a/build/scenario-xDomain.rst +++ b/build/scenario-xDomain.rst @@ -1,5 +1,6 @@ .. _build/scenario-xDomain: +========================= Building an x-domain Dojo ========================= diff --git a/build/simpleExample.rst b/build/simpleExample.rst index 92dadfa7e..aba0148e1 100644 --- a/build/simpleExample.rst +++ b/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 `. 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 ======== diff --git a/build/transforms/copy.rst b/build/transforms/copy.rst index 556c406ba..052f8dfc1 100644 --- a/build/transforms/copy.rst +++ b/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 =============== diff --git a/build/transforms/depsDump.rst b/build/transforms/depsDump.rst index 5c7be8b8c..14770d2c1 100644 --- a/build/transforms/depsDump.rst +++ b/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 =============== diff --git a/build/transforms/depsScan.rst b/build/transforms/depsScan.rst index 31875f555..2fb5bed1e 100644 --- a/build/transforms/depsScan.rst +++ b/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 =============== diff --git a/build/transforms/dojoPragmas.rst b/build/transforms/dojoPragmas.rst index c405279bf..44843d47b 100644 --- a/build/transforms/dojoPragmas.rst +++ b/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 =============== diff --git a/build/transforms/hasFindAll.rst b/build/transforms/hasFindAll.rst index bccc3fa66..aead107ad 100644 --- a/build/transforms/hasFindAll.rst +++ b/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 =============== diff --git a/build/transforms/hasFixup.rst b/build/transforms/hasFixup.rst index 3e792a569..2d00f0282 100644 --- a/build/transforms/hasFixup.rst +++ b/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 =============== diff --git a/build/transforms/write.rst b/build/transforms/write.rst index 0ed5ddd70..c84b431ed 100644 --- a/build/transforms/write.rst +++ b/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 =============== diff --git a/build/transforms/writeAmd.rst b/build/transforms/writeAmd.rst index ccd7576ea..57230701d 100644 --- a/build/transforms/writeAmd.rst +++ b/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 =============== diff --git a/build/transforms/writeDojo.rst b/build/transforms/writeDojo.rst index 9072df9b8..a1425da61 100644 --- a/build/transforms/writeDojo.rst +++ b/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 =============== diff --git a/build/transforms/writeOptimized.rst b/build/transforms/writeOptimized.rst index 07c307c5d..e88609f06 100644 --- a/build/transforms/writeOptimized.rst +++ b/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 =============== diff --git a/build/webkit-mobile.rst b/build/webkit-mobile.rst index 575817a1b..1752a0af3 100644 --- a/build/webkit-mobile.rst +++ b/build/webkit-mobile.rst @@ -1,5 +1,6 @@ .. _build/webkit-mobile: +=================================== Special Dojo Build: WebKit Mobile =================================== diff --git a/build/xDomain.rst b/build/xDomain.rst index 257c69b0a..ee3641f2a 100644 --- a/build/xDomain.rst +++ b/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 `_ showing how to load local modules along with an xdomain-loaded Dojo and Dijit. You can `download this example `_. -======== See also ======== diff --git a/developer/a11y-requirements.rst b/developer/a11y-requirements.rst index 2e4528853..c8e702db3 100644 --- a/developer/a11y-requirements.rst +++ b/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 `_ -====== 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 `_. 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 ========== diff --git a/developer/bugs.rst b/developer/bugs.rst index 39d7c1c75..1b7a55691 100644 --- a/developer/bugs.rst +++ b/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 `_ uses the LDAP information from the overall `Dojo Foundation `_. `Register for a Dojo Foundation account `_ 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 =============== diff --git a/developer/contributors.rst b/developer/contributors.rst index a978d83c7..a3c0b2189 100644 --- a/developer/contributors.rst +++ b/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 ================================================= diff --git a/developer/index.rst b/developer/index.rst index 4b3dc8d8f..d08c99094 100644 --- a/developer/index.rst +++ b/developer/index.rst @@ -1,5 +1,6 @@ .. _developer/index: +======================= Dojo Developer Notebook ======================= diff --git a/developer/projects.rst b/developer/projects.rst index 83763082d..d522db777 100644 --- a/developer/projects.rst +++ b/developer/projects.rst @@ -1,5 +1,6 @@ .. _developer/projects: +=============== Future Projects =============== diff --git a/developer/rules.rst b/developer/rules.rst index edcaf225e..fb2a7a935 100644 --- a/developer/rules.rst +++ b/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 `, 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. diff --git a/developer/styleguide.rst b/developer/styleguide.rst index d0c24c69d..e6d8fbb30 100644 --- a/developer/styleguide.rst +++ b/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 ` 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 ============= diff --git a/developer/svn.rst b/developer/svn.rst index e2873d9e2..db0d7711e 100644 --- a/developer/svn.rst +++ b/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 `_. -=================== 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: diff --git a/dijit/Calendar.rst b/dijit/Calendar.rst index e0435d9dd..e6bab959c 100644 --- a/dijit/Calendar.rst +++ b/dijit/Calendar.rst @@ -1,5 +1,6 @@ .. _dijit/Calendar: +=============== dijit.Calendar =============== @@ -18,7 +19,6 @@ The Calendar widget has been supported as a standalone widget since version 1.4. Non-Gregorian calendar use is possible using the datePackage attribute and experimental date classes in :ref:`dojox.date `. -======== Examples ======== @@ -244,21 +244,18 @@ With a local custom template to change the layout (does not work against CDN) } -==== Note ==== dijit._Calendar was upgraded to dijit.Calendar in version 1.4. An alias is provided for backwards compatibility. -======== See Also ======== * :ref:`dojox.widget.Calendar ` - An enhanced but still experimental calendar widget which has additional capabilities like year-only views and animation effects. -============= Accessibility ============= @@ -267,8 +264,7 @@ As of 1.6 full keyboard support has been implemented for the Calendar. Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate between date cells Left, Right, Up, and down arrows Navigate to same day in next month Page-down diff --git a/dijit/CalendarLite.rst b/dijit/CalendarLite.rst index 5bfae2f68..786ae995c 100644 --- a/dijit/CalendarLite.rst +++ b/dijit/CalendarLite.rst @@ -1,5 +1,6 @@ .. _dijit/CalendarLite: +================== dijit.CalendarLite ================== @@ -10,7 +11,6 @@ The CalendarLite widget is like the :ref:`dijit.Calendar ` widge In particular it's missing the drop down to display the list of months, and the _CSSStateMixin needed for getting hover CSS effects on older versions of IE. -======== Examples ======== @@ -33,7 +33,6 @@ A plain Calendar widget with the formatted date below

-======== See Also ======== diff --git a/dijit/CheckedMenuItem.rst b/dijit/CheckedMenuItem.rst index 7d037d962..49069cecc 100644 --- a/dijit/CheckedMenuItem.rst +++ b/dijit/CheckedMenuItem.rst @@ -138,8 +138,7 @@ Accessibility Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate to menu item Up and down arrow keys check/uncheck menu item Spacebar or enter diff --git a/dijit/ColorPalette.rst b/dijit/ColorPalette.rst index 7fc77a4f4..2b5ac9d8e 100644 --- a/dijit/ColorPalette.rst +++ b/dijit/ColorPalette.rst @@ -1,5 +1,6 @@ .. _dijit/ColorPalette: +================== dijit.ColorPalette ================== @@ -12,7 +13,6 @@ dijit.ColorPalette dijit.ColorPalette is a great little tool which provides a color picker for you to use in your application. The color palette size is definable. In addition, the color palette is accessible through screen readers as well as keyboard. The widget also supports the 'standard' dijit function *onChange*, which signals when a new selection was made from the palette. -============================== Widget Construction Parameters ============================== @@ -25,13 +25,11 @@ Widget Construction Parameters | |**optional** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -============= Return Values ============= As with all dijit widgets, the selected value can be obtained through the widget *attr("value")* function. The return type is an instance of :ref:`dojo.Color `. -======== Examples ======== @@ -76,15 +74,13 @@ Small color palette, created declaratively:
-============= Accessibility ============= Keyboard -------- -=============== =================== -Action Key +=============== Action Key =============== =================== Navigate colors Arrow keys Pick a color Spacebar or enter diff --git a/dijit/Declaration.rst b/dijit/Declaration.rst index 136188fcc..a38965ffd 100644 --- a/dijit/Declaration.rst +++ b/dijit/Declaration.rst @@ -1,5 +1,6 @@ .. _dijit/Declaration: +================= dijit.Declaration ================= @@ -12,13 +13,11 @@ dijit.Declaration Declares a widget from markup. -============ Introduction ============ Just as there are two ways to create a widget instances - declarative and programmatic - so there are two ways to declare a Dijit class (i.e., a type of widget). As you might guess, the declarative way is slightly easier. -===== Usage ===== To declare your class declaratively, use dijit.Declaration. Uhhhh, OK, too many "declare"s in that sentence. It's easier to show than to tell. @@ -129,7 +128,6 @@ Every widget declared with class simpleConnectedWidget will have the handler con Note that dojo/connect is not suitable for methods that need to return a value. -===== Notes ===== - widgetsInTemplate is automatically set to true, so any widgets you place in the template will be automatically filled in. diff --git a/dijit/Dialog.rst b/dijit/Dialog.rst index ad2a75a65..a2bd2ab7d 100644 --- a/dijit/Dialog.rst +++ b/dijit/Dialog.rst @@ -450,8 +450,7 @@ Accessibility Keyboard -------- -==================================================== ================================================= -Action Key +==================================================== Action Key ==================================================== ================================================= Navigate to next focusable element in the dialog tab Navigate to previous focusable element in the dialog shift-tab diff --git a/dijit/Editor.rst b/dijit/Editor.rst index db949dcce..76e66fbee 100644 --- a/dijit/Editor.rst +++ b/dijit/Editor.rst @@ -1,5 +1,6 @@ .. _dijit/Editor: +============ dijit.Editor ============ @@ -12,7 +13,6 @@ dijit.Editor Dijit's Rich Text editor, Dijit.Editor, is a text box on steroids. Designed to look and work like a word processor. The editor features a toolbar, HTML output, and a plugin architecture that supports new commands, new buttons and other new features. -======== Features ======== @@ -22,7 +22,6 @@ Features * Built-in filtering support. The editor provides hooks to register HTML and DOM filters with the editor, to pre and post process data going in, or coming out of, the document being edited. * Pluggable architecture. The editor's functionality can be extended by implementing and registering plugins with the editor. In fact, all the base commands of editor are effectively plugins. The plugin architecture makes it relatively easy to add new buttons and actions to the toolbar, to being 'headless', where it simply registers filters or augments existing actions. -=========== Limitations =========== @@ -48,7 +47,6 @@ Limitations * All browsers implement some of the underlying commands differently and may generate different markup, so do not expect identical markup out of each browser. All markup generated by any browser should render 'equivalently'. -======== Examples ======== @@ -106,7 +104,6 @@ Of course the toolbar can be reordered and customized to suit your layout needs. -======= Plugins ======= @@ -168,7 +165,6 @@ This example starts from scratch, thus removing some items from the toolbar (as -================ Builtin Commands ================ @@ -241,7 +237,6 @@ This is a list of the default commands (plugins) supported by the editor as buil | delete |Delete the currently selected text. | +------------------------------+-----------------------------------------------------------------------------------------------------+ -========================= Additional Editor Plugins ========================= @@ -253,7 +248,6 @@ DojoX (Dojo eXtensions) contains even more plugins for improving the capabilitie These are functions that were deemed 'less common' requirements and were therefore put in the extensions namespace. Please refer to the :ref:`dojox.editor.plugins ` page for more information about them. -===================== Auto-expanding editor ===================== @@ -286,15 +280,13 @@ The AlwaysShowToolbar plugin prevents that. It's used along with setting height -====================================== Accessibility (1.0 and later versions) ====================================== Keyboard for Editor ------------------- -==================================================================== ====================================================================== -Action Key +==================================================================== Action Key ==================================================================== ====================================================================== Move focus to the next widget in the tab order. Tab (must press tab twice in some situations - see Known Issues below) Move focus to the prior widget in the tab order (the editor toolbar) Shift+Tab (must press shift-tab twice in some situations - see Known Issues below) @@ -304,8 +296,7 @@ Move focus to the prior widget in the tab order (the editor toolbar) Shift+Tab ( Keyboard for Editor Toolbar --------------------------- -==================================================================== ====================================================================== -Action Key +==================================================================== Action Key ==================================================================== ====================================================================== Move focus to the next enabled button in the toolbar. arrow right in left to right locales, arrow left in right to left locales Move focus to the previous widget in the toolbar arrow left in left to right locales; arrow right in right to left locales. diff --git a/dijit/InlineEditBox.rst b/dijit/InlineEditBox.rst index 1c7c8c3c5..ef5203aa0 100644 --- a/dijit/InlineEditBox.rst +++ b/dijit/InlineEditBox.rst @@ -1,5 +1,6 @@ .. _dijit/InlineEditBox: +=================== dijit.InlineEditBox =================== @@ -12,7 +13,6 @@ dijit.InlineEditBox InlineEditBox is best described as a behavior on some text on the page, such that clicking that text brings up an editor, and when the text is saved, the screen is reverted to it's original state (but with the new text). The editor is created on-demand, so as to not slow down page load. -========================== Programmatic InlineEditBox ========================== @@ -43,7 +43,6 @@ Programmatic InlineEditBox Note that it was created with autoSave=false to make save/cancel buttons appear. Otherwise, the return key will end the edit, which is not appropriate for a multi-line edit. -====== Markup ====== @@ -62,7 +61,6 @@ Creation from markup is even easier. Here's an example with an initial value. 15 -=================== Initial blank value =================== @@ -83,7 +81,6 @@ Note also that the width argument is important so to indicate the editors width, -================ Rich Text Editor ================ @@ -111,7 +108,6 @@ To make the editor's initial size match the size the readonly text (ie, the size
-============= Notes on i18n ============= @@ -119,7 +115,6 @@ Note that the web server is responsible for the initial formatting of the data. For example, if you are display a large number, it would be formatted as 123,456,789.55 in the United States but as 123.456.789,00 in some European countries. InlineEditBox expects the number to be formatted in the page's locale and will fail if it can't parse it according to that locale. -============= Accessibility ============= @@ -134,8 +129,7 @@ Keyboard Widget is closed (not being edited) -============================================== ================================================= -Action Key +============================================== Action Key ============================================== ================================================= Navigate to the next widget in the tab order. Tab Navigate to the prior widget in the tab order. Shift+Tab diff --git a/dijit/Menu.rst b/dijit/Menu.rst index d590bc737..d1ff44511 100644 --- a/dijit/Menu.rst +++ b/dijit/Menu.rst @@ -1,5 +1,6 @@ .. _dijit/Menu: +========== dijit.Menu ========== @@ -12,7 +13,6 @@ dijit.Menu A Menu widget -============ Introduction ============ @@ -25,7 +25,6 @@ The Menu widget is used for three types of menus: MenuItem widgets are the actual items in the menu. The PopupMenuItem is like a MenuItem, but displays a submenu or other widget to the right. A PopupMenuItem always has two child nodes: a tag with the displayed label (usually in a SPAN tag), and a widget to be popped up, typically a dijit.Menu widget. -======== Examples ======== @@ -159,15 +158,13 @@ Usage to display a Menu statically is the same as context menus, except that you -============= Accessibility ============= Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Open a context menu On Windows: shift-f10 or the Windows context menu key. @@ -190,7 +187,6 @@ Known Issues When reading a menu item on Firefox 2, JAWS 8 may say "submenu" for an item that does not have a submenu. This will be fixed in Firefox 3. -==================== Implementation Notes ==================== diff --git a/dijit/MenuBar.rst b/dijit/MenuBar.rst index 60b886923..d4c461572 100644 --- a/dijit/MenuBar.rst +++ b/dijit/MenuBar.rst @@ -1,5 +1,6 @@ .. _dijit/MenuBar: +============= dijit.MenuBar ============= @@ -11,7 +12,6 @@ dijit.MenuBar The MenuBar widget models a typical menu bar like the quintessential "File" menu on (virtually?) all programs. -============ Introduction ============ @@ -20,7 +20,6 @@ PopupMenuBarItem widgets are the actual items in the menu, and like PopupMenuIte There's also a MenuBarItem widget if you need an entry in your MenuBar that *doesn't* have a drop down. -======== Examples ======== @@ -114,15 +113,13 @@ Creation from markup is even easier. -============= Accessibility ============= Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate into/out of a MenuBar Tab or shift-tab Navigate menubar items Left and right arrow keys @@ -132,7 +129,6 @@ Close a submenu Esc, or use right arrow to navigat ========================================== ================================================= -======== See also ======== diff --git a/dijit/MenuBarItem.rst b/dijit/MenuBarItem.rst index b0fc42823..97452cbde 100644 --- a/dijit/MenuBarItem.rst +++ b/dijit/MenuBarItem.rst @@ -69,8 +69,7 @@ Accessibility Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate menu bar items Left and right arrow keys Activate a menu item Spacebar or enter diff --git a/dijit/MenuItem.rst b/dijit/MenuItem.rst index 24a0f5b1e..13cd91355 100644 --- a/dijit/MenuItem.rst +++ b/dijit/MenuItem.rst @@ -73,8 +73,7 @@ Accessibility Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate menu items Top and Down arrow keys Activate a menu item Spacebar or enter diff --git a/dijit/ProgressBar.rst b/dijit/ProgressBar.rst index 3a36f37a6..cf39b633b 100644 --- a/dijit/ProgressBar.rst +++ b/dijit/ProgressBar.rst @@ -1,12 +1,12 @@ .. _dijit/ProgressBar: +================= dijit.ProgressBar ================= A ProgressBar gives dynamic feedback on the progress of a long-running operation. The progress can be updated by JavaScript function calls. This method works best for long-running JavaScript operations, or a series of JavaScript XHR calls to the server. -======== Examples ======== @@ -38,7 +38,6 @@ Declarative markup
-============= Accessibility ============= diff --git a/dijit/TitlePane.rst b/dijit/TitlePane.rst index c24ea231d..0ba01b915 100644 --- a/dijit/TitlePane.rst +++ b/dijit/TitlePane.rst @@ -1,5 +1,6 @@ .. _dijit/TitlePane: +=============== dijit.TitlePane =============== @@ -10,21 +11,18 @@ dijit.TitlePane :depth: 2 -============ Introduction ============ A TitlePane is a pane that can be opened or collapsed, with a title on top. The visibility of the pane's contents is toggled by activating an arrow "button" on the title bar via the mouse or keyboard. It extends :ref:`ContentPane ` but since it isn't used inside other layout widgets it's not in the dijit.layout module. -===== Usage ===== The constructor for TitlePane takes the following possible parameters in its keyword arguments: -========= ================================== ================================================== -Parameter Type Description +========= ================================== Parameter Type Description ========= ================================== ================================================== title String The title to be displayed in the pane header. The default is an empty string. content DomNode | NodeList | dijit._Widget The content (innerHTML) to be displayed in the pane. @@ -32,7 +30,6 @@ open Boolean Boolean option whether or not to ========= ================================== ================================================== -======== Examples ======== @@ -109,7 +106,6 @@ For example: -============= Accessibility ============= @@ -118,8 +114,7 @@ Keyboard Each title pane title is included in the tab order of the document. -=================================== ===================================================== -Action Key +=================================== Action Key =================================== ===================================================== toggle open/close of the title pane enter or space key with focus on the title pane title Navigate into an opened title pane tab diff --git a/dijit/Toolbar.rst b/dijit/Toolbar.rst index c2507b3d5..f7da5d107 100644 --- a/dijit/Toolbar.rst +++ b/dijit/Toolbar.rst @@ -1,5 +1,6 @@ .. _dijit/Toolbar: +============= dijit.Toolbar ============= @@ -10,14 +11,12 @@ dijit.Toolbar :depth: 2 -============ Introduction ============ Just as dijit.Menu is a container for dijit.MenuItem's, so dijit.Toolbar is a container for buttons. Any button-based Dijit component can be placed on the toolbar, including ComboButtons and DropdownButtons. -======== Examples ======== @@ -88,7 +87,6 @@ Creation from markup is even easier. -========== Drop Downs ========== @@ -126,7 +124,6 @@ By using :ref:`dijit.form.DropDownButton ` and :ref:` (The icons are no good but hopefully convey the idea.) -============= Accessibility ============= @@ -135,10 +132,8 @@ Note the use of showLabel="false" above. We've specified a label but then hidden Keyboard -------- -=========================================== ========================== -Action Key -=========================================== ========================== -Move focus between widgets in the toolbar Left and right arrow keys +=========================================== Action Key +=========================================== Move focus between widgets in the toolbar Left and right arrow keys =========================================== ========================== Known Issues @@ -146,7 +141,6 @@ Known Issues In high contrast mode when a toggle button is checked an html entity character (✓) is displayed since the CSS background image icon for the checked state is no longer visible. When the toggle button is part of a toolbar the checkmark character does not display properly in IE6. In IE6 with high contrast mode turned on, a checked toggle button in a toolbar displays as two vertical bars rather than the checkmark character. -======== See also ======== diff --git a/dijit/Tooltip.rst b/dijit/Tooltip.rst index d12183088..c13ebf297 100644 --- a/dijit/Tooltip.rst +++ b/dijit/Tooltip.rst @@ -1,5 +1,6 @@ .. _dijit/Tooltip: +============= dijit.Tooltip ============= @@ -10,7 +11,6 @@ dijit.Tooltip .. contents:: :depth: 2 -============ Introduction ============ @@ -19,7 +19,6 @@ Tooltip is similar to the title="" attribute in regular HTML, but is much more f Note that if you want your tooltip to contain a form or something that the user clicks on / focuses on, you should use the :ref:`dijit.TooltipDialog ` instead. -===== Usage ===== @@ -33,8 +32,7 @@ Usage }); -========= ========================= ============================================================================= -Parameter Type Description +========= ========================= Parameter Type Description ========= ========================= ============================================================================= connectId Array of Strings|DomNodes Id's of domNodes to attach the tooltip to. When user hovers over any of the specified dom nodes, the tooltip will appear. Note: Currently connectId can only be specified on initialization, it cannot be changed via attr('connectId', ...). Note: in 2.0 this will be renamed to connectIds for less confusion. Note: functions addTarget and removeTarget have been added to allow dynamic registration/deregistration of connected ids. label String Text to display in the tooltip. Specified as innerHTML when creating the widget from markup. @@ -50,7 +48,6 @@ position Array of Strings This variable controls the position of too showDelay Integer Number of milliseconds to wait after hovering over/focusing on the object, before the tooltip is displayed (default = 400). ========= ========================= ============================================================================= -======== Examples ======== @@ -137,7 +134,6 @@ And here's a tooltip created from markup connected to a :ref:`dijit.form.Button -=================== Tooltip Positioning =================== @@ -146,7 +142,6 @@ You can control the search path for positions via a global setting like: dijit.Tooltip.defaultPosition = ["above", "below"]; -============= Accessibility ============= @@ -159,7 +154,6 @@ When using Firefox 2 with JAWS 9, the tooltip text is spoken twice. This has bee Tooltips are not spoken in IE 8 with JAWS 10. This is because Dijit Tooltips are implemented using the ARIA alert role and IE 8 does not support that role. A ticket (http://bugs.dojotoolkit.org/ticket/3957) has been filed to modify Dijit Tooltips to use the ARIA tooltip role since that role is now supported in Firefox 3 and IE 8 -======== See also ======== diff --git a/dijit/TooltipDialog.rst b/dijit/TooltipDialog.rst index 1dcc20ddf..eb8309771 100644 --- a/dijit/TooltipDialog.rst +++ b/dijit/TooltipDialog.rst @@ -1,5 +1,6 @@ .. _dijit/TooltipDialog: +=================== dijit.TooltipDialog =================== @@ -12,7 +13,6 @@ dijit.TooltipDialog A variant on Dialog Box is dijit.TooltipDialog. -============ Introduction ============ @@ -23,7 +23,6 @@ Although both Dialog and TooltipDialog are modal, TooltipDialog can be closed by A TooltipDialog can only be opened as a drop down from another widget, usually `dijit.form.DropDownButton`. -======== Examples ======== @@ -128,15 +127,13 @@ Here's one displaying a TooltipDialog: -============= Accessibility ============= Keyboard -------- -============================================================ ================================================= -Action Key +============================================================ Action Key ============================================================ ================================================= Navigate to next focusable element in the tooltip dialog tab Navigate to previous focusable element in the tooltip dialog shift-tab diff --git a/dijit/Tree-examples.rst b/dijit/Tree-examples.rst index 8f1586d14..c5e82fa93 100644 --- a/dijit/Tree-examples.rst +++ b/dijit/Tree-examples.rst @@ -1,5 +1,6 @@ .. _dijit/Tree-examples: +=================== dijit.Tree examples =================== diff --git a/dijit/Tree.rst b/dijit/Tree.rst index cad88315e..5ea7120f4 100644 --- a/dijit/Tree.rst +++ b/dijit/Tree.rst @@ -1,5 +1,6 @@ .. _dijit/Tree: +========== dijit.Tree ========== @@ -23,7 +24,6 @@ Dojo makes easy trees easy, and hard trees possible. In particular, you can: * Drag and drop onto the tree, which updates the data store indirectly -============================= Components Involved In A Tree ============================= @@ -68,7 +68,6 @@ Data Store --> Model --> Tree That gets more complicated when we think about drag & drop, but we'll address that later. -===================== A Simple Tree Example ===================== @@ -142,7 +141,6 @@ A markup tree -===== Icons ===== @@ -193,7 +191,6 @@ to return a separate class name based on the type of item: -========================= Hiding a Tree's root node ========================= @@ -226,7 +223,6 @@ Sometimes you don't want that "the world" top level node to show up, especially Note that you can hide or show the root item regardless of whether that root item is fabricated or corresponds to a real item in the store. -=============== Updating a Tree =============== @@ -240,13 +236,11 @@ You can't update the tree directly, but rather you need to update the model. U This isn't supported. The store needs to notify the tree of any changes to the data. Currently this is really only supported (out of the box) by :ref:`dojo.data.ItemFileWriteStore `, as setting up a client-server dojo.data source where the server notifies the client whenever the data has changed is quite complicated, and beyond the scope of dojo, which is a client-only solution. -=================== Lazy Loading A Tree =================== People often ask how to lazy-load a tree, but this question is really unrelated to the Tree itself. If you use a data store that is lazy loading, such as :ref:`dojox.data.QueryReadStore ` or :ref:`dojox.data.JsonRestStore `, then the data will be loaded lazily. -============= Drag And Drop ============= @@ -348,7 +342,6 @@ What happens when a user moves an item from one position in a tree to another? In this way, the Tree, Model, and data store are always in sync. -============ Context Menu ============ @@ -404,7 +397,6 @@ Tree has no built-in support for context menus, but you can use the Menu widget -======= Styling ======= @@ -451,7 +443,6 @@ You can also remove the hover effect altogether by just writing a CSS rule that On the claro theme, the hover effect is done via a background-color (combined with a white gradient background image), so changing the hover effect just involves changing that background color. -============= Miscellaneous ============= @@ -459,22 +450,19 @@ Persistence ----------- By default, a Tree will remember which branches were opened/closed. To use this feature you must specify an id for the Tree. To disable the feature, set the "persist" parameter to false. -============= More examples ============= There are :ref:`more extensive examples ` of using the tree -============= Accessibility ============= Keyboard -------- -=================================== =============== -Action Key +=================================== Action Key =================================== =============== Navigate into tree* Tab Navigate to the next sibling Down arrow diff --git a/dijit/WidgetSet.rst b/dijit/WidgetSet.rst index ae7e1b6e8..a569f4e08 100644 --- a/dijit/WidgetSet.rst +++ b/dijit/WidgetSet.rst @@ -1,5 +1,6 @@ .. _dijit/WidgetSet: +=============== dijit.WidgetSet =============== @@ -12,13 +13,11 @@ dijit.WidgetSet A dijit.WidgetSet is a collection of Dijit widgets. It can be used for bulk operation and control of groups of widgets. In Dojo 1.7, including dijit.WidgetSet will add Array-like functions to the main :ref:`dijit/registry` object as well for backwards-compatibility; this behaviour will be removed in Dojo 2.0. -============ Introduction ============ dijit.WidgetSet works similarly to a dojo.NodeList, treating the list of widgets as a pseudo-array and allowing common Array-like functions to iterate through the list. -===== Usage ===== @@ -100,7 +99,6 @@ Inspecting how many widgets are in a WidgetSet // there are Dialog widgets in this set } -============== Other examples ============== @@ -131,7 +129,6 @@ Validating all widgets in a WidgetSet // didn't pass the test } -======== See also ======== diff --git a/dijit/_CssStateMixin.rst b/dijit/_CssStateMixin.rst index 08554d403..e351d07e8 100644 --- a/dijit/_CssStateMixin.rst +++ b/dijit/_CssStateMixin.rst @@ -1,5 +1,6 @@ .. _dijit/_CssStateMixin: +==================== dijit._CssStateMixin ==================== @@ -10,7 +11,6 @@ dijit._CssStateMixin .. contents:: :depth: 2 -============ Introduction ============ @@ -22,7 +22,6 @@ _CssStateMixin serves two functions: - for the semantic state updating (disabled, checked, selected, etc.) -======== Examples ======== @@ -30,7 +29,6 @@ _CssStateMixin will, fox example, set classes dijitCheckboxHover if a checkbox i More complicated widgets also set class names on sub nodes when they are hovered/pressed/focused. For example, the Slider widget has hover and active effects on the left/right arrows and the slider handle itself. -===== Usage ===== diff --git a/dijit/_FocusMixin.rst b/dijit/_FocusMixin.rst index d360383a8..9f3de9c42 100644 --- a/dijit/_FocusMixin.rst +++ b/dijit/_FocusMixin.rst @@ -1,5 +1,6 @@ .. _dijit/_FocusMixin: +===================== dijit._FocusMixin ===================== @@ -11,7 +12,6 @@ dijit._FocusMixin :depth: 2 -============ Introduction ============ @@ -21,7 +21,6 @@ See the :ref:`dijit.focus ` documentation for details on the active Note that the underscore in the name implies not that _FocusMixin is a private class, but rather that it's a mixin, rather than a widget. -===== Usage ===== diff --git a/dijit/_HasDropDown.rst b/dijit/_HasDropDown.rst index 2d051e937..24c425c57 100644 --- a/dijit/_HasDropDown.rst +++ b/dijit/_HasDropDown.rst @@ -1,5 +1,6 @@ .. _dijit/_HasDropDown: +================== dijit/_HasDropDown ================== @@ -11,13 +12,11 @@ dijit/_HasDropDown .. contents:: :depth: 2 -============ Introduction ============ dijit/_HasDropDown is a dijit Widget mixin that provides drop-down menu functionality. Widgets like :ref:`dijit/form/Select `, :ref:`dijit/form/ComboBox `, :ref:`dijit/form/DropDownButton `, and :ref:`dijit/form/DateTextBox ` all use dijit/_HasDropDown to implement their drop-down functionality. -===== Usage ===== @@ -44,7 +43,6 @@ Then, either set the value of :ref:``HasDropDown.dropDown`` to an existing widge Or, override the :ref:``HasDropDown.loadDropDown`` and :ref:``HasDropDown.isLoaded`` functions to allow for lazy instantiation of the drop-down (see `Dynamic & lazy-loading drop-downs`_, below). -======================== Optional node properties ======================== @@ -110,7 +108,6 @@ By default, _HasDropDown assumes that a dijit widget has been created and assign }); }); -======== See also ======== diff --git a/dijit/_OnDijitClickMixin.rst b/dijit/_OnDijitClickMixin.rst index cd586f541..9ceb91416 100644 --- a/dijit/_OnDijitClickMixin.rst +++ b/dijit/_OnDijitClickMixin.rst @@ -1,5 +1,6 @@ .. _dijit/_OnDijitClickMixin: +======================== dijit._OnDijitClickMixin ======================== @@ -11,7 +12,6 @@ dijit._OnDijitClickMixin :depth: 2 -============ Introduction ============ diff --git a/dijit/_Templated.rst b/dijit/_Templated.rst index d77a2a504..b079e9f25 100644 --- a/dijit/_Templated.rst +++ b/dijit/_Templated.rst @@ -1,5 +1,6 @@ .. _dijit/_Templated: +================ dijit._Templated ================ @@ -11,7 +12,6 @@ dijit._Templated :depth: 2 -============ Introduction ============ @@ -32,7 +32,6 @@ widgetsInTemplate Specifying the widgetsInTemplate flag to true turns on the widgets-in-template feature described by :ref:`dijit._WidgetsInTemplateMixin `. -======== See also ======== diff --git a/dijit/_TemplatedMixin.rst b/dijit/_TemplatedMixin.rst index 3607dd51f..57f55bc8a 100644 --- a/dijit/_TemplatedMixin.rst +++ b/dijit/_TemplatedMixin.rst @@ -1,5 +1,6 @@ .. _dijit/_TemplatedMixin: +===================== dijit._TemplatedMixin ===================== @@ -11,7 +12,6 @@ dijit._TemplatedMixin :depth: 2 -============ Introduction ============ @@ -19,7 +19,6 @@ dijit._TemplatedMixin is a mixin for most widgets in dijit. It takes an HTML tem Note that the underscore in the name implies not that _TemplatedMixin is a private class, but rather that it's a mixin, rather than a widget. -===== Usage ===== @@ -36,7 +35,6 @@ Mixin dijit._TemplatedMixin when you declare your widget: and then instead of defining buildRendering(), define a ``templateString``. -============ The template ============ @@ -188,7 +186,6 @@ However, this is not recommended, as (due to implementation details) it only han See the section on attributeMap in :ref:`Writing Widgets ` for an alternative to substitution variables. -=============== Common Pitfalls =============== @@ -199,7 +196,6 @@ Common Pitfalls 3. Avoid a trailing at the end of your template -======== See also ======== diff --git a/dijit/_Widget.rst b/dijit/_Widget.rst index a81c6b0c2..eedc0e4f8 100644 --- a/dijit/_Widget.rst +++ b/dijit/_Widget.rst @@ -1,5 +1,6 @@ .. _dijit/_Widget: +============= dijit._Widget ============= diff --git a/dijit/_WidgetsInTemplateMixin.rst b/dijit/_WidgetsInTemplateMixin.rst index 1bc9137a3..c78a9c057 100644 --- a/dijit/_WidgetsInTemplateMixin.rst +++ b/dijit/_WidgetsInTemplateMixin.rst @@ -1,5 +1,6 @@ .. _dijit/_WidgetsInTemplateMixin: +============================= dijit._WidgetsInTemplateMixin ============================= @@ -10,7 +11,6 @@ dijit._WidgetsInTemplateMixin .. contents:: :depth: 2 -=========== Description =========== @@ -72,14 +72,12 @@ The :ref:`dijit._WidgetsInTemplateMixin ` mixin d Also note that a widget's getChildren() method and similar methods will *not* include the widgets declared in the template, but rather just the widgets inside the containerNode. This is because the widgets declared in the template are internal objects, effectively hidden from widget users. In other words, only the developer of the widget knows that it internally contains widgets. -=============== Common Pitfalls =============== 1. Don't try to make the root node itself a widget. That's not supported (that would make the top node the root of two separate widgets and we can't support that). -======== See also ======== diff --git a/dijit/_editor/plugins.rst b/dijit/_editor/plugins.rst index 33486cb4c..9b89fda9c 100644 --- a/dijit/_editor/plugins.rst +++ b/dijit/_editor/plugins.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins: +==================== dijit.editor.plugins ==================== @@ -11,7 +12,6 @@ dijit.editor.plugins The dijit.editor.plugins is a component is a holding place for additional features for the dijit.Editor that load via the dijit.Editor plugin infrastructure. These plugins are generally well tested and are known to work well across browsers. Plugins with specific limitations are addressed in their own documentation -============ Introduction ============ @@ -58,7 +58,6 @@ There are currently a small set of nice features that can be plugged into the di **This plugin is new to the Dojo Toolkit 1.4.** -======== See Also ======== diff --git a/dijit/_editor/plugins/FontChoice.rst b/dijit/_editor/plugins/FontChoice.rst index bcc64031e..4d77fa7e7 100644 --- a/dijit/_editor/plugins/FontChoice.rst +++ b/dijit/_editor/plugins/FontChoice.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/FontChoice: +================================ dijit._editor.plugins.FontChoice ================================ @@ -14,7 +15,6 @@ dijit._editor.plugins.FontChoice Have you ever wanted to change the font size, font face, or block type containing the text in your document? If so, then this plugin is for you! It provides three drop down menu items for manipulating those aspects of your document. -======== Features ======== @@ -26,7 +26,6 @@ Once required in and enabled, this plugin provides the following features to dij * Preview mode in the dropdowns to show what the size or style type would appear like in the document. * Auto-updating of view of the current style, size, and name settings as the user moves through the document to sections with different styles. -===== Usage ===== @@ -50,7 +49,6 @@ Once it has been required in, all you have to do is include the control names in And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with all the toolbar actions provided by the FontChoice plugin. -============== Plugin Options ============== @@ -73,7 +71,6 @@ An example of disabling it is below: With the preview disabled, the selects show basic text only. -======== Examples ======== @@ -135,7 +132,6 @@ Basic Usage: Plain Text Previews -======== See Also ======== diff --git a/dijit/_editor/plugins/FullScreen.rst b/dijit/_editor/plugins/FullScreen.rst index baa68f2e6..cce287a10 100644 --- a/dijit/_editor/plugins/FullScreen.rst +++ b/dijit/_editor/plugins/FullScreen.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/FullScreen: +================================ dijit._editor.plugins.FullScreen ================================ @@ -14,7 +15,6 @@ dijit._editor.plugins.FullScreen Have you ever been on a website where you were able to edit some document to post, for example a blog site, and found that all they give you for an editing 'window' in some nearly postage stamp sized box to edit content in? Doesn't that make it nearly impossible to edit the document effectively? It's time to put an end to such behaviors and this plugin's goal is to do exactly that for the dijit.Editor. No more postage stamp sized editors! -======== Features ======== @@ -23,7 +23,6 @@ Once required in and enabled, this plugin provides the following features to dij * Button with icon in toolbar for toggling a dijit.Editor to take over the entire view port of its current 'window' (normally the entire browser window.) * HotKey enabled for CTRL-SHIFT-F11. When this combination is pressed in the view port, the editor will toggle between full screen and normal modes. -=========== Limitations =========== @@ -38,7 +37,6 @@ Limitations Your content here. -===== Usage ===== @@ -83,7 +81,6 @@ Example:
-===================================== Full Screen mode and LayoutContainers ===================================== Layout containers put restrictions on their children content in order to force specific layout. Such restrictions are often in the CSS definitions, and do things such as applying 'position: absolute' as a CSS property. These styles can cause issues with the Editor and FullScreen mode. The editor full screen plugin works around them by removing classes for amm parent dom nodes up to the body tag. The classes are re-applied back to their nodes when full screen is toggled off. This provides usable full screen modes in most layout containers. @@ -95,7 +92,6 @@ For FullScreen mode on an editor in BorderContainer to work properly, the Editor The ideal solution to scaling out issues with LayoutContainer nested Editors is to reparent the Editor temporarily to the element of your page. This, however, will not work in some browsers, such as FireFox. This is because FireFox forcibly reloads an IFRAME element if the iframe (or any of its parent dom nodes), moves its DOM position in the page. At this time there are no known workarounds to that FireFox behavior, and due to such, the editor takes the the alternate approach of class manipulation explained above. If a workaround is discovered, then the plugin and these docs will be updated to reflect the improved behavior. -=================== A11Y Considerations =================== @@ -103,7 +99,6 @@ A11Y Considerations * When using the button (via mouse click or keyboard), focus does not move into the edit area. This is so that users who accidentally enable the mode do not have to chift-tab out to undo the mode. They can just press the button again. -======== Examples ======== @@ -266,7 +261,6 @@ Nesting an Editor With FullScreen in BorderContainer -======== See Also ======== diff --git a/dijit/_editor/plugins/LinkDialog.rst b/dijit/_editor/plugins/LinkDialog.rst index 7bd860e61..a5869ffc3 100644 --- a/dijit/_editor/plugins/LinkDialog.rst +++ b/dijit/_editor/plugins/LinkDialog.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/LinkDialog: +================================ dijit._editor.plugins.LinkDialog ================================ @@ -14,7 +15,6 @@ dijit._editor.plugins.LinkDialog Have you ever wanted to insert a hyperlink into a document you are editing in the Dojo RTE (:ref:`dijit.Editor `)? Have you wanted to insert images as well? If so, then this plugin provides you a basic set of dropdown dialogs to allow you to do just that. The dialogs are not complex and are intended as example implementations so that users can implement dialogs of their own, but they still work fairly well as is. -======== Features ======== @@ -31,13 +31,11 @@ Once required in and enabled, this plugin provides the following features to dij * Single-clicking an image should select the image. This makes it easy to select, then edit, an image in the page -=========== Limitations =========== * You can't create a hyperlink that has no description and just wraps an image -===== Usage ===== @@ -62,13 +60,11 @@ Once it has been required in, all you have to do is include it in the list of ex And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with all the toolbar actions provided by the LinkDialog plugin. -=================== A11Y Considerations =================== * When using the dialog to insert images, please be sure to provide a description. This gets put as the alt text of the image tag and is used by screen readers to read the image information to the page viewer. -======== Examples ======== @@ -104,7 +100,6 @@ Basic Usage -======== See Also ======== diff --git a/dijit/_editor/plugins/NewPage.rst b/dijit/_editor/plugins/NewPage.rst index 8f951de77..16625f57e 100644 --- a/dijit/_editor/plugins/NewPage.rst +++ b/dijit/_editor/plugins/NewPage.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/NewPage: +============================= dijit._editor.plugins.NewPage ============================= @@ -14,7 +15,6 @@ dijit._editor.plugins.NewPage Have you ever wanted to be able to with the click of a button clear the editor and set it with some default content, be it an empty line of some template HTML? If so, then this plugin is for you. It's a simple plugin that adds 'NewPage' support to the editor toolbar. -======== Features ======== @@ -23,7 +23,6 @@ Once required in and enabled, this plugin provides the following features to dij * Button with icon in toolbar for clearing the current editor contents and inserting pre-defined 'new page' content. * Configurable 'New Page' content via the 'content' parameter of the plugin -===== Usage ===== @@ -62,7 +61,6 @@ Or programmatically: var editor = new dijit.Editor({extraPlugins: [{name: 'newpage', content: 'This is some custom content!'}]} -======== Examples ======== @@ -157,7 +155,6 @@ Custom New Page Content -======== See Also ======== diff --git a/dijit/_editor/plugins/Print.rst b/dijit/_editor/plugins/Print.rst index 552e0661e..22a31acb1 100644 --- a/dijit/_editor/plugins/Print.rst +++ b/dijit/_editor/plugins/Print.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/Print: +=========================== dijit._editor.plugins.Print =========================== @@ -14,7 +15,6 @@ dijit._editor.plugins.Print Have you ever wanted to print the contents contained within the editor? If so, then this plugin is for you. It's a simple plugin that adds 'Print' support to the editor toolbar. -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * Button with icon in toolbar for Printing the contents of the RTE only -===== Usage ===== @@ -46,7 +45,6 @@ Once it has been required in, all you have to do is include it in the list of ex And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the Printplugin! You can use the button to print the editor contents when you wish. -======== Examples ======== @@ -95,7 +93,6 @@ Basic Usage -======== See Also ======== diff --git a/dijit/_editor/plugins/TextColor.rst b/dijit/_editor/plugins/TextColor.rst index 3d795f43e..927d20247 100644 --- a/dijit/_editor/plugins/TextColor.rst +++ b/dijit/_editor/plugins/TextColor.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/TextColor: +=============================== dijit._editor.plugins.TextColor =============================== @@ -14,7 +15,6 @@ dijit._editor.plugins.TextColor Have you ever wanted to change the color of the font, or the background color of the text in the document you're editing in the dijit.Editor? If so, then this plugin is for you. The dijit._editor.plugins.TextColor plugin provides two action buttons on the editor toolbar for changing those items. Each make use of the dijit ColorPicker, so they are simple to use. -======== Features ======== @@ -30,7 +30,6 @@ Once required in and enabled, this plugin provides the following features to dij hiliteColor - Enable the text background color plugin. -===== Usage ===== @@ -53,7 +52,6 @@ Once it has been required in, all you have to do is include it in the list of ex And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the TextColor plugin! You can use the buttons to alter the colors of selected text. -======== Examples ======== @@ -191,7 +189,6 @@ Basic Usage: Both foreground and background color buttons together -======== See Also ======== diff --git a/dijit/_editor/plugins/ToggleDir.rst b/dijit/_editor/plugins/ToggleDir.rst index 153c84533..f4efa9469 100644 --- a/dijit/_editor/plugins/ToggleDir.rst +++ b/dijit/_editor/plugins/ToggleDir.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/ToggleDir: +=============================== dijit._editor.plugins.ToggleDir =============================== @@ -14,7 +15,6 @@ dijit._editor.plugins.ToggleDir Not all documents in the world are read from Left-To-Right. There are several languages, in fact, that are read from Right-To-Left, such as Arabic, Hebrew, and so forth. So, there are times it would be great to see what your document would look like in Right-To-Left view. With this plugin, you can do that. -======== Features ======== @@ -24,13 +24,11 @@ Once required in and enabled, this plugin provides the following features to dij * Update is done on the body element of the containing iframe, so as such does not alter the page containing the editor, only the editor contents. * Auto-detects if the whole page is in RTL mode when editor is initialized and toggles the mode appropriately on Editor. -=========== Limitations =========== * The button being toggled 'on' always means RTL mode. You cannot define button 'on' as meaning LTR. -===== Usage ===== @@ -55,7 +53,6 @@ Once it has been required in, all you have to do is include it in the list of ex And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with all the toolbar actions provided by the ToggleDir plugin. -======== Examples ======== @@ -93,7 +90,6 @@ Basic Usage -======== See Also ======== diff --git a/dijit/_editor/plugins/ViewSource.rst b/dijit/_editor/plugins/ViewSource.rst index 0ed21d94c..fa6540337 100644 --- a/dijit/_editor/plugins/ViewSource.rst +++ b/dijit/_editor/plugins/ViewSource.rst @@ -1,5 +1,6 @@ .. _dijit/_editor/plugins/ViewSource: +================================ dijit._editor.plugins.ViewSource ================================ @@ -14,7 +15,6 @@ dijit._editor.plugins.ViewSource Have you ever wanted to edit the source generated by the dijit.Editor, but were unable to do so well? Wouldn't it be nice to be able to see the source edited by the editor as an alternate view of the content? Well, with this plugin you can do exactly that. -======== Features ======== @@ -28,7 +28,6 @@ Once required in and enabled, this plugin provides the following features to dij * Provides a 'readOnly' mode that, if enabled on the plugin, allows the user to see the source, but they cannot change it. -===== Usage ===== @@ -73,13 +72,11 @@ The ViewSource plugin has several configurable options to tailor it for your usa -================ XSS Attack notes ================ See the section on limitations. -=========== Limitations =========== @@ -89,7 +86,6 @@ Limitations * The content of the editor (as obtained by editor.getValue() or editor.attr("value")) is not updated with the source view content until it is toggled off. This is to ensure that the filters are executed on the content to help prevent XSS attacks. * On IE 7, do not use the IE 'zoom' function (CTRL+ or CTRL-), with the editor in source mode and then try to resize the browser window. This is because the IE 7 function is, frankly, horribly broken. It does not generate any events, nor does it actually scale things appropriately. In fact, the information it returns isn't even valid and has to be 'fudged' to try and get things to size right. Unfortunately, this doesn't always work well and this is one of those cases. Because IE seems incapable of returning correct position data and the fudging amounts vary by some unknown formula, we cannot consistently get the source area to scale the height right. If we ever come up with a fix for this, this limitation will be removed. But at the moment, this seems highly doubtful. -================== Other useful notes ================== @@ -99,7 +95,6 @@ This plugin is particularly powerful when it is combined with the following plug * :ref:`dojox.editor.plugins.PrettyPrint ` - Format the content in the editor so that it is easily human readable and modifiable. -=================== A11Y Considerations =================== @@ -107,7 +102,6 @@ A11Y Considerations * When using the button (via mouse click or keyboard), focus does not move into the edit area. This is so that users who accidentally enable the mode do not have to chift-tab out to undo the mode. They can just press the button again. -======== Examples ======== @@ -332,7 +326,6 @@ This example also organizes the toolbar a bit. -======== See Also ======== diff --git a/dijit/a11y/index.rst b/dijit/a11y/index.rst index dbcd53901..0bd34acd1 100644 --- a/dijit/a11y/index.rst +++ b/dijit/a11y/index.rst @@ -1,5 +1,6 @@ .. _dijit/a11y/index: +========================== Dijit Accessibility (a11y) ========================== @@ -13,7 +14,6 @@ It is important that all users can access applications built using Dojo. People In addition, many countries require that Web content is accessible to all. Section 508 of the Disabilities Act requires the US Government to purchase accessible technology. Australia, Japan, Great Britain and the European Union all have accessibility regulations. Thus, it is important for the Dojo Toolkit to provide a way to build accessible applications. -======================== Web Accessibility Issues ======================== diff --git a/dijit/a11y/resources.rst b/dijit/a11y/resources.rst index 29c699ca5..f83b25219 100644 --- a/dijit/a11y/resources.rst +++ b/dijit/a11y/resources.rst @@ -1,5 +1,6 @@ .. _dijit/a11y/resources: +============================= Dijit Accessibility Resources ============================= diff --git a/dijit/a11y/statement.rst b/dijit/a11y/statement.rst index 1d890a780..d886cd354 100644 --- a/dijit/a11y/statement.rst +++ b/dijit/a11y/statement.rst @@ -1,5 +1,6 @@ .. _dijit/a11y/statement: +============================= Dijit Accessibility Statement ============================= @@ -9,7 +10,6 @@ Dijit Accessibility Statement :depth: 2 -=================== Dijit Accessibility =================== @@ -24,7 +24,6 @@ Dojo has made a serious commitment to creating a toolkit that allows the develop In addition, the documentation for each dijit widget contains a section explaining any parameters specific to accessibility, the keyboard navigation of the component, and any open accessibility issues. -============================= Dojo Accessibility Compliance ============================= @@ -39,7 +38,6 @@ People familiar with accessibility and accessibility guidelines such as the W3C' Additional WCAG 2.0 and US Section 508 compliance details are provided below. -======================== Accessibility Fine Print ======================== @@ -53,14 +51,12 @@ Widget sizing can also be an issue. When creating elements which require size, c Also be aware of source code ordering, the BorderContainer will properly align the ContentPane regions when it renders them, no matter if the bottom region is specified before the top region in source code order. But, for best support by assistive technology, add the ContentPane regions in correct source code order, with top regions appearing first and bottom regions last. The best way to be confident of an accessible application is to test, test, test! Any developer can test basic accessibility by getting rid of your mouse and make certain you can navigate and use your application with only a keyboard. There are many resources on the Web for creating Accessible content, use them! -========================= Accessibility Involvement ========================= Becky Gibson of IBM's Emerging Technology team is the accessibility lead for Dojo responsible for implementing and promoting accessibility within the Dojo community. She has been fortunate to get support for Accessibility from Dojo's leadership team as well as the `BDFL `_ of Dijit, Bill Keese, and other dijit developers. Grants from `IBM `_ and `Mozilla `_ enabled members of the `Adaptive Technology Research Centre `_ (ATRC) at the University of Toronto to actively participate in the development of the ARIA specification and its implementation within Dojo. The dijit team is always looking to recruit new members to help with accessibility or to help developers enable accessibility in new contributions to dojo, dijit, and dojox. -============================= Additional Compliance Details ============================= diff --git a/dijit/a11y/strategy.rst b/dijit/a11y/strategy.rst index 82a37f46f..701247a26 100644 --- a/dijit/a11y/strategy.rst +++ b/dijit/a11y/strategy.rst @@ -1,5 +1,6 @@ .. _dijit/a11y/strategy: +============================ Dijit Accessibility Strategy ============================ diff --git a/dijit/focus.rst b/dijit/focus.rst index bd45aac46..4f22ea76c 100644 --- a/dijit/focus.rst +++ b/dijit/focus.rst @@ -1,5 +1,6 @@ .. _dijit/focus: +=========== dijit/focus =========== @@ -9,7 +10,6 @@ dijit/focus .. contents:: :depth: 2 -============ Introduction ============ @@ -17,7 +17,6 @@ dijit/focus is a utility module that is used to manage focused nodes and widgets Until Dojo 2.0, requiring dijit/focus will also create a ``dijit.focus`` function with the same semantics as ``focus.focus``. -===== Usage ===== @@ -109,7 +108,6 @@ If you don’t register an iframe, when focus changes to elements within the ifr focusUtil.unregisterIframe(handle); }); -======== See also ======== diff --git a/dijit/form.rst b/dijit/form.rst index c747fe515..b2db8d482 100644 --- a/dijit/form.rst +++ b/dijit/form.rst @@ -1,5 +1,6 @@ .. _dijit/form: +========== dijit.form ========== @@ -19,7 +20,6 @@ The widgets can be used in a FORM tag, in a :ref:`dijit.form.Form ` and :ref:`dojox.widget ` that complement the dijit.form pieces and will probably be incorporated into dijit eventually. -=============== Form validation =============== @@ -166,7 +165,6 @@ Prevent form submission ----------------------- Using the :ref:`dijit.form.Form ` widget you can prevent form submission if any of the fields are invalid. Dijit provides hooks so you can either disable the submit button, or popup an error message when the user tries to submit, or even focus on the invalid field. -================================= Use Dijit Form Controls All Over! ================================= @@ -188,7 +186,6 @@ Never fear. For every HTML control, there's a Dijit equivalent that does the sa .. _mapped: -==================== Mapped Form Controls ==================== @@ -206,7 +203,6 @@ This is handled internally by having two fields in the widget: The upshot of this is that Dijit handles localization issues on the client, the server doesn't have to worry about it (except of course for translating the boilerplate text on the page, like the label for the above control). -======================== Styling of Form Controls ======================== @@ -269,7 +265,6 @@ Using the classes defined on the DOM node you can affect the styling of any sub- color: red; } -======== See also ======== diff --git a/dijit/form/Button.rst b/dijit/form/Button.rst index 57fdabfa1..d49f0ad1e 100644 --- a/dijit/form/Button.rst +++ b/dijit/form/Button.rst @@ -1,5 +1,6 @@ .. _dijit/form/Button: +================= dijit.form.Button ================= @@ -11,7 +12,6 @@ dijit.form.Button :depth: 2 -============ Introduction ============ @@ -20,7 +20,6 @@ The dijit.form.Button widget is a representation of a normal -============= Accessibility ============= Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate to a button tab - all buttons are in the tab order Activate the button enter or space key @@ -150,7 +147,6 @@ Screen Reader In order to identify the button description to the screen reader, all buttons should include a label parameter even if the showLabel parameter is set to false. -======== See also ======== diff --git a/dijit/form/CheckBox.rst b/dijit/form/CheckBox.rst index ed61bbdaa..718711de0 100644 --- a/dijit/form/CheckBox.rst +++ b/dijit/form/CheckBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/CheckBox: +=================== dijit.form.CheckBox =================== @@ -12,7 +13,6 @@ dijit.form.CheckBox **dijit.form.CheckBox** is nearly the same as an HTML checkbox, but with fancy styling. -===== Usage ===== @@ -21,7 +21,6 @@ CheckBox widgets in dijit are very intuitive and easy to use. Markup constructs Conceptually, native HTML checkboxes have 2 separate values; the first being the boolean checked state, and the second being the text value that is submitted with the containing FORM element if the checked state is true. To resolve this dichotomy, the *value* of a CheckBox widget is false when unchecked, but the text value when checked. Setting the *value* to true will check the box (but leave the submittable text string unchanged) while false will uncheck it. Setting the *value* to a text string will check the box and set the value to be submitted to the indicated text string. -======== Examples ======== @@ -68,7 +67,6 @@ Let's create a checkbox with HTML markup, initially checked: -============= Accessibility ============= diff --git a/dijit/form/ComboBox.rst b/dijit/form/ComboBox.rst index a52c48f34..8ffa9e2d7 100644 --- a/dijit/form/ComboBox.rst +++ b/dijit/form/ComboBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/ComboBox: +=================== dijit.form.ComboBox =================== @@ -12,7 +13,6 @@ dijit.form.ComboBox The ComboBox is a hybrid between a SELECT combo-box and an INPUT text field. -===== Usage ===== @@ -24,7 +24,6 @@ ComboBox widgets are dojo.data-enabled. This means rather than embedding all the `note:` ComboBox only has a single value that matches what is displayed while :ref:`FilteringSelect ` incorporates a hidden value that corresponds to the displayed value. -======== Examples ======== @@ -108,7 +107,6 @@ Codependent FilteringSelect/ComboBox widgets :ref:`The city ComboBox sets the state FilteringSelect value, and the state FilteringSelect filters the city ComboBox choices in this example. ` -============= Accessibility ============= diff --git a/dijit/form/ComboButton.rst b/dijit/form/ComboButton.rst index 9f569a5de..fad356b47 100644 --- a/dijit/form/ComboButton.rst +++ b/dijit/form/ComboButton.rst @@ -1,5 +1,6 @@ .. _dijit/form/ComboButton: +====================== dijit.form.ComboButton ====================== @@ -12,7 +13,6 @@ dijit.form.ComboButton The dijit.form.ComboButton widget has a regular button on the left, and on the right has an arrow to show a drop down (often a menu). -======== Examples ======== @@ -82,15 +82,13 @@ and the other for the drop-down widget that's displayed when you press the butto -============= Accessibility ============= Keyboard -------- -========================================================= ================================================= -Action Key +========================================================= Action Key ========================================================= ================================================= Navigate to a button tab - all buttons are in the tab order Activate the button to display the drop down menu enter or space key diff --git a/dijit/form/CurrencyTextBox.rst b/dijit/form/CurrencyTextBox.rst index 460bdb654..8226c281c 100644 --- a/dijit/form/CurrencyTextBox.rst +++ b/dijit/form/CurrencyTextBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/CurrencyTextBox: +========================== dijit.form.CurrencyTextBox ========================== @@ -13,7 +14,6 @@ dijit.form.CurrencyTextBox CurrencyTextBox widgets inherit all the attributes and behaviors of the :ref:`NumberTextBox ` widget but are specialized for input monetary values, much like the currency type in spreadsheet programs. -===== Usage ===== @@ -24,7 +24,6 @@ Usage * The optional boolean ``fractional`` property of the ``constraints`` object attribute can be set to require/refuse fractional input. -======== Examples ======== @@ -87,7 +86,6 @@ In this example using euros with German formatting, the invalid message contains EUR -============= Accessibility ============= diff --git a/dijit/form/DataList.rst b/dijit/form/DataList.rst index f3e3c8391..eed64f32b 100644 --- a/dijit/form/DataList.rst +++ b/dijit/form/DataList.rst @@ -1,5 +1,6 @@ .. _dijit/form/DataList: +=================== dijit.form.DataList =================== @@ -15,7 +16,6 @@ dijit.form.DataList DataList is a read-only data store that processes inline OPTION tags as data items. This store implements the new :ref:`Dojo Object Store API `. The DataList store is also a synchronous store. All the functions directly return results, so you don't have to use asynchronous callbacks in your code. -======== Examples ======== diff --git a/dijit/form/DateTextBox.rst b/dijit/form/DateTextBox.rst index b3e37588f..af2918ecb 100644 --- a/dijit/form/DateTextBox.rst +++ b/dijit/form/DateTextBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/DateTextBox: +====================== dijit.form.DateTextBox ====================== @@ -13,7 +14,6 @@ dijit.form.DateTextBox DateTextBox widgets are easy-to-use date entry controls that allow either typing or choosing a date from any calendar widget. -============ Introduction ============ @@ -39,7 +39,6 @@ ISO formatted date values sort properly as strings and are lighter-weight than J The DateTextBox widget uses a hidden form element with the *NAME* of the original tag to submit the ISO data; the form element provided for user interaction is an additional form element instantiated only for this purpose. When you access the DateTextBox value attribute programmatically from the widget using JavaScript, you must use a native Javascript Date object, e.g. new Date(2007, 11, 25) The time portion of the Date object is ignored. -======== Examples ======== @@ -158,7 +157,6 @@ Sometimes you may want to input and display years in a format with only 2-digit -============= Accessibility ============= diff --git a/dijit/form/DropDownButton.rst b/dijit/form/DropDownButton.rst index a1f7190e0..4d3845360 100644 --- a/dijit/form/DropDownButton.rst +++ b/dijit/form/DropDownButton.rst @@ -1,5 +1,6 @@ .. _dijit/form/DropDownButton: +========================= dijit.form.DropDownButton ========================= @@ -13,7 +14,6 @@ dijit.form.DropDownButton The dijit.form.DropDownButton widget is for a button that displays some kind of drop down, often a menu, when you press it. -======== Examples ======== @@ -94,15 +94,13 @@ Here's one displaying a :ref:`TooltipDialog `: Note that DropDownButton is often used in :ref:`dijit.Toolbar `. -============= Accessibility ============= Keyboard -------- -========================================================= ================================================= -Action Key +========================================================= Action Key ========================================================= ================================================= Navigate to a button tab - all buttons are in the tab order Activate the button to display the drop down menu enter or space key diff --git a/dijit/form/FilteringSelect.rst b/dijit/form/FilteringSelect.rst index 6aeb7a6fa..46a8a05eb 100644 --- a/dijit/form/FilteringSelect.rst +++ b/dijit/form/FilteringSelect.rst @@ -1,5 +1,6 @@ .. _dijit/form/FilteringSelect: +========================== dijit.form.FilteringSelect ========================== @@ -13,7 +14,6 @@ dijit.form.FilteringSelect The FilteringSelect widget is a replacement for the native SELECT element. -===== Usage ===== @@ -26,7 +26,6 @@ FilteringSelect widgets are dojo.data-enabled. This means rather than embedding `note:` When using a DataStore with FilteringSelect, the store must implement the :ref:`Identity API `. -======== Examples ======== @@ -495,7 +494,6 @@ In this example, the FilteringSelect takes a labelFunc attribute pointing to a f name="state"> -============= Accessibility ============= @@ -522,7 +520,6 @@ JAWS 8 and Window-Eyes 6 may fail to read an option when it becomes highlighted. When using JAWS 10 with IE 8 all of the visible choices in the ComboBox are spoken as you arrow down through the items - the currently focused item is spoken last. Event the hidden previous choices / more choices options are spoken. This appears to be an issue with IE 8 and list items (which are uses to implement the option choices) and with IE 8 not honoring hidden items. -======== See Also ======== diff --git a/dijit/form/Form.rst b/dijit/form/Form.rst index 3d7c9156b..b1d19aa83 100644 --- a/dijit/form/Form.rst +++ b/dijit/form/Form.rst @@ -1,5 +1,6 @@ .. _dijit/form/Form: +=============== dijit.form.Form =============== @@ -13,7 +14,6 @@ dijit.form.Form **dijit.form.Form** is the dijit equivalent of the
node, and it provides various methods for serializing/deserializing form data, and checking whether or not a form is valid. -======== Examples ======== @@ -246,7 +246,6 @@ It is possible to submit a dijit.form.Form with native elements to the server, v -============= Accessibility ============= diff --git a/dijit/form/HorizontalRuleLabels.rst b/dijit/form/HorizontalRuleLabels.rst index fd9311038..4c24dc2f1 100644 --- a/dijit/form/HorizontalRuleLabels.rst +++ b/dijit/form/HorizontalRuleLabels.rst @@ -1,5 +1,6 @@ .. _dijit/form/HorizontalRuleLabels: +=============================== dijit.form.HorizontalRuleLabels =============================== diff --git a/dijit/form/HorizontalSlider.rst b/dijit/form/HorizontalSlider.rst index 63c3aa367..c51f79ee8 100644 --- a/dijit/form/HorizontalSlider.rst +++ b/dijit/form/HorizontalSlider.rst @@ -1,5 +1,6 @@ .. _dijit/form/HorizontalSlider: +=========================== dijit.form.HorizontalSlider =========================== diff --git a/dijit/form/MappedTextBox.rst b/dijit/form/MappedTextBox.rst index ecc64134a..04f24ec6a 100644 --- a/dijit/form/MappedTextBox.rst +++ b/dijit/form/MappedTextBox.rst @@ -1,12 +1,12 @@ .. _dijit/form/MappedTextBox: +======================== dijit.form.MappedTextBox ======================== .. contents:: :depth: 2 -============ Introduction ============ diff --git a/dijit/form/MultiSelect.rst b/dijit/form/MultiSelect.rst index b891440e3..7a7c77e00 100644 --- a/dijit/form/MultiSelect.rst +++ b/dijit/form/MultiSelect.rst @@ -1,5 +1,6 @@ .. _dijit/form/MultiSelect: +====================== dijit.form.MultiSelect ====================== @@ -13,7 +14,6 @@ dijit.form.MultiSelect The MultiSelect widget allows the selection of multiple items. -============ Introduction ============ @@ -24,7 +24,6 @@ On FORM submit, the selected item's hidden text values of a non-disabled MultiSe MultiSelect widgets are not dojo.data-enabled. This means that the data must be embedded as OPTION tags, children of the parent SELECT element. However, it is possible to create the OPTION tags dynamically at runtime. -======== Examples ======== @@ -80,7 +79,6 @@ Programmatic example

-============= Accessibility ============= diff --git a/dijit/form/NumberSpinner.rst b/dijit/form/NumberSpinner.rst index 640604d7f..69dfa95e2 100644 --- a/dijit/form/NumberSpinner.rst +++ b/dijit/form/NumberSpinner.rst @@ -1,5 +1,6 @@ .. _dijit/form/NumberSpinner: +======================== dijit.form.NumberSpinner ======================== @@ -13,7 +14,6 @@ dijit.form.NumberSpinner The NumberSpinner is similar to :ref:`dijit.form.NumberTextBox `, but makes integer entry easier when small adjustments are required. -===== Usage ===== @@ -21,7 +21,6 @@ Usage * Furthermore, when you hold down the buttons, the spinning accelerates to make coarser adjustments easier. -======== Examples ======== @@ -127,7 +126,6 @@ If you'd like onChange to fire after every button click, set the attribute inter     -============= Accessibility ============= diff --git a/dijit/form/NumberTextBox.rst b/dijit/form/NumberTextBox.rst index cf7651d65..0cb67f9eb 100644 --- a/dijit/form/NumberTextBox.rst +++ b/dijit/form/NumberTextBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/NumberTextBox: +======================== dijit.form.NumberTextBox ======================== @@ -13,7 +14,6 @@ dijit.form.NumberTextBox NumberTextBox widgets are used when user input is restricted to numeric input. -============ Introduction ============ @@ -26,7 +26,6 @@ To further restrict/validate user input, this widget makes additional numeric `` **Warning**: if you use programmatic creation without direct value, be sure to cast your value to ``Number`` (``value: Number(input.value)``) otherwise you'll get strange results (unformatted values and errors depending on locales). -======== Examples ======== @@ -106,7 +105,6 @@ The ``constraints`` attribute can also contain formatting information. The exam required="true"> -============= Accessibility ============= diff --git a/dijit/form/RadioButton.rst b/dijit/form/RadioButton.rst index 6aaf3bdc5..40f5f6048 100644 --- a/dijit/form/RadioButton.rst +++ b/dijit/form/RadioButton.rst @@ -1,5 +1,6 @@ .. _dijit/form/RadioButton: +====================== dijit.form.RadioButton ====================== @@ -12,7 +13,6 @@ dijit.form.RadioButton RadioButton widgets capture binary user-choices unlike buttons which normally perform some action when clicked. -===== Usage ===== @@ -21,7 +21,6 @@ Normally, there are multiple RadioButton widgets assigned to a single group defi **Note:** To use the RadioButton widget, you currently have to call dojo.require("dijit.form.CheckBox") -======== Examples ======== @@ -55,7 +54,6 @@ Let's create 2 RadioButton widgets, 1 programmatically and 1 declaratively. We'l -============= Accessibility ============= diff --git a/dijit/form/RangeBoundTextBox.rst b/dijit/form/RangeBoundTextBox.rst index 360fc7e6f..cbd1eb694 100644 --- a/dijit/form/RangeBoundTextBox.rst +++ b/dijit/form/RangeBoundTextBox.rst @@ -1,12 +1,12 @@ .. _dijit/form/RangeBoundTextBox: +============================ dijit.form.RangeBoundTextBox ============================ .. contents:: :depth: 2 -============ Introduction ============ diff --git a/dijit/form/Select.rst b/dijit/form/Select.rst index 57aa90171..fbb0fdf33 100644 --- a/dijit/form/Select.rst +++ b/dijit/form/Select.rst @@ -1,5 +1,6 @@ .. _dijit/form/Select: +================= dijit.form.Select ================= @@ -15,14 +16,12 @@ dijit.form.Select A styleable drop down select box (similar to html select element) -============ Introduction ============ HTML Select tags are problematic when it comes to styling - they are not very styleable, not to mention nearly impossible to get a consistent cross-browser widget. This widget aims to resolve that issue. -===== Usage ===== @@ -30,7 +29,6 @@ The Select widget is designed to replace existing HTML select elements with mini You can specify the maximum height of your dropdown menu by specifying "maxHeight" attribute during widget instantiation. If the dropdown menu would be larger than that value (in pixels), then scrollbars are added to the dropdown menu. -======== Examples ======== @@ -136,7 +134,6 @@ By default, the width of the select widget will be to fit the width of the selec The above example also demonstrates using type="separator" to get dividing lines between groups of options. -============= Accessibility ============= diff --git a/dijit/form/SimpleTextarea.rst b/dijit/form/SimpleTextarea.rst index 4f1b5a0e7..a99cf8176 100644 --- a/dijit/form/SimpleTextarea.rst +++ b/dijit/form/SimpleTextarea.rst @@ -1,5 +1,6 @@ .. _dijit/form/SimpleTextarea: +========================= dijit.form.SimpleTextarea ========================= @@ -12,7 +13,6 @@ dijit.form.SimpleTextarea A SimpleTextarea widget is an exact replacement for the native TEXTAREA element and was created to provide a thin widget wrapper that was necessary to interact with the :ref:`Form ` widget, and to provide the ability to specify *rows* and *cols* attributes which are not available in the :ref:`Textarea ` widget. Unlike the :ref:`Textarea ` widget, the height of this widget does not adjust to its content. It takes nearly all the parameters (*name*, *style*, etc.) that are available with a native TEXTAREA element. Note that when declaring a SimpleTextarea in markup you should use a -============= Accessibility ============= diff --git a/dijit/form/Slider.rst b/dijit/form/Slider.rst index 3f732ccfb..71eb88ff6 100644 --- a/dijit/form/Slider.rst +++ b/dijit/form/Slider.rst @@ -1,5 +1,6 @@ .. _dijit/form/Slider: +================= dijit.form.Slider ================= @@ -11,13 +12,11 @@ dijit.form.Slider .. contents:: :depth: 2 -============ Introduction ============ A **dijit.form.HorizontalSlider** or **dijit.form.VerticalSlider** is a scale with a handle you can drag left/right or up/down to select a value. -===== Usage ===== @@ -32,8 +31,7 @@ Usage Here are some of the constructor parameters: -============== ==================== ============================================================================= -Parameter Type Description +============== ==================== Parameter Type Description ============== ==================== ============================================================================= value integer Initial value of the slider (``0``) showButtons boolean Whether to show or not buttons at each end of the slider (``true``) @@ -42,7 +40,6 @@ maximum integer Maximum value of the slider (``100``) discreteValues integer Number of "steps" in the slider. For example if ``discreteValues`` is ``3``, you'll have 3 steps: ``minimum``, ``maximum`` and a value in the middle ============== ==================== ============================================================================= -======== Examples ======== @@ -157,7 +154,6 @@ And here we create a slider declaratively. Note that we set the value of the "di -============= Accessibility ============= diff --git a/dijit/form/TextBox.rst b/dijit/form/TextBox.rst index cb2b5efd5..86f1e9d1d 100644 --- a/dijit/form/TextBox.rst +++ b/dijit/form/TextBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/TextBox: +================== dijit.form.TextBox ================== @@ -12,7 +13,6 @@ dijit.form.TextBox TextBox is a basic -style form control. -============ Introduction ============ @@ -31,7 +31,6 @@ HTML control, even if you don't have to do any input scrubbing. However: * If text can be validated with a regular expression, use :ref:`dijit.form.ValidationTextBox `. -======== Examples ======== @@ -143,7 +142,6 @@ In order to use it, submit a parameter "placeHolder" to your widget: -============= Accessibility ============= diff --git a/dijit/form/Textarea.rst b/dijit/form/Textarea.rst index e47c467d3..2eb7c3b55 100644 --- a/dijit/form/Textarea.rst +++ b/dijit/form/Textarea.rst @@ -1,5 +1,6 @@ .. _dijit/form/Textarea: +=================== dijit.form.Textarea =================== @@ -13,7 +14,6 @@ dijit.form.Textarea A Textarea widget is like a regular HTML TEXTAREA element, but it dynamically resizes to fit the content of the text inside. It takes nearly all the parameters (*name*, *value*, etc.) that a vanilla TEXTAREA takes. The attribute *rows* is not supported since this widget adjusts the height. It is especially useful in an :ref:`InlineEditBox `. Note that when declaring a Textarea in markup you should use a -============= Accessibility ============= @@ -69,7 +68,6 @@ Keyboard The Textarea widget uses native HTML TEXTAREA controls. -============================= Known Issues (1.2 and before) ============================= diff --git a/dijit/form/TimeTextBox.rst b/dijit/form/TimeTextBox.rst index 956081369..1a3cfcafe 100644 --- a/dijit/form/TimeTextBox.rst +++ b/dijit/form/TimeTextBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/TimeTextBox: +====================== dijit.form.TimeTextBox ====================== @@ -12,7 +13,6 @@ dijit.form.TimeTextBox TimeTextBox widgets are time input controls that allow either typing or choosing a time from any time-picker widget. -============ Introduction ============ @@ -24,7 +24,6 @@ Introduction :ref:`Options defined by the dojo.date package ` to alter the way times are formatted and parsed can be specified in the TimeTextBox ``constraints`` object. -===== Usage ===== @@ -39,7 +38,6 @@ To prevent the ambiguity in specifying time formats, TimeTextBox allows only one However, when you get the widget's current ``value`` programmatically on the client, the returned value will be the native JavaScript Date object. The date portion of this value should be ignored. -======== Examples ======== @@ -84,7 +82,6 @@ Declarative example
string value: -============= Accessibility ============= diff --git a/dijit/form/ToggleButton.rst b/dijit/form/ToggleButton.rst index ef5bf7473..52528ae41 100644 --- a/dijit/form/ToggleButton.rst +++ b/dijit/form/ToggleButton.rst @@ -1,5 +1,6 @@ .. _dijit/form/ToggleButton: +======================= dijit.form.ToggleButton ======================= @@ -13,7 +14,6 @@ dijit.form.ToggleButton ToggleButton widgets are a cross between :ref:`Button ` and :ref:`Checkbox ` widgets. They are created like Button widgets, but like CheckBox widgets, they maintain a *checked* boolean attribute (settable/gettable) that toggles on each click action. Unlike CheckBox widgets however, ToggleButton widgets do not submit any value on FORM submit. They are used solely for client-side processing where the user can toggle between 2 states before performing some additional action. The CSS class "dijitToggleButtonChecked" is appended to the widget's outermost DOM node when the *checked* attribute is true to allow for custom styling. -======== Examples ======== @@ -62,7 +62,6 @@ Now let's create a ToggleButton widget with HTML markup, initially checked: -============= Accessibility ============= diff --git a/dijit/form/ValidationTextBox.rst b/dijit/form/ValidationTextBox.rst index 69c1200a0..45261f519 100644 --- a/dijit/form/ValidationTextBox.rst +++ b/dijit/form/ValidationTextBox.rst @@ -1,5 +1,6 @@ .. _dijit/form/ValidationTextBox: +============================ dijit.form.ValidationTextBox ============================ @@ -10,7 +11,6 @@ dijit.form.ValidationTextBox .. contents:: :depth: 2 -============ Introduction ============ @@ -19,14 +19,12 @@ A ValidationTextBox is an -like widget that checks to make sure the user' Note that a ValidationTextBox by itself *will not* prevent invalid entries from submission. To ensure they're not, simply surround your form with a :ref:`dijit.form.Form ` widget. -===== Usage ===== The following attributes can be specified when you create a ValidationTextBox: -=============== ============= ====================================================================== -Parameter Type Description +=============== ============= Parameter Type Description =============== ============= ====================================================================== required Whether the field is required or not. false by default. promptMessage Tooltip text that appears when the text box is empty and on focus. Null by default. @@ -47,7 +45,6 @@ displayMessage() Method that displays validation errors or prompt messages. Uses dijit.Tooltip by default. -======== Examples ======== @@ -120,7 +117,6 @@ ValidationTextBox also supports functions that generate regular expressions. Hav -============= Accessibility ============= @@ -141,7 +137,6 @@ Sometimes the popup message supplied by invalidMessage attribute may be unnecess As of the Dojo 1.0 release and beyond: Window-Eyes 6.1 speaks "read only" for fields that have been marked with the ARIA property invalid=true even though the field is still editable. -======== See also ======== diff --git a/dijit/form/VerticalRuleLabels.rst b/dijit/form/VerticalRuleLabels.rst index 85fc26805..8b180109c 100644 --- a/dijit/form/VerticalRuleLabels.rst +++ b/dijit/form/VerticalRuleLabels.rst @@ -1,5 +1,6 @@ .. _dijit/form/VerticalRuleLabels: +=============================== dijit.form.VerticalRuleLabels =============================== diff --git a/dijit/form/VerticalSlider.rst b/dijit/form/VerticalSlider.rst index 99e5161c0..db2f266b3 100644 --- a/dijit/form/VerticalSlider.rst +++ b/dijit/form/VerticalSlider.rst @@ -1,5 +1,6 @@ .. _dijit/form/VerticalSlider: +========================= dijit.form.VerticalSlider ========================= diff --git a/dijit/form/_FormSelectWidget.rst b/dijit/form/_FormSelectWidget.rst index 2324af48d..22fab8338 100644 --- a/dijit/form/_FormSelectWidget.rst +++ b/dijit/form/_FormSelectWidget.rst @@ -1,5 +1,6 @@ .. _dijit/form/_FormSelectWidget: +============================ dijit.form._FormSelectWidget ============================ @@ -11,13 +12,11 @@ widgets. It is used by :ref:`dijit/form/Select ` and :ref:`do `. It extends :ref:`dijit/form/_FormValueWidget ` with the ability to handle multiple values and retrieve options from a :ref:`dojo/data ` store. -===== Usage ===== See :ref:`dijit/form/Select ` for usage information. -======== See also ======== diff --git a/dijit/form/_FormValueWidget.rst b/dijit/form/_FormValueWidget.rst index 6f910985b..77f0b9012 100644 --- a/dijit/form/_FormValueWidget.rst +++ b/dijit/form/_FormValueWidget.rst @@ -1,5 +1,6 @@ .. _dijit/form/_FormValueWidget: +=========================== dijit.form._FormValueWidget =========================== diff --git a/dijit/form/_FormWidget.rst b/dijit/form/_FormWidget.rst index a0d717ed4..8ad3648da 100644 --- a/dijit/form/_FormWidget.rst +++ b/dijit/form/_FormWidget.rst @@ -1,18 +1,17 @@ .. _dijit/form/_FormWidget: +====================== dijit.form._FormWidget ====================== .. contents :: :depth: 2 -============ Introduction ============ dijit/form/_FormWidget is a base class for all form widgets. -======== See Also ======== diff --git a/dijit/info.rst b/dijit/info.rst index e74ea4765..ae62b3f0c 100644 --- a/dijit/info.rst +++ b/dijit/info.rst @@ -1,5 +1,6 @@ .. _dijit/info: +================== Dijit Introduction ================== @@ -10,7 +11,6 @@ Dijit Introduction *Dijit* is a widget system layered on top of Dojo. If you are new to the whole :ref:`Dojo experience `, Dijit is a good place to start. You can build amazing Web 2.0 GUI's using very little, or no, JavaScript (though having an understanding of JavaScript will take you a long way, as will a good understanding of HTML and CSS). -============ Dijit Basics ============ @@ -99,7 +99,6 @@ This will cause the creator to use the node with id="makeADialog", and turn it i dialog.show(); -========== Attributes ========== @@ -165,7 +164,6 @@ There are several attributes common to (most) all Dijit instances. These appear dialog.declaredClass == "dijit.Dialog" // true -====== Events ====== The other interface for dealing with widgets is to setup event handlers. For example: @@ -188,7 +186,6 @@ Event handlers can be setup programmatically (as above), or declaratively, like: Click me! -====== Themes ====== @@ -199,7 +196,6 @@ You can override the theme by container or by widget element to add nuance and f To learn more about themes, see :ref:`Dijit Themes and Theming `. -=============== Dijit i18n/a11y =============== @@ -210,7 +206,6 @@ no assumptions about local conventions. All widgets are keyboard accessible and in high-contrast mode as well as by screen readers. These features are baked in so that, as much as possible, all users are treated equally. -================ Locating Widgets ================ @@ -261,7 +256,6 @@ Note: it typically doesn't take that many lines to use :ref:`dijit.byNode `, a collection of all widgets active on a page. -================== Behavioral widgets ================== @@ -299,7 +293,6 @@ This comes naturally if you are instantiating from markup. For example, a behav Dijit doesn't have any behavioral widgets, given that it's meant to be able to be used in a purely programmatic setting (without requiring the developer to create any skeletal ``sourceDOM`` nodes), but it is a useful paradigm for some applications, and is supported by Dijit. -======== See also ======== diff --git a/dijit/layout.rst b/dijit/layout.rst index 5087d6749..53c607efa 100644 --- a/dijit/layout.rst +++ b/dijit/layout.rst @@ -1,5 +1,6 @@ .. _dijit/layout: +============ dijit.layout ============ @@ -10,7 +11,6 @@ dijit.layout .. contents:: :depth: 2 -================ An example first ================ @@ -58,7 +58,6 @@ Once you have read through this page you should be able to create such a layout } -================ HTML and Layouts ================ @@ -125,7 +124,6 @@ Layout like above can be done using tables or fancy CSS (see recent `A List Apar However, that technique has it's limits... it doesn't allow things like tabs or accordions or split containers where the user can adjust the size of each pane. -============ Dijit Layout ============ @@ -278,7 +276,6 @@ Conceptually it looks like this: :alt: block diagram of container nesting -================== Sizing to Viewport ================== @@ -296,14 +293,12 @@ where mainDiv is the id of the outermost div. Note that height=width=100% means different things depending on the browser when you have padding or border, so when using those tags it's best not to have either of those. Put your padding, border, and margin on elements inside the outer layout container. -========== Visibility ========== Restrictions about visibility: none of the layout widgets work if they are inside a hidden element. This is very important and a mistake many people make. Dialog, etc. are created using visibility:hidden rather than display:none to avoid this problem. -=================================== Programmatic Creation and Lifecycle =================================== @@ -413,7 +408,6 @@ If you want to notify a widget that it's size has been changed, you omit that ar bc.resize(); -====================== Writing Layout Widgets ====================== diff --git a/dijit/layout/AccordionContainer.rst b/dijit/layout/AccordionContainer.rst index 975b66f00..b21aeb25e 100644 --- a/dijit/layout/AccordionContainer.rst +++ b/dijit/layout/AccordionContainer.rst @@ -1,5 +1,6 @@ .. _dijit/layout/AccordionContainer: +=============================== dijit.layout.AccordionContainer =============================== @@ -14,7 +15,6 @@ dijit.layout.AccordionContainer Like :ref:`StackContainer ` and :ref:`TabContainer `, an **AccordionContainer** holds a set of panes whose titles are all visible, but only one pane's content is visible at a time. Clicking on a pane title slides the currently-displayed one away, similar to a garage door. Users can explicitly select the pane that is to be made visible when the widget is loaded. If it is not specified, then the first pane is taken by default. -======== Examples ======== @@ -83,15 +83,13 @@ Declarative example -============= Accessibility ============= Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate to next title Right or down arrow Navigate to previous title Left or up arrow @@ -102,7 +100,6 @@ Navigate to previous page Ctrl + page up -============= Blueprint ============= diff --git a/dijit/layout/BorderContainer.rst b/dijit/layout/BorderContainer.rst index 4d5e01e34..7fed33c33 100644 --- a/dijit/layout/BorderContainer.rst +++ b/dijit/layout/BorderContainer.rst @@ -1,5 +1,6 @@ .. _dijit/layout/BorderContainer: +============================ dijit.layout.BorderContainer ============================ @@ -13,7 +14,6 @@ dijit.layout.BorderContainer This widget is a container partitioned into up to five regions: left (or leading), right (or trailing), top, and bottom with a mandatory center to fill in any remaining space. Each edge region may have an optional splitter user interface for manual resizing. -===== Usage ===== @@ -60,7 +60,6 @@ BorderContainer operates in a choice of two layout modes: the design attribute m However, the layoutPriority setting for child panes overrides the design attribute on the BorderContainer. In other words, if the top and bottom sections have a lower layoutPriority then the left and right panes then the top and bottom panes will extend the entire width of the box. -======== Examples ======== @@ -310,15 +309,13 @@ You can use a BorderContainer inside your own dijit template with a bit of care } -============= Accessibility ============= Keyboard -------- -=========================================== ================================================= -Action Key +=========================================== Action Key =========================================== ================================================= Navigate to splitters for resizable regions tab - all resizable splitters are in the tab order Change the size of a vertical region left / right arrows to decrease and increase diff --git a/dijit/layout/ContentPane.rst b/dijit/layout/ContentPane.rst index 4c533608f..b23fe21d0 100644 --- a/dijit/layout/ContentPane.rst +++ b/dijit/layout/ContentPane.rst @@ -1,5 +1,6 @@ .. _dijit/layout/ContentPane: +======================== dijit.layout.ContentPane ======================== @@ -12,7 +13,6 @@ dijit.layout.ContentPane A Content Pane is the most basic layout tile. Conceptually, it's like the content boxes in portals like MyYahoo. A content pane resembles an iframe, but contains extra design features, fits in with the current theme, and renders widgets properly. -===== Usage ===== @@ -56,7 +56,6 @@ An example of using a callback might be as follows: myCp.attr("href", "myHtml.html"); -======== Examples ======== @@ -127,7 +126,6 @@ Programmatic example -============= Accessibility ============= diff --git a/dijit/layout/StackContainer.rst b/dijit/layout/StackContainer.rst index c6e2fe69a..81dd260af 100644 --- a/dijit/layout/StackContainer.rst +++ b/dijit/layout/StackContainer.rst @@ -1,5 +1,6 @@ .. _dijit/layout/StackContainer: +=========================== dijit.layout.StackContainer =========================== @@ -11,14 +12,12 @@ dijit.layout.StackContainer A container that has multiple children, but shows only one child at a time (like looking at the pages in a book one by one). -============ Introduction ============ This container is good for wizards, slide shows, and long lists or text blocks. -===== Usage ===== @@ -69,7 +68,6 @@ StackContainer publishes topics * [widgetId]-**selectChild**. -======== Examples ======== @@ -162,15 +160,13 @@ Here you will see a declaratively created StackContainer -============= Accessibility ============= Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate to next tab button Right arrow Navigate to previous tab button Left arrow diff --git a/dijit/layout/TabContainer.rst b/dijit/layout/TabContainer.rst index 464c6574e..90330a7a5 100644 --- a/dijit/layout/TabContainer.rst +++ b/dijit/layout/TabContainer.rst @@ -1,5 +1,6 @@ .. _dijit/layout/TabContainer: +========================= dijit.layout.TabContainer ========================= @@ -14,14 +15,12 @@ dijit.layout.TabContainer A TabContainer is a container that has multiple panes, but shows only one pane at a time. There are a set of tabs corresponding to each pane, where each tab has the title (aka label) of the pane, and optionally a close button. -===== Usage ===== You can use tabs in your own application and style them as you want, but they also fit perfectly into the dijit.layout system. -======== Examples ======== @@ -207,7 +206,6 @@ Normally, TabContainer will show the first Tab. But it's also possible to automa -============= More examples ============= @@ -348,15 +346,13 @@ It is worth noting: If you need a function to be called *absolutely every* time This is because ``addChild`` will not be called for existing panes (in markup). -============= Accessibility ============= Keyboard -------- -========================================== ================================================= -Action Key +========================================== Action Key ========================================== ================================================= Navigate to next tab button Right arrow Navigate to previous tab button Left arrow diff --git a/dijit/layout/_LayoutWidget.rst b/dijit/layout/_LayoutWidget.rst index 1654f3ad3..22c28a6f8 100644 --- a/dijit/layout/_LayoutWidget.rst +++ b/dijit/layout/_LayoutWidget.rst @@ -1,5 +1,6 @@ .. _dijit/layout/_LayoutWidget: +=================== dijit._LayoutWidget =================== @@ -10,7 +11,6 @@ Typically layout widgets inherit from the dijit.layout._LayoutWidget base class. The widget is responsible for implementing some callback methods and setting some properties though: -================= Properties to Set ================= @@ -26,7 +26,6 @@ baseClass Like other widgets, you should define baseClass to be the CSS class name associated with the widget, for example "dijitTabContainer". -==================== Methods To Implement ==================== @@ -58,7 +57,6 @@ To bridge this gap and do processing common to both initial children and added c _setupChild() is useful for tasks like in TabContainer where it sets up a tab label for each child. -========= Lifecycle ========= diff --git a/dijit/place.rst b/dijit/place.rst index 7d278b848..147f4768a 100644 --- a/dijit/place.rst +++ b/dijit/place.rst @@ -1,5 +1,6 @@ .. _dijit/place: +=========== dijit.place =========== @@ -10,13 +11,11 @@ dijit.place .. contents:: :depth: 2 -============ Introduction ============ dijit/place is used to place one DOMNode relative to another DOMNode, or specified rectangle. It is mainly used internally by dijit, by the :ref:`dijit.popup ` code and by :ref:`dijit.Menu ` for displaying context menus. -====== Around ====== @@ -44,7 +43,6 @@ The possible values for the position parameters (inside the array of the second * below: drop down goes below anchor node * below-alt: drop down goes below anchor node, right sides aligned -== At == diff --git a/dijit/popup.rst b/dijit/popup.rst index dd440cd7b..874cbc067 100644 --- a/dijit/popup.rst +++ b/dijit/popup.rst @@ -1,5 +1,6 @@ .. _dijit/popup: +=========== dijit.popup =========== @@ -10,13 +11,11 @@ dijit.popup .. contents:: :depth: 2 -============ Introduction ============ dijit/popup is the main mechanism within dijit that enables the creation of pop-ups like dropdowns and tooltips. It is used by every widget that creates a pop-up around another element. -============== Parent widgets ============== @@ -100,7 +99,6 @@ As you can see, there are three essential calls here, ``popup.moveOffScreen``, ` It’s important to note here that the parent widget is responsible for both opening *and closing* the pop-up. This architecture was used so that the parent widget is always aware of whether or not its child pop-up is open, and so that it can easily perform any necessary clean-up or other relevant activity once its pop-up has closed. -============== Pop-up widgets ============== @@ -133,7 +131,6 @@ Here’s an example from a pop-up widget that triggers onExecute when it’s bee ... } -========= Lifecycle ========= @@ -151,13 +148,11 @@ If the user clicks a blank section of the screen in order to close the pop-up in 2. dijit/popup code doesn’t close the pop-up widget directly, but rather calls the ``onCancel`` callback from the original ``popup.open`` call 3. Parent widget calls ``popup.close``, which closes the pop-up -====== Stacks ====== Pop-ups can open other pop-ups. This ability is leveraged heavily by :ref:`dijit/Menu`. To facilitate this, dijit/popup keeps track of the entire stack of open pop-ups. In the case when a hierarchy of pop-ups all need to be closed at once, calling ``popup.close`` on the top-most pop-up will close all child pop-ups. This means that parent widgets do not need to maintain their own stack of pop-ups in order to ensure that they can clean up properly after themselves. -================= Keyboard handling ================= @@ -165,7 +160,6 @@ dijit/popup automatically listens for key presses on the ESC key as a way to can Note that in neither of these cases does the dijit/popup code directly close any pop-ups—it just calls the ``onCancel`` callback defined in the call to ``popup.open``. That callback then is responsible for calling ``popup.close(popupWidget)``. -========================== Popup DOM node positioning ========================== diff --git a/dijit/registry.rst b/dijit/registry.rst index e58158e4e..9749ad587 100644 --- a/dijit/registry.rst +++ b/dijit/registry.rst @@ -1,5 +1,6 @@ .. _dijit/registry: +============== dijit/registry ============== @@ -9,7 +10,6 @@ dijit/registry .. contents:: :depth: 2 -============ Introduction ============ @@ -22,7 +22,6 @@ Requiring dijit/WidgetSet will automatically re-add these methods (until Dojo 2. If you need to iterate over the entire registry, it is best to call ``registry.toArray`` and use the standard :ref:`dojo array ` functions. -===== Usage ===== @@ -103,7 +102,6 @@ The following will return the TextBox widget, **not** the Form widget: registry.getEnclosingWidget(dom.byId("myTextField")); // returns TextBox }); -======== See also ======== diff --git a/dijit/themes.rst b/dijit/themes.rst index b1881f984..8491ba75a 100644 --- a/dijit/themes.rst +++ b/dijit/themes.rst @@ -1,5 +1,6 @@ .. _dijit/themes: +================== Themes and Theming ================== @@ -37,7 +38,6 @@ and by the addition of a theme class name on a parent element. By using the `` <-- Some Dijit widget HTML files -====================== Widget CSS inheritance ====================== @@ -410,7 +404,6 @@ The following Claro widgets inherit styling from other Claro widgets: - dijit.Toolbar inherits and overwrites dijit.form.Button.css -=================== Theme customization =================== @@ -712,7 +705,6 @@ The class names used on widgets do not change based on the theme, although they -=================================== Applying style directly to a widget =================================== diff --git a/dijit/tree/ForestStoreModel.rst b/dijit/tree/ForestStoreModel.rst index 4a8cdac4d..fe22ef589 100644 --- a/dijit/tree/ForestStoreModel.rst +++ b/dijit/tree/ForestStoreModel.rst @@ -1,5 +1,6 @@ .. _dijit/tree/ForestStoreModel: +=========================== dijit.tree.ForestStoreModel =========================== diff --git a/dijit/tree/Model.rst b/dijit/tree/Model.rst index b49556f43..d1dc1ae8d 100644 --- a/dijit/tree/Model.rst +++ b/dijit/tree/Model.rst @@ -1,5 +1,6 @@ .. _dijit/tree/Model: +================ dijit.tree.Model ================ diff --git a/dijit/tree/TreeStoreModel.rst b/dijit/tree/TreeStoreModel.rst index 33db85846..784e1eac0 100644 --- a/dijit/tree/TreeStoreModel.rst +++ b/dijit/tree/TreeStoreModel.rst @@ -1,5 +1,6 @@ .. _dijit/tree/TreeStoreModel: +========================= dijit.tree.TreeStoreModel ========================= diff --git a/dijit/typematic.rst b/dijit/typematic.rst index 35bbef11f..90464cc7a 100644 --- a/dijit/typematic.rst +++ b/dijit/typematic.rst @@ -1,5 +1,6 @@ .. _dijit/typematic: +=============== dijit.typematic =============== @@ -10,7 +11,6 @@ dijit.typematic .. contents:: :depth: 2 -============ Introduction ============ @@ -19,7 +19,6 @@ dijit/typematic is used for two purposes: * normalize the speed which browsers implement key-repeat (when the user holds down a key on the keyboard, such as the arrow keys) * implement a repeating action when the user holds down a mouse button (typically pressing an arrow icon) -======== Examples ======== diff --git a/dojo/Color.rst b/dojo/Color.rst index 133332f5c..fdf6e5593 100644 --- a/dojo/Color.rst +++ b/dojo/Color.rst @@ -1,5 +1,6 @@ .. _dojo/Color: +================ dojo.Color ================ @@ -20,7 +21,6 @@ As with all dojo._base components, these functions are included within Dojo Base The Color object provides a unified way to store colors, which holds the color in rgba form. This simplifies dealing with the different ways to define colors as everyone can use the format they are most comfortable with. Color objects can be used directly as a value to the various color attributes. -======== Features ======== @@ -48,7 +48,6 @@ Features Parses a string for a color value. You can pass either one of the 16 named colors, hex strings such as "#23ab45" and "#28a", or rgb(a) strings such as "rgb(200,100,50)" and "rgba(200,100,50,0.5)" -======== Examples ======== diff --git a/dojo/Deferred.rst b/dojo/Deferred.rst index 3c35082ed..dc16bf2be 100644 --- a/dojo/Deferred.rst +++ b/dojo/Deferred.rst @@ -1,5 +1,6 @@ .. _dojo/Deferred: +============= dojo.Deferred ============= @@ -13,7 +14,6 @@ dojo.Deferred dojo.Deferred manages the communication between asynchronous threads (Callbacks). dojo.Deferred encapsulates a sequence of callbacks in response to a value that may not yet be available. All of dojo.xhr* functions make use of this class, as do many others, such as dojo.io.script. -============ Introduction ============ @@ -23,7 +23,6 @@ The basic premise is that an asynchronous task (or even a synchronous task) can As with all dojo classes, please see the API documentation for more detail on using dojo.Deferred. -===== Usage ===== @@ -59,7 +58,6 @@ Pseudocode Example 2: Assigning callbacks to fire when a deferred fires. //Do something on failure. }); -========= dojo.when ========= @@ -69,7 +67,6 @@ As of Dojo 1.7, the ``when`` function is exposed as a member of the ``dojo/_base Deferred objects also have a ``promise`` property that provides a read-only view of the result of the operation. This provides a safe robust object that can be passed to other functions without worry of the Deferred being mutated or improperly resolved against expectations. -======== Examples ======== @@ -113,7 +110,6 @@ Example 1: Creating a deferred and adding callbacks -======== See Also ======== diff --git a/dojo/DeferredList.rst b/dojo/DeferredList.rst index 102de06ad..55775286c 100644 --- a/dojo/DeferredList.rst +++ b/dojo/DeferredList.rst @@ -1,5 +1,6 @@ .. _dojo/DeferredList: +================= dojo.DeferredList ================= diff --git a/dojo/Evented.rst b/dojo/Evented.rst index 09004dc39..7e4c6994b 100644 --- a/dojo/Evented.rst +++ b/dojo/Evented.rst @@ -1,5 +1,6 @@ .. _dojo/Evented: +======= dojo/on ======= @@ -12,7 +13,6 @@ dojo/on The dojo/Evented module is a class that can be used as a base class or mixin for JavaScript classes that have their own events. -================ dojo/Evented API ================ @@ -36,7 +36,6 @@ The Evented class provides two methods, on(eventType, listener) and emit(eventTy component.startup(); }); -======================== Event Handler Properties ======================== diff --git a/dojo/NodeList-data.rst b/dojo/NodeList-data.rst index f4fe3b5bc..71ed134c0 100644 --- a/dojo/NodeList-data.rst +++ b/dojo/NodeList-data.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList-data: +================== dojo.NodeList-data ================== @@ -9,7 +10,6 @@ dojo.NodeList-data :author: Peter Higgins :since: 1.6.0 -======== Overview ======== @@ -31,7 +31,6 @@ Since Dojo 1.7, you need to use 'require()' to import this module: // your codes here }); -============ Using data() ============ @@ -234,7 +233,6 @@ Here is a comparison: if(data == dat2){ alert("see?") } }); -============ Data Removal ============ @@ -270,7 +268,6 @@ There is, however, no way to remove a list of keys. An example of how to do so w array.forEach(["key", "otherkey", "somekey"], remover); }); -===================== Memory Considerations ===================== @@ -278,7 +275,6 @@ There is no automatic node-deletion tracking going on. If you bind data to a nod You can call :ref:``gcNodeData`` at any time. It will remove items from the cache for nodes that no longer exist in the DOM. This function could be **wildly** expensive, especially on pages with a large DOM. Again, though this API is provided, it is **highly** recommended you manually manage your Data items if in a scenario leading to these potential "leaks". -========= See Also ========= diff --git a/dojo/NodeList-dom.rst b/dojo/NodeList-dom.rst index 7f67e8447..e0065045e 100644 --- a/dojo/NodeList-dom.rst +++ b/dojo/NodeList-dom.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList-dom: +================= dojo/NodeList-dom ================= diff --git a/dojo/NodeList-manipulate.rst b/dojo/NodeList-manipulate.rst index 032f86961..bbc2188d3 100644 --- a/dojo/NodeList-manipulate.rst +++ b/dojo/NodeList-manipulate.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList-manipulate: +======================== dojo.NodeList-manipulate ======================== @@ -14,14 +15,12 @@ dojo.NodeList-manipulate Method extensions to :ref:`dojo.NodeList `/:ref:`dojo.query ` that manipulate HTML. These methods are intended to match the API naming and behavior as the similarly named methods in jQuery. -============ Introduction ============ Doing a dojo.require("dojo.NodeList-manipulate") (since Dojo 1.7, it's suggested to use AMD-style module loading, e.g. require(["dojo/NodeList-manipulate"]).) will add some addition methods to :ref:`dojo.NodeList ` (the return object from a :ref:`dojo.query ` call) that allow easier manipulation of HTML as it relates to the nodes in the dojo.NodeList. -===== Usage ===== @@ -48,7 +47,6 @@ Here is a simple example showing how dojo.NodeList-manipulate adds an "after" me }); -========================================= Methods added by dojo.NodeList-manipulate ========================================= @@ -922,7 +920,6 @@ Results in this DOM structure: -======== See also ======== diff --git a/dojo/NodeList-traverse.rst b/dojo/NodeList-traverse.rst index 7954746b7..1c9d70b79 100644 --- a/dojo/NodeList-traverse.rst +++ b/dojo/NodeList-traverse.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList-traverse: +======================== dojo.NodeList-traverse ======================== @@ -13,14 +14,12 @@ dojo.NodeList-traverse Method extensions to :ref:`dojo.NodeList `/:ref:`dojo.query ` for traversing the DOM. These methods are intended to match the API naming and behavior as the similarly named methods in jQuery. -============ Introduction ============ Doing a dojo.require("dojo.NodeList-traverse") (since Dojo 1.7 you're suggested to use AMD-style module loading, e.g. require(["dojo/NodeList-traverse"])) will add some addition methods to :ref:`dojo.NodeList ` (the return object from a :ref:`dojo.query ` call) that allow easier traversal of the DOM as it relates to the nodes in the dojo.NodeList. -===== Usage ===== @@ -50,7 +49,6 @@ Here is a simple example showing how dojo.NodeList-traverse adds a "children" me }); -========================================= Methods added by dojo.NodeList-traverse ========================================= diff --git a/dojo/NodeList.rst b/dojo/NodeList.rst index c3deb6061..554a70254 100644 --- a/dojo/NodeList.rst +++ b/dojo/NodeList.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList: +============= dojo.NodeList ============= @@ -11,7 +12,6 @@ dojo.NodeList **NodeLists** are standard Arrays, decorated with many helpful functions which act on each DOM Node in the list. -============ Introduction ============ @@ -102,7 +102,6 @@ The helper functions attached to the NodeList typically return the same instance dojo.query(e.target).style({ opacity:1 }).toggleClass("clicked"); }); -========================= Common NodeList Functions ========================= @@ -180,7 +179,6 @@ As is the case for ``removeClass()``, ``addClass()``, ``place()``, and most othe console.log(n, "has", coords[i].w, "width"); }); -===================== Events with NodeLists ===================== @@ -307,7 +305,6 @@ This example prevents the form from submitting and instead uses Ajax to send the An event delegation API is provided in :ref:`dojox.NodeList.delegate ` -================== Extending NodeList ================== @@ -344,7 +341,6 @@ Or, "Writing Your Own Plugins": Adding your own code to the dojo.NodeList class The import part being ``'return this'``, ensuring any following chains will work. -=================== NodeList extensions =================== @@ -381,7 +377,6 @@ Additional Extensions * :ref:`dojox.NodeList.delegate ` - Event delegation for dojo.NodeList -=========== API Details =========== diff --git a/dojo/NodeList/attr.rst b/dojo/NodeList/attr.rst index 3dd3221de..17adbd811 100644 --- a/dojo/NodeList/attr.rst +++ b/dojo/NodeList/attr.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList/attr: +================== dojo.NodeList.attr ================== @@ -12,7 +13,6 @@ dojo.NodeList.attr A getter and setter for DOM attributes, events and CSS styles adapted to work with node lists. -============ Introduction ============ @@ -21,7 +21,6 @@ Introduction See :ref:`dojo.attr ` for more details. -===== Usage ===== @@ -36,7 +35,6 @@ value If passed, sets value on the node for an attribute, handling cross-browser concerns. -======== Examples ======== @@ -70,7 +68,6 @@ The following example will set several attributes such as the ``value`` and ``di

-======== See also ======== diff --git a/dojo/NodeList/removeAttr.rst b/dojo/NodeList/removeAttr.rst index 9657049cf..9d24f78b9 100644 --- a/dojo/NodeList/removeAttr.rst +++ b/dojo/NodeList/removeAttr.rst @@ -1,5 +1,6 @@ .. _dojo/NodeList/removeAttr: +======================== dojo.NodeList.removeAttr ======================== @@ -12,7 +13,6 @@ dojo.NodeList.removeAttr Removes an attribute from a list f DOM nodes. -============ Introduction ============ @@ -21,7 +21,6 @@ Introduction See :ref:`dojo.removeAttr ` for more details. -===== Usage ===== @@ -33,7 +32,6 @@ attr the attribute property name. -======== Examples ======== @@ -60,7 +58,6 @@ The following example removes ``disabled`` from nodes.

-======== See also ======== diff --git a/dojo/Stateful.rst b/dojo/Stateful.rst index 17f5e9006..c730dbf69 100644 --- a/dojo/Stateful.rst +++ b/dojo/Stateful.rst @@ -1,5 +1,6 @@ .. _dojo/Stateful: +============= dojo.Stateful ============= @@ -13,13 +14,11 @@ dojo.Stateful A new generic interface and base class for getting, setting, and watching for property changes (with getters and setters) in a consistent manner. -============ Introduction ============ dojo.Stateful provides the ability to get and set named properties in conjunction with the ability to monitor these properties for changes. dojo.Stateful is intended to be a base class that can be extended by other components that wish to support watchable properties. This can be very useful for creating live bindings that utilize current property states and must react to any changes in properties. -===== Usage ===== @@ -55,7 +54,6 @@ Dojo < 1.7 // test: change obj.foo: myObj.set("foo","bar"); -================= Available Methods ================= @@ -72,7 +70,6 @@ Available Methods Watches a property for changes. ***new in 1.5*** -======== Examples ======== @@ -213,7 +210,6 @@ returns: -======== See also ======== diff --git a/dojo/Url.rst b/dojo/Url.rst index e92634184..46c4fa188 100644 --- a/dojo/Url.rst +++ b/dojo/Url.rst @@ -1,5 +1,6 @@ .. _dojo/Url: +============= dojo._Url ============= diff --git a/dojo/_base/Color.rst b/dojo/_base/Color.rst index 6a38b1095..190517bae 100644 --- a/dojo/_base/Color.rst +++ b/dojo/_base/Color.rst @@ -1,5 +1,6 @@ .. _dojo/_base/Color: +================ dojo._base.Color ================ @@ -20,7 +21,6 @@ As with all dojo._base components, these functions are included within Dojo Base The Color object provides a unified way to store colors, which holds the color in rgba form. This simplifies dealing with the different ways to define colors as everyone can use the format they are most comfortable with. Color objects can be used directly as a value to the various color attributes. -======== Features ======== @@ -48,7 +48,6 @@ Features Parses a string for a color value. You can pass either one of the 16 named colors, hex strings such as "#23ab45" and "#28a", or rgb(a) strings such as "rgb(200,100,50)" and "rgba(200,100,50,0.5)" -====================== Examples 1.7 AMD-style ====================== @@ -141,7 +140,6 @@ The last example shows how one can use the color object directly to change the p // This changes the background-color of the element "someId" to the color specified in myColor }); -========================== Examples pre-1.7 API style ========================== diff --git a/dojo/_base/Deferred.rst b/dojo/_base/Deferred.rst index 1b7e4935a..e14e0aefd 100644 --- a/dojo/_base/Deferred.rst +++ b/dojo/_base/Deferred.rst @@ -1,5 +1,6 @@ .. _dojo/_base/Deferred: +=================== dojo._base.Deferred =================== @@ -15,7 +16,6 @@ dojo._base.Deferred As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/_base/NodeList.rst b/dojo/_base/NodeList.rst index 396c20d4b..b722f9f3f 100644 --- a/dojo/_base/NodeList.rst +++ b/dojo/_base/NodeList.rst @@ -1,5 +1,6 @@ .. _dojo/_base/NodeList: +=================== dojo._base.NodeList =================== @@ -15,7 +16,6 @@ dojo._base.NodeList As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/_base/connect.rst b/dojo/_base/connect.rst index 181304b60..d1edaba0c 100644 --- a/dojo/_base/connect.rst +++ b/dojo/_base/connect.rst @@ -1,5 +1,6 @@ .. _dojo/_base/connect: +================== dojo._base.connect ================== @@ -18,7 +19,6 @@ dojo._base.connect As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/_base/declare.rst b/dojo/_base/declare.rst index ae976e911..f992fd045 100644 --- a/dojo/_base/declare.rst +++ b/dojo/_base/declare.rst @@ -1,5 +1,6 @@ .. _dojo/_base/declare: +================== dojo._base.declare ================== @@ -15,7 +16,6 @@ dojo._base.declare As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/_base/fx.rst b/dojo/_base/fx.rst index 5e14be07f..78c166e45 100644 --- a/dojo/_base/fx.rst +++ b/dojo/_base/fx.rst @@ -1,5 +1,6 @@ .. _dojo/_base/fx: +============= dojo/_base/fx ============= @@ -15,7 +16,6 @@ dojo/_base/fx As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== @@ -23,7 +23,6 @@ Features * :ref:`dojo.fadeIn ` * :ref:`dojo.fadeOut ` -======== See also ======== diff --git a/dojo/_base/html.rst b/dojo/_base/html.rst index e6328acfc..8cbdba62a 100644 --- a/dojo/_base/html.rst +++ b/dojo/_base/html.rst @@ -1,5 +1,6 @@ .. _dojo/_base/html: +=============== dojo/_base/html =============== @@ -16,7 +17,6 @@ The **dojo/_base/html** module defines aliases to basic DOM & HTML handling func As of Dojo 1.7, the recommended practice going forward (with ``async: true``) is to require just the individual dependencies you need, instead of ``dojo/_base/html``. The new locations of its functions are indicated in the list below. -======== Features ======== @@ -197,7 +197,6 @@ Features Accesses styles on a node. If 2 arguments are passed, acts as a getter. If 3 arguments are passed, acts as a setter. -======== See also ======== diff --git a/dojo/_base/json.rst b/dojo/_base/json.rst index 356ac3da9..42eb3a57f 100644 --- a/dojo/_base/json.rst +++ b/dojo/_base/json.rst @@ -1,5 +1,6 @@ .. _dojo/_base/json: +=============== dojo._base.json =============== @@ -15,7 +16,6 @@ dojo._base.json As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/_base/lang.rst b/dojo/_base/lang.rst index 0c16cd677..512a4d523 100644 --- a/dojo/_base/lang.rst +++ b/dojo/_base/lang.rst @@ -1,5 +1,6 @@ .. _dojo/_base/lang: +=============== dojo/_base/lang =============== @@ -13,7 +14,6 @@ dojo/_base/lang As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== @@ -81,7 +81,6 @@ Features -======== See also ======== diff --git a/dojo/_base/query.rst b/dojo/_base/query.rst index beee62198..4cee5897d 100644 --- a/dojo/_base/query.rst +++ b/dojo/_base/query.rst @@ -1,5 +1,6 @@ .. _dojo/_base/query: +================ dojo._base.query ================ @@ -16,7 +17,6 @@ dojo._base.query As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/_base/window.rst b/dojo/_base/window.rst index c55027a74..1a2d3801c 100644 --- a/dojo/_base/window.rst +++ b/dojo/_base/window.rst @@ -1,5 +1,6 @@ .. _dojo/_base/window: +================= dojo._base.window ================= @@ -13,7 +14,6 @@ dojo._base.window As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/addClass.rst b/dojo/addClass.rst index 1472a8f80..5cd2eb707 100644 --- a/dojo/addClass.rst +++ b/dojo/addClass.rst @@ -1,5 +1,6 @@ .. _dojo/addClass: +============= dojo.addClass ============= @@ -13,7 +14,6 @@ Safely adds a CSS class or a set of classes to a node avoiding duplications. Since Dojo 1.7, ``dojo.addClass`` is exposed via the ``add`` method of the ``dojo/dom-class`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -53,7 +53,6 @@ Dojo < 1.7 // Add a class to some node: dojo.addClass("someNode", "anewClass"); -======== Examples ======== @@ -257,7 +256,6 @@ See it in action: -======== See also ======== diff --git a/dojo/addOnLoad.rst b/dojo/addOnLoad.rst index 63680b94e..53d861ef1 100644 --- a/dojo/addOnLoad.rst +++ b/dojo/addOnLoad.rst @@ -1,5 +1,6 @@ .. _dojo/addOnLoad: +============== dojo.addOnLoad ============== @@ -7,7 +8,6 @@ dojo.addOnLoad() has been deprecated in favor of the (equivalent) :ref:`dojo.rea The documentation below is preserved for legacy purposes: -================= Old Documentation ================= dojo.addOnLoad is a fundamental aspect of using Dojo. Passing addOnLoad a function will register the function to run when the Dom is ready. This differs slightly from document.ready and body.onload in that addOnLoad waits until all dependencies (and their recursive dependencies) have loaded before firing. @@ -100,7 +100,6 @@ Another use is "embedded onLoad". We'll define an addOnLoad function (anonymous) If no in-flight XHR activity is found, and all dependencies have been solved, addOnLoad functions fire immediately. -======== Examples ======== diff --git a/dojo/addOnUnload.rst b/dojo/addOnUnload.rst index f922e8a33..8aae1df5c 100644 --- a/dojo/addOnUnload.rst +++ b/dojo/addOnUnload.rst @@ -1,5 +1,6 @@ .. _dojo/addOnUnload: +================ dojo.addOnUnload ================ @@ -13,14 +14,12 @@ dojo.addOnUnload dojo.addOnUnload registers a function to be called when the page unloads. -============ Introduction ============ Since working with the DOM or JavaScript during a `window.onunload` event is not recommended, dojo.addOnUnload is triggered during `window.onbeforeunload`. However, you need to be careful about what work you do during `dojo.addOnUnload/window.onbeforeunload` since this event can be triggered if the user clicks a link to download a file or a `javascript:` link. In these cases, the `document` will not be destroyed and so any destructive operations done during a `dojo.addOnUnload` callback may be premature. If you need to run code during `window.onunload` then you can register a function using :ref:`dojo.addOnWindowUnload `. -===== Usage ===== @@ -70,7 +69,6 @@ Dojo < 1.7 -======== Examples ======== @@ -94,7 +92,6 @@ This example demonstrates how a `javascript:` link will trigger a `dojo.addOnUnl This link has an
href="javascript:unLoad()"
which fires dojo.addOnUnload but won't destroy the page. -======== See also ======== diff --git a/dojo/addOnWindowUnload.rst b/dojo/addOnWindowUnload.rst index 3a57e1c0f..739a5466c 100644 --- a/dojo/addOnWindowUnload.rst +++ b/dojo/addOnWindowUnload.rst @@ -1,5 +1,6 @@ .. _dojo/addOnWindowUnload: +====================== dojo.addOnWindowUnload ====================== @@ -13,14 +14,12 @@ dojo.addOnWindowUnload dojo.addOnWindowUnload registers a function to be triggered when window.onunload fires. -============ Introduction ============ When a user exits the page to visit another page, the page is unloaded and a `window.onunload` event handler is fired. During this phase of page loading, it is not recommended that you try to modify the DOM or access JavaScript properties since they may not be available. You should consider using :ref:`dojo.addOnUnload ` if you need to modify the DOM or do heavy JavaScript work since it triggers functions during the `window.onbeforeunload`. -===== Usage ===== diff --git a/dojo/anim.rst b/dojo/anim.rst index 22b80d90e..236755155 100644 --- a/dojo/anim.rst +++ b/dojo/anim.rst @@ -1,5 +1,6 @@ .. _dojo/anim: +========= dojo.anim ========= @@ -12,7 +13,6 @@ dojo.anim A simpler interface to `dojo.animateProperty()`. -============ Introduction ============ @@ -23,7 +23,6 @@ dojo.anim returns an instance of `dojo.Animation` but begins the animation immed The `dojo.Animation` object returned from `dojo.anim` will be already playing when it is returned from this function, so calling play() on it again is (usually) a no-op. -===== Usage ===== @@ -50,8 +49,7 @@ Dojo < 1.7 Here is the definition of arguments: -=========== ============== ====================================================================== -Parameter Type Description +=========== ============== Parameter Type Description =========== ============== ====================================================================== node DOMNode|String Can be a DOM node or the id of a node (as string) to animate CSS properties on. @@ -67,7 +65,6 @@ delay Integer The number of milliseconds to delay beginning the a =========== ============== ====================================================================== -======== Examples ======== @@ -82,7 +79,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojo/animateProperty.rst b/dojo/animateProperty.rst index 7f6c343b9..ab55c977e 100644 --- a/dojo/animateProperty.rst +++ b/dojo/animateProperty.rst @@ -1,5 +1,6 @@ .. _dojo/animateProperty: +==================== dojo.animateProperty ==================== @@ -13,7 +14,6 @@ dojo.animateProperty dojo.animateProperty is a very useful method for animating CSS properties. An example use case is fading a background color from red to green to indicate status changes. -===== Usage ===== @@ -81,7 +81,6 @@ As seen, we simply add new keys to the ``properties:`` hash. The above example i It is also worth noting: when animating multi-word CSS properties such as ``font-size``, Javascript requires they be converted to the mixed-case: ``fontSize``. -=================== Advanced Properties =================== @@ -155,7 +154,6 @@ Dojo <1.7 As pointed out above, the height: function is passed a reference to the domNode being animated. This functionality is new in Dojo 1.4, as well as the addition of the node being passed to the start: and end: functions. -======== Examples ======== diff --git a/dojo/aspect.rst b/dojo/aspect.rst index f86f34ff1..34c2e5301 100644 --- a/dojo/aspect.rst +++ b/dojo/aspect.rst @@ -1,5 +1,6 @@ .. _dojo/aspect: +=========== dojo/aspect =========== @@ -12,7 +13,6 @@ dojo/aspect The dojo/aspect module provides aspect oriented programming facilities to attach additional functionality to existing methods. The dojo/aspect module returns three functions. Note: If you are connecting to DOM Events rather than regular JS objects and functions, use dojo/on rather than dojo/aspect. -=============== dojo/aspect API =============== diff --git a/dojo/attr.rst b/dojo/attr.rst index 993abdeb2..d529bd4bb 100644 --- a/dojo/attr.rst +++ b/dojo/attr.rst @@ -1,5 +1,6 @@ .. _dojo/attr: +========= dojo.attr ========= @@ -11,7 +12,6 @@ dojo.attr A getter and setter for DOM attributes, events and CSS styles -============ Introduction ============ @@ -23,7 +23,6 @@ If an attribute was not specified for the DOM node, it will return a falsy value Since Dojo 1.7, ``dojo.attr`` is exposed via the ``get`` and ``set`` methods of the ``dojo/dom-attr`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -94,7 +93,6 @@ This function can be used to associate a function with a DOM event. Please note * Internally it uses :ref:`dojo.connect ` to attach an event handler. See :ref:`dojo.connect ` for more details on event processing. * Unlike :ref:`dojo.connect ` no handle is returned. It means that there is no simple way to remove the event handler: use ``dojo.attr()`` to set event handlers only in simple cases. Always consider to use :ref:`dojo.connect ` and :ref:`dojo.disconnect ` instead. -======== Examples ======== @@ -191,7 +189,6 @@ The following example will set the "style" attribute of the given dom node. When
Hi, change my style
-======== See also ======== diff --git a/dojo/back.rst b/dojo/back.rst index 32849185a..b3d28111c 100644 --- a/dojo/back.rst +++ b/dojo/back.rst @@ -1,5 +1,6 @@ .. _dojo/back: +========= dojo.back ========= @@ -12,7 +13,6 @@ dojo.back allows you to update the browser history, so that it's possible to use **NOTE**: There are problems with using dojo.back with semantically-named fragment identifiers ("hash values" on an URL). In most browsers it will be hard for dojo.back to know distinguish a back from a forward event in those cases. For back/forward support to work best, the fragment ID should always be a unique value (something using new Date().getTime() for example). If you want to detect hash changes using semantic fragment IDs, then consider using :ref:`dojo.hash ` instead (in Dojo 1.4+). -===== Usage ===== @@ -110,7 +110,6 @@ To change the URL in the browser's location bar, include a **changeUrl** propert This will allow users to bookmark the page. -======== Examples ======== diff --git a/dojo/base.rst b/dojo/base.rst index d9d99ae7e..a5f3b948a 100644 --- a/dojo/base.rst +++ b/dojo/base.rst @@ -1,5 +1,6 @@ .. _dojo/base: +========== dojo._base ========== diff --git a/dojo/base/loader.rst b/dojo/base/loader.rst index 2957acbce..658547009 100644 --- a/dojo/base/loader.rst +++ b/dojo/base/loader.rst @@ -1,5 +1,6 @@ .. _dojo/base/loader: +================= dojo._base.loader ================= @@ -15,7 +16,6 @@ dojo._base.loader As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -======== Features ======== diff --git a/dojo/behavior.rst b/dojo/behavior.rst index 6f358262f..c54922779 100644 --- a/dojo/behavior.rst +++ b/dojo/behavior.rst @@ -1,5 +1,6 @@ .. _dojo/behavior: +============= dojo.behavior ============= @@ -15,7 +16,6 @@ dojo.behavior A very simple, lightweight mechanism for applying code to existing documents, based around :ref:`dojo.query ` for node selection, and a simple two-command API: dojo.behavior.add() and dojo.behavior.apply(); -===== Usage ===== @@ -56,7 +56,6 @@ Dojo < 1.7 Calling ``.apply()`` applies all the added behaviors. -===================== Behaviors with events ===================== @@ -111,7 +110,6 @@ Beyond simple application, we can bind selectors to Dom Events, and more, using The ``found:`` function is applied to all found nodes. The ``onclick:`` identifier will bind an onclick function to all found nodes. You can use any Dom Event name, such as ``onclick``, ``onmouseenter``, ``onmouseleave``, ``onblur``, etc. -===================== Behaviors with topics ===================== diff --git a/dojo/body.rst b/dojo/body.rst index 9a70d5013..751bd4bd2 100644 --- a/dojo/body.rst +++ b/dojo/body.rst @@ -1,5 +1,6 @@ .. _dojo/body: +========= dojo.body ========= @@ -13,7 +14,6 @@ dojo.body Returns the body element of the document. -============ Introduction ============ @@ -21,7 +21,6 @@ This is a shorthand ``method`` for accessing the `` element within the doc `dojo.body` is a very simple function with one purpose: -===== Usage ===== diff --git a/dojo/browser.rst b/dojo/browser.rst index 1cf6c9fb1..e660e61f3 100644 --- a/dojo/browser.rst +++ b/dojo/browser.rst @@ -1,5 +1,6 @@ .. _dojo/browser: +============ dojo.browser ============ diff --git a/dojo/byId.rst b/dojo/byId.rst index c73021b6a..6012612e4 100644 --- a/dojo/byId.rst +++ b/dojo/byId.rst @@ -1,5 +1,6 @@ .. _dojo/byId: +========= dojo.byId ========= @@ -12,7 +13,6 @@ This is a simple alias to ''document.getElementById'', which not only is shorter Since dojo 1.7, dojo.byId is defined in the ``dojo/dom`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -131,7 +131,6 @@ JavaScript has a fun convention for conditionals inline. Imagine wanting a domNo Above, if the node id="missingNode" is in fact missing, the logical OR will continue, and use othernode as the value of node. -======== Examples ======== diff --git a/dojo/cache.rst b/dojo/cache.rst index 9d8c30e5d..56537d357 100644 --- a/dojo/cache.rst +++ b/dojo/cache.rst @@ -1,5 +1,6 @@ .. _dojo/cache: +========== dojo.cache ========== @@ -12,7 +13,6 @@ dojo.cache A getter and setter method for storing the string content associated with the module and url arguments. It is a generic version of the functionality provided by dijit's templatePath method. -============ Introduction ============ @@ -23,7 +23,6 @@ There are many times where you will want to inject some raw HTML into the DOM. H The Dojo build system will inline the HTML as a string where the ``dojo.cache`` call happens, so it allows for better performance just by doing a build. Doing a build also allows the module to be used in xdomain loading scenarios. -===== Usage ===== @@ -50,8 +49,7 @@ Usage Here is the definition of arguments: -=========== ============= ====================================================================== -Parameter Type Description +=========== ============= Parameter Type Description =========== ============= ====================================================================== module String|Object Can be a String or an Object. @@ -79,7 +77,6 @@ configValue String|Object Can be a String or an Object. =========== ============= ====================================================================== -======== Examples ======== @@ -135,7 +132,6 @@ Example using an object that has like the previous example, but uses an object w var text = dojo.cache(new dojo._Url("my/module/template.html"), {sanitize: true}); -======== See Also ======== diff --git a/dojo/cldr.rst b/dojo/cldr.rst index a5128c5c2..c04d596af 100644 --- a/dojo/cldr.rst +++ b/dojo/cldr.rst @@ -1,5 +1,6 @@ .. _dojo/cldr: +========= dojo.cldr ========= @@ -13,14 +14,12 @@ dojo.cldr Contains data from the Common Locale Data Repository (CLDR) http://unicode.org/cldr with associated utility classes -============ Introduction ============ This data contains tables with culturally sensitive information for hundreds of languages and country variants, such as translations of days of the week, months of the year, patterns for formatting dates and numbers. This is used by dojo.date, dojo.number, and dojo.currency to produce localized output. The nls/ directory as provided in the standard download of Dojo contains a subset of the available locales; a complete set is available by running the ant script in util/buildscripts/cldr. See the section "Buildscripts" below for more information. It is therefore usually not necessary to hand-craft localized copies of this information. The unicode.org CLDR project is responsible for the choices made in these files and has both a bug tracker and survey application on their website. -===== Usage ===== @@ -72,7 +71,6 @@ To trigger generation of a full set of locale resources, change into the directo NOTE: it is currently necessary to perform a one-time installation of the Saxon XSLT processor in ~/.ant/lib due to classpath issues and workarounds. The ant task will do this for you. Also, ant version 1.6.5 is recommended. The build script does not properly resolve the XSLT catalog with newer versions of ant which makes the process take much longer. See ticket #7969 -======== Examples ======== @@ -111,7 +109,6 @@ The following example prints out the monetary data (places and round) for EUR (E
-======== See also ======== diff --git a/dojo/clone.rst b/dojo/clone.rst index bc12ec53f..ebb34fcbb 100644 --- a/dojo/clone.rst +++ b/dojo/clone.rst @@ -1,5 +1,6 @@ .. _dojo/clone: +=============== dojo.clone =============== @@ -13,7 +14,6 @@ dojo.clone Part of Base Dojo (dojo.js) - Clones `anything` objects and/or nodes, returning a new `anything`. -===== Usage ===== diff --git a/dojo/config.rst b/dojo/config.rst index 2e8e93db7..1967a3982 100644 --- a/dojo/config.rst +++ b/dojo/config.rst @@ -1,5 +1,6 @@ .. _dojo/config: +=============================== dojo.config (dojo/_base/config) =============================== @@ -11,7 +12,6 @@ dojo.config (dojo/_base/config) Configuring Dojo with dojoConfig (formerly known as djConfig) -============ Introduction ============ @@ -23,7 +23,6 @@ Dojo allows developers to override certain global settings that control how the * If you rename core dojo components or place dojo resources in non-standard locations -===== Usage ===== @@ -223,7 +222,6 @@ This creates a `new` configuration parameter named ``myCustomVariable``. To use By referencing `dojo.config.myCustomVariable` as opposed to relying on `dojoConfig.myCustomVariable` you will be able to utilize the variable safely in built versions using an alternate scopeName -=============================================== Backwards Compatibility and Order of Precedence =============================================== diff --git a/dojo/connect.rst b/dojo/connect.rst index 14d2e12df..bd4c9aa70 100644 --- a/dojo/connect.rst +++ b/dojo/connect.rst @@ -1,5 +1,6 @@ .. _dojo/connect: +================================= dojo.connect (dojo/_base/connect) ================================= @@ -11,13 +12,11 @@ dojo.connect (dojo/_base/connect) dojo.connect connects events to methods, so that after the event occurs, the new connected method is called too. -================================================= Preferred event handling mechanism is now dojo/on ================================================= Dojo versions prior to 1.7 used the connect module for event handling. As of Dojo 1.7, the preferred way of handling events is to use the new lightweight dojo/on module. For compatibility reasons, the dojo.connect api's will remain fully supported through remaining 1.x releases, but will likely be removed in Dojo 2.0. Migration from connect() to on() should be straightforward as the api signature is very similar. -============ Introduction ============ @@ -34,7 +33,6 @@ When setting up a connection, the `event` parameter must be a string that is the The return value is a handle that is needed to remove this connection with `dojo.disconnect`. -===== Usage ===== @@ -47,8 +45,7 @@ Usage // Dojo < 1.7 dojo.connect(obj, event, context, method, dontFix); -========= =============== ================================================== -Parameter Type Description +========= =============== Parameter Type Description ========= =============== ================================================== obj Object|null The source object for the event function. Defaults to dojo.global if null. If obj is a DOM node, the connection is delegated to the DOM event manager (unless dontFix is true). event String name of the event function in obj. I.e. identifies a property obj[event]. @@ -58,7 +55,6 @@ dontFix Boolean Optional. If obj is a DOM node, set dontFix to true ========= =============== ================================================== -======== Examples ======== @@ -128,7 +124,6 @@ Dojo < 1.7 dojo.connect("globalEvent", globalHandler); // same -======== See also ======== diff --git a/dojo/connectPublisher.rst b/dojo/connectPublisher.rst index 9b8247c95..ea410c751 100644 --- a/dojo/connectPublisher.rst +++ b/dojo/connectPublisher.rst @@ -69,8 +69,7 @@ Usage Returns a handle which can be passed to :ref:`dojo.disconnect() ` to disable subsequent automatic publication on the topic. -========= =========== ============================================================================= -Parameter Type Description +========= =========== Parameter Type Description ========= =========== ============================================================================= topic String The name of the topic to publish. obj Object|null The source object for the event function. Defaults to dojo.global if null. diff --git a/dojo/contentHandlers.rst b/dojo/contentHandlers.rst index 941b9a495..03d8789f8 100644 --- a/dojo/contentHandlers.rst +++ b/dojo/contentHandlers.rst @@ -1,5 +1,6 @@ .. _dojo/contentHandlers: +==================== dojo.contentHandlers ==================== @@ -12,7 +13,6 @@ dojo.contentHandlers dojo.contentHandlers is an object containing several pre-defined "handlers" for Ajax traffic, exposed as a public API to allow your own custom handlers to be mixed in. -===== Usage ===== @@ -67,7 +67,6 @@ There are several pre-defined contentHandlers available to use. The value repres * **json-comment-optional** - A handler which detects the presence of a filtered response and toggles between json or json-comment-filtered appropriately. -======== Examples ======== @@ -283,7 +282,6 @@ Standard AOP techniques apply. If you find yourself needing to *replace* a conte }; -===== Notes ===== diff --git a/dojo/cookie.rst b/dojo/cookie.rst index fe39927ad..bfb8f0953 100644 --- a/dojo/cookie.rst +++ b/dojo/cookie.rst @@ -1,5 +1,6 @@ .. _dojo/cookie: +=========== dojo.cookie =========== @@ -8,7 +9,6 @@ dojo.cookie ``dojo.cookie`` is your one stop for handling client side cookies. Its usage is very simple and the following example should make it clear -===== Usage ===== @@ -28,8 +28,7 @@ Usage // To get a cookie var cookieValue = dojo.cookie(cookieName); -============= =============== ================================================== -Parameter Type Description +============= =============== Parameter Type Description ============= =============== ================================================== cookieName String Name of the cookie to set/get cookieValue String Value of the cookie to set. @@ -65,7 +64,6 @@ Set a cookie by clicking on the button, reload the page and click the "Get Cooki -======== See also ======== diff --git a/dojo/coords.rst b/dojo/coords.rst index 11a453a29..6c592cc0c 100644 --- a/dojo/coords.rst +++ b/dojo/coords.rst @@ -1,5 +1,6 @@ .. _dojo/coords: +=========== dojo.coords =========== @@ -14,7 +15,6 @@ dojo.coords Getter for the complete coordinates of a dom node. -============ Introduction ============ @@ -26,7 +26,6 @@ for a node offset from its parent 50px to the left, 200px from the top with a ma Since dojo 1.7, ``dojo.coords`` is available in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -46,7 +45,6 @@ Dojo < 1.7 var coords = dojo.coords(node); -======== Examples ======== @@ -111,7 +109,6 @@ Comparison of various DOM node position/size methods :ref:`Link: Comparison of various DOM node position/size methods. ` -===== Notes ===== * For dom nodes with border styles, on Internet Explorer the absolute coordinates (x and y axis), do not include the border position, so you may have to adjust for that depending on what your indented usage of the information is. diff --git a/dojo/create.rst b/dojo/create.rst index 25708c422..799dd5f12 100644 --- a/dojo/create.rst +++ b/dojo/create.rst @@ -1,5 +1,6 @@ .. _dojo/create: +=========== dojo.create =========== @@ -11,7 +12,6 @@ dojo.create A convenient DOM creation, manipulation and placement utility shorthand. -============ Introduction ============ @@ -27,7 +27,6 @@ To see this utility in context, read the :ref:`DOM Quick Start ` Since Dojo 1.7, ``dojo.create`` is exposed via the ``create`` method of the ``dojo/dom-construct`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -45,8 +44,7 @@ The function takes up to four arguments: Here is the definition of arguments: -========= =========== ======================================================= -Parameter Type Description +========= =========== Parameter Type Description ========= =========== ======================================================= tag String|Node Can be a string or a DOM node. If it is a string, it will be treated as a node tag name, which will be used @@ -108,7 +106,6 @@ Dojo < 1.7 var node = dojo.create("div"); -======== Examples ======== @@ -204,7 +201,6 @@ Create an anchor, with an href. Place in : // dojo < 1.7 dojo.create("a", { href: "foo.html", title: "Goto FOO!", innerHTML: "link" }, dojo.body()); -============ Alternatives ============ @@ -257,7 +253,6 @@ While you can use dojo.create to set attributes on the existing node without pla // dojo < 1.7 dojo.attr(node, "innerHTML", "

hi

"); -======== See also ======== diff --git a/dojo/currency.rst b/dojo/currency.rst index 82119a013..88cd77652 100644 --- a/dojo/currency.rst +++ b/dojo/currency.rst @@ -1,5 +1,6 @@ .. _dojo/currency: +============= dojo.currency ============= @@ -10,7 +11,6 @@ dojo.currency :depth: 2 -============ Introduction ============ @@ -18,12 +18,10 @@ dojo.currency extends dojo.number to handle formatting and printing. Data provi By default, the Dojo Toolkit is prepared to support for a short list of major world currencies. That list can be extended by running the scripts in util/buildscripts/cldr. Please see the README in that directory for details. -================ format()/parse() ================ -======== See Also ======== diff --git a/dojo/data.rst b/dojo/data.rst index ec1710034..f66983242 100644 --- a/dojo/data.rst +++ b/dojo/data.rst @@ -1,5 +1,6 @@ .. _dojo/data: +========= dojo.data ========= @@ -7,7 +8,6 @@ dojo.data :depth: 2 -============ Introduction ============ @@ -18,7 +18,6 @@ Ultimately, the goal of dojo.data is to provide a flexible set of APIs as interf You can think of dojo.data as one layer above dojo.xhrGet(). Both operate asynchronously, and without refreshing the page. But, xhrGet will get almost any MIME type and return the data in a glob. It's your job to interpret it. With dojo.data, you call one set of APIs to access the data items and the attributes of the items, and it's up to the store to handle the interpretation of the native formats into a common access model. -===== Usage ===== @@ -33,7 +32,6 @@ Basic store usage consists primarily of creating stores from which items are fet * :ref:`dojo.data.ItemFileWriteStore ` -======== See also ======== diff --git a/dojo/data/ItemFileReadStore.rst b/dojo/data/ItemFileReadStore.rst index 956bca4a1..6cf110da6 100644 --- a/dojo/data/ItemFileReadStore.rst +++ b/dojo/data/ItemFileReadStore.rst @@ -1,5 +1,6 @@ .. _dojo/data/ItemFileReadStore: +=========================== dojo.data.ItemFileReadStore =========================== @@ -20,7 +21,6 @@ Dojo core provides an implementation of a read-only datastore, ItemFileReadStore 2. This is an in-memory store. It is not designed to operate as a remote server store and often trying to make it work with specific remote services ends up far more work than simply implementing a completely new data store that conforms to the dojo.data APIs. So, if you find it extremely complicated to modify for your needs, take a step back and look at what you're trying to do. It may be simpler to implement the data store interface over your services. -============== Supported APIs ============== @@ -30,7 +30,6 @@ The following dojo.data APIs are implemented by ItemFileReadStore * :ref:`dojo.data.api.Identity ` -====================== Constructor Parameters ====================== @@ -85,7 +84,6 @@ Constructor Parameters -================= Input Data Format ================= @@ -150,7 +148,6 @@ The other special structure is the custom type structure. The purpose of the cus When ItemFileReadStore parses that structure, it detects the JavaScript Object value for attribute *birthdate* has the special attributes *_type* and *_value*. what it then does with this is look into the type map of the store and determines if any deserializer has been defined for the value of *_type*. If it has, it takes the value of *_value*, and calls the deserializer function with it. The return of the deserializer will be a Date() object. -======================= Item Structure Examples ======================= @@ -287,7 +284,6 @@ Items with Custom Types ] } -============ Custom Types ============ @@ -449,7 +445,6 @@ Functional Example: Using custom type maps with ItemFileReadStore -============== Custom Sorting ============== @@ -503,7 +498,6 @@ ItemFileReadStore uses the dojo.data.util.sorter helper functions to implement i //Invoke the fetch. store.fetch({onComplete: completed, onError: error, sort: sortAttributes}); -============ Query Syntax ============ @@ -521,7 +515,6 @@ Okay, easy. Now what if I want to do a fuzzy match of items? Can this be done? { foo:new RegExp("/^bar$/"), bit:/^bite$/} -============== Query Examples ============== @@ -557,7 +550,6 @@ Match items on multiple attributes { foo:"?ar", bar:"bob", bit:"*it*"} -============= Query Options ============= @@ -576,7 +568,6 @@ Dojo.data defines support for a 'queryOptions' modifier object that affects the +------------+------------------------------------------------------------------------------------------------------------------------+ -============== Usage Examples ============== @@ -1053,7 +1044,6 @@ Reloading/Refreshing ItemFileReadStore from a url (Dojo Toolkit 1.4+)
Reload DataStore
-======== See Also ======== diff --git a/dojo/data/ItemFileWriteStore.rst b/dojo/data/ItemFileWriteStore.rst index 731e83937..44375470a 100644 --- a/dojo/data/ItemFileWriteStore.rst +++ b/dojo/data/ItemFileWriteStore.rst @@ -1,5 +1,6 @@ .. _dojo/data/ItemFileWriteStore: +============================ dojo.data.ItemFileWriteStore ============================ @@ -14,7 +15,6 @@ dojo.data.ItemFileWriteStore Dojo core provides the ItemFileWriteStore store as an extension to ItemFileReadStore that adds on the dojo.data.api.Write and dojo.data.api.Notification API support to ItemFileReadStore. It was specifically created as a separate class so that if you only need read capability, you do not incur the download penalty of the write and notification API support if you won't use it. If your application needs to write to the ItemFileStore instead of just Read, then ItemFileWriteStore is the store you should instantiate. The input data format is identical to :ref:`ItemFileReadStore `. -=========== API Support =========== @@ -23,13 +23,11 @@ API Support * :ref:`dojo.data.api.Identity ` * :ref:`dojo.data.api.Notification ` -====================== Constructor Parameters ====================== The constructor for ItemFileWriteStore takes the same parameters as :ref:`dojo.data.ItemFileReadStore ` -============ Custom Types ============ @@ -60,13 +58,11 @@ So, when Date objects are encountered, ItemFileWriteStore automatically serializ { "_type":"Date", "value":"1993-05-24T00:00:00Z" } -============ Query Syntax ============ The query syntax for ItemFileWriteStore is identical to the query syntax of ItemFileReadStore so see that :ref:`section ` for more information. -============= The Write API ============= @@ -131,13 +127,11 @@ As of dojo 1.1, dojo.data.ItemFileWriteStore Write actions are reference aware. To put it more simply, say you have Item C which is referenced by Items A and B. If you delete Item C, a deleteItem event occurs, then two onSet notifications will occur; one for Item A and one for Item B, indicating that the attribute that referenced Item C was modified because Item C was deleted. -==================== The Notification API ==================== ItemFileWriteStore supports dojo.data.api.Notification. This means that every action through *newItem*, *setValue(s)*, *unsetAttribute*, and *deleteItem* will generate events to indicate these actions. These events are functions on the store that widgets and user code can *dojo.connect* to. This allows for pages to be very dynamic in that a change from one widget in a data store can be detected and reacted to in another. For more details on Notification in general, please refer to the :ref:`Notification section ` of the dojo.data API. -=================== Pseudocode Examples =================== @@ -198,7 +192,6 @@ Delete a country var request = store.fetch({query: {name:"Egypt"}, queryOptions: {ignoreCase: true}, onComplete: gotNames} -=================== Functional Examples =================== diff --git a/dojo/data/ObjectStore.rst b/dojo/data/ObjectStore.rst index 3849dd074..6cb159259 100644 --- a/dojo/data/ObjectStore.rst +++ b/dojo/data/ObjectStore.rst @@ -1,5 +1,6 @@ .. _dojo/data/ObjectStore: +======================== dojo.data.ObjectStore ======================== @@ -13,13 +14,11 @@ dojo.data.ObjectStore **dojo.data.ObjectStore** is an adapter for using the new :ref:`Dojo Object Stores ` with Dojo Data consumers. This adapter takes an object store and implements the Dojo Data API (Read, Write, Identity, and Notification). -============ Introduction ============ The ObjectStore is very simple to use, you simply provide a object store to the constructor (in the objectStore property of the first argument) and you can use this data store with any Dojo Data compliant widget or other consumer. -======== Examples ======== @@ -35,7 +34,6 @@ Examples ... }); -==================== Implementation Notes ==================== diff --git a/dojo/data/api/Read.rst b/dojo/data/api/Read.rst index 4610a8e31..80004e4fb 100644 --- a/dojo/data/api/Read.rst +++ b/dojo/data/api/Read.rst @@ -1,5 +1,6 @@ .. _dojo/data/api/Read: +================== dojo.data Read API ================== @@ -22,7 +23,6 @@ The most fundamental API of dojo.data is the Read API. All stores will implement * Obtain a human-readable label of the item if possible. -======== Examples ======== @@ -105,7 +105,6 @@ Further examples Further examples of the API usage are covered in the Using Datastores section. Refer to it for examples on paging, sorting, selecting, and so forth. -================ The complete API ================ diff --git a/dojo/date.rst b/dojo/date.rst index 352d2de42..a4924b025 100644 --- a/dojo/date.rst +++ b/dojo/date.rst @@ -1,5 +1,6 @@ .. _dojo/date: +========= dojo.date ========= @@ -10,7 +11,6 @@ dojo.date :depth: 2 -============ Introduction ============ @@ -24,7 +24,6 @@ Note that in JavaScript, counting of months starts at "0" so if you want to crea So don't get confused by the new Date() statements in the tests, the second parameter is the month and is always one number lower than the month you actually want. -===== Usage ===== @@ -64,7 +63,6 @@ Dojo < 1.7 dojo.date.difference(date1, date2, "day"); //output: -29 -======== See Also ======== diff --git a/dojo/date/locale.rst b/dojo/date/locale.rst index 52f8b92a1..8e6764d57 100644 --- a/dojo/date/locale.rst +++ b/dojo/date/locale.rst @@ -1,5 +1,6 @@ .. _dojo/date/locale: +================ dojo.date.locale ================ @@ -13,7 +14,6 @@ dojo.date.locale dojo.date.locale offers a library of localization methods to format and parse dates and times. -============ Introduction ============ @@ -21,7 +21,6 @@ When you want to present dates or times to the user, Javascript only knows how t Dojo comes with a powerful library to format and parse dates and times using local language and conventions, from your choice of hundreds of locales, or as you would like using custom date/time patterns. -================= Available Methods ================= @@ -52,7 +51,6 @@ dojo.date.locale offers the following methods: Builds the regular needed to parse a localized date -======== See also ======== diff --git a/dojo/date/locale/format.rst b/dojo/date/locale/format.rst index 0c83b911a..a70e2f39a 100644 --- a/dojo/date/locale/format.rst +++ b/dojo/date/locale/format.rst @@ -1,5 +1,6 @@ .. _dojo/date/locale/format: +======================= dojo.date.locale.format ======================= @@ -11,14 +12,12 @@ dojo.date.locale.format Creates a string from a Date object using a known localized pattern. -============ Introduction ============ By default, this method formats both date and time from dateObject. Formatting patterns are chosen appropriate to the locale. Different formatting lengths may be chosen, with “full” used by default. Custom patterns may be used or registered with translations using the dojo.date.locale.addCustomFormats method. Formatting patterns are implemented using the syntax described at unicode.org -===== Usage ===== @@ -108,7 +107,6 @@ Notes: * the source mentions that a single quote can be added by supplying 2 of them, but this doesn't appear to work -======== Examples ======== @@ -222,7 +220,6 @@ Render the current Date in several ways using format(). The inverse operation to -======== See also ======== diff --git a/dojo/date/locale/parse.rst b/dojo/date/locale/parse.rst index 520c12c69..7e2e0bd6d 100644 --- a/dojo/date/locale/parse.rst +++ b/dojo/date/locale/parse.rst @@ -1,5 +1,6 @@ .. _dojo/date/locale/parse: +====================== dojo.date.locale.parse ====================== @@ -14,14 +15,12 @@ dojo.date.locale.parse Converts a properly formatted string to a primitive Date object, using locale-specific settings. -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojo/date/stamp.rst b/dojo/date/stamp.rst index ec234cd4c..4d2ac17b6 100644 --- a/dojo/date/stamp.rst +++ b/dojo/date/stamp.rst @@ -1,5 +1,6 @@ .. _dojo/date/stamp: +=============== dojo.date.stamp =============== @@ -10,7 +11,6 @@ dojo.date.stamp :depth: 2 -============ Introduction ============ @@ -18,7 +18,6 @@ dojo.date.stamp methods use a profile of the ISO-8601 standard to handle dates i -===== Usage ===== @@ -47,7 +46,6 @@ Usage -======== See Also ======== diff --git a/dojo/declare.rst b/dojo/declare.rst index cdf83b44a..feb13e9a8 100644 --- a/dojo/declare.rst +++ b/dojo/declare.rst @@ -1,5 +1,6 @@ .. _dojo/declare: +================================= dojo.declare (dojo/_base/declare) ================================= @@ -19,14 +20,12 @@ If you prefer books, chapter 9 of `David Flanagan's JavaScript: The Definitive G This section has some pretty abstract stuff, and you may wish to skip it on the first read. Certainly you can do a lot with Dojo without using ``dojo.declare`` or the other object orientation functions. But a good knowledge of it will help you program faster and smarter. -=========== Basic Usage =========== ``dojo.declare`` accepts up to three arguments: -========== ==================== ================================================== -Parameter Type Description +========== ==================== Parameter Type Description ========== ==================== ================================================== className String|null The optional name of the Class to declare. @@ -261,7 +260,6 @@ Note the use of anonymous functions here. You are passing to ``dojo.declare`` a In pure JavaScript, this is handled by a prototype function named after the class - for example, ``Person.prototype``. Dojo wires in your constructor as a part of the prototype, but then adds extra goodies like calling the superclass constructor and initializing extra properties. -====================================== Arrays and Objects as member variables ====================================== @@ -341,7 +339,6 @@ Now *x* and *y* both refer to the same object. Modifying *x.fruit* will also aff On the other hand, numbers, booleans, and strings are used as values. Any assignment updates a variable, rather than shared object. -=========== Inheritance =========== @@ -486,7 +483,6 @@ You can send custom parameters to the ancestor function. Just place the extra a See `inherited()`_ for more details. -==================== Multiple inheritance ==================== @@ -559,7 +555,6 @@ This will first print "mixing in Vanilla" on the debug console because VanillaSo Mixins are used a lot in defining Dijit classes, with most classes extending ``dijit._Widget`` and mixing in ``dijit._Templated``. -================== Inheritance chains ================== @@ -634,7 +629,6 @@ As you can see the inheritance chain is the same for all three classes. Why? Bec Note that ``-> B -> A`` are folded into our superclass ``D`` and are not instantiated directly. -===================== Technical information ===================== @@ -1640,7 +1634,6 @@ Every instance created by ``dojo.declare``'d class has a special property called Every method mixed in by ``dojo.declare`` or :ref:`dojo.safeMixin ` is annotated: a special property called ``nom`` is added. It contains a name of the method in question and used by `inherited()`_ and `getInherited()`_ to deduce the name of a superclass method. See :ref:`dojo.safeMixin ` for more details. -======== See Also ======== diff --git a/dojo/delegate.rst b/dojo/delegate.rst index 0a6cb3cd3..44d1e3970 100644 --- a/dojo/delegate.rst +++ b/dojo/delegate.rst @@ -1,5 +1,6 @@ .. _dojo/delegate: +============= dojo.delegate ============= @@ -12,14 +13,12 @@ dojo.delegate Returns a new object which "looks" to obj for properties which it does not have a value for. Optionally takes a bag of properties to seed the returned object with initially. -============ Introduction ============ This is a small implementation of the Boodman/Crockford delegation pattern in JavaScript. An intermediate object constructor mediates the prototype chain for the returned object, using it to delegate down to obj for property lookup when object-local lookup fails. This can be thought of similarly to ES4's "wrap", save that it does not act on types but rather on pure objects. -===== Usage ===== @@ -35,8 +34,7 @@ Usage dojo.delegate accepts two arguments: -========== ==================== ================================================== -Parameter Type Description +========== ==================== Parameter Type Description ========== ==================== ================================================== obj object The object to delegate to for properties not found directly on the return object or in props. @@ -47,7 +45,6 @@ props object An object containing properties to assign to t dojo.delegate returns an Object of anonymous type. -======== Examples ======== diff --git a/dojo/deprecated.rst b/dojo/deprecated.rst index 51df82cfa..d54047f4c 100644 --- a/dojo/deprecated.rst +++ b/dojo/deprecated.rst @@ -1,5 +1,6 @@ .. _dojo/deprecated: +=============== dojo.deprecated =============== diff --git a/dojo/destroy.rst b/dojo/destroy.rst index 67c107799..912e87489 100644 --- a/dojo/destroy.rst +++ b/dojo/destroy.rst @@ -1,5 +1,6 @@ .. _dojo/destroy: +============ dojo.destroy ============ @@ -12,7 +13,6 @@ dojo.destroy Destroys a DOM element. dojo.destroy deletes all children and the node itself. -============ Introduction ============ @@ -20,7 +20,6 @@ dojo.destroy removes a node from its parent, clobbering it and all of its childr Since Dojo 1.7, ``dojo.destroy`` is exposed via the ``destroy`` method of the ``dojo/dom-construct`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -55,14 +54,11 @@ Dojo < 1.7 This function only works with DomNodes, and returns nothing. -========= ============== ============================================================================= -Parameter Type Description -========= ============== ============================================================================= -node String|DomNode A String ID or DomNode reference of the element to be destroyed. +========= ============== Parameter Type Description +========= ============== node String|DomNode A String ID or DomNode reference of the element to be destroyed. ========= ============== ============================================================================= -======== Examples ======== @@ -154,7 +150,6 @@ Destroy all nodes in a list by reference
-======== See also ======== diff --git a/dojo/disconnect.rst b/dojo/disconnect.rst index 4618c8b28..63f496a80 100644 --- a/dojo/disconnect.rst +++ b/dojo/disconnect.rst @@ -1,5 +1,6 @@ .. _dojo/disconnect: +=============== dojo.disconnect =============== @@ -12,13 +13,11 @@ dojo.disconnect Disconnects methods from linked events. -============ Introduction ============ Dojo's :ref:`event ` system provides `dojo.disconnect` to cleanly remove event listeners created by :ref:`dojo.connect `. The more events in the page that exist, the more the browser (or otherwise) has to do. -===== Usage ===== diff --git a/dojo/dnd.rst b/dojo/dnd.rst index 6b5bd40a4..b418c9aa0 100644 --- a/dojo/dnd.rst +++ b/dojo/dnd.rst @@ -1,5 +1,6 @@ .. _dojo/dnd: +================ dojo.dnd package ================ @@ -11,7 +12,6 @@ dojo.dnd package .. contents:: :depth: 2 -============ Introduction ============ @@ -44,7 +44,6 @@ In order to show an insertion point correctly it is possible to specify if we de See Selector_ for more details. -====================== _`dojo.dnd` principals ====================== @@ -417,7 +416,6 @@ Following CSS classes are used by the manager to style the DnD operation: No styles are assigned when there is no DnD in progress. -=========================== _`dojo.dnd.move` principals =========================== @@ -572,13 +570,11 @@ TimedMoveable * ``timeout`` --- the time delay number in milliseconds. The node will not be moved for that number of milliseconds, but it will continue to accumulate changes in the mouse position. -======================= Subclassing DnD classes ======================= If you want to subclass Container_, Selector_, Source_, Moveable_, or their descendants, and you want to use the declarative markup, don't forget to implement the ``markupFactory()`` method. The reason for that is ``dojo.parser``, which instantiates the markup, expects a very particular signature from a constructor. Dojo DnD classes predate ``dojo.parser``, and have a non-conformant signature. ``dojo.parser`` is smart enough to use a special adapter function in such cases. See the source code for ``dojo.dnd.Source.markupFactory()`` (for the Container_-Selector_-Source_ chain), and ``dojo.dnd.Moveable.markupFactory()`` for details. The key point is to return the instance of your new class there. Otherwise the instance of your base class is going to be created, which is probably not what you want. -====================== Summary of CSS classes ====================== @@ -655,7 +651,6 @@ Following CSS classes are used: * ``dojoMoveItem`` --- assigned to the dragged node when the move is in progress. -================= Summary of topics ================= @@ -676,7 +671,6 @@ Following topic events are raised by Moveable_: * ``/dnd/move/start`` --- published by the default implementation of Moveable_'s ``onMoveStart()`` passing a mover_ as parameter. * ``/dnd/move/stop`` --- published by the default implementation of Moveable_'s ``onMoveStop()`` passing a mover as parameter. -=============== Available tests =============== @@ -701,7 +695,6 @@ All tests are located in the ``dojo/tests/dnd/`` sub-directory. They are used by The same directory contains a simple CSS file, which shows how you can style the DnD objects: `dndDefault.css `_. You can see it in action in almost all tests. It can be used as a starting point for your own styling. -==================================== External tutorials and documentation ==================================== @@ -717,7 +710,6 @@ External tutorials and documentation `dojo.dnd 1.1 technical documentation `_ by `Eugene Lazutkin `_ This is the technical documentation for Dojo DnD 1.1 listed here only as a historic reference. This document is based on it. -==== Tips ==== @@ -727,7 +719,6 @@ If you want to create dojo.dnd.Source with markup, and want to select that Sourc The DnD itself uses ``onmousedown``/``onmousemove``/``onmouseup`` to operate. If you want to process ``onclick``, be warned that this is the synthetic event: essentially it is ``onmousedown + onmouseup``, which occurred within some predefined time interval (usually settable on the OS level), or using other criteria. Some browsers generate ``onclick`` on every ``onmouseup``. Working with DnD you will get plenty of false ``onclick`` events. Some of them happen naturally, when user decided to drag but changed her mind clicking the mouse button generating ``onclick``. *Be extra careful when processing* ``onclick`` *on DnD sources!* -============= Accessibility ============= @@ -767,7 +758,6 @@ However, in order to detect that high contrast mode has been set on a MS Windows Note that your src path may vary and you may need to do a custom build to include this dijit file since it is not included in dojo.js by default. -======== See also ======== diff --git a/dojo/dnd/Moveable.rst b/dojo/dnd/Moveable.rst index e6fd0efa8..1e6960f67 100644 --- a/dojo/dnd/Moveable.rst +++ b/dojo/dnd/Moveable.rst @@ -1,5 +1,6 @@ .. _dojo/dnd/Moveable: +================= dojo.dnd.Moveable ================= @@ -9,13 +10,11 @@ dojo.dnd.Moveable .. contents:: :depth: 3 -============ Introduction ============ Makes a DOM node moveable using the mouse. -===== Usage ===== @@ -46,7 +45,6 @@ You can connect to the following events of a Moveable: * onMoving : called at the begining of any move step (before the moveable position has been updated); * onMoved : called at the end of any move step (after the moveable position has been updated). -======= Example ======= @@ -88,7 +86,6 @@ Example } -==================== Custom Mover Example ==================== diff --git a/dojo/doc.rst b/dojo/doc.rst index 0fe6a6482..36e8c8741 100644 --- a/dojo/doc.rst +++ b/dojo/doc.rst @@ -1,5 +1,6 @@ .. _dojo/doc: +======== dojo.doc ======== @@ -11,13 +12,11 @@ dojo.doc Alias for the current document. This is normally the value of window["document"]; -============ Introduction ============ The purpose of this class is twofold. First, it provides a shorter reference to getting ahold of the current document. Second, all references that make use of it can have its document scope altered temporarily by changes to the dojo.doc variable. This is used by other functions :ref:`dojo.withDoc ` and :ref:`dojo.setContext ` to change the document scope during certain operations. -===== Usage ===== @@ -49,7 +48,6 @@ Dojo < 1.7 -======== Examples ======== @@ -78,7 +76,6 @@ Example usage of dojo.doc as replacement for document calls Click the button several times, then scroll down to see the appended text. -======== See also ======== diff --git a/dojo/domReady.rst b/dojo/domReady.rst index 5cb62fa4c..d32558803 100644 --- a/dojo/domReady.rst +++ b/dojo/domReady.rst @@ -1,9 +1,9 @@ .. _dojo/domReady: +============== dojo/domReady! ============== -============ Introduction ============ @@ -50,7 +50,6 @@ As a more complicated example, this code will wait until the DOM has finished lo dojo/domReady! is similar to :ref:`dojo.ready ` or :ref:`dojo.addOnLoad `, but more granular, because dojo/domReady! merely waits for the DOM to finish loading, without waiting for other require() or dojo.require() calls to complete. -======== Cautions ======== diff --git a/dojo/empty.rst b/dojo/empty.rst index b921ba727..790485ddd 100644 --- a/dojo/empty.rst +++ b/dojo/empty.rst @@ -1,5 +1,6 @@ .. _dojo/empty: +========== dojo.empty ========== @@ -12,7 +13,6 @@ dojo.empty Empty the contents of a DOM element. dojo.empty deletes all children but keeps the node there. -============ Introduction ============ @@ -20,7 +20,6 @@ dojo.empty safely removes all children of the node. Since Dojo 1.7, ``dojo.empty`` is exposed via the ``empty`` method of the ``dojo/dom-construct`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -56,14 +55,11 @@ Dojo < 1.7 This function only works with DomNodes, and returns nothing. -========= ============== ============================================================================= -Parameter Type Description -========= ============== ============================================================================= -node String|DomNode A String ID or DomNode reference of the element to empty. +========= ============== Parameter Type Description +========= ============== node String|DomNode A String ID or DomNode reference of the element to empty. ========= ============== ============================================================================= -======== Examples ======== @@ -166,7 +162,6 @@ Empty all nodes in a list by reference -======== See also ======== diff --git a/dojo/eval.rst b/dojo/eval.rst index 9d01a7e62..82aabc726 100644 --- a/dojo/eval.rst +++ b/dojo/eval.rst @@ -1,5 +1,6 @@ .. _dojo/eval: +========= dojo.eval ========= @@ -12,14 +13,12 @@ dojo.eval Evaluate some string of JavaScript in global context. -============ Introduction ============ Evaluates the given string into window (global) scope rather than in current scope. Use this rather than ``eval``. -===== Usage ===== diff --git a/dojo/every.rst b/dojo/every.rst index f28952e17..1d649e243 100644 --- a/dojo/every.rst +++ b/dojo/every.rst @@ -1,9 +1,9 @@ .. _dojo/every: +========== dojo.every ========== -================ Usage & examples ================ diff --git a/dojo/exists.rst b/dojo/exists.rst index eec2a5607..5b3658620 100644 --- a/dojo/exists.rst +++ b/dojo/exists.rst @@ -1,5 +1,6 @@ .. _dojo/exists: +=========== dojo.exists =========== @@ -13,14 +14,12 @@ dojo.exists Check if all objects in a dot-separated string object path exist, such as ``"A.B.C"``. -============ Introduction ============ ``dojo.exists`` is a convenience function, particularly useful for testing long object paths. It accepts a string as its first parameter, and walks down the path it represents. You can optionally provide a root for the path as a second parameter, otherwise it will use a default value of the global object. Each portion of the '.' delimited string is tested for defined-ness, returning true only if each object exists as defined in the strong. -===== Usage ===== @@ -72,7 +71,6 @@ The second ``root`` parameter is optional, ``dojo.exists`` will use the value of } -======== See also ======== diff --git a/dojo/extend.rst b/dojo/extend.rst index b3a4446ca..a6dea21a0 100644 --- a/dojo/extend.rst +++ b/dojo/extend.rst @@ -1,5 +1,6 @@ .. _dojo/extend: +=========== dojo.extend =========== @@ -30,7 +31,6 @@ The way the :ref:`dojo.parser ` works, a custom attribute on the no After the extend, any new instances of a TitlePane will have the 'randomAttribute' member mixed into the instance. dojo.extend affects all future instances of a Class (or rather, any object with a .prototype). -================= Extending _Widget ================= @@ -52,7 +52,6 @@ A potentially confusing result of the above actually provides us a lot of flexib The side-effect of this is a documentation nightmare. Now ``every`` Dijit appears to have a region variable, when in fact it is just there for the benefit of BorderContainer. -================================== Example: dojo.extend vs dojo.mixin ================================== diff --git a/dojo/fadeIn.rst b/dojo/fadeIn.rst index 7508052ab..9dd9abe38 100644 --- a/dojo/fadeIn.rst +++ b/dojo/fadeIn.rst @@ -1,5 +1,6 @@ .. _dojo/fadeIn: +=========== dojo.fadeIn =========== @@ -12,7 +13,6 @@ dojo.fadeIn This function is a helper function that wraps the :ref:`dojo.animateProperty ` function to provide an easy interface to fading a node into view on the page. While this can be done with the *dojo.animateProperty* function, this function is simpler to use and will handle 99% of the cases a fade-in is desired. -========== Parameters ========== @@ -20,13 +20,11 @@ The *dojo.fadeIn* takes an object as its parameter. This object defines what do `FIXME: just inline API signature` -============ Return value ============ The *dojo.fadeIn* function returns an instance of dojo._Animation. To execute the fadeIn, call the *play()* function on the animation. This object can be used with other dojo animation functions, such as :ref:`dojo.fx.chain ` and :ref:`dojo.fx.combine ` to link it with other effects to perform complex animations. -======== Examples ======== @@ -130,7 +128,6 @@ Example 3: Fade in a dom node with an easing function
-======== See Also ======== diff --git a/dojo/fadeOut.rst b/dojo/fadeOut.rst index c004cde28..d3a5a4eeb 100644 --- a/dojo/fadeOut.rst +++ b/dojo/fadeOut.rst @@ -1,5 +1,6 @@ .. _dojo/fadeOut: +============ dojo.fadeOut ============ @@ -14,7 +15,6 @@ dojo.fadeOut This function is a helper function that wraps the :ref:`dojo.animateProperty ` function to provide an easy interface to fading a node out of view on the page. While this can be done with the *dojo.animateProperty* function, this function is simpler to use and will handle 99% of the cases a fade-out is desired. -========== Parameters ========== @@ -22,13 +22,11 @@ The *dojo.fadeOut* takes an object as its parameter. This object defines what d All standard :ref:`dojo.Animation ` events and parameters apply, though *properties:{}* is explicitly set to control opacity, so should be omitted. -============ Return value ============ The *dojo.fadeOut* function returns an instance of :ref:`dojo.Animation `. To execute the fadeOut, call the *play()* function on the animation. This object can be used with other dojo animation functions, such as :ref:`dojo.fx.chain ` and :ref:`dojo.fx.combine ` to link it with other effects to perform complex animations. -======== Examples ======== @@ -123,7 +121,6 @@ Example 3: Fade in a dom node with an easing function
-======== See Also ======== diff --git a/dojo/fieldToObject.rst b/dojo/fieldToObject.rst index 72c4dfbce..6e0b2e9ec 100644 --- a/dojo/fieldToObject.rst +++ b/dojo/fieldToObject.rst @@ -1,5 +1,6 @@ .. _dojo/fieldToObject: +================== dojo.fieldToObject ================== @@ -12,7 +13,6 @@ dojo.fieldToObject Helper function for converting a HTML form field to a JavaScript Object -============ Introduction ============ @@ -22,7 +22,6 @@ This function is used internally by :ref:`dojo.formToObject ` Since Dojo 1.7, ``dojo.fieldToObject`` is exposed via the ``fieldToObject`` method of the ``dojo/dom-form`` module. An alias is kept in ``dojo/_base/xhr`` for backward-compatibility. -===== Usage ===== @@ -63,7 +62,6 @@ Dojo < 1.7 // //firstInputValue will be "value1" -======== Examples ======== @@ -104,7 +102,6 @@ Example 1: Using fieldToObject to get field values

 
 
-========
 See also
 ========
 
diff --git a/dojo/filter.rst b/dojo/filter.rst
index 892f5cd15..883ef92d4 100644
--- a/dojo/filter.rst
+++ b/dojo/filter.rst
@@ -1,9 +1,9 @@
 .. _dojo/filter:
 
+===========
 dojo.filter
 ===========
 
-================
 Usage & examples
 ================
 
diff --git a/dojo/formToJson.rst b/dojo/formToJson.rst
index 70e914811..45f422d5d 100644
--- a/dojo/formToJson.rst
+++ b/dojo/formToJson.rst
@@ -1,5 +1,6 @@
 .. _dojo/formToJson:
 
+===============
 dojo.formToJson
 ===============
 
@@ -10,7 +11,6 @@ dojo.formToJson
 
 Helper function for converting a HTML form to a JSON string
 
-============
 Introduction
 ============
 
@@ -22,7 +22,6 @@ You can refer to the :ref:`dojo.formToObject ` documentation
 
 Since Dojo 1.7, ``dojo.formToJson`` is exposed via the ``toJson`` method of the ``dojo/dom-form`` module.  An alias is kept in ``dojo/_base/xhr`` for backward-compatibility.
 
-=====
 Usage
 =====
 
@@ -70,7 +69,6 @@ Dojo < 1.7
   //Note the button was skipped.
 
 
-========
 Examples
 ========
 
@@ -141,7 +139,6 @@ Example 2: Using formToJson to create a JSON version of a form with dijit widget
     

 
 
-========
 See also
 ========
 
diff --git a/dojo/formToObject.rst b/dojo/formToObject.rst
index 46868926c..060123005 100644
--- a/dojo/formToObject.rst
+++ b/dojo/formToObject.rst
@@ -1,5 +1,6 @@
 .. _dojo/formToObject:
 
+==================
 dojo.formToObject
 ==================
 
@@ -11,7 +12,6 @@ dojo.formToObject
 Helper function for converting a HTML form to a JavaScript Object
 
 
-============
 Introduction
 ============
 
@@ -19,7 +19,6 @@ This function is one of many helpers used by the dojo Xhr subsystem for handling
 
 Since Dojo 1.7, ``dojo.formToObject`` is exposed via the ``toObject`` method of the ``dojo/dom-form`` module.  An alias is kept in ``dojo/_base/xhr`` for backward-compatibility.
 
-=====
 Usage
 =====
 
@@ -45,7 +44,6 @@ Dojo < 1.7
 The function will hand back a JavaScript object of the name/value pairs from the form elements. The values are either strings or arrays. If a checkbox group has a single item selected, the function will return a string value; if several, an array.
 
 
-========
 Examples
 ========
 
@@ -121,7 +119,6 @@ Create an object version of a form with Dijit widgets
     

 
 
-========
 See also
 ========
 
diff --git a/dojo/formToQuery.rst b/dojo/formToQuery.rst
index 560bb3e5a..59373ae1f 100644
--- a/dojo/formToQuery.rst
+++ b/dojo/formToQuery.rst
@@ -1,5 +1,6 @@
 .. _dojo/formToQuery:
 
+================
 dojo.formToQuery
 ================
 
@@ -10,7 +11,6 @@ dojo.formToQuery
 
 Helper function for converting a HTML form into an URL-encoded query string.
 
-============
 Introduction
 ============
 
@@ -24,7 +24,6 @@ You can refer to the :ref:`dojo.formToObject ` and :ref:`dojo
 
 Since Dojo 1.7, ``dojo.formToQuery`` is exposed via the ``toQuery`` method of the ``dojo/dom-form`` module.  An alias is kept in ``dojo/_base/xhr`` for backward-compatibility.
 
-=====
 Usage
 =====
 
@@ -72,7 +71,6 @@ Dojo < 1.7
   //Note the button was skipped.
 
 
-========
 Examples
 ========
 
@@ -144,7 +142,6 @@ Example 2: Using formToQuery to create a query string version of a form with dij
     

 
 
-========
 See also
 ========
 
diff --git a/dojo/fromJson.rst b/dojo/fromJson.rst
index 79212af33..61f031406 100644
--- a/dojo/fromJson.rst
+++ b/dojo/fromJson.rst
@@ -1,5 +1,6 @@
 .. _dojo/fromJson:
 
+=============
 dojo.fromJson
 =============
 
@@ -10,7 +11,6 @@ dojo.fromJson
 
 Parses a JSON string to return a JavaScript object.
 
-============
 Introduction
 ============
 
@@ -38,7 +38,6 @@ This function creates a JavaScript object from a passed JSON string, such as one
     }
   });
 
-=====
 Usage
 =====
 
@@ -66,7 +65,6 @@ Dojo < 1.7
   console.log(obj.a, obj.b, obj.c);
   >>> one 3 true
 
-========
 See also
 ========
 
diff --git a/dojo/fx.rst b/dojo/fx.rst
index 8f46159b4..65cd548f4 100644
--- a/dojo/fx.rst
+++ b/dojo/fx.rst
@@ -1,5 +1,6 @@
 .. _dojo/fx:
 
+=======
 dojo.fx
 =======
 
@@ -18,7 +19,6 @@ This page is a landing point for reference off to each function, their descripti
 
 **NOTE:** There is a great :ref:`quickstart animation guide ` to get you up and running with basic FX animations
 
-========
 Features
 ========
 
@@ -49,7 +49,6 @@ Functions provided by the dojo.fx module
 
 Additionally, there is a collection of easing functions living in the  :ref:`dojo.fx.easing ` module.
 
-========
 See also
 ========
 
diff --git a/dojo/fx/Toggler.rst b/dojo/fx/Toggler.rst
index 9c5a4c70b..9d698ff61 100644
--- a/dojo/fx/Toggler.rst
+++ b/dojo/fx/Toggler.rst
@@ -1,5 +1,6 @@
 .. _dojo/fx/Toggler:
 
+===============
 dojo.fx.Toggler
 ===============
 
@@ -15,7 +16,6 @@ dojo.fx.Toggler
 The dojo.fx.Toggler is a helper class for wrapping a DOM node with 'FX' to use when showing and hiding that node.  By default it uses the :ref:`dojo.fadeIn ` for showing and :ref:`dojo.fadeOut ` for hiding of a node.  The Togger is set up by passing in an JavaScript object of parameters that define the node, the animation functions to use, and the duration for the show and hide operations.
 
 
-======================
 Constructor Parameters
 ======================
 
@@ -45,13 +45,11 @@ Constructor Parameters
 |                               |**optional**                                                                                |
 +-------------------------------+--------------------------------------------------------------------------------------------+
 
-===============================
 show() and hide() return values
 ===============================
 
 The functions *Toggler.show()* and *Toggler.hide()* both return the animation object for the animation in play.  This object can be used to stop, pause, set the current animation location 'percentage', and get the status of the animation.  For more information on animation objects, refer to the excellent :ref:`Animation Quickstart `
 
-========
 Examples
 ========
 
diff --git a/dojo/fx/easing.rst b/dojo/fx/easing.rst
index 43a0dd151..c0ca42b95 100644
--- a/dojo/fx/easing.rst
+++ b/dojo/fx/easing.rst
@@ -1,5 +1,6 @@
 .. _dojo/fx/easing:
 
+==============
 dojo.fx.easing
 ==============
 
@@ -16,7 +17,6 @@ Have you ever wanted a fade out, fade in, wipe in, and so forth to apply the eff
 
 Instead of having to write the easing function yourself, dojo provides a collection of easing functions to use as this parameter to get a variety of effects.
 
-================
 Easing Functions
 ================
 
@@ -131,7 +131,6 @@ All functions follow a simple naming convention of "ease type" + "when".  If the
 | dojo.fx.easing.bounceInOut            | A function that 'bounces' near the beginning and end of the animation                                |
 +---------------------------------------+------------------------------------------------------------------------------------------------------+
 
-========
 Examples
 ========
 
@@ -210,7 +209,6 @@ Example: Playing with Easing
     
-======== See Also ======== diff --git a/dojo/fx/slideTo.rst b/dojo/fx/slideTo.rst index 5d0c36143..a40236329 100644 --- a/dojo/fx/slideTo.rst +++ b/dojo/fx/slideTo.rst @@ -1,5 +1,6 @@ .. _dojo/fx/slideTo: +=============== dojo.fx.slideTo =============== @@ -16,7 +17,6 @@ This function is a helper function that wraps the :ref:`dojo.animateProperty ` and :ref:`dojo.fx.combine ` to link it with other effects to perform complex animations. -======== Examples ======== @@ -73,7 +71,6 @@ Example 1: Slide a dom node right 200 pixels. -======== See Also ======== diff --git a/dojo/fx/wipeIn-examples.rst b/dojo/fx/wipeIn-examples.rst index d05cdf473..d90277c43 100644 --- a/dojo/fx/wipeIn-examples.rst +++ b/dojo/fx/wipeIn-examples.rst @@ -1,5 +1,6 @@ .. _dojo/fx/wipeIn-examples: +======================= dojo.fx.wipeIn examples ======================= diff --git a/dojo/fx/wipeIn.rst b/dojo/fx/wipeIn.rst index 15f434419..c6817f25a 100644 --- a/dojo/fx/wipeIn.rst +++ b/dojo/fx/wipeIn.rst @@ -1,5 +1,6 @@ .. _dojo/fx/wipeIn: +============== dojo.fx.wipeIn ============== @@ -16,19 +17,16 @@ This function is a helper function that wraps the :ref:`dojo.animateProperty ` parameters and events apply to this function, with no additional properties included. -============ Return value ============ The *dojo.fx.wipeIn* function returns an instance of dojo._Animation. To execute the wipeIn, call the *play()* function on the animation. This object can be used with other dojo animation functions, such as :ref:`dojo.fx.chain ` and :ref:`dojo.fx.combine ` to link it with other effects to perform complex animations. -======== Examples ======== @@ -132,7 +130,6 @@ Example 3: Wipe in a dom node with an easing function This is a container of random content to wipe in slowly with the expoOut easing! -======== See Also ======== diff --git a/dojo/fx/wipeOut.rst b/dojo/fx/wipeOut.rst index 42d861af4..eef410641 100644 --- a/dojo/fx/wipeOut.rst +++ b/dojo/fx/wipeOut.rst @@ -1,5 +1,6 @@ .. _dojo/fx/wipeOut: +=============== dojo.fx.wipeOut =============== @@ -16,19 +17,16 @@ This function is a helper function that wraps the :ref:`dojo.animateProperty ` events and parameters apply, with no custom additions for this function. -============ Return value ============ The *dojo.fx.wipeOut* function returns an instance of dojo._Animation. To execute the wipeOut, call the *play()* function on the animation. This object can be used with other dojo animation functions, such as :ref:`dojo.fx.chain ` and :ref:`dojo.fx.combine ` to link it with other effects to perform complex animations. -======== Examples ======== @@ -135,7 +133,6 @@ Example 3: Wipe out a dom node with an easing function This is a container of random content to wipe out slowly with the expoOut easing! -======== See Also ======== diff --git a/dojo/gears.rst b/dojo/gears.rst index 31b0882a4..9e76622fc 100644 --- a/dojo/gears.rst +++ b/dojo/gears.rst @@ -1,5 +1,6 @@ .. _dojo/gears: +========== dojo.gears ========== diff --git a/dojo/getAttr.rst b/dojo/getAttr.rst index 759d997fb..f3e22084d 100644 --- a/dojo/getAttr.rst +++ b/dojo/getAttr.rst @@ -1,5 +1,6 @@ .. _dojo/getAttr: +============ dojo.getAttr ============ @@ -9,7 +10,6 @@ dojo.getAttr Gets an attribute on an HTML element. -============ Introduction ============ @@ -17,7 +17,6 @@ Introduction Since Dojo 1.7, ``dojo.getAttr`` is exposed via the ``get`` method of the ``dojo/dom-attr`` module. An alias is kept in dojo/_base/html for backward-compatibility. -===== Usage ===== @@ -38,7 +37,6 @@ attr the name of the attribute to get. -======== Examples ======== @@ -81,7 +79,6 @@ Dojo < 1.7 // or we can just pass the id: dojo.getAttr("nodeId", "foo"); -======== See also ======== diff --git a/dojo/getComputedStyle.rst b/dojo/getComputedStyle.rst index 4d58ccc4e..586a879ec 100644 --- a/dojo/getComputedStyle.rst +++ b/dojo/getComputedStyle.rst @@ -1,5 +1,6 @@ .. _dojo/getComputedStyle: +===================== dojo.getComputedStyle ===================== @@ -8,7 +9,6 @@ dojo.getComputedStyle Returns a "computed style" object. -============ Introduction ============ @@ -20,7 +20,6 @@ Use the dojo.style() method for more consistent (pixelized) return values. Since Dojo 1.7, ``dojo.getComputedStyle`` is exposed via the ``getComputedStyle`` method of the ``dojo/dom-style`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -37,7 +36,6 @@ Usage node A reference to a DOM node. Does NOT support taking an ID string for speed reasons. -======== Examples ======== @@ -79,7 +77,6 @@ Dojo < 1.7 var cs = dojo.getComputedStyle(dojo.byId("someNode")); var w = cs.width, h = cs.height; -======== See also ======== diff --git a/dojo/getContentBox.rst b/dojo/getContentBox.rst index dd0bd3aca..052620d11 100644 --- a/dojo/getContentBox.rst +++ b/dojo/getContentBox.rst @@ -1,5 +1,6 @@ .. _dojo/getContentBox: +================== dojo.getContentBox ================== @@ -8,7 +9,6 @@ dojo.getContentBox Returns an object that encodes the width, height, left and top positions of the node's content box, irrespective of the current box model. -============ Introduction ============ @@ -16,7 +16,6 @@ The dojo.getContentBox function is used to obtain an object that encodes the wid Since Dojo 1.7, ``dojo.getContentBox`` is exposed via the ``getContentBox`` method of the ``dojo/dom-geometry`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== diff --git a/dojo/getMarginBox.rst b/dojo/getMarginBox.rst index 1bde08e54..f0180a857 100644 --- a/dojo/getMarginBox.rst +++ b/dojo/getMarginBox.rst @@ -1,5 +1,6 @@ .. _dojo/getMarginBox: +================= dojo.getMarginBox ================= @@ -8,7 +9,6 @@ dojo.getMarginBox Returns an object that encodes the width, height, left and top positions of the node's margin box. -============ Introduction ============ @@ -16,7 +16,6 @@ The dojo.getMarginBox function is used to obtain an object that encodes the widt Since Dojo 1.7, ``dojo.getMarginBox`` is exposed via the ``getMarginBox`` method of the ``dojo/dom-geometry`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== diff --git a/dojo/getNodeProp.rst b/dojo/getNodeProp.rst index 4303dee9e..5aacc29ee 100644 --- a/dojo/getNodeProp.rst +++ b/dojo/getNodeProp.rst @@ -1,5 +1,6 @@ .. _dojo/getNodeProp: +================ dojo.getNodeProp ================ @@ -11,7 +12,6 @@ dojo.getNodeProp Returns a property value falling back to an attribute, if property is not available. -============ Introduction ============ @@ -23,7 +23,6 @@ There is no corresponding ``dojo.setNodeProp``. If you want to set a property va Since Dojo 1.7, ``dojo.getNodeProp`` is exposed via the ``getNodeProp`` method of the ``dojo/dom-attr`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -44,7 +43,6 @@ attr the attribute property name. -======== Examples ======== @@ -107,7 +105,6 @@ The following example reads effective values from the ``input`` node.

-======== See also ======== diff --git a/dojo/getObject.rst b/dojo/getObject.rst index dd68c9e5e..4a30f467b 100644 --- a/dojo/getObject.rst +++ b/dojo/getObject.rst @@ -1,5 +1,6 @@ .. _dojo/getObject: +=============== dojo.getObject =============== @@ -13,7 +14,6 @@ dojo.getObject dojo.getObject returns the property of an object from a dot-separated string such as "A.B.C" -===== Usage ===== @@ -100,7 +100,6 @@ You can also pass an object as the third parameter. This will define the context dojo.getObject("bar", false, foo); // returns "some value" -======== See also ======== diff --git a/dojo/getProp.rst b/dojo/getProp.rst index b6f303e13..972f6e3de 100644 --- a/dojo/getProp.rst +++ b/dojo/getProp.rst @@ -1,5 +1,6 @@ .. _dojo/getProp: +============= dojo.getProp ============= @@ -8,7 +9,6 @@ dojo.getProp Gets a property on an HTML element. -============ Introduction ============ @@ -16,7 +16,6 @@ Handles normalized getting of properties on DOM nodes. Since Dojo 1.7, ``dojo.getProp`` is exposed via the ``get`` method of the ``dojo/dom-prop`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -37,7 +36,6 @@ name the name of the property to get. -======== Examples ======== @@ -79,7 +77,6 @@ Dojo < 1.7 // or we can just pass the id: dojo.getProp("nodeId", "foo"); -======== See also ======== diff --git a/dojo/getStyle.rst b/dojo/getStyle.rst index 7be4dc93b..1e587f275 100644 --- a/dojo/getStyle.rst +++ b/dojo/getStyle.rst @@ -1,5 +1,6 @@ .. _dojo/getStyle: +============= dojo.getStyle ============= @@ -9,7 +10,6 @@ dojo.getStyle Accesses styles on a node. -============ Introduction ============ @@ -18,7 +18,6 @@ will be a calculated value, not just the immediate node.style value. Also when g Since Dojo 1.7, ``dojo.getStyle`` is exposed via the ``get`` method of the ``dojo/dom-style`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -39,7 +38,6 @@ name the style property to get -======== Examples ======== @@ -81,7 +79,6 @@ Dojo < 1.7 // Passing a node and a style property returns the current normalized, computed value for that property: dojo.getStyle("thinger", "opacity"); // 1 by default -======== See also ======== diff --git a/dojo/global.rst b/dojo/global.rst index 1e4a89a50..ded14d86e 100644 --- a/dojo/global.rst +++ b/dojo/global.rst @@ -1,5 +1,6 @@ .. _dojo/global: +=========== dojo.global =========== @@ -14,14 +15,12 @@ dojo.global dojo.global is an alias for the global scope. -============ Introduction ============ In a browser environment, dojo.global is the window object. You should refer to `dojo.global` rather than `window` so that your code will run correctly in other contexts (e.g. Rhino on a server). -===== Usage ===== @@ -37,7 +36,6 @@ Usage Though this example is clearly targeted at a browser environment, by using `dojo.global` over the `window` object we are ensuring the code will run in any other environments with a defined host environment file (hostenv_something). -======== See also ======== diff --git a/dojo/hasAttr.rst b/dojo/hasAttr.rst index 35deea03b..967b16a2f 100644 --- a/dojo/hasAttr.rst +++ b/dojo/hasAttr.rst @@ -1,5 +1,6 @@ .. _dojo/hasAttr: +============ dojo.hasAttr ============ @@ -11,7 +12,6 @@ dojo.hasAttr Checks a node for the presence of an attribute. -============ Introduction ============ @@ -21,7 +21,6 @@ Since 1.4 it will return true for standard properties that can't have a correspo Since Dojo 1.7, ``dojo.hasAttr`` is exposed via the ``has`` method of the ``dojo/dom-attr`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -45,7 +44,6 @@ result truthy, if the attribute is present, falsy otherwise -======== Examples ======== @@ -109,7 +107,6 @@ The following example will check for several attributes.

-======== See also ======== diff --git a/dojo/hasClass.rst b/dojo/hasClass.rst index f3932e932..73256269f 100644 --- a/dojo/hasClass.rst +++ b/dojo/hasClass.rst @@ -1,5 +1,6 @@ .. _dojo/hasClass: +============= dojo.hasClass ============= @@ -13,7 +14,6 @@ Returns a boolean depending on whether or not a node has a passed class string. Since Dojo 1.7, ``dojo.hasClass`` is exposed via the ``contains`` method of the ``dojo/dom-class`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -100,7 +100,6 @@ Using :ref:`dojo.query ` to find a node and check if it has a class: Note: You do not need to explicitly check for ``dojo.hasClass`` before adding or removing a class with :ref:`dojo.addClass ` or :ref:`dojo.removeClass `, they do it for you. -======== See also ======== diff --git a/dojo/hitch.rst b/dojo/hitch.rst index b8beb6ac3..8a4c8e338 100644 --- a/dojo/hitch.rst +++ b/dojo/hitch.rst @@ -1,5 +1,6 @@ .. _dojo/hitch: +========== dojo.hitch ========== diff --git a/dojo/i18n.rst b/dojo/i18n.rst index 103bb7d4d..2b6ce59a6 100644 --- a/dojo/i18n.rst +++ b/dojo/i18n.rst @@ -1,5 +1,6 @@ .. _dojo/i18n: +========= dojo.i18n ========= @@ -13,7 +14,6 @@ Utility classes to enable loading of resources for internationalization. Used exclusively with :ref:`dojo.requireLocalization `. -===== Usage ===== @@ -41,7 +41,6 @@ Dojo < 1.7 -======== See also ======== diff --git a/dojo/index.rst b/dojo/index.rst index 5aee9a4ed..5ea8fc121 100644 --- a/dojo/index.rst +++ b/dojo/index.rst @@ -1,5 +1,6 @@ .. _dojo/index: +==== Dojo ==== @@ -14,7 +15,6 @@ The dojo directory contains three categories of modules: Each category is described in detail below. -======= dojo.js ======= @@ -25,7 +25,6 @@ See the :ref:`loader documentation ` for details. For backwards-compatibility, when dojo.js is included without the async:false configuration flag, all the symbols in dojo/_base are implicitly loaded. -========== dojo/_base ========== @@ -381,7 +380,6 @@ Miscellaneous Base dojo/_base/sniff is introduced in dojo 1.7 as the browser detection utility. -========= Dojo Core ========= @@ -835,7 +833,6 @@ Miscellaneous Core Loads a Dojo module, by name -======== See also ======== diff --git a/dojo/indexOf.rst b/dojo/indexOf.rst index ba2c02150..59d9587ea 100644 --- a/dojo/indexOf.rst +++ b/dojo/indexOf.rst @@ -1,5 +1,6 @@ .. _dojo/indexOf: +============ dojo.indexOf ============ diff --git a/dojo/io-query.rst b/dojo/io-query.rst index a3eae742c..c5ce15275 100644 --- a/dojo/io-query.rst +++ b/dojo/io-query.rst @@ -11,7 +11,6 @@ dojo/io-query This module defines query string processing functions which contain objectToQuery and queryToObject. -======== Features ======== diff --git a/dojo/io.rst b/dojo/io.rst index cb98dbdb3..1ca83385b 100644 --- a/dojo/io.rst +++ b/dojo/io.rst @@ -1,5 +1,6 @@ .. _dojo/io: +======= dojo.io ======= diff --git a/dojo/io/iframe.rst b/dojo/io/iframe.rst index cf1731327..a4c81b9b8 100644 --- a/dojo/io/iframe.rst +++ b/dojo/io/iframe.rst @@ -1,5 +1,6 @@ .. _dojo/io/iframe: +============== dojo.io.iframe ============== @@ -12,7 +13,6 @@ dojo.io.iframe dojo.io.frame sends an AJAX I/O call using an IFrame (for instance, to upload files). -============ Introduction ============ @@ -23,7 +23,6 @@ The iframe IO functions are intended to handle complex IO operations that cannot It also retains much of the same operating semantics as dojo.xhrGet with regards to how you get the response from the service. All results are response data is returned through callbacks. There is a caveat to this; it requires the server to send the responses back in a very specific format, please refer to the :ref:`Additional Information ` section. -===== Usage ===== @@ -89,7 +88,6 @@ dojo.io.iframe calls cannot be made synchronous; therefore trying to set the 'sy Other than the reason noted above about reliability (getting proper events indicating data retrieved), the choice of using textarea was because a textarea provides a fixed container that dojo can locate in the iframe DOM and extract the contents from. And since it is a text area, it can contain JSON, XML, Text, etc. Once the data is obtained, the usual data handlers from dojo process it and pass it back through the callbacks specified by the user. -======== Examples ======== @@ -210,7 +208,6 @@ Pass in parameters manually }); -======== See Also ======== diff --git a/dojo/io/script.rst b/dojo/io/script.rst index 945dfe9fe..67ab4f0af 100644 --- a/dojo/io/script.rst +++ b/dojo/io/script.rst @@ -1,5 +1,6 @@ .. _dojo/io/script: +=============== dojo.io.script =============== @@ -10,26 +11,22 @@ dojo.io.script .. contents:: :depth: 2 -============ Introduction ============ This is an alternate IO mechanism to :ref:`dojo.xhrGet ` that has the capability of doing cross-site data access. It accomplishes this feat by doing an IO call via a dynamically inserted -======== See also ======== diff --git a/dojo/map.rst b/dojo/map.rst index ec77bcf71..37349ed15 100644 --- a/dojo/map.rst +++ b/dojo/map.rst @@ -1,5 +1,6 @@ .. _dojo/map: +======== dojo.map ======== @@ -12,14 +13,12 @@ dojo.map Applies callback to each element of given array and returns an Array with the results. -============ Introduction ============ This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when run over sparse arrays, this implementation passes the "holes" in the sparse array to the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array. For more details, see: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map -===== Usage ===== @@ -35,7 +34,6 @@ Usage console.log(changedArray); // logs [2,3,4,5] }); -======== Examples ======== diff --git a/dojo/marginBox.rst b/dojo/marginBox.rst index b76d28ee4..c83974f27 100644 --- a/dojo/marginBox.rst +++ b/dojo/marginBox.rst @@ -1,5 +1,6 @@ .. _dojo/marginBox: +=============== dojo.marginBox =============== @@ -13,7 +14,6 @@ dojo.marginBox Getter/setter for the margin-box of node. -============ Introduction ============ @@ -29,7 +29,6 @@ for a node offset from its parent 50px to the left, 200px from the top with a ma Since Dojo 1.7, ``dojo.marginBox`` is exposed via the ``getMarginBox`` and ``setMarginBox`` methods of the ``dojo/dom-geometry`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -79,7 +78,6 @@ Dojo < 1.7 var marginBox = dojo.getMarginBox(domNode); dojo.setMarginBox(domNode, {w: 300, h: 150}); -======== Examples ======== @@ -204,7 +202,6 @@ Comparison of various DOM node position/size methods :ref:`Link: Comparison of various DOM node position/size methods. ` -======== See also ======== diff --git a/dojo/mixin.rst b/dojo/mixin.rst index b4f41633f..6f02d9d76 100644 --- a/dojo/mixin.rst +++ b/dojo/mixin.rst @@ -1,5 +1,6 @@ .. _dojo/mixin: +========== dojo.mixin ========== @@ -13,7 +14,6 @@ dojo.mixin dojo.mixin is a simple utility function for mixing objects together. Mixin combines two objects from right to left, overwriting the left-most object, and returning the newly mixed object for use. Dojo mixin is very similar to :ref:`dojo.extend ` but only works on objects, whereas extend explicitly extends an object.prototype. Merging two objects -============ Simple Mixes ============ @@ -52,7 +52,6 @@ This example overwrites the "d" member from the second object, leaving the varia This will create and play a fadeIn animation passing and onEnd function and node, using a default duration. -==================== Creating new Objects ==================== @@ -91,7 +90,6 @@ Alternately, you can pass an empty object as the first mix, and mix another obje Just remember the object instance in the first position will always be overwritten, and the right-most object will take precedence in the mix. -=================== Mixins with Classes =================== @@ -123,7 +121,6 @@ Now, any time we create a new instance of a my.Thinger, it will have a member va var thing = new my.Thinger({ defaultValue:"blue" }); -===================== Mixing into instances ===================== @@ -143,7 +140,6 @@ Sometimes is it useful to mix custom variables and members into instances of wid Now, that instance of the ContentPane as a Date object attached in the _timeCreated member, which is accessible to the widget as 'this._timeCreated'. -============== Mixing methods ============== diff --git a/dojo/moduleUrl.rst b/dojo/moduleUrl.rst index 4762570d0..1e4076ecd 100644 --- a/dojo/moduleUrl.rst +++ b/dojo/moduleUrl.rst @@ -1,5 +1,6 @@ .. _dojo/moduleUrl: +============== dojo.moduleUrl ============== @@ -10,7 +11,6 @@ dojo.moduleUrl dojo.moduleUrl is used to return a dojo._Url object relative to a module. -===== Usage ===== @@ -49,7 +49,6 @@ Dojo < 1.7 }); -======== See also ======== diff --git a/dojo/mouse.rst b/dojo/mouse.rst index 6a7cdc091..95b3d1b19 100644 --- a/dojo/mouse.rst +++ b/dojo/mouse.rst @@ -1,5 +1,6 @@ .. _dojo/mouse: +=========== dojo/mouse =========== @@ -12,7 +13,6 @@ dojo/mouse The dojo/mouse module provides extension events for hovering and mouse button utility functions. The module has three properties: enter, leave, and mouseButtons. -=========== mouse.enter =========== @@ -26,7 +26,6 @@ The mouse.enter event is an extension event for being notified of when the mouse }); }); -=========== mouse.leave =========== @@ -38,7 +37,6 @@ The mouse.leave event is an extension event for being notified of when the mouse dojo.removeClass(node, "hoverClass"); }); -============ mouseButtons ============ diff --git a/dojo/node.rst b/dojo/node.rst index fcf98a7c8..e5d567a94 100644 --- a/dojo/node.rst +++ b/dojo/node.rst @@ -1,5 +1,6 @@ .. _dojo/node: +================================= *Proposal* for dojo.Node object ================================= diff --git a/dojo/number.rst b/dojo/number.rst index f0219a1c8..c70afd4fa 100644 --- a/dojo/number.rst +++ b/dojo/number.rst @@ -1,5 +1,6 @@ .. _dojo/number: +=========== dojo.number =========== @@ -10,7 +11,6 @@ dojo.number :depth: 2 -============ Introduction ============ @@ -19,7 +19,6 @@ dojo.number contains methods for user presentation of Javascript Number objects: Formatting and parsing are done in a locale-sensitive manner, using culturally appropriate patterns for representing group (thousands) and decimal separators, percent signs, etc. This module forms the basis of dojo.currency, which uses similar methods but adds support for currency symbols and alters the pattern as appropriate. -================ format()/parse() ================ @@ -28,7 +27,6 @@ Similar to dojo.date.locale, dojo.number uses the Unicode.org Common Locale Data Custom formats may be specified to override the localized convention by passing in a 'pattern', for example dojo.number.format(123, {pattern:"00000"}) gives a result of "00123". The pattern string is constructed according to the Unicode CLDR specification, which uses a convention similar to Java's NumberFormat. See the API docs for details. -======= round() ======= @@ -38,7 +36,6 @@ IE: (0.9).toFixed(1) yields "0.0" All other browsers: (0.9).toFixed(1) yields "1.0" -======== See Also ======== diff --git a/dojo/objectToQuery.rst b/dojo/objectToQuery.rst index c47bba3c9..7f6374e61 100644 --- a/dojo/objectToQuery.rst +++ b/dojo/objectToQuery.rst @@ -1,5 +1,6 @@ .. _dojo/objectToQuery: +================== dojo.objectToQuery ================== @@ -10,7 +11,6 @@ dojo.objectToQuery Helper function for converting a JavaScript object into a properly encoded query string. -============ Introduction ============ @@ -18,7 +18,6 @@ This function is one of many helpers used by the dojo Xhr subsystem for handling Since Dojo 1.7, ``dojo.objectToQuery`` is exposed via the ``objectToQuery`` method of the ``dojo/io-query`` module. An alias is kept in ``dojo/_base/xhr`` for backward-compatibility. -===== Usage ===== @@ -63,7 +62,6 @@ Dojo < 1.7 // http://some.server.org/somecontext/?foo=bar&foo=bar2&bit=byte -======== Examples ======== @@ -104,7 +102,6 @@ Example 1: Using dojo.objectToQuery to create a query string and assign it to a The modified URI with a query string.:

 
-========
 See also
 ========
 
diff --git a/dojo/on.rst b/dojo/on.rst
index 1b36a5ce0..3a75a7b20 100644
--- a/dojo/on.rst
+++ b/dojo/on.rst
@@ -1,5 +1,6 @@
 .. _dojo/on:
 
+=======
 dojo/on
 =======
 
@@ -12,7 +13,6 @@ dojo/on
 
 The dojo/on module is a general-purpose event handler for DOM nodes and other event emitting objects, providing normalized event listening and event dispatching functionality. This module is designed to be lightweight and fast, based on modern browsers' event model.
 
-===========
 dojo/on API
 ===========
 
@@ -169,7 +169,6 @@ The on.once function allows you to register a listener that will be called just
 
   on.once(finishedButton, "click", onFinished);
 
-=================
 dojo/on migration
 =================
 
diff --git a/dojo/parser.rst b/dojo/parser.rst
index 458528026..4da0f4b39 100644
--- a/dojo/parser.rst
+++ b/dojo/parser.rst
@@ -1,5 +1,6 @@
 .. _dojo/parser:
 
+===============
 The Dojo Parser
 ===============
 
@@ -37,7 +38,6 @@ The parser also allows function parameters and connections to be done via ` rather than `dijit._Templated `, so the parser isn't included in that case.
 
-==================
 Running the Parser
 ==================
 
@@ -91,7 +90,6 @@ To run the parser when your page loads, add a data-dojo-config="parseOnLoad: tru
 Parser syntax
 -------------
 
-=====================
 Specifying parameters
 =====================
 
@@ -103,7 +101,6 @@ Attributes which correspond to native HTML attributes appear directly in the mar
             data-dojo-props="scrollOnFocus: true"/>
 
 
-==================
 Boolean parameters
 ==================
 
@@ -134,7 +131,6 @@ Although specifying disabled="true" will disable a widget, note that the followi
   
 
 
-===============
 Date parameters
 ===============
 * Regardless of the locale of the client or server, dates are specified to the parser in ISO format:
@@ -152,7 +148,6 @@ Incidentally, this is also how dates are returned to the server when a form is s
 
   
-=================== Function parameters =================== There are two ways to specify a function parameter to a widget, either via an attribute or a script tag (see below). To specify a function as an attribute you can either specify the name of a function: @@ -172,7 +167,6 @@ Alternately, you can inline the text of a function:
-=========== Script Tags =========== The parser allows the specification of behaviours through custom types in script blocks to extend and enhance the functionality of declarative widgets. This is done by specifying a script block that is a direct child of a node with decorate with `data-dojo-type`. There are different types of script tags supported: @@ -295,7 +289,6 @@ Writing widgets This section discusses how to write widgets that the parser can understand. -=============================== Specifying parameters and types =============================== @@ -354,7 +347,6 @@ If you don't want to set a default value for an attribute, you can give it an em * new Date("") = a date/time -============= markupFactory ============= diff --git a/dojo/partial.rst b/dojo/partial.rst index d74331375..d9d92469c 100644 --- a/dojo/partial.rst +++ b/dojo/partial.rst @@ -1,5 +1,6 @@ .. _dojo/partial: +============ dojo.partial ============ @@ -98,7 +99,6 @@ Basic Example
-========= See Also: ========= diff --git a/dojo/place.rst b/dojo/place.rst index 8eb6da0d5..00a85dbf7 100644 --- a/dojo/place.rst +++ b/dojo/place.rst @@ -1,5 +1,6 @@ .. _dojo/place: +========== dojo.place ========== @@ -16,7 +17,6 @@ To see this utility in context, read the :ref:`DOM Quick Start ` Since Dojo 1.7, ``dojo.place`` is exposed via the ``place`` method of the ``dojo/dom-construct`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -======== Overview ======== @@ -63,7 +63,6 @@ The naming of the positions are intentionally concise. Note that DocumentFragment is a Node, but not an Element. It does not support ``innerHTML``, ``style``, or any other familiar attributes of the element. -===== Usage ===== @@ -96,7 +95,6 @@ Dojo < 1.7 // place node to refNode dojo.place(node, refNode, "first"); -================= Placement options ================= @@ -320,7 +318,6 @@ In the fragment above the

node will have 3 children: a text node (spaces and Or you can construct DOM programmatically. -============ Alternatives ============ @@ -342,7 +339,6 @@ An alternative way to place (and create) a node is :ref:`dojo.create -===== Notes ===== diff --git a/dojo/prop.rst b/dojo/prop.rst index f2ffe0ab3..6b80e02b8 100644 --- a/dojo/prop.rst +++ b/dojo/prop.rst @@ -1,5 +1,6 @@ .. _dojo/prop: +=============== dojo.prop =============== @@ -9,7 +10,6 @@ dojo.prop Gets or sets a property on an HTML element. -============ Introduction ============ Handles normalized getting and setting of properties on DOM Nodes. If 2 arguments are passed, and a the second argument is a string, acts as a getter. If a third argument is passed, or if the second argument is a map of attributes, acts as a setter. @@ -17,7 +17,6 @@ When passing functions as values, note that they will not be directly assigned t Since Dojo 1.7, ``dojo.prop`` is exposed via the ``get`` and ``set`` methods of the ``dojo/dom-prop`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -81,7 +80,6 @@ Dojo < 1.7 // Set node property dojo.prop("nodeId", "tabIndex", 3); -======== Examples ======== @@ -233,7 +231,6 @@ Set style as an object hash of styles dojo.prop("someNode", "style", obj); dojo.style("someNode", obj); -======== See also ======== diff --git a/dojo/provide.rst b/dojo/provide.rst index 1038a2c6d..f4d5683cf 100644 --- a/dojo/provide.rst +++ b/dojo/provide.rst @@ -1,5 +1,6 @@ .. _dojo/provide: +============ dojo.provide ============ @@ -12,14 +13,12 @@ dojo.provide dojo.provide is a core part of the dojo module system. It tells the loader that a specific module has been loaded. -============ Introduction ============ Each javascript source file must have at least one dojo.provide() call at the top of the file, corresponding to the file name. For example, `js/dojo/foo.js` must have `dojo.provide("dojo.foo");` before any calls to `dojo.require()` are made. -===== Usage ===== @@ -59,7 +58,6 @@ Dojo < 1.7 Multiple dojo.provide calls can live in a file, but outside of built layer, it is normal just to see one for the module that matches the file name. -======== See also ======== diff --git a/dojo/publish.rst b/dojo/publish.rst index 34cffb968..618eff885 100644 --- a/dojo/publish.rst +++ b/dojo/publish.rst @@ -1,5 +1,6 @@ .. _dojo/publish: +============ dojo.publish ============ @@ -12,13 +13,11 @@ dojo.publish Publish an event to all subscribers of a `topic`. Publish is provided as part of Base Dojo (dojo.js), so no additional requires are needed. -============ Introduction ============ `dojo.publish` is one of three topic-related functions used to publish (broadcast?) any kind of information within the application, to be received by other functions :ref:`subscribed ` to the same channel. A channel can be any string in almost any form you like. Additionally, like other Dojo :ref:`event ` functions, a :ref:`dojo.unsubscribe ` function is provided to disconnect subscriptions to channels. -======== Examples ======== @@ -79,7 +78,6 @@ Subscribe returns a handle to later be used for disconnecting a subscription, mu In the above example, we're disconnecting the handle from within the subscribed function, effectively creating a "subscribe-once" pattern. After the first time something published on the ``/foo/bar`` channel, the connection is interrupted, and the function will no longer fire. -======== See also ======== diff --git a/dojo/query.rst b/dojo/query.rst index 42822fb45..f9d929820 100644 --- a/dojo/query.rst +++ b/dojo/query.rst @@ -242,8 +242,7 @@ Standard CSS3 Selectors Because dojo.query adopts the CSS3 standard for selecting nodes, you can use any CSS reference guide for help on choosing the right queries. Eric Meyer's CSS: The Definitive Guide is a good resource. For convenience, here's a chart of the standard CSS3 selectors, taken from the current working draft RFC. -====================== ========== -Pattern Meaning +====================== Pattern Meaning ====================== ========== \* any element E an element of type E diff --git a/dojo/queryToObject.rst b/dojo/queryToObject.rst index 392288da6..baa3d8a0f 100644 --- a/dojo/queryToObject.rst +++ b/dojo/queryToObject.rst @@ -1,5 +1,6 @@ .. _dojo/queryToObject: +================== dojo.queryToObject ================== @@ -10,7 +11,6 @@ dojo.queryToObject Helper function for converting a URI query string to a JavaScript Object -============ Introduction ============ @@ -18,7 +18,6 @@ This function is one of many helpers used by the dojo Xhr subsystem for handling Since Dojo 1.7, ``dojo.queryToObject`` is exposed via the ``queryToObject`` method of the ``dojo/io-query`` module. An alias is kept in ``dojo/_base/xhr`` for backward-compatibility. -===== Usage ===== @@ -58,7 +57,6 @@ Dojo < 1.7 // } -======== Examples ======== @@ -132,7 +130,6 @@ Example 2: Using queryToObject to alter query strings The modified query string in the URI:

-======== See also ======== diff --git a/dojo/rawXhrPost.rst b/dojo/rawXhrPost.rst index 01f5b9701..2febd8d37 100644 --- a/dojo/rawXhrPost.rst +++ b/dojo/rawXhrPost.rst @@ -1,5 +1,6 @@ .. _dojo/rawXhrPost: +=============== dojo.rawXhrPost =============== @@ -11,7 +12,6 @@ dojo.rawXhrPost The original purpose of dojo.rawXhrPost was a method that could be used to send a raw post body to the server. As of 1.3, this function is common with dojo.xhrPost(). So, for usage of dojo.rawXhrPost(), see :ref:`dojo.xhrPost() ` -======== See also ======== diff --git a/dojo/rawXhrPut.rst b/dojo/rawXhrPut.rst index 04068f312..51c00100c 100644 --- a/dojo/rawXhrPut.rst +++ b/dojo/rawXhrPut.rst @@ -1,5 +1,6 @@ .. _dojo/rawXhrPut: +============== dojo.rawXhrPut ============== @@ -11,7 +12,6 @@ dojo.rawXhrPut The original purpose of dojo.rawXhrPut was a method that could be used to send a raw post body to the server. As of 1.3, this function is common with dojo.xhrPut(). So, for usage of dojo.rawXhrPut(), see :ref:`dojo.xhrPut() ` -======== See also ======== diff --git a/dojo/ready.rst b/dojo/ready.rst index 0b5623e67..11df161b5 100644 --- a/dojo/ready.rst +++ b/dojo/ready.rst @@ -1,5 +1,6 @@ .. _dojo/ready: +========== dojo.ready ========== @@ -13,7 +14,6 @@ However, dojo.ready() implements a priority queue, so applications can register Note that if the DOM has already loaded, and all dependencies have been resolved, ready() functions fire immediately. -======== Examples ======== A typical usage is: diff --git a/dojo/registerModulePath.rst b/dojo/registerModulePath.rst index 6fa822dc5..3f3d474e3 100644 --- a/dojo/registerModulePath.rst +++ b/dojo/registerModulePath.rst @@ -1,5 +1,6 @@ .. _dojo/registerModulePath: +======================= dojo.registerModulePath ======================= @@ -13,7 +14,6 @@ dojo.registerModulePath Maps a module name to a path -============ Introduction ============ @@ -31,7 +31,6 @@ Note that the path given to dojo.registerModulePath is always assumed to be rela The second argument to dojo.registerModulePath, the path, should *not* end with a slash. Otherwise the calculated path could be inefficient and generate a path that has two slashes together. For paths that actually point to a file, the ending slash will generate the wrong path. -===== Usage ===== @@ -103,7 +102,6 @@ Dojo < 1.7 dojo.registerModulePath("aoldojo", "http://o.aolcdn.com/dojo/1.5/dojo"); -======== Example ======== @@ -171,7 +169,6 @@ Note: The custom button is simply an extension of "dijit.form.Button". my.form.button -======== See Also ======== diff --git a/dojo/removeAttr.rst b/dojo/removeAttr.rst index 6f8012e57..cc0d3e7f7 100644 --- a/dojo/removeAttr.rst +++ b/dojo/removeAttr.rst @@ -1,5 +1,6 @@ .. _dojo/removeAttr: +=============== dojo.removeAttr =============== @@ -11,7 +12,6 @@ dojo.removeAttr Removes an attribute. -============ Introduction ============ @@ -19,7 +19,6 @@ Introduction Since Dojo 1.7, ``dojo.removeAttr`` is exposed via the ``remove`` method of the ``dojo/dom-attr`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -40,7 +39,6 @@ attr the attribute property name. -======== Examples ======== @@ -90,7 +88,6 @@ The following example will remove ``disabled`` from the ``input`` node.

— our model node

-======== See also ======== diff --git a/dojo/removeClass.rst b/dojo/removeClass.rst index b32e61580..742462724 100644 --- a/dojo/removeClass.rst +++ b/dojo/removeClass.rst @@ -1,5 +1,6 @@ .. _dojo/removeClass: +================ dojo.removeClass ================ @@ -11,7 +12,6 @@ dojo.removeClass Removes a class or a list of classes from a DOM node. -============ Introduction ============ @@ -20,7 +20,6 @@ Follows the same pattern as most Dojo functionality by accepting a string ID of Since Dojo 1.7, ``dojo.removeClass`` is exposed via the ``remove`` method of the ``dojo/dom-class`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -62,7 +61,6 @@ Dojo < 1.7 // Remove a class from some node: dojo.removeClass("someNode", "firstClass"); -======== Examples ======== @@ -314,7 +312,6 @@ See it in action: -======== See also ======== diff --git a/dojo/replace.rst b/dojo/replace.rst index b76a1d62d..c59cdb4af 100644 --- a/dojo/replace.rst +++ b/dojo/replace.rst @@ -1,5 +1,6 @@ .. _dojo/replace: +============ dojo.replace ============ @@ -13,7 +14,6 @@ dojo.replace This function provides a light-weight foundation for substitution-based templating. It is a sane alternative to string concatenation technique, which is brittle and doesn't play nice with localization. -=========== Basic Usage =========== @@ -173,7 +173,6 @@ This code in action:

-============== Advanced Usage ============== @@ -352,7 +351,6 @@ It is advised for the new pattern to be: * Global * It should capture one substring, usually some text inside "braces". -======== Examples ======== diff --git a/dojo/replaceClass.rst b/dojo/replaceClass.rst index 2154fff27..1d907da34 100644 --- a/dojo/replaceClass.rst +++ b/dojo/replaceClass.rst @@ -1,5 +1,6 @@ .. _dojo/replaceClass: +================= dojo.replaceClass ================= @@ -8,7 +9,6 @@ dojo.replaceClass Removes a class or a list of classes from a DOM node. -============ Introduction ============ @@ -16,7 +16,6 @@ Replaces one or more classes on a node if not present. Operates more quickly tha Since Dojo 1.7, ``dojo.replaceClass`` is exposed via the ``replace`` method of the ``dojo/dom-class`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -52,7 +51,6 @@ Dojo < 1.7 dojo.replaceClass("someNode", "add1 add2", "remove1 remove2"); -======== Examples ======== @@ -84,7 +82,6 @@ Available in `dojo.NodeList()` for multiple toggles // dojo < 1.7 dojo.query(".findMe").replaceClass("addMe", "removeMe"); -======== See also ======== diff --git a/dojo/require.rst b/dojo/require.rst index 97f82624d..29cb7ab60 100644 --- a/dojo/require.rst +++ b/dojo/require.rst @@ -1,5 +1,6 @@ .. _dojo/require: +============ dojo.require ============ @@ -13,7 +14,6 @@ dojo.require Loads a Dojo module, by name. -============ Introduction ============ @@ -80,7 +80,6 @@ Additionally, you can re-call addOnLoad anytime you immediately call dojo.requir }); }); -===== Usage ===== @@ -110,7 +109,6 @@ Simply pass it a string: Throughout Dojo, the pattern above remains consistent. However, by using :ref:`dojo.registerModulePath ` in your code, you are able to redefine the meaning of parts of namespaces. -======== Examples ======== @@ -134,7 +132,6 @@ Examples -======== See Also ======== diff --git a/dojo/requireLocalization.rst b/dojo/requireLocalization.rst index 669aa93e0..2d8750ebb 100644 --- a/dojo/requireLocalization.rst +++ b/dojo/requireLocalization.rst @@ -1,5 +1,6 @@ .. _dojo/requireLocalization: +======================== dojo.requireLocalization ======================== @@ -12,7 +13,6 @@ dojo.requireLocalization Loads localized resources, according to the operating locale, or other locale if specified. -============ Introduction ============ @@ -26,7 +26,6 @@ Note that the root, by convention is usually US-English, so there are actually n A Dojo build will collapse these locales into flattened resource bundles, resulting in a single server hit. -===== Usage ===== @@ -38,7 +37,6 @@ Usage -======== See also ======== diff --git a/dojo/robot.rst b/dojo/robot.rst index eba487556..efe92e1d7 100644 --- a/dojo/robot.rst +++ b/dojo/robot.rst @@ -10,7 +10,6 @@ dojo/robot Users who use doh+dojo get the added convenience of dojo.mouseMoveAt instead of computing the absolute coordinates of their elements themselves -======== Features ======== diff --git a/dojo/robotx.rst b/dojo/robotx.rst index 8f84e542e..83ac4fe4d 100644 --- a/dojo/robotx.rst +++ b/dojo/robotx.rst @@ -10,7 +10,6 @@ dojo/robotx Loads an external app into an iframe and points dojo.doc to the iframe document, allowing the robot to control it -======== Features ======== diff --git a/dojo/rpc.rst b/dojo/rpc.rst index 016818f09..7112fa52c 100644 --- a/dojo/rpc.rst +++ b/dojo/rpc.rst @@ -1,5 +1,6 @@ .. _dojo/rpc: +======== dojo.rpc ======== @@ -12,7 +13,6 @@ dojo.rpc dojo.rpc offers methods to communicate via Remote Procedure Calls (RPC) with Backend Servers. -================== Available Services ================== @@ -29,7 +29,6 @@ Available Services RPC service class -======== See also ======== diff --git a/dojo/rpc/JsonService.rst b/dojo/rpc/JsonService.rst index b07dfffce..02e10572c 100644 --- a/dojo/rpc/JsonService.rst +++ b/dojo/rpc/JsonService.rst @@ -1,5 +1,6 @@ .. _dojo/rpc/JsonService: +==================== dojo.rpc.JsonService ==================== @@ -14,14 +15,12 @@ dojo.rpc.JsonService dojo.rpc.JsonService is a generic JSON RPC service. -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojo/rpc/JsonpService.rst b/dojo/rpc/JsonpService.rst index 2826210c8..bdee2fe67 100644 --- a/dojo/rpc/JsonpService.rst +++ b/dojo/rpc/JsonpService.rst @@ -1,5 +1,6 @@ .. _dojo/rpc/JsonpService: +===================== dojo.rpc.JsonpService ===================== @@ -14,14 +15,12 @@ dojo.rpc.JsonpService dojo.rpc.JsonpService is a generic JSONP service. -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojo/rpc/RpcService.rst b/dojo/rpc/RpcService.rst index 08d0914a7..1cfdd6de8 100644 --- a/dojo/rpc/RpcService.rst +++ b/dojo/rpc/RpcService.rst @@ -1,5 +1,6 @@ .. _dojo/rpc/RpcService: +=================== dojo.rpc.RpcService =================== @@ -11,7 +12,6 @@ dojo.rpc.RpcService .. contents:: :depth: 2 -============ Introduction ============ @@ -22,7 +22,6 @@ This class provide SMD v.1 parsing facilities as well as all hooks to implement Dojo ships in with a :ref:`JSON RPC Service ` and a :ref:`JSONP RPC Service `. -===== Usage ===== @@ -36,13 +35,10 @@ Usage -============== ================= ======================================= -Parameter Type Description -============== ================= ======================================= -``args`` Object|String|URL If ``args`` is a String or an URL, its location is fetched and treated as JSON describing the SMD. If it is an object and contains a ``smdStr`` property, it is passed to ``eval`` to get the SMD, otherwise we assume that it is an SMD object. +============== ================= Parameter Type Description +============== ================= ``args`` Object|String|URL If ``args`` is a String or an URL, its location is fetched and treated as JSON describing the SMD. If it is an object and contains a ``smdStr`` property, it is passed to ``eval`` to get the SMD, otherwise we assume that it is an SMD object. ============== ================= ======================================= -========== SMD format ========== @@ -81,13 +77,11 @@ Here is an example SMD v.1 as expected by ``dojo.rpc``. This SMD describes a single method, ``add``, with two parameters. If ``add`` is called with less than two parameters, an error is thrown. The way method name and parameters are transmitted to the end point depends on the service type -=================== Creating subclasses =================== TODO -======== See also ======== diff --git a/dojo/safeMixin.rst b/dojo/safeMixin.rst index 05728a12b..302782255 100644 --- a/dojo/safeMixin.rst +++ b/dojo/safeMixin.rst @@ -1,5 +1,6 @@ .. _dojo/safeMixin: +============== dojo.safeMixin ============== @@ -11,7 +12,6 @@ dojo.safeMixin ``dojo.safeMixin`` is a companion function for :ref:`dojo.declare `. It has the same functionality as :ref:`dojo.mixin `, but additionally it annotates all copied methods compatibly with :ref:`dojo.declare `. This decoration can affect how ``this.inherited()`` works in mixed-in methods. -=========== Basic Usage =========== @@ -64,7 +64,6 @@ The function is usually used with classes and instances produced by :ref:`dojo.d return this.inherited("m5", arguments); // calls A.m5 }); -================= Technical details ================= diff --git a/dojo/setAttr.rst b/dojo/setAttr.rst index b85347e77..e8ac0a973 100644 --- a/dojo/setAttr.rst +++ b/dojo/setAttr.rst @@ -1,5 +1,6 @@ .. _dojo/setAttr: +============ dojo.setAttr ============ @@ -9,7 +10,6 @@ dojo.setAttr Sets an attribute on an HTML element. -============ Introduction ============ @@ -18,7 +18,6 @@ using `dojo.connect()`, meaning that event handler properties will be normalized Since Dojo 1.7, ``dojo.setAttr`` is exposed via the ``set`` method of the ``dojo/dom-attr`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -42,7 +41,6 @@ value the value to set for the attribute, if the name is a string. -======== Examples ======== @@ -87,7 +85,6 @@ Dojo < 1.7 var obj = { color:"#fff", backgroundColor:"#000" }; dojo.setAttr("someNode", "style", obj); -======== See also ======== diff --git a/dojo/setContentSize.rst b/dojo/setContentSize.rst index 4013e75a6..738f2f72d 100644 --- a/dojo/setContentSize.rst +++ b/dojo/setContentSize.rst @@ -1,5 +1,6 @@ .. _dojo/setContentSize: +=================== dojo.setContentSize =================== @@ -8,7 +9,6 @@ dojo.setContentSize Sets the size of the node's contents, irrespective of margins, padding, or borders. -============ Introduction ============ @@ -16,7 +16,6 @@ The dojo.setContentSize function is used to set the size of the node's contents, Since Dojo 1.7, ``dojo.setContentSize`` is exposed via the ``setContentSize`` method of the ``dojo/dom-geometry`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== diff --git a/dojo/setContext.rst b/dojo/setContext.rst index 5b47c347d..142b0435f 100644 --- a/dojo/setContext.rst +++ b/dojo/setContext.rst @@ -1,5 +1,6 @@ .. _dojo/setContext: +=============== dojo.setContext =============== @@ -11,7 +12,6 @@ dojo.setContext Changes the behavior of many core Dojo functions that deal with namespace and DOM lookup. -============ Introduction ============ @@ -55,7 +55,6 @@ This is because dojo stores many of the common global variables: By calling "dojo.setContext" (which modifies the convenience variables above), you can easily query another frame's content. -===== Usage ===== @@ -81,7 +80,6 @@ Dojo < 1.7 dojo.setContext(myIframe.contentWindow, myIframe.contentWindow.document); -======== Examples ======== diff --git a/dojo/setMarginBox.rst b/dojo/setMarginBox.rst index 957309a1d..5870ab7a3 100644 --- a/dojo/setMarginBox.rst +++ b/dojo/setMarginBox.rst @@ -1,5 +1,6 @@ .. _dojo/setMarginBox: +================= dojo.setMarginBox ================= @@ -8,7 +9,6 @@ dojo.setMarginBox Sets the size of the node's margin box and placement (left/top), irrespective of box model. Think of it as a passthrough to setBox that handles box-model vagaries for you. -============ Introduction ============ @@ -16,7 +16,6 @@ The dojo.setMarginBox function is used to set the size of the node's margin box Since Dojo 1.7, ``dojo.setMarginBox`` is exposed via the ``setMarginBox`` method of the ``dojo/dom-geometry`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== diff --git a/dojo/setObject.rst b/dojo/setObject.rst index b362adbce..b189fe476 100644 --- a/dojo/setObject.rst +++ b/dojo/setObject.rst @@ -1,5 +1,6 @@ .. _dojo/setObject: +============== dojo.setObject ============== @@ -13,7 +14,6 @@ dojo.setObject Set a property from a dot-separated string, such as "A.B.C". -===== Usage ===== @@ -45,7 +45,6 @@ Wheras with `dojo.setObject`, we can shorten that to: dojo.setObject("parent.child.prop", "some value", obj); -======== Examples ======== @@ -85,7 +84,6 @@ Examples -======== See also ======== diff --git a/dojo/setProp.rst b/dojo/setProp.rst index 3045ea8c6..cff20fb39 100644 --- a/dojo/setProp.rst +++ b/dojo/setProp.rst @@ -1,5 +1,6 @@ .. _dojo/setProp: +============= dojo.setProp ============= @@ -8,7 +9,6 @@ dojo.setProp Sets a property on an HTML element. -============ Introduction ============ @@ -18,7 +18,6 @@ When passing functions as values, note that they will not be directly assigned t Since Dojo 1.7, ``dojo.setProp`` is exposed via the ``set`` method of the ``dojo/dom-prop`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -43,7 +42,6 @@ value This API will return the DOM node. -======== Examples ======== @@ -148,7 +146,6 @@ Dojo < 1.7 dojo.setProp("someNode", "style", obj); dojo.style("someNode", obj); -======== See also ======== diff --git a/dojo/setStyle.rst b/dojo/setStyle.rst index a0383bace..6240acfd2 100644 --- a/dojo/setStyle.rst +++ b/dojo/setStyle.rst @@ -1,5 +1,6 @@ .. _dojo/setStyle: +============= dojo.setStyle ============= @@ -9,7 +10,6 @@ dojo.setStyle Sets styles on a node. -============ Introduction ============ @@ -17,7 +17,6 @@ Introduction Since Dojo 1.7, ``dojo.setStyle`` is exposed via the ``set`` method of the ``dojo/dom-style`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -41,7 +40,6 @@ value If passed, sets value on the node for style, handling cross-browser concerns. When setting a pixel value, be sure to include "px" in the value. For instance, top: 200px. Otherwise, in some cases, some browsers will not apply the style. -======== Examples ======== @@ -143,7 +141,6 @@ Dojo < 1.7 fontSize:"13pt" }); -======== See also ======== diff --git a/dojo/some.rst b/dojo/some.rst index eca17b363..f18db593d 100644 --- a/dojo/some.rst +++ b/dojo/some.rst @@ -1,9 +1,9 @@ .. _dojo/some: +========= dojo.some ========= -================ Usage & examples ================ diff --git a/dojo/stopEvent.rst b/dojo/stopEvent.rst index 01b231c80..0683a6172 100644 --- a/dojo/stopEvent.rst +++ b/dojo/stopEvent.rst @@ -1,5 +1,6 @@ .. _dojo/stopEvent: +============== dojo.stopEvent ============== @@ -48,7 +49,6 @@ dojo.fixEvent TO DOC -======== See Also ======== diff --git a/dojo/store.rst b/dojo/store.rst index a8cb30704..793c4ae77 100644 --- a/dojo/store.rst +++ b/dojo/store.rst @@ -1,5 +1,6 @@ .. _dojo/store: +========== dojo.store ========== @@ -12,7 +13,6 @@ dojo.store Dojo Store is an uniform interface for the access and manipulation of stored data. Dojo Store is intended to supersede, integrate, and improve upon the Dojo Data API and Dojo Storage API with a simple, easy to implement and extend API, based on `HTML5/W3C's IndexedDB object store API `_. The Dojo Storage API (implemented in `dojox.storage `_) is already a compatible subset of the the Dojo object store API. -============== Dojo Store API ============== @@ -22,8 +22,7 @@ Methods Every method in the API is optional, it's presence indicating support for that feature. Every method can return a promise (except where noted otherwise) to represent an asynchronous completion of the action. (Some of these are still wavering a bit in W3C's object store API): -================================================ ====================================================================== -Method Description +================================================ Method Description ================================================ ====================================================================== get(id) Retrieves an object by its identifier, returning the object. @@ -68,29 +67,25 @@ getMetadata(object) Returns any metadata about the Properties ---------- -=========== ================ ====================================================================== -Property Type Description +=========== ================ Property Type Description =========== ================ ====================================================================== idProperty String Name of the property to use as the identifier data Array of Objects If the store has a collection of cached objects, it can make this available in this property. This is included so an additional layer could add referential integrity cleanup on object deletion (which is a pain to implement). =========== ================ ====================================================================== -================ Returned Objects ================ Objects returned from store should primarily be treated as normal hash objects and have standard JavaScript properties to access their data and modify their data. However, methods may also be defined on the objects returned by the store (once again, they are optional). These methods should '''not''' be the object's own properties (hasOwnProperty(methodName) should return false), but rather should be inherited from one of the object's prototypes). This is to ensure ease of enumeration of data properties. In particular, a store may choose to return objects that are instances of dojo.Stateful (although none of the core stores do this). -===================== Observing Result Sets ===================== When a store is wrapped with ``dojo.store.Observable``, one can listen for changes in data through the observe method on the result set (the object returned from a query). The observe method has the following signature: -======================================================== ======================================================================= -Method Description +======================================================== Method Description ======================================================== ======================================================================= observe(listener) The listener function is called with following arguments: listener(object, removedFrom, insertedInto); @@ -102,7 +97,6 @@ observe(listener) The listener function close When close() is called on a result set, notifications will no longer be fired. ======================================================== ======================================================================= -============================== Core Stores included with Dojo ============================== @@ -167,7 +161,6 @@ We will need to include a helper mixin or wrapper to make it easy to implement t I believe this generally facilitates all of the Dojo Data functionality. Some of it may require some composition, but I think most of the needed things would be in place to achieve anything you could with Dojo Data. The one thing I did intentionally omit was getLabel/getLabelAttributes, as I think is clearly a UI concern. It would be easy enough to include a labelProperty property on the store, but I don't think it is necessary. -============ Design Goals ============ @@ -179,7 +172,6 @@ Design Goals * Objects returned from the data store (via query or get) should be plain JavaScript objects whose properties can be typically accessed and modified through standard property access. -======== See Also ======== diff --git a/dojo/store/Cache.rst b/dojo/store/Cache.rst index 256075d27..0e27eeb30 100644 --- a/dojo/store/Cache.rst +++ b/dojo/store/Cache.rst @@ -1,5 +1,6 @@ .. _dojo/store/Cache: +================ dojo.store.Cache ================ @@ -13,13 +14,11 @@ dojo.store.Cache **dojo.store.Cache** is a object store wrapper for caching data from one store in another store. This store follows the :ref:`Dojo Object Store API `. -============ Introduction ============ The Cache store provides caching capabilities for stores. The Cache store takes two stores, a master store and caching store. The master store is considered the data authority, all modifications go to the master store, and when data is not available in the cache, it is retrieved from the master store. The caching store is used to record cached data from master store. Doing get() and query() call results are added to the cache (unless they don't meet provided criteria), but only get() uses the cache, whereas query() uses the master store. If you want to a query to come from the cache, directly call query() on the caching store. Data modifications are also mirrored in the caching store. A typical usage of dojo.store.Cache would be to use a JsonRest store as the master store, and a Memory store as the caching store. -======== Examples ======== @@ -34,7 +33,6 @@ Examples store.put({id:2, name:"two"}) -> Stores the object in both master and cache store store.get(2) -> Returns the object, using the local memory cache -=== API === diff --git a/dojo/store/DataStore.rst b/dojo/store/DataStore.rst index a657d674a..9bb092f18 100644 --- a/dojo/store/DataStore.rst +++ b/dojo/store/DataStore.rst @@ -1,5 +1,6 @@ .. _dojo/store/DataStore: +==================== dojo.store.DataStore ==================== @@ -13,7 +14,6 @@ dojo.store.DataStore **dojo.store.DataStore** is an adapter for using Dojo DataStores with an object store consumer. This store allows the developer to convert existing datastores to implement the new :ref:`Dojo Object Store API `. -======== Examples ======== @@ -27,7 +27,6 @@ Examples // use the query results returned from the server }); -============== Method Mapping ============== diff --git a/dojo/store/JsonRest.rst b/dojo/store/JsonRest.rst index aac306a1d..4099a8496 100644 --- a/dojo/store/JsonRest.rst +++ b/dojo/store/JsonRest.rst @@ -1,5 +1,6 @@ .. _dojo/store/JsonRest: +======================== dojo/store/JsonRest ======================== @@ -14,13 +15,11 @@ dojo/store/JsonRest **dojo/store/JsonRest** is a lightweight object store implementation of an HTTP-based (RFC 2616) client with RESTful data interaction capabilities. This store implements the new :ref:`Dojo Object Store API `. -============ Introduction ============ JsonRest provides full read, write, and notification capabilities through standards based HTTP/REST interaction with the server using GET, PUT, POST, and DELETE commands. This data store allows you to communicate with server side database/persistent data storage using the Dojo Data API with JavaScript and efficiently handles create, read, update, and delete (CRUD) operations. This can greatly simplify client server communication, interacting can be done simply using straightforward JavaScript instead of having to build your communication for CRUD actions. -======== Examples ======== @@ -43,7 +42,6 @@ Examples store.remove(3); // delete the object }); -========================== Implementing a REST Server ========================== @@ -53,7 +51,6 @@ The JsonRest store follows `RFC 2616 `_ whe This URL will be used to retrieve items by identity and make modifications (PUT and DELETE). It is also recommended that a /{Table}/ URL is used to represent the entire collection of items for the store. When a query is performed, any query string is appended to the target URL to retrieve the results of the query. The JsonRest expects the results to be returned in an array (not in an object with an items property like some stores). The store will also POST to that URL to create new items. -============== Method Mapping ============== @@ -65,7 +62,6 @@ With the JsonRest store, store methods should intuitively map to HTTP methods: * put(object, options) - If object includes an identity property, or options includes an id, this will trigger a PUT request to {target}{id} with the request body being the provided object serialized as JSON. If no identity is provided, then a POST request is made to the store's target URL (no id appended) with the object as the body. If the options.incremental property is true, then a POST request is made to {target}{id} with the object as the body. You may also include an options.overwrite property. If overwrite is set to true, then an If-Match: * header is included. If overwrite is set to false, then an If-None-Match: * header is included. * add(object, options) - This behaves exactly like put(object, options), except that options.overwrite is set to false, indicating that a new object must be created. -====== Paging ====== @@ -77,7 +73,6 @@ On your server, you should look at the Range header in the request to know which Content-Range: items 0-24/66 -======= Sorting ======= @@ -108,7 +103,6 @@ If ``sortParam`` is not set, the sort value is appended without a key-value pair /FooObject/?foo=value1&sort(+foo,-bar) -==== Misc ==== diff --git a/dojo/store/Memory.rst b/dojo/store/Memory.rst index 16d110d81..b40858ca3 100644 --- a/dojo/store/Memory.rst +++ b/dojo/store/Memory.rst @@ -1,5 +1,6 @@ .. _dojo/store/Memory: +================= dojo.store.Memory ================= @@ -13,13 +14,11 @@ dojo.store.Memory **dojo.store.Memory** is a object store wrapper for JavaScript/JSON available directly with an array. This store implements the new :ref:`Dojo Object Store API `. -============ Introduction ============ The Memory store provides full read and write capabilities for in memory data. The Memory store is very simple to use, just provide an array of objects. The Memory store is also a synchronous store, which also simplifies its usage. All the functions directly return results, so you don't have to use asynchronous callbacks in your code. -======== Examples ======== @@ -43,7 +42,6 @@ Examples store.remove(3); // delete the object -======== See Also ======== diff --git a/dojo/store/Observable.rst b/dojo/store/Observable.rst index c600c5298..fa44fc876 100644 --- a/dojo/store/Observable.rst +++ b/dojo/store/Observable.rst @@ -14,7 +14,6 @@ dojo.store.Observable **dojo.store.Observable** is an object store wrapper that adds support for notification of data changes to query result sets. The query result sets returned from a Observable store will include a observe function that can be used to monitor for changes. This store follows the new :ref:`Dojo Object Store API `. The observe function provides indication of the previous and new index values of changed objects to properly update result arrays. -============ Introduction ============ @@ -38,7 +37,6 @@ The listener function is called with following arguments: The observe() method returns an object with a cancel() method that can be called to stop observing the given result set. -======== Examples ======== diff --git a/dojo/string.rst b/dojo/string.rst index 50f1a1e23..828b4f4fc 100644 --- a/dojo/string.rst +++ b/dojo/string.rst @@ -1,5 +1,6 @@ .. _dojo/string: +========================= dojo.string (dojo/string) ========================= @@ -11,7 +12,6 @@ dojo.string (dojo/string) dojo.string provides some simple string manipulation utilities -============ Introduction ============ diff --git a/dojo/string/trim.rst b/dojo/string/trim.rst index c38e6798b..1e9f56897 100644 --- a/dojo/string/trim.rst +++ b/dojo/string/trim.rst @@ -1,5 +1,6 @@ .. _dojo/string/trim: +================ dojo.string.trim ================ diff --git a/dojo/style.rst b/dojo/style.rst index 089f7e8ac..d5158abcd 100644 --- a/dojo/style.rst +++ b/dojo/style.rst @@ -1,5 +1,6 @@ .. _dojo/style: +========== dojo.style ========== @@ -12,7 +13,6 @@ dojo.style A getter/setter for styles on a DOM node. -============ Introduction ============ @@ -22,7 +22,6 @@ See the Tips section below for caveats on getting style information, like when u Since Dojo 1.7, ``dojo.style`` is exposed via the ``get`` and ``set`` methods of the ``dojo/dom-style`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -169,7 +168,6 @@ Dojo < 1.7 fontSize:"13pt" }); -======== Examples ======== @@ -359,7 +357,6 @@ dojo.NodeList implements .style() using the same syntax, omitting the "node" par -==== Tips ==== @@ -376,7 +373,6 @@ Tips * For getting a node's dimensions, use :ref:`dojo.marginBox ` or :ref:`dojo.contentBox `: the .width and .style properties are not accurate from getComputedStyle. -======== See also ======== diff --git a/dojo/subscribe.rst b/dojo/subscribe.rst index ccb5c4116..8c94c34e5 100644 --- a/dojo/subscribe.rst +++ b/dojo/subscribe.rst @@ -1,5 +1,6 @@ .. _dojo/subscribe: +============== dojo.subscribe ============== @@ -12,13 +13,11 @@ dojo.subscribe Linked a listener to a named topic. -============ Introduction ============ Subscribe is a part of the the Dojo Topic system used to register a function listening to a named channel. The channel is sent data via :ref:`dojo.publish `. -===== Usage ===== diff --git a/dojo/toJson.rst b/dojo/toJson.rst index d91c4e5da..d5c52e5f1 100644 --- a/dojo/toJson.rst +++ b/dojo/toJson.rst @@ -1,5 +1,6 @@ .. _dojo/toJson: +=========== dojo.toJson =========== @@ -10,13 +11,11 @@ dojo.toJson Returns a JSON serialization of an object. -============ Introduction ============ This function takes an object and converts it to a String serialization of that object. -======== Examples ======== @@ -52,7 +51,6 @@ Dojo < 1.7 TODOC: Date objects in objects -========= See Also: ========= diff --git a/dojo/toggleClass.rst b/dojo/toggleClass.rst index 093c1f514..64f854b04 100644 --- a/dojo/toggleClass.rst +++ b/dojo/toggleClass.rst @@ -1,5 +1,6 @@ .. _dojo/toggleClass: +================ dojo.toggleClass ================ @@ -11,7 +12,6 @@ dojo.toggleClass Simply toggles (adds or removes) a CSS class. -============ Introduction ============ @@ -19,7 +19,6 @@ dojo.toggleClass adds a class to node if not present, or removes if present. Since Dojo 1.7, ``dojo.toggleClass`` is exposed via the ``toggle`` method of the ``dojo/dom-class`` module. An alias is kept in ``dojo/_base/html`` for backward-compatibility. -===== Usage ===== @@ -56,7 +55,6 @@ Dojo < 1.7 dojo.toggleClass("someNode", "hovered"); -======== Examples ======== @@ -206,7 +204,6 @@ See it in action: -===================== Technical information ===================== @@ -233,7 +230,6 @@ This function is a simple convenience wrapper for :ref:`dojo.hasClass ` and provides "press | move | rel -============================== Relationship with dojo/gesture ============================== dojo/touch is the underneath basis for :ref:`dojox/gesture ` -============ Known Issues ============ diff --git a/dojo/trim.rst b/dojo/trim.rst index fb146813a..5075d139c 100644 --- a/dojo/trim.rst +++ b/dojo/trim.rst @@ -1,5 +1,6 @@ .. _dojo/trim: +========= dojo.trim ========= @@ -15,7 +16,6 @@ This function implements a frequently required functionality: it removes white-s Dojo's implementation was informed by `Steven Levithan's blog post `_. We chose to implement the compact yet performant version. If your application requires even more speed, check out `dojo.string.trim `_, which implements the fastest version. -===== Usage ===== @@ -51,7 +51,6 @@ dojo.trim accepts the only argument: a string to be trimmed. var output4 = show("\tfour\r\n"); var output5 = show("\f\n\r\t\vF I V E\f\n\r\t\v"); -======== Examples ======== diff --git a/dojo/uacss.rst b/dojo/uacss.rst index 67eaa6617..6e7cb4467 100644 --- a/dojo/uacss.rst +++ b/dojo/uacss.rst @@ -1,5 +1,6 @@ .. _dojo/uacss: +============ dojo.uacss ============ @@ -10,7 +11,6 @@ dojo.uacss .. contents:: :depth: 2 -============ Introduction ============ @@ -53,7 +53,6 @@ flag. In addition, the classes from above are repeated with -rtl appended. Fo dj_rtl dj_ie-rtl dj_ie7-rtl dj_iequirks-rtl dj_borderBox-rtl -===== Usage ===== diff --git a/dojo/unsubscribe.rst b/dojo/unsubscribe.rst index 683acd2f9..dcb5052a2 100644 --- a/dojo/unsubscribe.rst +++ b/dojo/unsubscribe.rst @@ -1,5 +1,6 @@ .. _dojo/unsubscribe: +================ dojo.unsubscribe ================ @@ -12,7 +13,6 @@ dojo.unsubscribe Remove a topic listener. -============ Introduction ============ diff --git a/dojo/version.rst b/dojo/version.rst index bd194a006..df6c719e2 100644 --- a/dojo/version.rst +++ b/dojo/version.rst @@ -1,5 +1,6 @@ .. _dojo/version: +============ dojo.version ============ @@ -13,7 +14,6 @@ dojo.version An object describing the current version of dojo.js -===== Usage ===== diff --git a/dojo/when.rst b/dojo/when.rst index 13d9530d7..ac8190d2a 100644 --- a/dojo/when.rst +++ b/dojo/when.rst @@ -1,5 +1,6 @@ .. _dojo/when: +======================= Deferred.when/dojo.when ======================= @@ -15,7 +16,6 @@ dojo.when provides the ability to define a callback (and error handler) for the As of Dojo 1.7, the ``when`` function is exposed as a member of the ``dojo/_base/Deferred`` module return (which is also the ``Deferred`` constructor). It is aliased to ``dojo.when`` for backward-compatibility. -===== Usage ===== @@ -59,7 +59,6 @@ Example 2: Creating and calling a deferred (Dojo < 1.7 style). console.log(value); } -======== See Also ======== diff --git a/dojo/window.rst b/dojo/window.rst index 8f43647f2..b9f825f03 100644 --- a/dojo/window.rst +++ b/dojo/window.rst @@ -12,7 +12,6 @@ dojo.window **dojo.window** contains functions related to the viewport. -======== Features ======== @@ -29,7 +28,6 @@ Features Scrolls a node into view, similar to node.scrollIntoView() but working around browser quirks. -======== See also ======== diff --git a/dojo/window/get.rst b/dojo/window/get.rst index 28de08882..e97e4deda 100644 --- a/dojo/window/get.rst +++ b/dojo/window/get.rst @@ -1,5 +1,6 @@ .. _dojo/window/get: +================== dojo.window.get ================== @@ -10,13 +11,11 @@ dojo.window.get Gets the window object associated with a document -============ Introduction ============ Returns the window object associated with a document. -======== Examples ======== diff --git a/dojo/window/getBox.rst b/dojo/window/getBox.rst index 154f359f9..f99474ebc 100644 --- a/dojo/window/getBox.rst +++ b/dojo/window/getBox.rst @@ -1,5 +1,6 @@ .. _dojo/window/getBox: +================== dojo.window.getBox ================== @@ -11,13 +12,11 @@ dojo.window.getBox Gets the size of the viewport. -============ Introduction ============ The viewport is the part of the document that's visible on the screen. In contrast to this, the part of the document that's scrolled out of view is not part of the viewport. In order to get the size of the viewport, you can use dojo.window.getBox(). -===== Usage ===== @@ -44,7 +43,6 @@ Usage console.log('viewport size:', ' width: ', vs.w, ', height: ', vs.h, ', left: ', vs.l, ', top: ', vs.t); -======== Examples ======== diff --git a/dojo/window/scrollIntoView.rst b/dojo/window/scrollIntoView.rst index c25c67914..239c26023 100644 --- a/dojo/window/scrollIntoView.rst +++ b/dojo/window/scrollIntoView.rst @@ -1,5 +1,6 @@ .. _dojo/window/scrollIntoView: +========================== dojo.window.scrollIntoView ========================== @@ -10,7 +11,6 @@ dojo.window.scrollIntoView Scrolls a node into view, similar to node.scrollIntoView() but working around browser quirks. -======== Examples ======== diff --git a/dojo/windowUnloaded.rst b/dojo/windowUnloaded.rst index a2f54845c..f6cf92016 100644 --- a/dojo/windowUnloaded.rst +++ b/dojo/windowUnloaded.rst @@ -1,5 +1,6 @@ .. _dojo/windowUnloaded: +=================== dojo.windowUnloaded =================== @@ -12,7 +13,6 @@ dojo.windowUnloaded Signal fired by impending window destruction. Favor using :ref:`dojo.addOnWindowUnload ` instead of this method directly. -======== See also ======== diff --git a/dojo/withDoc.rst b/dojo/withDoc.rst index fd4240b0b..f406d2cf3 100644 --- a/dojo/withDoc.rst +++ b/dojo/withDoc.rst @@ -1,5 +1,6 @@ .. _dojo/withDoc: +=============== dojo.withDoc =============== @@ -10,13 +11,11 @@ dojo.withDoc dojo.withDoc provides a mechanism by which a function can have the document root temporarily changed for the execution of the function. This allows document scope changes without affecting other items in the current dojo application. -============ Introduction ============ This function provides a quick way to alter the 'document' root as seen by dojo for specific operations. This is most notably useful when iframes are involved and you want to use a core dojo function, such as dojo.query or dojo.style against contents of that iframe. -===== Usage ===== @@ -56,7 +55,6 @@ Dojo < 1.7 -======== Examples ======== @@ -96,7 +94,6 @@ Example 1: Using dojo.withDoc alter documents in an iFrame. -======== See also ======== diff --git a/dojo/withGlobal.rst b/dojo/withGlobal.rst index fda0ddd69..28e3314a2 100644 --- a/dojo/withGlobal.rst +++ b/dojo/withGlobal.rst @@ -1,5 +1,6 @@ .. _dojo/withGlobal: +=============== dojo.withGlobal =============== @@ -12,14 +13,12 @@ dojo.withGlobal dojo.withGlobal provides a mechanism by which a function can have its dojo.global and dojo.doc scope temporarily changed. This allows complete scope changes without affecting other items in the current dojo applications. -============ Introduction ============ This function provides a quick way to alter both the dojo.global scope and the dojo.doc document scope with a single call. You pass in a global scope (window object) and if it contains a "document" property, it is used in place of the default dojo.doc for the life of the function call. This call makes it possible for widgets that are dojo.global and dojo.doc scope-control away to have their scopes changed temporarily without affecting the rest of the page. -===== Usage ===== @@ -63,7 +62,6 @@ Dojo < 1.7 -======== See also ======== diff --git a/dojo/xhr.rst b/dojo/xhr.rst index be6f3252d..5eb3ebaa4 100644 --- a/dojo/xhr.rst +++ b/dojo/xhr.rst @@ -1,5 +1,6 @@ .. _dojo/xhr: +============== dojo.xhr ============== @@ -13,7 +14,6 @@ dojo.xhr As with all dojo._base components, these functions are included within Dojo Base. You get this functionality by just including ``dojo.js`` in your page. -============ Introduction ============ @@ -22,7 +22,6 @@ The XMLHTTP request object (XHR for short) is one of the basic building blocks f Dojo provides a solid set of battle-tested XHR wrapper functions to allow you to build Ajax interactions with confidence, use a unified API, and handle forms with ease. Read on to learn how easy it is to build powerful Ajax interactions with Dojo. -======== Features ======== @@ -39,7 +38,6 @@ Features * :ref:`dojo.rawXhrPut ` : Use HTTP PUT method to make an xhr call. -======== Examples ======== @@ -124,7 +122,6 @@ dojo.xhr allows you to submit all the values of your form with minimal effort: In fact, the attribute "form:" could be set on each node, not only on form nodes. If your page contains more than one form and these forms are enclosed with a div- or span-tag, then you're able to submit all these forms, if you set "form:" to the surrounding div- or span-tag. -======== See also ======== diff --git a/dojo/xhrDelete.rst b/dojo/xhrDelete.rst index bc870c5ca..7737e78c8 100644 --- a/dojo/xhrDelete.rst +++ b/dojo/xhrDelete.rst @@ -1,5 +1,6 @@ .. _dojo/xhrDelete: +============== dojo.xhrDelete ============== @@ -9,7 +10,6 @@ dojo.xhrDelete :depth: 2 -============ Introduction ============ @@ -17,13 +17,11 @@ The dojo.xhrDelete() function is is a lesser used, but still important, function The following information should get you up and going with dojo.xhrDelete(). As with all dojo functions, always refer to the API docs for detailed information. -=========== Limitations =========== The general limitations are the same as :ref:`dojo.xhrGet `. Also be aware that your server side must permit the DELETE operation for this method to work with a server. Some servers by default disable HTTP DELETE support. So, when using this method be sure your server allows HTTP DELETE and that your services will understand and do the appropriate action. -===== Usage ===== @@ -44,7 +42,6 @@ Handling Status Codes Handling status codes for xhrPost is the same as handling them for xhrGet. Please refer to the dojo.xhrGet :ref:`status code documentation ` for details. -======== Examples ======== @@ -97,7 +94,6 @@ Example 1: dojo.xhrDelete call to request a 'delete' of a URI Result
-======== See also ======== diff --git a/dojo/xhrGet.rst b/dojo/xhrGet.rst index 2590b96b6..74fe8fb5c 100644 --- a/dojo/xhrGet.rst +++ b/dojo/xhrGet.rst @@ -1,5 +1,6 @@ .. _dojo/xhrGet: +=========== dojo.xhrGet =========== @@ -9,7 +10,6 @@ dojo.xhrGet :depth: 2 -============ Introduction ============ @@ -17,14 +17,12 @@ The dojo.xhrGet() function is the cornerstone function of AJAX development. Its The following information should get you up and going with dojo.xhrGet(). As with all dojo functions, always refer to the API docs for detailed information. -=========== Limitations =========== dojo.xhrGet (and other functions in the same line: dojo.xhrPost, dojo.xhrDelete, dojo.xhrPut), are bound by the 'same domain' security policy of the browser. This means that they can only establish a connection back to the same server that served the HTML page. If you wish to use this API to talk to servers other than the one that originated your page, then you will have to use a proxy on your originating server and have it forward the requests. The only other solution to working around the same domain restriction is to use alternate IO methods, such as dojo.io.script. -===== Usage ===== @@ -151,7 +149,6 @@ A second parameter is always passed to the 'load', 'error', and 'handle' functio By making use of this status check, you can implement handling for authentication, proxy authentication, and myraid of other items you may need to react to, to make your application dynamic and user friendly. -======== Examples ======== @@ -560,7 +557,6 @@ Example 9: dojo.xhrGet call and checking the xhr 'status' code in 'handle'
-======== See also ======== diff --git a/dojo/xhrPost.rst b/dojo/xhrPost.rst index 13f3b855f..1fc367a78 100644 --- a/dojo/xhrPost.rst +++ b/dojo/xhrPost.rst @@ -1,5 +1,6 @@ .. _dojo/xhrPost: +============ dojo.xhrPost ============ @@ -9,7 +10,6 @@ dojo.xhrPost :depth: 2 -============ Introduction ============ @@ -17,14 +17,12 @@ The dojo.xhrPost() function is another the cornerstone function of AJAX developm The following information should get you up and going with dojo.xhrPost(). As with all dojo functions, always refer to the API docs for detailed information. -=========== Limitations =========== * Unable to post binary data. Consider :ref:`dojo.io.iframe ` * The limitations are the same as :ref:`dojo.xhrGet ` -===== Usage ===== @@ -68,7 +66,6 @@ Handling Status Codes Handling status codes for xhrPost is the same as handling them for xhrGet. Please refer to the dojo.xhrGet :ref:`status code documentation ` for details. -======== Examples ======== @@ -182,7 +179,6 @@ Example 2: dojo.xhrPost call to send some text data Result
-======== See also ======== diff --git a/dojo/xhrPut.rst b/dojo/xhrPut.rst index 2c6663d80..3a0e63045 100644 --- a/dojo/xhrPut.rst +++ b/dojo/xhrPut.rst @@ -1,5 +1,6 @@ .. _dojo/xhrPut: +=========== dojo.xhrPut =========== @@ -9,7 +10,6 @@ dojo.xhrPut :depth: 2 -============ Introduction ============ @@ -17,13 +17,11 @@ The dojo.xhrPut() function is lesser used function for pushing data for a server The following information should get you up and going with dojo.xhrPut(). As with all dojo functions, always refer to the API docs for detailed information. -=========== Limitations =========== The limitations are the same as :ref:`dojo.xhrGet ` -===== Usage ===== @@ -52,7 +50,6 @@ Handling Status Codes Handling status codes for xhrPost is the same as handling them for xhrGet. Please refer to the dojo.xhrGet :ref:`status code documentation ` for details. -======== Examples ======== @@ -106,7 +103,6 @@ Example 1: dojo.xhrPut call to send some text data Result
-======== See also ======== diff --git a/dojox/NodeList.rst b/dojox/NodeList.rst index 47c7b7c64..e8dfb4b77 100644 --- a/dojox/NodeList.rst +++ b/dojox/NodeList.rst @@ -1,5 +1,6 @@ .. _dojox/NodeList: +============== dojox.NodeList ============== @@ -11,13 +12,11 @@ dojox.NodeList A project containing modules which explicitly extend :ref:`dojo.NodeList `, which is the result of calling :ref:`dojo.query ` -======= Modules ======= * :ref:`dojox.NodeList.delegate ` - provides a ``delegate`` method, for event delegation -======== See Also ======== diff --git a/dojox/NodeList/delegate.rst b/dojox/NodeList/delegate.rst index 225030f4d..a7f84700a 100644 --- a/dojox/NodeList/delegate.rst +++ b/dojox/NodeList/delegate.rst @@ -1,5 +1,6 @@ .. _dojox/NodeList/delegate: +======================= dojox.NodeList.delegate ======================= @@ -9,7 +10,6 @@ dojox.NodeList.delegate :author: Bill :since: 1.6.0 -======== Overview ======== @@ -33,7 +33,6 @@ Note that delegate() will not work for events that don't bubble, like focus. onmouseenter/onmouseleave also don't currently work. -======= Example ======= @@ -63,7 +62,6 @@ Example }); }); -======== See Also ======== diff --git a/dojox/app.rst b/dojox/app.rst index 89e5a83b3..954667f10 100644 --- a/dojox/app.rst +++ b/dojox/app.rst @@ -1,5 +1,6 @@ .. _dojox/app: +========= dojox.app ========= @@ -11,7 +12,6 @@ dojox.app Implements application framework using dojox.mvc for web application on desktop/mobile platforms. -============ Introduction ============ dojox.app is an application frame work designed to allow simple configuration @@ -25,7 +25,6 @@ dojox.app - A library that provides high-level application controllers, defined dojox.mvc - A library that provides the ability to have view concerns separated from model or data concerns but have simple bindings or connections between them that can keep either side in sync, as well as respond to events or actions. The library also provides the ability to generate data-bound forms and views dynamically, built on key elements of mvc and app. -============= Overview ============= Application structure overview. @@ -55,7 +54,6 @@ Components in dojox.app :ref:`dojox.app.main ` - dojox.app.main(Application) is used to create a dojox.app application by the configuration in config.json. The main function includes: load configuration, load data from data source, create views, create data models, bind data models to views by dojox.app.bind, create scenes between views, parse application by dojo.parser.parse. -============= Usage ============= @@ -126,7 +124,6 @@ Here is the configuration instruction table. |views |The children views/scenes of the application or current scene. | +-----------------------+-----------------------------------------------------------------------+ -============ Sample ============ Sample application html page: @@ -303,7 +300,6 @@ Sample render result .. image :: ./app/pic3.png -================================ Comparison with dojox.mobile.app ================================ diff --git a/dojox/app/bind.rst b/dojox/app/bind.rst index 5b54246ed..d7a9938f8 100644 --- a/dojox/app/bind.rst +++ b/dojox/app/bind.rst @@ -1,5 +1,6 @@ .. _dojox/app/bind: +============== dojox.app.bind ============== @@ -9,7 +10,6 @@ dojox.app.bind dojox.app.bind provides a function to query dojox.mvc widgets, get and set binding data for each widgets with "ref" or data-dojo-props="ref: xxx" tag. dojoType, data-dojo-type, ref and data-dojo-props are compatible in a view. -============== Binding API ============== @@ -31,7 +31,6 @@ Parameters Detail | |and its associated dojo.Stateful model object| +----------------------+---------------------------------------------+ -============= Sample ============= diff --git a/dojox/app/main.rst b/dojox/app/main.rst index b58f07763..0988f4c45 100644 --- a/dojox/app/main.rst +++ b/dojox/app/main.rst @@ -1,5 +1,6 @@ .. _dojox/app/main: +============== dojox.app.main ============== diff --git a/dojox/app/model.rst b/dojox/app/model.rst index b8376ba67..981cb126d 100644 --- a/dojox/app/model.rst +++ b/dojox/app/model.rst @@ -1,5 +1,6 @@ .. _dojox/app/model: +================ dojox.app.model ================ @@ -12,7 +13,6 @@ dojox.app.model creates statefulModel data objects using JSON data or dojo data Models can be declared in the application configuration at application level or different view levels. The model declared at application level can be accessed by all scenes and views in this application. The model declared at view level can be accessed by this view or its children views. -============== Sample ============== Sample application configuration for dojox.app.model diff --git a/dojox/app/module/history.rst b/dojox/app/module/history.rst index bbb008689..3c23632db 100644 --- a/dojox/app/module/history.rst +++ b/dojox/app/module/history.rst @@ -1,5 +1,6 @@ .. _dojox/app/module/history: +============================ dojox.app.module.history ============================ @@ -9,7 +10,6 @@ dojox.app.module.history dojox.app.module.history manages transition forward and backward between views/scenes. A view can use 'transitionOptions' or 'href' to navigate forward or backward by utilizing HTML5 history API. -========== Usage ========== @@ -51,7 +51,6 @@ To start backward transition, all we need to do is to add a back button on the H

Data Binding Example

-===================== Sample ===================== Sample excerpt of view template with regarding to navigation and history diff --git a/dojox/app/scene.rst b/dojox/app/scene.rst index a1450aef7..918daf89d 100644 --- a/dojox/app/scene.rst +++ b/dojox/app/scene.rst @@ -1,5 +1,6 @@ .. _dojox/app/scene: +================ dojox.app.scene ================ @@ -9,12 +10,10 @@ dojox.app.scene dojox.app.scene is used to create the layout for each child view, manage the transition between views, resize layout to fit the display area. A scene can contains one or more children views or scenes. The difference between scene and view is that scene can have multiple children scenes views but view does not have child. -=============== Usage =============== If there is no child scene in the application, it is not necessary to declare the view as type 'dojox.app.scene' because dojox.app.main inherits dojox.app.scene and the application itself is a scene. For the application contains child scene, the child scene needs to be declared as 'dojox.app.scene' in the application like the 'tabscene' in the following sample. -=============== Sample =============== Sample application configuration diff --git a/dojox/app/view.rst b/dojox/app/view.rst index 4224fd293..262d91ed1 100644 --- a/dojox/app/view.rst +++ b/dojox/app/view.rst @@ -1,5 +1,6 @@ .. _dojox/app/view: +================ dojox.app.view ================ @@ -9,7 +10,6 @@ dojox.app.view dojox.app.view provides a view like dojox.mobile.View. It contains a template string which will be rendered with user defined template segments. A view should have no child view. -============== Sample ============== Sample application configuration for dojox.app.view diff --git a/dojox/atom.rst b/dojox/atom.rst index 98855cbe8..5b07586da 100644 --- a/dojox/atom.rst +++ b/dojox/atom.rst @@ -1,5 +1,6 @@ .. _dojox/atom: +========== dojox.atom ========== @@ -13,13 +14,11 @@ dojox.atom The *dojox.atom* project is a container project for functions and widgets that specifically deal with working with the `ATOM `_ data format. -============ Introduction ============ ATOM is a syndication format that uses a defined schema of XML for providing updated lists of things. The things can be news events, blog posts, whatever the syndication publisher wishes to publish. It came about as an alternative (and a more extensible), competitor to the widely used `RSS `_ format. This project contains libraries and and examples of how to work with ATOM feeds using the Dojo Toolkit. -====================== Available Sub-projects ====================== @@ -32,7 +31,6 @@ Available Sub-projects * **widget**: Example widgets that use the ATOM IO later and model to render and edit ATOM feeds. These are primarily examples and may not be perfect. * **tests**: Tests for the various modules. -===== Usage ===== @@ -41,7 +39,6 @@ For specific usage, please see each module's documentation page: * :ref:`dojox.atom.io.model ` * :ref:`dojox.atom.io.Connection ` -======== See Also ======== diff --git a/dojox/atom/io/Connection.rst b/dojox/atom/io/Connection.rst index 5597dcfb9..4eed138bf 100644 --- a/dojox/atom/io/Connection.rst +++ b/dojox/atom/io/Connection.rst @@ -1,5 +1,6 @@ .. _dojox/atom/io/Connection: +======================== dojox.atom.io.Connection ======================== @@ -13,7 +14,6 @@ dojox.atom.io.Connection The *dojox.atom.io.Connection* module is a IO class for performing APP (ATOM Publishing Protocol) styled IO actions with a server. -============ Introduction ============ @@ -21,7 +21,6 @@ This module simplifies performing APP by handling the configuration of all the n method for performing a particular type of ATOM action, from getting a Feed (xhrGet), to publishing a new entry (xhrPut). This class makes use of the dojox.atom.io.model class as its backing representation of the ATOM document and elements. -=========== Limitations =========== @@ -29,7 +28,6 @@ Since this module uses the core :ref:`dojo.xhr ` functions for perform same-domain policy for xhr requests. This means that it can only issue requests back to the server and port that served the HTML page using the API. For accessing alternate servers, you will need to use a proxy to broker the request to the target server. -====================== Constructor Parameters ====================== @@ -44,7 +42,6 @@ Constructor Parameters | | |the browser from caching the results of the IO call. The default is false. | | +----------------+--------------+------------------------------------------------------------------------------------------------+-----------+ -========= Functions ========= @@ -68,7 +65,6 @@ Functions | deleteEntry(entry,callback,errorCallback,xmethod,scope) | Function to delete an entry in a feed via APP (DELETE of an existing entry | +--------------------------------------------------------------+-----------------------------------------------------------------------------+ -======== Examples ======== @@ -190,7 +186,6 @@ Example 2: Update an entry in a Feed **Note:** You can see more example usage in the tests file at: dojox/atom/tests/io/module.js -======== See Also ======== diff --git a/dojox/atom/io/model.rst b/dojox/atom/io/model.rst index 55809f119..be5255c96 100644 --- a/dojox/atom/io/model.rst +++ b/dojox/atom/io/model.rst @@ -1,5 +1,6 @@ .. _dojox/atom/io/model: +=================== dojox.atom.io.model =================== @@ -13,13 +14,11 @@ dojox.atom.io.model The *dojox.atom.io.model* module is a JavaScript model of an ATOM feed. -============ Introduction ============ This module handles the parsing of the ATOM XML into a JavaScript structure that can be easily modified and then serialized out as XML. This set of classes handles browser idiosyncrasies when parsing the XML, making it very cross-browser compatible and is far simpler to work with than using DOM apis to walk the ATOM XML document. -============================ Classes defined in the model ============================ @@ -61,7 +60,6 @@ When the model file is loaded, several classes are defined that represent ATOM t Atom collection element -================= Utility Functions ================= @@ -85,13 +83,11 @@ There are also several utility functions defined by the model. These functions +-----------------------------------------------------+----------------------------------------------------------------------------------------+ -===== Usage ===== The model is intended for creating, parsing, and working with ATOM feeds in Javascript and being able to easily serialize them out. Generally to create a Feed you would use dojo.xhrGet() to load an XML document into a DOM, then pass that dom Object to buildFromDom() of a newly instantiated Atom Feed model class. It will then construct all its subclasses and set its attributes correctly. For specific usage, please refer to the examples section. -======== Examples ======== @@ -268,7 +264,6 @@ Example 3: Modify a loaded feed -======== See Also ======== diff --git a/dojox/atom/io/model/Collection.rst b/dojox/atom/io/model/Collection.rst index 6c5297455..6867a7aa0 100644 --- a/dojox/atom/io/model/Collection.rst +++ b/dojox/atom/io/model/Collection.rst @@ -1,5 +1,6 @@ .. _dojox/atom/io/model/Collection: +============================== dojox.atom.io.model.Collection ============================== @@ -13,7 +14,6 @@ dojox.atom.io.model.Collection An Atom collection describes a set of resources, accessible from a given URL that are identified by a title. -==================================== Public properties (and their types): ==================================== @@ -35,7 +35,6 @@ Public properties (and their types): | String | id | The ID string of this collection | +----------------------------+-----------------+---------------------------------------------------------------------------------------------+ -========================================== Public functions (and their return types): ========================================== @@ -49,7 +48,6 @@ Below are all the functions implemented by this model class. | String | toString() | Return the XML representation of the Service | +-------------------+------------------------------------------------------+-------------------------------------------------------------+ -========= See Also: ========= diff --git a/dojox/atom/io/model/Generator.rst b/dojox/atom/io/model/Generator.rst index 039b8c6aa..9664299e3 100644 --- a/dojox/atom/io/model/Generator.rst +++ b/dojox/atom/io/model/Generator.rst @@ -1,5 +1,6 @@ .. _dojox/atom/io/model/Generator: +============================= dojox.atom.io.model.Generator ============================= @@ -13,7 +14,6 @@ dojox.atom.io.model.Generator This Atom element conveys information about the package that generated this Atom feed. A generator can have a URI and a version number, in addition to the human-readable name. -==================================== Public properties (and their types): ==================================== @@ -27,7 +27,6 @@ Public properties (and their types): | String | value | The human-readable name of this generator | +----------------------------+-----------------+---------------------------------------------------------------------------------------------+ -========================================== Public functions (and their return types): ========================================== @@ -41,7 +40,6 @@ Below are all the functions implemented by this model class. | String | toString() | Return the XML representation of the Generator | +-------------------+------------------------------------------------------+-------------------------------------------------------------+ -========= See Also: ========= diff --git a/dojox/atom/io/model/Service.rst b/dojox/atom/io/model/Service.rst index 0664ccccf..45ae5ec86 100644 --- a/dojox/atom/io/model/Service.rst +++ b/dojox/atom/io/model/Service.rst @@ -1,5 +1,6 @@ .. _dojox/atom/io/model/Service: +=========================== dojox.atom.io.model.Service =========================== @@ -13,7 +14,6 @@ dojox.atom.io.model.Service An Atom service document describes the services that a server implementing the Atom Publishing Protocol offers. This object represents this type of document. -==================================== Public properties (and their types): ==================================== @@ -23,7 +23,6 @@ Public properties (and their types): | String | href | The URL to the service document | +----------------------------+-----------------+---------------------------------------------------------------------------------------------+ -========================================== Public functions (and their return types): ========================================== @@ -40,7 +39,6 @@ Below are all the functions implemented by this model class. | | | given URL | +-------------------+------------------------------------------------------+-------------------------------------------------------------+ -========= See Also: ========= diff --git a/dojox/atom/io/model/Workspace.rst b/dojox/atom/io/model/Workspace.rst index 436cb2e7e..de66facfd 100644 --- a/dojox/atom/io/model/Workspace.rst +++ b/dojox/atom/io/model/Workspace.rst @@ -1,5 +1,6 @@ .. _dojox/atom/io/model/Workspace: +============================= dojox.atom.io.model.Workspace ============================= @@ -13,7 +14,6 @@ dojox.atom.io.model.Workspace An Atom workspace element is a part of an Atom Service document, as defined by the Atom Publishing Protocol specification, and is for organization in the service document. -==================================== Public properties (and their types): ==================================== @@ -25,7 +25,6 @@ Public properties (and their types): | Array | collections | The collections housed by this workspace | +----------------------------+-----------------+---------------------------------------------------------------------------------------------+ -========================================== Public functions (and their return types): ========================================== @@ -39,7 +38,6 @@ Below are all the functions implemented by this model class. | String | toString() | Return the XML representation of the Service | +-------------------+------------------------------------------------------+-------------------------------------------------------------+ -========= See Also: ========= diff --git a/dojox/atom/widget.rst b/dojox/atom/widget.rst index 922c8e81f..1c4be6326 100644 --- a/dojox/atom/widget.rst +++ b/dojox/atom/widget.rst @@ -1,5 +1,6 @@ .. _dojox/atom/widget: +================= dojox.atom.widget ================= @@ -12,7 +13,6 @@ dojox.atom.widget dojox.atom.widget offers widgets for reading and editing ATOM feeds. -======== Features ======== @@ -29,7 +29,6 @@ Features An ATOM feed entry editor that allows viewing of the individual attributes of an entry -======== See also ======== diff --git a/dojox/av.rst b/dojox/av.rst index 6786cdc23..b06b885f5 100644 --- a/dojox/av.rst +++ b/dojox/av.rst @@ -1,5 +1,6 @@ .. _dojox/av: +======== dojox.av ======== @@ -14,7 +15,6 @@ dojox.av DojoX A/V aims to bring audio and video capabilities to the Open Web, first by wrapping common media types (Flash and Quicktime) and then by providing easy to use objects to accomplish basic A/V tasks. As of version 0.1, only the base is included (Flash and Quicktime embedding mechanisms); in the near future, usable objects will appear, both in raw programmatic form and also with Dijit-compatible wrappers. -==================== Available Components ==================== diff --git a/dojox/av/FLAudio.rst b/dojox/av/FLAudio.rst index d1d1854a4..ac28e8011 100644 --- a/dojox/av/FLAudio.rst +++ b/dojox/av/FLAudio.rst @@ -1,5 +1,6 @@ .. _dojox/av/FLAudio: +================ dojox.av.FLAudio ================ @@ -15,7 +16,6 @@ dojox.av.FLAudio dojo.av.FLAudio provides the ability of implementing MP3 sounds into your dojo applications through an embedded SWF, built in the DEFT project. This class provides the sound and programmatic control only - there is no user interface or widget. -============ Introduction ============ @@ -48,7 +48,6 @@ To find the status of the audio files, connect to onPlayStatus(). This provides Note, this class is still experimental, and the APIs could change in future versions. There is currently no ability to include this class as markup - it may be implemented in the future if the need is there. -======== Examples ======== @@ -84,7 +83,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/av/FLVideo.rst b/dojox/av/FLVideo.rst index 3b4fb056c..d4567ecd1 100644 --- a/dojox/av/FLVideo.rst +++ b/dojox/av/FLVideo.rst @@ -1,5 +1,6 @@ .. _dojox/av/FLVideo: +================ dojox.av.FLVideo ================ @@ -15,7 +16,6 @@ dojox.av.FLVideo dojo.av.FLVideo provides the ability to play Flash movie files (FLVs) within the dojo environment. It Also plays the H264/M4V codec (high definition) with a little trickery: change the '.M4V' extension to '.flv'. -============ Introduction ============ @@ -36,14 +36,12 @@ There is also volume() which is used as a getter/setter. There are also a large amount of events that are triggered. These events can be viewed in the base class of dojox.av._Media. Ky events are: onLoad() for when the SWF is ready, onBuffer() which is checking if there is enough video downloaded to play, onDownloaded() for the amount of the movie downloaded, onMetaData() which contains the video properties, and onPlay(), onStart(), onEnd(), etc. See the source code or http://dojotoolkit.org/api/dojox/av/FLVideo for full details. -======== Examples ======== For examples, please refer to the test file in the SDK: dojox/av/tests/testFLVideo.html -======== See also ======== diff --git a/dojox/av/widget.rst b/dojox/av/widget.rst index 1edac7b39..c5cb75176 100644 --- a/dojox/av/widget.rst +++ b/dojox/av/widget.rst @@ -1,5 +1,6 @@ .. _dojox/av/widget: +=============== dojox.av.widget =============== @@ -14,14 +15,12 @@ dojox.av.widget dojox.av.widget provides base player control widgets for building a media player. -============ Introduction ============ This package includes a PlayButton, VolumeButton, ProgressSlider, Status container, and the Player container. These widgets were built primarily for use with dojox.av.FLVideo, but could also be used to create players of other media types, including dojox.av.FLAudio. -===== Usage ===== @@ -48,7 +47,6 @@ Usage See the test file in the SDK for more information. -======== See also ======== diff --git a/dojox/charting.rst b/dojox/charting.rst index ff7da7ea1..abcbeb398 100644 --- a/dojox/charting.rst +++ b/dojox/charting.rst @@ -1,5 +1,6 @@ .. _dojox/charting: +============== dojox.charting ============== @@ -40,13 +41,11 @@ Dojo comes with an amazing charting library, in the form of dojox.charting. A la
-============ Introduction ============ Dojo's Charting module provides a way to quickly and easily add great looking and functional dynamic charts and graphs to your web pages. All you need is a tiny bit of JavaScript skills and a copy of Dojo. -=============== Charting Basics =============== @@ -102,14 +101,12 @@ As you can see from the source it is simple to create charts. As part of configuring any Chart, you'll need to define Plots, Axes and Series data. Plots describe how data is to be visualized. Axes describe the dimensions of data that are being visualized and includes things like specifying labels. Series describes the Data itself that the chart will visualize. -============ Adding Title ============ You can add a general title to the chart, and the title can be specified on position and font styles. Here are related parameters: -======== =========== ======= =========== -Name Type Default Description +======== =========== ======= Name Type Default Description ======== =========== ======= =========== titlePos string top determine adding title at the top/bottom of the chart. titleGap number 20 determine the spacing between title and the chart. @@ -128,7 +125,6 @@ And here comes an example: titleFontColor: "orange" }) -================== Working with Plots ================== @@ -386,7 +382,6 @@ Basically these are the same parameters than the ones passe to dojo.Animation. S See :ref:`Animated Chart ` for a full example. -================ Configuring Axis ================ @@ -451,8 +446,7 @@ Axis Title ----------- Adding title to axis, the position, orientation and color of the axis title can be specified. The parameters are: -================ =========== ======= =========== -Name Type Default Description +================ =========== ======= Name Type Default Description ================ =========== ======= =========== title string null axis title text. titleGap number 15 the spacing between title and corresponding axis, measured by pixel. @@ -536,15 +530,13 @@ Axis Label Shortening Axis labels will be overlapped with each other if there are some long labels. The label shortening rules can be specified by parameters as follows. -================= =========== ======= =========== -Name Type Default Description +================= =========== ======= Name Type Default Description ================= =========== ======= =========== trailingSymbol string null define the symbol replacing the omitted part of label. maxLabelSize number 0 define the max length of label in pixel. maxLabelCharCount number 0 define the max count of characters in label. ================= =========== ======= =========== -=============== Data Management =============== @@ -621,8 +613,7 @@ dojox.charting.DataSeries is used to connect to :ref:`dojo.data ` sto DataSeries' constructor has following parameters: -====== ========================== ======= =========== -Name Type Default Description +====== ========================== ======= Name Type Default Description ====== ========================== ======= =========== store object none Data store to use. Should implement at least :ref:`dojo.data.api.Read ` and :ref:`dojo.data.api.Identity `. If it implements :ref:`dojo.data.api.Notification `, it will be used to redraw chart dynamically. kwArgs object none Used for fetching items. Will vary depending upon store. See :ref:`dojo.data.api.Read.fetch() ` for details. @@ -683,7 +674,6 @@ If a field name is specified, it is used to pull one (numeric) value. The effect return store.getValue(item, field); } -===================== Changing Color Themes ===================== @@ -701,7 +691,6 @@ Under dojox.charting.themes, you will find a variety of predefined color themes at the top of any HTML file the chart is displayed in. -================= Events Management ================= @@ -780,7 +769,6 @@ TODO: please explain more. How does this work? Show an example. Coming with the Dojo 1.2 release, Charting will also support customized events, such as tooltip attachment and mouseover actions! -==================================== Zooming, Scrolling, and Panning APIs ==================================== @@ -806,7 +794,6 @@ Dojo Charting provides methods to control arbitrary zooming to drill down to the Both methods on Chart perform sanity checks, and won't allow you to scroll outside of axis’ boundaries, or zoom out too far. Starting with Dojo Toolkit 1.7 you can also zoom and pan using mouse and touch gestures, see Actions & Animated Effects section. -========================== Actions & Animated Effects ========================== @@ -1118,7 +1105,6 @@ The first parameter is a chart. The second parameter is the name of a plot. The As you can see from the example above you can mixin several actions. In order to avoid unnecessary interference between actions, use your best judgment when selecting them. Try to avoid actions that modify the same visual attributes, like geometry. You can safely mix Tooltip, Highlight, and one geometric action (Magnify, MoveSlice, or Shake). -================= Charts as Widgets ================= @@ -1159,7 +1145,6 @@ An interactive legend for all dojo charts that allows the end-user to click and var selectableLegend = new dojox.charting.widget.SelectableLegend({chart: chart1, outline: true},"selectableLegend"); -======== Examples ======== @@ -1320,7 +1305,6 @@ See :ref:`Plots Animation ` for more details.
-======== See also ======== @@ -1333,7 +1317,6 @@ See also * `Zooming, Scrolling, and Panning in Dojo Charting `_ * `Dojo Charting Reorganization `_ -======= Credits ======= diff --git a/dojox/charting/DataChart.rst b/dojox/charting/DataChart.rst index 837cbfdc6..90a5ee059 100644 --- a/dojox/charting/DataChart.rst +++ b/dojox/charting/DataChart.rst @@ -1,5 +1,6 @@ .. _dojox/charting/DataChart: +========================= dojox.charting.DataChart ========================= diff --git a/dojox/collections.rst b/dojox/collections.rst index dd5afc65f..5c53612dd 100644 --- a/dojox/collections.rst +++ b/dojox/collections.rst @@ -1,5 +1,6 @@ .. _dojox/collections: +================= dojox.collections ================= @@ -16,14 +17,12 @@ It is intended for use by people who are looking for a little bit more functiona Included are the Iterator and DictionaryIterator classes, both of which can operate on standard arrays and objects (respectively). -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -37,7 +36,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -52,7 +50,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/color.rst b/dojox/color.rst index 4b27ac354..686ec1342 100644 --- a/dojox/color.rst +++ b/dojox/color.rst @@ -1,5 +1,6 @@ .. _dojox/color: +=========== dojox.color =========== diff --git a/dojox/color/Palette.rst b/dojox/color/Palette.rst index 75975804d..ecc856e19 100644 --- a/dojox/color/Palette.rst +++ b/dojox/color/Palette.rst @@ -1,5 +1,6 @@ .. _dojox/color/Palette: +=================== dojox.color.Palette =================== diff --git a/dojox/cometd.rst b/dojox/cometd.rst index 4fdd41674..9e137f7d0 100644 --- a/dojox/cometd.rst +++ b/dojox/cometd.rst @@ -1,5 +1,6 @@ .. _dojox/cometd: +============ dojox.cometd ============ diff --git a/dojox/data.rst b/dojox/data.rst index a52948273..39c7805a8 100644 --- a/dojox/data.rst +++ b/dojox/data.rst @@ -1,5 +1,6 @@ .. _dojox/data: +========== dojox.data ========== @@ -13,7 +14,6 @@ dojox.data The DojoX Data project is a container for extensions and extra example stores that implement the dojo.data APIs. It may also contain utility functions for working with specific types of data. -======== Features ======== @@ -154,7 +154,6 @@ Features A read and write interface to basic XML data -======== See also ======== diff --git a/dojox/data/AndOrReadStore.rst b/dojox/data/AndOrReadStore.rst index a12eb74ca..5d6f9e85a 100644 --- a/dojox/data/AndOrReadStore.rst +++ b/dojox/data/AndOrReadStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/AndOrReadStore: +========================== dojox.data.AndOrReadStore ========================== @@ -13,7 +14,6 @@ dojox.data.AndOrReadStore dojox.data.AndOrReadStore is a clone of dojo.data.ItemFileReadStore. The only significant difference is that it supports more complex queries than the simple AND format property matching. Specifically, it can perform AND and ORing, and NOT. For general functions, data format, and information refer to :ref:`dojo.data.ItemFileReadStore `. -============== Supported APIs ============== @@ -22,7 +22,6 @@ The following dojo.data APIs are implemented by AndOrReadStore * :ref:`dojo.data.api.Read ` * :ref:`dojo.data.api.Identity ` -============ Query Syntax ============ AndOrReadStore supports all the same query capability as dojo.data.ItemFileReadStore as well as several others that allow for more complicated queries. In specific, it allows for chaining of ANDs, ORs, and NOTs for attributes (along with wildcards), for a much more flexible structure. @@ -31,7 +30,6 @@ AndOrReadStore supports all the same query capability as dojo.data.ItemFileReadS , NOT AND OR ( ) ! && || Note: "," included for legacy queries (translated to AND). -=============== Example queries =============== @@ -54,7 +52,6 @@ Object-Based Query ... -=================== Functional Examples =================== diff --git a/dojox/data/AndOrWriteStore.rst b/dojox/data/AndOrWriteStore.rst index 69905ca30..7c7ae7fb0 100644 --- a/dojox/data/AndOrWriteStore.rst +++ b/dojox/data/AndOrWriteStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/AndOrWriteStore: +========================== dojox.data.AndOrWriteStore ========================== @@ -13,7 +14,6 @@ dojox.data.AndOrWriteStore dojox.data.AndOrWriteStore is a clone of dojo.data.ItemFileWriteStore. The only significant difference is that like AndOrReadStore, AndOrWriteStore supports more complex queries. Please refer to :ref:`dojo.data.ItemFileWriteStore ` for general information about write support and refer to :ref:`dojox.data.AndOrReadStore ` for the query enhancements. -=========== API Support =========== diff --git a/dojox/data/AppStore.rst b/dojox/data/AppStore.rst index c71d546d9..5b3bb4af1 100644 --- a/dojox/data/AppStore.rst +++ b/dojox/data/AppStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/AppStore: +=================== dojox.data.AppStore =================== @@ -13,19 +14,16 @@ dojox.data.AppStore A store implementing an Atom store with complete ATOM Publishing Protocol support. Allows reading and writing of ATOM formatted feeds. -============ Introduction ============ The dojox.data.AppStore is an data store implementation of the ATOM Publishing Protocol (APP). It makes use of the dojox.atom subproject for handling ATOM feeds and entries. -=========== Limitations =========== The AppStore makes use of dojo.xhr to get and modify feeds and entries. Because of this, the AppStore is limited by the browser same domain policy, where xhr can only open connections back to the server that originated the page. If you require accessing ATOM feeds from external services, you will need to make use of a proxy. -============== Supported APIs ============== @@ -35,7 +33,6 @@ The following dojo.data APIs are implemented by AppStore: * :ref:`dojo.data.api.Write ` * :ref:`dojo.data.api.Identity ` -====================== Constructor Parameters ====================== @@ -49,7 +46,6 @@ Constructor Parameters | | |the browser from caching the feed url. | | +----------------+--------------+------------------------------------------------------------------------------------------------+-----------+ -================= Input Data Format ================= @@ -107,7 +103,6 @@ The input data format is the standard `ATOM -===== Usage ===== @@ -178,7 +173,6 @@ Complex properties are those that require more than a simple string to represent +---------------+------------------------------------------------------------------------------------+----------------------------------------+ -============ Query Syntax ============ @@ -190,7 +184,6 @@ The fetch method query syntax for AppStore is the same as :ref:`ItemFilereadStor Okay, easy. Now what if I want to do a fuzzy match of items? Can this be done? Yes. AppStore supports wildcard matching. Specifically, it supports multi-character * and single character ? as wildcards in attribute value queries. -============== Query Examples ============== @@ -226,7 +219,6 @@ Match items on multiple attributes { title:"?ar", subtitle:"bob", category:"*it*"} -======== Examples ======== @@ -445,7 +437,6 @@ Example 4: Write example: Changing Title and showing in DataGrid -======== See also ======== diff --git a/dojox/data/AtomReadStore.rst b/dojox/data/AtomReadStore.rst index 8bad0ed2e..246aa340d 100644 --- a/dojox/data/AtomReadStore.rst +++ b/dojox/data/AtomReadStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/AtomReadStore: +========================== dojox.data.AtomReadStore ========================== @@ -14,13 +15,11 @@ dojox.data.AtomReadStore The AtomReadStore is a store designed to provide read-only access to `Atom XML `_ documents. Atom XML is a common document format for web feeds providing lists of data. It is similar in many respects to RSS, but provides much more flexibility. -=========== API Support =========== * :ref:`dojo.data.api.Read ` -================== Constructor Params ================== @@ -42,7 +41,6 @@ The following parameters are supported by the GoogleFeedStore implementation. | |**New in Dojo 1.4.** | | +---------------+------------------------------------------------------------------------------------------+----------------------+ -=============== Item Attributes =============== @@ -66,7 +64,6 @@ The following attributes are available on items returned from the AtomReadStore: |author |A JSON object containing one or two elements, '''name''' and '''uri'''. The former is the name of the author, the latter is the authors personal uri, or web page. E.g. '''var author = store.getValue(item, 'author'); alert("Name is " + author.name + " and homepage is " + author.uri); | +-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ @@ -81,13 +78,11 @@ Query Example With One Parameter user: '1234' } -==================================================== Examples in Dojo Explorer ==================================================== Many examples are available in Dojo Explorer, at http://dojocampus.org/explorer/#Dojo_Data_AtomReadStore -==================================================== Example Usage of using AtomReadStore with a DataGrid ==================================================== diff --git a/dojox/data/ClientFilter.rst b/dojox/data/ClientFilter.rst index 172627a7e..5395c965e 100644 --- a/dojox/data/ClientFilter.rst +++ b/dojox/data/ClientFilter.rst @@ -1,5 +1,6 @@ .. _dojox/data/ClientFilter: +======================= dojox.data.ClientFilter ======================= @@ -15,14 +16,12 @@ dojox.data.ClientFilter An abstract data store module for adding updateable result set functionality to an existing data store class. -============ Introduction ============ This is an abstract class that data stores can extend to add updateable result set functionality as well as client side querying capabilities. This enables widgets to be aware of how active results change in response to the modifications/notifications. -===== Usage ===== @@ -41,7 +40,6 @@ matchesQuery(item, request) You can define a property on this object instance "**cacheByDefault**" to a value of true that will cause all queries to be cached by default unless the cache queryOption is explicitly set to false. This can be defined in the constructor options for ServiceStore/JsonRestStore and subtypes. -======== Examples ======== @@ -88,7 +86,6 @@ The important note is that you must load ClientFilter before you dojo.require a -======== See also ======== diff --git a/dojox/data/CouchDBRestStore.rst b/dojox/data/CouchDBRestStore.rst index 92ff02c82..75e43452d 100644 --- a/dojox/data/CouchDBRestStore.rst +++ b/dojox/data/CouchDBRestStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/CouchDBRestStore: +=========================== dojox.data.CouchDBRestStore =========================== @@ -15,14 +16,12 @@ dojox.data.CouchDBRestStore **dojox.data.CouchDBRestStore** is a subclass of `JsonRestStore `_ for connecting to the open source document-oriented database `Apache CouchDB `_. -============ Introduction ============ CouchDBRestStore essentially has the same functionality as JsonRestStore, but has some extra adaptations for automatic creation of stores based on CouchDB's database listing and working properly with CouchDB's idiosyncrasies. -===== Usage ===== @@ -35,7 +34,6 @@ You can create a set of stores for all available CouchDB tables/databases: This will return a object where each property name is the name of the store, and each value is the actual store for interacting with the CouchDB database. -======== See also ======== diff --git a/dojox/data/CssClassStore.rst b/dojox/data/CssClassStore.rst index 3409e4c5a..edfa521bc 100644 --- a/dojox/data/CssClassStore.rst +++ b/dojox/data/CssClassStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/CssClassStore: +======================== dojox.data.CssClassStore ======================== @@ -12,13 +13,11 @@ dojox.data.CssClassStore CssClassStore is a read interface based on the CssRuleStore. Items represent the individual classes present in the stylesheets loaded in the current page. In other words, compared to the results of a query on the CssRuleStore, the CssClassStore generates items that may be represented by a single item in the rule store (if several classes are mentioned in a single selector) OR may occur multiple times in the rule store (for a class that's mentioned in several selectors). Since the class store is based upon (extends) the rule store, it takes the same constructor parameters and operates very similarly. The single biggest difference is the support for the Identity API in the CssClassStore. The identity of an individual item is the same as it's 'class' attribute, which is the class name, including the '.' that is used to denote a class in a CSS selector. -=========== API Support =========== * dojo.data.api.Read * dojo.data.api.Identity -====================== Constructor Parameters ====================== @@ -31,7 +30,6 @@ The constructor for CssClassStore allows for one optional parameter. | |which rules to index. | | +----------+-------------------------------------------------------------------------------------------------+-------------+ -=============== Item Attributes =============== @@ -41,13 +39,11 @@ Item Attributes |classSans |The class name, without the '.' | +--------------------+-------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ The query syntax is identical to :ref:`dojo.data.ItemFileReadStore `. Please refer to it for the format of the queries. -======== Examples ======== diff --git a/dojox/data/CssRuleStore.rst b/dojox/data/CssRuleStore.rst index 1e9535837..19a1be98d 100644 --- a/dojox/data/CssRuleStore.rst +++ b/dojox/data/CssRuleStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/CssRuleStore: +======================= dojox.data.CssRuleStore ======================= @@ -12,12 +13,10 @@ dojox.data.CssRuleStore CssRuleStore is a read interface to the CSS rules loaded in the current page. Rules can be selected based on several different filterable attributes outlined below. Which CSS rules are indexed can be determined by a context provided to the store at the time of creation. This store is useful for reading the CSS rules that are loaded and in effect on the page. -=========== API Support =========== * dojo.data.api.Read -====================== Constructor Parameters ====================== @@ -30,7 +29,6 @@ The constructor for CssRuleStore allows for one optional parameter. | |which rules to index. | | +----------+-------------------------------------------------------------------------------------------------+-------------+ -=============== Item Attributes =============== @@ -54,13 +52,11 @@ Item Attributes |parentStyleSheetHref|The url to the parent stylesheet. May be null. | +--------------------+-------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ The query syntax is identical to :ref:`dojo.data.ItemFileReadStore `. Please refer to it for the format of the queries. -======== Examples ======== diff --git a/dojox/data/CsvStore.rst b/dojox/data/CsvStore.rst index 4f39aee8e..3aa8ace92 100644 --- a/dojox/data/CsvStore.rst +++ b/dojox/data/CsvStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/CsvStore: +=================== dojox.data.CsvStore =================== @@ -29,7 +30,6 @@ The following dojo.data APIs are implemented by CsvStore * :ref:`dojo.data.api.Read ` * :ref:`dojo.data.api.Identity ` -================== Constructor Params ================== @@ -53,13 +53,11 @@ Constructor Params | | |caching values loaded from a webserver. | | +----------------+--------------+------------------------------------------------------------------------------------------------+-----------+ -============ Query Syntax ============ The query syntax used by dojox.data.CsvStore is identical to the query syntax used by :ref:`dojo.data.ItemFileReadStore ` -============= Query Options ============= @@ -75,7 +73,6 @@ Dojo.data defines support for a 'queryOptions' modifier object that affects the +------------+------------------------------------------------------------------------------------------------------------------------+ -============== Custom Sorting ============== @@ -117,7 +114,6 @@ All fields in the CsvStore are read as strings. Therefore, they are sorted as s store.fetch({onComplete: completed, onError: error, sort: sortAttributes}); -======== Examples ======== diff --git a/dojox/data/FileStore.rst b/dojox/data/FileStore.rst index 83d6de7bc..6b6d5ba77 100644 --- a/dojox/data/FileStore.rst +++ b/dojox/data/FileStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/FileStore: +==================== dojox.data.FileStore ==================== @@ -16,7 +17,6 @@ The dojox.data.FileStore is a lightweight javascript implementation for accessin The datastore implementation and its example PHP back-end by default do not inflate the child file objects of a DataStore file item. This allows it to quickly return information about a file without having to return everything, while at the same time providing hooks that allow for the extra information to be gathered on-demand. -======== Features ======== @@ -40,7 +40,6 @@ Features 8. Works directly with all current data bound widgets in dijit, including :ref:`dijit.Tree `, :ref:`dijit.form.ComboBox `, and as well :ref:`dojox.grid `. -============== Item structure ============== @@ -71,7 +70,6 @@ All items returned by a query to the FileStore and will generally have the follo +-------------+---------------------------------------------------------------------------------------------------------+----------+ -=============== Query Structure =============== @@ -89,7 +87,6 @@ would return all files that have the name foo at the start of the name and end w Please note that the store is a hierarchical store and if you wish to query the entire file system (not just the root of it), for a file name, you must set the standard dojo.data.api.Read queryOption 'deep' to the value true. -======== Examples ======== @@ -256,7 +253,6 @@ Attaching the FileStore to dojox.grid.DataGrid declaratively -========================== Technical/Protocol Details ========================== diff --git a/dojox/data/FileStore/protocol.rst b/dojox/data/FileStore/protocol.rst index e537c96c5..2e8eedda5 100644 --- a/dojox/data/FileStore/protocol.rst +++ b/dojox/data/FileStore/protocol.rst @@ -1,5 +1,6 @@ .. _dojox/data/FileStore/protocol: +================================================ dojox.data.FileStore: Technical/Protocol Details ================================================ @@ -12,7 +13,6 @@ dojox.data.FileStore: Technical/Protocol Details The following section is not necessary to fully understand how to just use the existing dojox.data.FileStore back end implementation, it is intended for people who wish to implement their own back end service in another language, such as python or java. -======== Protocol ======== diff --git a/dojox/data/FlickrRestStore.rst b/dojox/data/FlickrRestStore.rst index 411baf8db..f019769a3 100644 --- a/dojox/data/FlickrRestStore.rst +++ b/dojox/data/FlickrRestStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/FlickrRestStore: +========================== dojox.data.FlickrRestStore ========================== @@ -18,7 +19,6 @@ The following dojo.data APIs are implemented by FlickrRestStore FlickrRestStore is built upon :ref:`FlickrStore `, a store which reads from Flickr's more simplistic public API. However, FlickrRestStore provides many more features: -======== Features ======== @@ -30,13 +30,11 @@ Features * Filter by Photo Set. By specifying a setid parameter on the query, you can retrieve photos only from a single set. Due to limitations of the Flickr API, using this parameter negates the use of the full text search. * Tag search. Passing a tags parameter to the request query searches by the given tags. This parameter can be either a comma separated string, or an array of strings. See the examples below. -=========================== Flickr Terms and Conditions =========================== Note: While this store wraps making calls to the Flickr service, as a user, you should still verify that you agree to the terms and conditions by which you are using the public Flickr photo service. Review their terms and conditions, and the API terms and conditions, `here `_. -======= API Key ======= @@ -47,7 +45,6 @@ Example Query the first three photos from a user: -================== Flickr API Example ================== @@ -107,7 +104,6 @@ Query the first three photos from a user FlickrRestStore's role is to process the query parameters passed to the dojo.data.api.Read API and generate the appropriate service URL. It then processes the response from the service and handles accessing the items returned from the query. It also provides simple attribute access to all the values. -====================== Constructor Parameters ====================== @@ -125,7 +121,6 @@ Constructor Parameters -=============== Item Attributes =============== @@ -153,7 +148,6 @@ Item Attributes | link |A URL linking to the Flickr page displaying the image. | +-----------------+-----------------------------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ @@ -191,7 +185,6 @@ sort **Note:** Unlike many of the other example stores, the FlickrRestStore store cannot do wild-card matching of the attributes. This is because the Flickr public photo feed service cannot do it. In an ideal service implementation, the Flickr service would provide a mechanism by with to pass in wild cards as part of its query parameters. -============== Usage Examples ============== diff --git a/dojox/data/FlickrStore.rst b/dojox/data/FlickrStore.rst index 0ff8ca7f3..bbf896eda 100644 --- a/dojox/data/FlickrStore.rst +++ b/dojox/data/FlickrStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/FlickrStore: +====================== dojox.data.FlickrStore ====================== @@ -14,7 +15,6 @@ FlickrStore is one such store. The purpose of FlickrStore is to wrapper the publ The Flickr service provides its data back in a wide variety of formats (for example, ATOM, RSS, and JSON) but FlickrStore only makes use of the JSON format. The following example shows a query that FlickrStore processes and the response: -============================= Brief intro to the Flickr API ============================= @@ -62,7 +62,6 @@ Response ] }) -=========== FlickrStore =========== @@ -128,7 +127,6 @@ The fetch method query syntax for FlickrStore is simple and straightforward. It **Note:** Unlike all the other example stores, the FlickrStore store cannot do wild-card matching of the attributes. This is because the Flickr public photo feed service cannot do it. In an ideal service implementation, the Flickr service would provide a mechanism by with to pass in wild cards as part of its query parameters. Also, the Flickr public feed API limits the number of returned photos to a maximum of twenty. -======== Examples ======== diff --git a/dojox/data/GoogleBlogSearchStore.rst b/dojox/data/GoogleBlogSearchStore.rst index acbd98bd5..d7a069010 100644 --- a/dojox/data/GoogleBlogSearchStore.rst +++ b/dojox/data/GoogleBlogSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleBlogSearchStore: +================================ dojox.data.GoogleBlogSearchStore ================================ @@ -13,13 +14,11 @@ dojox.data.GoogleBlogSearchStore dojox.data.GoogleBlogSearchStore is a data store that uses Google APIs to search the blogosphere. -============ Introduction ============ dojox.data.GoogleBlogSearchStore is a read only data store that uses Google to search blog posts. It implements the 'dojo.data.api.Read API '_, which you should refer to for general usage. -===== Usage ===== @@ -79,7 +78,6 @@ The pattern of using the GoogleBlogSearchStore is -======== Examples ======== @@ -165,7 +163,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/GoogleBookSearchStore.rst b/dojox/data/GoogleBookSearchStore.rst index 2311dbc2d..137e7b2b6 100644 --- a/dojox/data/GoogleBookSearchStore.rst +++ b/dojox/data/GoogleBookSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleBookSearchStore: +================================ dojox.data.GoogleBookSearchStore ================================ @@ -13,13 +14,11 @@ dojox.data.GoogleBookSearchStore dojox.data.GoogleBookSearchStore is a data store that uses Google APIs to search for books. -============ Introduction ============ dojox.data.GoogleBookSearchStore is a read only data store that can be used to search Google. It implements the 'dojo.data.api.Read API '_, which you should refer to for general usage. -===== Usage ===== @@ -77,7 +76,6 @@ The pattern of using the GoogleBookSearchStore is -======== Examples ======== @@ -166,7 +164,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/GoogleFeedStore.rst b/dojox/data/GoogleFeedStore.rst index 72a2facca..5f121531a 100644 --- a/dojox/data/GoogleFeedStore.rst +++ b/dojox/data/GoogleFeedStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleFeedStore: +========================== dojox.data.GoogleFeedStore ========================== @@ -17,13 +18,11 @@ The GoogleFeedStore is a store designed to work against Google's feed reading AJ **Note:** These stores make use of Google's `AJAX search and feed services. `_ In order to use them in your web-sites, please make sure to read `Google's terms and conditions `_ and agree to them before using these stores. -=========== API Support =========== * :ref:`dojo.data.api.Read ` -================== Constructor Params ================== @@ -40,7 +39,6 @@ The following parameters are supported by the GoogleFeedStore implementation. |lang |The language locale to use. Defaults to the browser locale. | string | +-------------+------------------------------------------------------------------------------------------+----------------------+ -=============== Item Attributes =============== @@ -63,7 +61,6 @@ The following attributes are available on items returned from the GoogleFeedStor |categories |An array of string tags for the entry | +-----------------+-----------------------------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ @@ -77,7 +74,6 @@ Query Example "url" : "http://news.google.com/nwshp?hl=en&tab=wn&output=atom" } -============= Example Usage ============= diff --git a/dojox/data/GoogleImageSearchStore.rst b/dojox/data/GoogleImageSearchStore.rst index 236f6657c..9c4c43a83 100644 --- a/dojox/data/GoogleImageSearchStore.rst +++ b/dojox/data/GoogleImageSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleImageSearchStore: +================================= dojox.data.GoogleImageSearchStore ================================= @@ -13,13 +14,11 @@ dojox.data.GoogleImageSearchStore dojox.data.GoogleImageSearchStore is a data store that can be used to search Google. -============ Introduction ============ dojox.data.GoogleImageSearchStore is a read only data store uses Google APIs to find images. It implements the 'dojo.data.api.Read API '_, which you should refer to for general usage. -===== Usage ===== @@ -81,7 +80,6 @@ The pattern of using the GoogleImageSearchStore is -======== Examples ======== @@ -163,7 +161,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/GoogleLocalSearchStore.rst b/dojox/data/GoogleLocalSearchStore.rst index 350eb9aa4..f9a7f2380 100644 --- a/dojox/data/GoogleLocalSearchStore.rst +++ b/dojox/data/GoogleLocalSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleLocalSearchStore: +================================= dojox.data.GoogleLocalSearchStore ================================= @@ -13,13 +14,11 @@ dojox.data.GoogleLocalSearchStore dojox.data.GoogleLocalSearchStore is a data store that can be used to search Google. -============ Introduction ============ dojox.data.GoogleLocalSearchStore is a read only data store that can be used to search Google. It implements the 'dojo.data.api.Read API '_, which you should refer to for general usage. -===== Usage ===== @@ -93,7 +92,6 @@ The pattern of using the GoogleLocalSearchStore is -======== Examples ======== @@ -185,7 +183,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/GoogleNewsSearchStore.rst b/dojox/data/GoogleNewsSearchStore.rst index 1afba274a..70a23a464 100644 --- a/dojox/data/GoogleNewsSearchStore.rst +++ b/dojox/data/GoogleNewsSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleNewsSearchStore: +================================ dojox.data.GoogleNewsSearchStore ================================ @@ -13,13 +14,11 @@ dojox.data.GoogleNewsSearchStore dojox.data.GoogleNewsSearchStore is a data store that uses Google APIs to search news sources. -============ Introduction ============ dojox.data.GoogleNewsSearchStore is a read only data store that can be used to search Google. It implements the 'dojo.data.api.Read API '_, which you should refer to for general usage. -===== Usage ===== @@ -78,7 +77,6 @@ The pattern of using the GoogleNewsSearchStore is -======== Examples ======== @@ -157,7 +155,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/GoogleSearchStore.rst b/dojox/data/GoogleSearchStore.rst index d3fd3a882..5d9893c70 100644 --- a/dojox/data/GoogleSearchStore.rst +++ b/dojox/data/GoogleSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleSearchStore: +============================ dojox.data.GoogleSearchStore ============================ @@ -24,13 +25,11 @@ The GoogleSearchStore is actually a collection of stores designed to work with G **Note:** These stores make use of Google's `AJAX search services. `_. In order to use them in your web-sites, please make sure to read `Google's terms and conditions `_ and agree to them before using these stores. -=========== API Support =========== * :ref:`dojo.data.api.Read ` -================== Constructor Params ================== @@ -50,7 +49,6 @@ The following parameters are supported by all Google store implementations. | |**New to Dojo 1.4** | | +---------------+------------------------------------------------------------------------------------------+----------------------+ -=============== Item Attributes =============== @@ -281,7 +279,6 @@ dojox.data.GoogleImageSearchStore |contentNoFormatting|A snippet of information about the image, in plain text. | +-------------------+---------------------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ @@ -310,7 +307,6 @@ New to Dojo 1.4, the GoogleLocalSearchStore allows for a few extra options when } -============= Example Usage ============= diff --git a/dojox/data/GoogleVideoSearchStore.rst b/dojox/data/GoogleVideoSearchStore.rst index e9876620d..a33b46d29 100644 --- a/dojox/data/GoogleVideoSearchStore.rst +++ b/dojox/data/GoogleVideoSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleVideoSearchStore: +================================= dojox.data.GoogleVideoSearchStore ================================= @@ -13,13 +14,11 @@ dojox.data.GoogleVideoSearchStore dojox.data.GoogleVideoSearchStore is a data store that can be used to search YouTube and Google Video. -============ Introduction ============ dojox.data.GoogleVideoSearchStore is a read only data store that can be used to search YouTube and Google Video. It implements the 'dojo.data.api.Read API '_, which you should refer to for general usage. -===== Usage ===== @@ -79,7 +78,6 @@ The pattern of using the GoogleSearchStore is -======== Examples ======== @@ -159,7 +157,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/GoogleWebSearchStore.rst b/dojox/data/GoogleWebSearchStore.rst index 2e7e7d35a..89f2da56f 100644 --- a/dojox/data/GoogleWebSearchStore.rst +++ b/dojox/data/GoogleWebSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/GoogleWebSearchStore: +=============================== dojox.data.GoogleWebSearchStore =============================== @@ -13,7 +14,6 @@ dojox.data.GoogleWebSearchStore dojox.data.GoogleSearchStore is a data store that can be used to search Google. -============ Introduction ============ @@ -22,7 +22,6 @@ dojox.data.GoogleSearchStore is a read only data store that can be used to searc GoogleSearchStore has a number of child classes, each of which implement different search types, e.g. Web, Books, Images etc. The default search type is Web search, which returns the same results you would get when using google.com. This means that dojox.data.GoogleSearchStore is functionally equivalent to it's child class dojox.data.GoogleWebSearchStore. -===== Usage ===== @@ -80,7 +79,6 @@ The pattern of using the GoogleSearchStore is -======== Examples ======== @@ -159,7 +157,6 @@ Programmatic example -======== See also ======== diff --git a/dojox/data/HtmlStore.rst b/dojox/data/HtmlStore.rst index 1f4eb2bb2..32b7f4689 100644 --- a/dojox/data/HtmlStore.rst +++ b/dojox/data/HtmlStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/HtmlStore: +========================= dojox.data.HtmlStore ========================= @@ -15,7 +16,6 @@ dojox.data.HtmlStore HtmlStore is an improved version of the older :ref:`dojox.data.HtmlTableStore `. It is a simple read-only store provided by Dojo and contained in the DojoX project. HtmlTableStore is a read interface to work with HTML tables, Lists, and collections of DIV and SPAN tags with a generally set format. HTML tables, lists and DIV collections are common ways for Web data to be displayed. In Ajax applications they also remain extremely useful as an alternate representation of data that is displayed in a charting, dynamic grid, or gauge widget. This store was created so that widgets, that can use dojo.data data stores, can read their input from existing HTML structures (data islands) in the current page or in a remote page URL. -=========== API Support =========== @@ -23,7 +23,6 @@ API Support * :ref:`dojo.data.api.Identity ` -================== Example data input ================== @@ -124,7 +123,6 @@ DIV Collection **Note:** The
entries are the items. Each has a single attribute 'name' which corresponds to the text content of the
. -================== Constructor params ================== @@ -152,7 +150,6 @@ The constructor for HtmlTableStore takes the following possible parameters in it +--------------+------------------------------------------------------------------------------------------+----------------------+ -=============== Item Attributes =============== @@ -168,14 +165,12 @@ List: In a list, the list items have one value, the text content. Use the attribute Use the attribute 'name' to acquire it. -============ Query Syntax ============ The query syntax is identical to :ref:`dojo.data.ItemFileReadStore `. Please refer to it for the format of the queries. -======== Examples ======== diff --git a/dojox/data/HtmlTableStore.rst b/dojox/data/HtmlTableStore.rst index 6e7f5202a..08ba751eb 100644 --- a/dojox/data/HtmlTableStore.rst +++ b/dojox/data/HtmlTableStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/HtmlTableStore: +========================= dojox.data.HtmlTableStore ========================= @@ -66,7 +67,6 @@ The following example shows an HTML table that this store can read: **Note:** The table rows in the tag are the items. The tag is used for defining the attribute name for each column in the table row for an item. -================== Constructor params ================== @@ -82,19 +82,16 @@ The constructor for HtmlTableStore takes the following possible parameters in it | |required. | | +-------------+------------------------------------------------------------------------------------------+----------------------+ -=============== Item Attributes =============== The item attributes are defined by the tag of the referenced table. Each column name becomes the attribute name for that column when generating the data store view of the data. -============ Query Syntax ============ The query syntax is identical to :ref:`dojo.data.ItemFileReadStore `. Please refer to it for the format of the queries. -======== Examples ======== diff --git a/dojox/data/JsonRestStore.rst b/dojox/data/JsonRestStore.rst index 6d0eec4b8..e3d2b3efa 100644 --- a/dojox/data/JsonRestStore.rst +++ b/dojox/data/JsonRestStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/JsonRestStore: +======================== dojox.data.JsonRestStore ======================== @@ -13,7 +14,6 @@ dojox.data.JsonRestStore **dojox.data.JsonRestStore** is a lightweight datastore implementation of an HTTP-based (RFC 2616) client with RESTful data interaction capabilities. -============ Introduction ============ @@ -26,7 +26,6 @@ JsonRestStore caches objects that have been retrieved from the server locally in JsonRestStore also store objects in a format to ease direct property access for significant performance advantages. -======== Features ======== @@ -52,7 +51,6 @@ Features 8. Works directly with all current data bound widgets in dijit, including :ref:`dijit.Tree `, :ref:`dijit.form.ComboButton `, and as well :ref:`dojox.grid `. -===== Usage ===== @@ -90,7 +88,6 @@ syncMode Setting this to true will set the store to using synchronous calls by default. Sync calls return their data immediately from the calling function, so callbacks are unnecessary. -======== Examples ======== @@ -101,7 +98,6 @@ Examples store = new dojox.data.JsonRestStore({service:myService, syncMode: true}); -==================== JsonRestStore + Grid ==================== @@ -122,7 +118,6 @@ The Dojo Grid is designed to work with the Dojo Data API, so the JsonRestStore c Now we have grid that connected to our store and when you edit data in the grid the changes are automatically sent back to the store. -========================== Implementing a REST Server ========================== @@ -141,7 +136,6 @@ The server can also assign or change properties of the object (such an id or def Note that in PHP, sometimes setting the Location will erroneously trigger a 302 status code which will cause JsonRestStore to fail. Per RFC 2616, the correct response to a POST that creates a new resource is to return a 201 status code with the Location header. In PHP, you must set the status code as well as the Location header if you want to avoid a 302 response. -====== Paging ====== @@ -154,7 +148,6 @@ On your server, you should look at the Range header in the request to know which Content-Range: items 0-24/66 -============ Transactions ============ @@ -163,7 +156,6 @@ JsonRestStore provides transaction state information so that servers can impleme JsonRestStore also features a shared repository of transactional data between all JsonRestStore instances. Therefore, if you save a change, all the JsonRestStore data store’s unsaved data will be committed. This means that you don’t have to track which data stores have modified data, and it also means that you transactions can involve modifications across multiple data stores and corresponding server tables. -======== See also ======== diff --git a/dojox/data/KeyValueStore.rst b/dojox/data/KeyValueStore.rst index a3251bccb..8d21cb8f7 100644 --- a/dojox/data/KeyValueStore.rst +++ b/dojox/data/KeyValueStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/KeyValueStore: +======================== dojox.data.KeyValueStore ======================== @@ -12,7 +13,6 @@ dojox.data.KeyValueStore This is a dojo.data store implementation. The KeyValueStore is a store that takes content in a format similar to those used by property files, such as Java, and many other languages were there are unique keys mapping to some value for display. Think of it as an interface for reading property style files in dojo through the dojo.data interface. -============ Input Format ============ @@ -41,7 +41,6 @@ Such a construct can be formed from a JS object of the form { k1:v1, k2:v2, ... } -====================== Constructor Parameters ====================== @@ -60,7 +59,6 @@ The constructor for the store can take three different parameters as a way to lo | |false. **New to Dojo 1.4** | | +---------------+------------------------------------------------------------------------------+------------------------------+ -=============== Item Attributes =============== @@ -77,7 +75,6 @@ Items from the KeyValueStore have two well-defined attribute names 'key' and 'va |getValue(item, "key") |The named key of the key/value pair. | | +------------------------+------------------------------------------------------------------------------+------------------------------+ -======== Examples ======== diff --git a/dojox/data/OpenSearchStore.rst b/dojox/data/OpenSearchStore.rst index be8cd9b08..8939f8e8d 100644 --- a/dojox/data/OpenSearchStore.rst +++ b/dojox/data/OpenSearchStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/OpenSearchStore: +========================== dojox.data.OpenSearchStore ========================== @@ -13,7 +14,6 @@ dojox.data.OpenSearchStore A store implementing the dojo.data.Read API for talking to OpenSearch based search providing services. For specific information on the concepts of dojo.data and its APIs please refer to the :ref:`API documentation `. -============ Introduction ============ @@ -27,14 +27,12 @@ Supported OpenSearch Return Formats * RSS * XML -=========== Limitations =========== * This store uses dojo.xhrGet and other xhr functions to fetch the OpenSearch descriptor and make search queries. Therefore, the OpenSearchStore is limited by the browser 'same domain' policy for xhr requests. Therefore, to make OpenSearch calls to providers that reside on servers other than the one that provided the HTML file that instantiated the OpenSearchStore, a proxy must be used. * The OpenSearchStore does not currently support HTML return formats. The reason for this is an open issue with dojo.query and searching by ID. The bug the OpenSearchStore is blocked on can be found `here `_. -============== Supported APIs ============== @@ -42,7 +40,6 @@ The following dojo.data APIs are implemented by OpenSearchStore: * :ref:`dojo.data.api.Read ` -====================== Constructor Parameters ====================== @@ -67,7 +64,6 @@ An OpenSearch search result is a simplistic data item. It contains very few att | content | The content/text returned for the search result | string | +---------------+------------------------------------------------------------------------------------------------------+----------------------+ -============ Query Syntax ============ @@ -79,7 +75,6 @@ The fetch method query syntax for OpenSearchStore is limited to what the OpenSea openSearchStore.fetch(fetchArgs); -======== Examples ======== diff --git a/dojox/data/OpmlStore.rst b/dojox/data/OpmlStore.rst index f25afe5a4..96105825f 100644 --- a/dojox/data/OpmlStore.rst +++ b/dojox/data/OpmlStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/OpmlStore: +==================== dojox.data.OpmlStore ==================== @@ -76,7 +77,6 @@ The following example shows an Opml data source: Each data item is one of the tags. Each attribute on the outline acts as a attribute of the data item. For children tags, they are accessed via a special 'children' attribute. So, as expected by dojo.data, everything can be easily accessed via csvStore.getValue's'(), which makes it pluggable into dojo.data aware widgets. -================== Constructor Params ================== @@ -96,13 +96,11 @@ Constructor Params |urlPreventCache | No |Flag denoting whether or not browser caching should be avoided. Defaults to false. | 1.4 | +----------------+--------------+------------------------------------------------------------------------------------------------+-----------+ -============ Query Syntax ============ The query syntax used by dojox.data.OpmlStore is identical to the query syntax used by :ref:`dojo.data.ItemFileReadStore ` -============= Query Options ============= @@ -117,7 +115,6 @@ Dojo.data defines support for a 'queryOptions' modifier object that affects the | deep |Default is *false*. By default, only root outline tags are matched. By setting to true, children tags are also scanned | +------------+------------------------------------------------------------------------------------------------------------------------+ -======== Examples ======== diff --git a/dojox/data/PersevereStore.rst b/dojox/data/PersevereStore.rst index d8aab7336..94e1e1d0b 100644 --- a/dojox/data/PersevereStore.rst +++ b/dojox/data/PersevereStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/PersevereStore: +========================= dojox.data.PersevereStore ========================= @@ -15,13 +16,11 @@ dojox.data.PersevereStore **dojox.data.PersevereStore** is a subclass of `JsonRestStore ` for connecting to a Persevere server. -============ Introduction ============ PersevereStore essentially has the same functionality as JsonRestStore, but has some extra adaptations for automatic creation of stores based on Persevere's introspective table/class querying. -===== Usage ===== @@ -38,7 +37,6 @@ You can create a set of stores for all available Persevere classes/tables: This will return a object where each property name is the name of the store, and each value is the actual store for interacting with the Persevere database. -======== See also ======== diff --git a/dojox/data/PicasaStore.rst b/dojox/data/PicasaStore.rst index 94cb573b4..67063210f 100644 --- a/dojox/data/PicasaStore.rst +++ b/dojox/data/PicasaStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/PicasaStore: +====================== dojox.data.PicasaStore ====================== @@ -14,7 +15,6 @@ PicasaStore is one such store. The purpose of PicasaStore is to wrapper the publ The Picasa service provides its data back in a wide variety of formats (for example, ATOM, RSS, and JSON) but PicasaStore only makes use of the JSON format. The following example shows a query that PicasaStore processes and the response: -============================= Brief intro to the Picasa API ============================= @@ -663,7 +663,6 @@ Response } ); -=========== PicasaStore =========== @@ -729,7 +728,6 @@ The fetch method query syntax for PicasaStore is simple and straightforward. It **Note:** Unlike all the other example stores, the PicasaStore store cannot do wild-card matching of the attributes. This is because the Picasa public photo feed service cannot do it. In an ideal service implementation, the Picasa service would provide a mechanism by with to pass in wild cards as part of its query parameters. Also, the Picasa public feed API limits the number of returned photos to a maximum of 500. The datastore limits this to a default of 20. This can be changed by altering the maxResults attribute of the store to your desired value. Please note that maxResults does not affect count, which is how many out of the entire (maxResults), set to return. -======== Examples ======== diff --git a/dojox/data/QueryReadStore.rst b/dojox/data/QueryReadStore.rst index c46f418d0..d2f96e057 100644 --- a/dojox/data/QueryReadStore.rst +++ b/dojox/data/QueryReadStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/QueryReadStore: +========================== dojox.data.QueryReadStore ========================== @@ -14,7 +15,6 @@ dojox.data.QueryReadStore QueryReadStore is very similar to :ref:`ItemFileReadStore `. They both use JSON as their exchange format. The difference is in the way they query data. ItemFileReadStore makes one fetch from the server, and handles all sorting and filtering in the client. That's fine for hundreds of records, even thousands. But for hundreds of thousands of records or slow Internet connections, that's less feasible. -============== Supported APIs ============== @@ -24,7 +24,6 @@ The following dojo.data APIs are implemented by QueryReadStore * :ref:`dojo.data.api.Identity ` - -============ How it works ============ @@ -69,7 +68,6 @@ Fortunately, it's easy to translate between the two and you can quickly customiz We can place this file into a folder "custom" at the same level as the dojo, dijit and dojox directories of the distribution. (See Creating Your Own Modules for a discussion and alternatives. -========================== Server Side implementation ========================== @@ -78,14 +76,12 @@ The server side is where all the heavy work of QueryReadStore occurs. Specifical Your implementation could be similar to the sample php, or it could translate your queries to run against a database via SQL. That decision is entirely up to you. Another good example store to help understand how to develop server backed datastores is :ref:`dojox.data/FileStore ` -============================= Example Client Implementation ============================= For a fully functional example extension of QueryReadStore, please follow this :ref:`link ` -=================== Functional Examples =================== diff --git a/dojox/data/QueryReadStore/example.rst b/dojox/data/QueryReadStore/example.rst index 63879804d..188fb1a33 100644 --- a/dojox/data/QueryReadStore/example.rst +++ b/dojox/data/QueryReadStore/example.rst @@ -1,5 +1,6 @@ .. _dojox/data/QueryReadStore/example: +========================= dojox.data.QueryReadStore ========================= diff --git a/dojox/data/RailsStore.rst b/dojox/data/RailsStore.rst index 22495db37..39c225211 100644 --- a/dojox/data/RailsStore.rst +++ b/dojox/data/RailsStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/RailsStore: +===================== dojox.data.RailsStore ===================== @@ -14,25 +15,21 @@ dojox.data.RailsStore RailsStore extends the JsonRestStore to interact properly with Ruby on Rail's REST interface. -============ Introduction ============ RailsStore provides the same functionality as the JsonRestStore except that it formats the request URLs to Rail's specifications, post-pending URLs with .json extension to indicate that JSON format is being requested. It will also translate Dojo Data sort attributes to query parameters for Rail's will_paginate module. -===== Usage ===== See dojox/data/JsonRestStore for usage from Dojo. For setting up the REST interaction from Ruby on Rail's see Ruby code that is available here: http://github.com/ttilley/railsstore/tree/master. -======== Examples ======== See dojox/data/JsonRestStore for examples of Dojo usage. The attached Ruby code should contain examples on how to setup Rails. -======== See also ======== diff --git a/dojox/data/S3Store.rst b/dojox/data/S3Store.rst index 5480e94f8..1054c9d81 100644 --- a/dojox/data/S3Store.rst +++ b/dojox/data/S3Store.rst @@ -1,5 +1,6 @@ .. _dojox/data/S3Store: +=========================== dojox.data.S3Store =========================== @@ -15,13 +16,11 @@ dojox.data.S3Store **dojox.data.S3Store** is a subclass of `JsonRestStore ` for connecting to Amazon S3 service . -============ Introduction ============ S3Store essentially has the same functionality as JsonRestStore, but has some extra adaptations for Amazon S3's idiosyncrasies. -===== Usage ===== diff --git a/dojox/data/ServiceStore.rst b/dojox/data/ServiceStore.rst index 5e95457bf..1a38d3776 100644 --- a/dojox/data/ServiceStore.rst +++ b/dojox/data/ServiceStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/ServiceStore: +======================= dojox.data.ServiceStore ======================= @@ -15,14 +16,12 @@ dojox.data.ServiceStore ServiceStore is an adapter for web services to implement the Dojo Data API, providing simple Dojo Data access for web services. -============ Introduction ============ dojox.rpc.Service provides a comprehensive mechanism for connecting to web services, and can be auto-configured based on `Service Mapping Descriptions (SMDs) `_, and these services can be used directly with the ServiceStore for use with Dojo Data store consumer. `This page `_ provides directions for creating a ServiceStore from a web service. `This page `__ describes features of ServiceStore and it's subclass JsonRestStore. -===== Usage ===== diff --git a/dojox/data/WikipediaStore.rst b/dojox/data/WikipediaStore.rst index f11d0cb73..883628625 100644 --- a/dojox/data/WikipediaStore.rst +++ b/dojox/data/WikipediaStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/WikipediaStore: +========================= dojox.data.WikipediaStore ========================= @@ -12,7 +13,6 @@ dojox.data.WikipediaStore The Wikipedia store is a datastore that extends :ref:`dojox.data.ServiceStore `. Its purpose is to expose the Wikipedia search service SMD in a datastore format. This store is fairly simplistic in what it allows searching on, such as full title, or searching title and body text for certain keywords. It doesn't provide facilities for doing wildcard searching, unfortunately, which does not make it terribly useful for widgets such as dijit.form.ComboBox. -============== Supported APIs ============== @@ -21,7 +21,6 @@ The following dojo.data APIs are implemented by XmlStore * :ref:`dojo.data.api.Read ` -=============== Item Attributes =============== @@ -31,7 +30,6 @@ All items returned from a Wikipedia search provide the following attributes you | title |The title of the article identified that matched the search criteria | +---------------+-----------------------------------------------------------------------------------------------------------------------------+ -============ Query Syntax ============ @@ -73,7 +71,6 @@ Search article text (paged) }, -======== Examples ======== diff --git a/dojox/data/XmlStore-examples.rst b/dojox/data/XmlStore-examples.rst index a112fe37b..42fd92f98 100644 --- a/dojox/data/XmlStore-examples.rst +++ b/dojox/data/XmlStore-examples.rst @@ -1,5 +1,6 @@ .. _dojox/data/XmlStore-examples: +============================= dojox.data.XmlStore examples ============================= diff --git a/dojox/data/XmlStore.rst b/dojox/data/XmlStore.rst index 33097bb2a..412226b6e 100644 --- a/dojox/data/XmlStore.rst +++ b/dojox/data/XmlStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/XmlStore: +=================== dojox.data.XmlStore =================== @@ -14,7 +15,6 @@ dojox.data.XmlStore XmlStore is a store provided by Dojo that is contained in the DojoX project. XmlStore is a read and write interface to basic XML data. XML is a common data interchange format and a store that can work with fairly generic XML documents is useful. The store is designed so that you can over-ride certain functions to get specific behaviors to occur when performing reads and saves. -============== Supported APIs ============== @@ -27,7 +27,6 @@ The following dojo.data APIs are implemented by XmlStore * **New for dojo 1.3!** Identity API has been implemented. The store wil return xpath for an item, or it will return the value of a key attribute you specified. Specifying keyAttribute is not needed for client-side query and filtering case, but it is required for server-side query handling and update. -================= Example XML Input ================= @@ -70,7 +69,6 @@ The store is designed so that it can read generic XML and present back nodes as ... -====================== Constructor Parameters ====================== @@ -108,7 +106,6 @@ The constructor for XmlStore takes the following possible parameters in its keyw | **(since dojo 1.4)** |caching values loaded from a webserver. The default is true for backwards compatibility | +--------------------------+--------------------------------------------------------------------------------------------------------+ -================================= User-provided function over-rides ================================= @@ -121,7 +118,6 @@ _getPutUrl(item) _getDeleteUrl(item) Function that can be over-ridden to alter the way the store sends a DELETE item to the service. Note that this follows the REST convention in which an HTTP DELETE is used to remove a resource. -============ Query Syntax ============ @@ -148,7 +144,6 @@ To find all items with attribute foo the value of which ends with ar and ignorin **NOTE:** Other stores should follow the same query definition semantics for consistency. -============= Query Options ============= @@ -166,7 +161,6 @@ Dojo.data defines support for a 'queryOptions' modifier object that affects the | |root items and *all* child data items. Think of it as a recursive search. | +------------+------------------------------------------------------------------------------------------------------------------------+ -============== Usage Examples ============== @@ -203,7 +197,6 @@ Query for all books that start with ISBN: A9B57 Case insensitively var request = store.fetch({query: {isbn:"a9b57*"}, queryOptions: {ignoreCase: true}, onComplete: gotBooks}); -========================= Functional Usage Examples ========================= @@ -362,7 +355,6 @@ Connecting XmlStore to dojox.grid.DataGrid -============= More examples ============= diff --git a/dojox/data/dom.rst b/dojox/data/dom.rst index f569449a8..c94a8504c 100644 --- a/dojox/data/dom.rst +++ b/dojox/data/dom.rst @@ -1,5 +1,6 @@ .. _dojox/data/dom: +=============== dojox.data.dom =============== @@ -13,14 +14,12 @@ dojox.data.dom A set of DOM manipulation functions. -============ Introduction ============ When working with DOM objects, these additional functions can come in extremely handy. Their relationship to each other is loose and they are basically a catch-all for functions not found elsewhere. -===== Usage ===== diff --git a/dojox/data/google-stores.rst b/dojox/data/google-stores.rst index 90d9cbb12..f52c56f07 100644 --- a/dojox/data/google-stores.rst +++ b/dojox/data/google-stores.rst @@ -1,11 +1,11 @@ .. _dojox/data/google-stores: +====================================== dojox.data Google-based Service Stores ====================================== `fixme`: shaneosullivan, overview of stores and caveats. examples. All dojox.data.Google*SearchStore stubs land here. -======== See Also ======== diff --git a/dojox/data/jsonPathStore.rst b/dojox/data/jsonPathStore.rst index b1895dbce..16ada59d0 100644 --- a/dojox/data/jsonPathStore.rst +++ b/dojox/data/jsonPathStore.rst @@ -1,5 +1,6 @@ .. _dojox/data/jsonPathStore: +======================== dojox.data.jsonPathStore ======================== @@ -16,14 +17,12 @@ Note: This API was removed for the Dojo 1.4 release. http://svn.dojotoolkit.org/ A local (in memory) store which can attach a dojo.data interface to each JavaScript object and uses jsonPath as the query language. It takes an arbitrary JavaScript object as its data structure and attaches to this data structure to present a dojo.data.api interface. Each JavaScript object in the store is an Item in dojo.data parlance. -============ Introduction ============ JsonPathStore is intended to allow any Object data structure to easily be accessed and controlled by various widgets. It uses :ref:`JsonPath ` as a query language. It is a very lightweight server, yet it is flexible enough to allow you to define a single store maintaining several unrelated data sets in a single store. Furthermore, it implements a synchronous mode which makes manipulation of the store possible when appropriate for an application. -============== Supported APIs ============== @@ -57,7 +56,6 @@ Two additional notification events are also triggered in this store, onSave() an events have completed. -===== Usage ===== @@ -114,7 +112,6 @@ mode: dojox.data.ASYNC_MODE || dojox.data.SYNC_MODE Sync calls return their data immediately from the calling function instead of calling the callback functions. Functions such as fetchItemByIdentity() and fetch() both accept a string parameter in addition to the normal keywordArgs parameter. When passed this option, SYNC_MODE will automatically be used even when the default mode of the system is ASYNC_MODE. A normal request to fetch or fetchItemByIdentity (with kwArgs object) can also include a mode property to override this setting for that one request. -======== Examples ======== diff --git a/dojox/date.rst b/dojox/date.rst index a0cd3657b..345659389 100644 --- a/dojox/date.rst +++ b/dojox/date.rst @@ -1,5 +1,6 @@ .. _dojox/date: +========== dojox.date ========== @@ -14,14 +15,12 @@ dojox.date TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/date/hebrew.rst b/dojox/date/hebrew.rst index 7d278bc4c..d487db16f 100644 --- a/dojox/date/hebrew.rst +++ b/dojox/date/hebrew.rst @@ -1,5 +1,6 @@ .. _dojox/date/hebrew: +================= dojox.date.hebrew ================= @@ -14,13 +15,11 @@ dojox.date.hebrew Implements the traditional Hebrew calendar. This is the civil calendar in Israel and the liturgical calendar of the Jewish faith worldwide. -============ Introduction ============ The Hebrew calendar is lunisolar and thus has a number of interesting properties that distinguish it from the Gregorian. Months start on the day of (an arithmetic approximation of) each new moon. Since the solar year (approximately 365.24 days) is not an even multiple of the lunar month (approximately 29.53 days) an extra "leap month" is inserted in 7 out of every 19 years. To make matters even more interesting, the start of a year can be delayed by up to three days in order to prevent certain holidays from falling on the Sabbath and to prevent certain illegal year lengths. Finally, the lengths of certain months can vary depending on the number of days in the year. -===== Usage ===== @@ -61,7 +60,6 @@ The Hebrew calendar implemented in this package can be used in conjunction with .. image:: hebrew.png -======== Examples ======== @@ -109,7 +107,6 @@ Code snippet below illustrates usage of Hebrew calendar in the context of graphi -======== See also ======== diff --git a/dojox/date/islamic.rst b/dojox/date/islamic.rst index 52928e36e..9ec7089f7 100644 --- a/dojox/date/islamic.rst +++ b/dojox/date/islamic.rst @@ -1,5 +1,6 @@ .. _dojox/date/islamic: +================== dojox.date.islamic ================== @@ -13,13 +14,11 @@ dojox.date.islamic Implements the traditional Islamic (Hijri) calendar. This is the civil calendar in Saudi Arabia and the liturgical calendar of the Islamic faith worldwide. -============ Introduction ============ The Islamic calendar (Hijri calendar) is a purely lunar calendar. It contains 12 months that are based on the motion of the moon, and because 12 synodic months is only 12 x 29.53=354.36 days, the Islamic calendar is consistently shorter than a tropical year, and therefore it shifts with respect to the Gregorian calendar. The calendar is based on the Qur'an (Sura IX, 36-37) and its proper observance is a sacred duty for Muslims. -===== Usage ===== @@ -58,7 +57,6 @@ Islamic calendar implemented in this package can be used in conjunction with Dat .. image:: dijit.jpg -======== Examples ======== @@ -105,7 +103,6 @@ Code snippet below illustrates usage of Islamic calendar in the context of graph -======== See also ======== diff --git a/dojox/date/relative.rst b/dojox/date/relative.rst index 629ef56b7..cc2b94a60 100644 --- a/dojox/date/relative.rst +++ b/dojox/date/relative.rst @@ -1,5 +1,6 @@ .. _dojox/date/relative: +=================== dojox.date.relative =================== diff --git a/dojox/drawing.rst b/dojox/drawing.rst index 12486f13d..b473b73a5 100644 --- a/dojox/drawing.rst +++ b/dojox/drawing.rst @@ -1,5 +1,6 @@ .. _dojox/drawing: +============= dojox.Drawing ============= diff --git a/dojox/dtl.rst b/dojox/dtl.rst index 8dd6c774a..3d459e977 100644 --- a/dojox/dtl.rst +++ b/dojox/dtl.rst @@ -1,5 +1,6 @@ .. _dojox/dtl: +========= dojox.dtl ========= @@ -15,7 +16,6 @@ once and rendered indefinitely afterward. Templates consist of simple tags and filters. -======== Overview ======== @@ -53,7 +53,6 @@ allows for new DOM-centric capabilities.
-============= Markup Syntax ============= @@ -62,7 +61,6 @@ Since Dojo implements markup just as it is in Django's implementation, the best But in case you are just itching to know what it looks like, it's made up of some simple parts: ``{% tags %}``, ``{{ variables }}``, ``{{ variables|filtered }}`` and ``{{ variables|more:"advanced"|filtering }}``. Sometimes tags have groupings of tags, sometimes they work alone. -===================== Template Constructors ===================== @@ -75,7 +73,6 @@ We have 2 base constructors when using DTL outside of a widget: ``dojox.dtl.Temp Both of these constructors can take either plain text or a URL. -============================== Using the Template Constructor ============================== @@ -131,7 +128,6 @@ To use, make sure you require the ``dojox.dtl.ext-dojo.NodeList`` module, which -================ Writing a Widget ================ @@ -163,7 +159,6 @@ The template will be rendered using the widget object as its context. If you don -==================================== Differences with the ``extends`` tag ==================================== @@ -192,7 +187,6 @@ The significantly better way is partly outlined in the section above on ``dojo.m }); -======================================= Differences with the ``Context`` Object ======================================= diff --git a/dojox/editor.rst b/dojox/editor.rst index d4095a3cc..504563be3 100644 --- a/dojox/editor.rst +++ b/dojox/editor.rst @@ -1,5 +1,6 @@ .. _dojox/editor: +============ dojox.editor ============ @@ -13,13 +14,11 @@ dojox.editor The dojox.editor component is a holding place for additional features for the dijit.Editor that are useful, but not extremely commonplace. -============ Introduction ============ The dojox.editor component is a holding place for additional features for the dijit.Editor that are useful, but not extremely commonplace. -======== See also ======== diff --git a/dojox/editor/plugins.rst b/dojox/editor/plugins.rst index 5f2f4b848..bb2626c69 100644 --- a/dojox/editor/plugins.rst +++ b/dojox/editor/plugins.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins: +==================== dojox.editor.plugins ==================== @@ -11,7 +12,6 @@ dojox.editor.plugins The dojox.editor.plugins is a component is a holding place for additional features for the dijit.Editor that load via the dijit.Editor plugin infrastructure. Some of the plugins are very stable while others may be considered less so. Please refer to the dojox/editor/README for project status -============ Introduction ============ @@ -164,7 +164,6 @@ There are currently a small set of nice features that can be plugged into the di A plugin that extends the PasteFromWord plugin and adds basic content filtering and script tag removal to the dijit.Editor. It opens a dialog where content from Word or similar programs can be pasted in, then filters are run against the input to remove extraneous HTML that causes the editor difficulty or may be security threats, leaving the injected content cleaner HTML. It also supports a user specified list of tags that can should be stripped from the content before injecting it into the editor body. -======== See Also ======== diff --git a/dojox/editor/plugins/AutoSave.rst b/dojox/editor/plugins/AutoSave.rst index a0473653f..49d41bddb 100644 --- a/dojox/editor/plugins/AutoSave.rst +++ b/dojox/editor/plugins/AutoSave.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/AutoSave: +==================================================== dojox.editor.plugins.AutoSave (Under Construction) ==================================================== @@ -12,7 +13,6 @@ dojox.editor.plugins.AutoSave (Under Construction) Have you ever wanted to save your editing content at intervals so that you won't lose it by accident? This plugin is for you. -======== Features ======== @@ -21,7 +21,6 @@ Once required in and enabled, this plugin provides the following features to dij * Save the content immediately with one click. * Set the save interval and save the content at intervals. -===== Usage ===== @@ -63,8 +62,7 @@ And that's it. The editor instance you can reference by 'dijit.byId("editor")' i Configurable Options -------------------- -======================== ================= ============ ======================= ============================================================================= -Argument Name Data Type Optional Default Value Description +======================== ================= ============ ======================= Argument Name Data Type Optional Default Value Description ======================== ================= ============ ======================= ============================================================================= name String False autosave The name of this plugin. It should always be "autosave". url String False The service url which the content of the editor is submitted to. @@ -83,7 +81,6 @@ AutoSave uses POST method to pass the current content to the server-side piece. print(htmlentities($HTTP_RAW_POST_DATA)); -============== User Interface ============== @@ -123,19 +120,16 @@ After the text being saved automatically, a tooltip dialog will be displayed to .. image :: IntervalSaved.png -=================== A11Y Considerations =================== All fields within the Auto-Save dialog can be accessed with the keyboard. -=========== Limitations =========== None. -======== Examples ======== @@ -188,7 +182,6 @@ Basic Usage
-======== See Also ======== diff --git a/dojox/editor/plugins/AutoUrlLink.rst b/dojox/editor/plugins/AutoUrlLink.rst index 956a33d4b..8fddfb253 100644 --- a/dojox/editor/plugins/AutoUrlLink.rst +++ b/dojox/editor/plugins/AutoUrlLink.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/AutoUrlLink: +===================================================== dojox.editor.plugins.AutoUrlLink (Under Construction) ===================================================== @@ -12,13 +13,11 @@ dojox.editor.plugins.AutoUrlLink (Under Construction) Have you ever wanted to turn the URL you entered in the document into a hyperlink automatically? This plug-in is for you. -======== Features ======== Once required in and enabled, this plugin can turn a URL like string (such as http, https and ftp) into a hyperlink. -===== Usage ===== @@ -52,7 +51,6 @@ Then just declare the plugin and configure it as follows. And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the AutoUrlLink plugin! -============== User Interface ============== @@ -64,13 +62,11 @@ AutoUrlLink plugin is a plugin for dijit.Editor, which provides the users with t .. image :: AutoUrlLink.png -=========== Limitations =========== None. -======== Examples ======== @@ -123,7 +119,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/Blockquote.rst b/dojox/editor/plugins/Blockquote.rst index 330b7f1ab..34aef8f3b 100644 --- a/dojox/editor/plugins/Blockquote.rst +++ b/dojox/editor/plugins/Blockquote.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/Blockquote: +=============================== dojox.editor.plugins.Blockquote =============================== @@ -12,7 +13,6 @@ dojox.editor.plugins.Blockquote Have you ever wanted to set apart a section of text in your document as a 'quotation' of something someone else has said? Have you ever wanted to remove quotation indication from a section of text in your document? If so, then this plugin is for you! -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * Handles blockquoting a section from current cursor position as well as blockquoting the selected section of the document as best it can determine. * Updates its blockquote status based on whether or not the cursor is positioned inside a blockquoted section of the document. -===== Usage ===== @@ -54,7 +53,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the Blockqupte plugin! You can use the button to toggle the quotation mode of the text underneath the cursor in the document, or across a selection of text in the document. -======== Examples ======== @@ -108,7 +106,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/Breadcrumb.rst b/dojox/editor/plugins/Breadcrumb.rst index a63d7e303..99a4e1471 100644 --- a/dojox/editor/plugins/Breadcrumb.rst +++ b/dojox/editor/plugins/Breadcrumb.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/Breadcrumb: +=============================== dojox.editor.plugins.Breadcrumb =============================== @@ -12,7 +13,6 @@ dojox.editor.plugins.Breadcrumb Have you ever wanted to know how node you were in while editing some rich text? Have you ever wanted to be sure the entire element was deleted, not just its content? If so, then this plugin is for you. -======== Features ======== @@ -22,14 +22,12 @@ Once required in and enabled, this plugin provides the following features to dij * Clicking the node name in the footer selects the contents of that node. * Each node button provides a dropdown for other operations, such as deleting the entire element, or moving the cursor to the start or end of the contents of that element. -=========== Limitations =========== * This plugin does not work well with the :ref:`full screen ` plugin. In Full screen mode the footer toolbar is out of view. This will be fixed in a later version of dojo. It requires minor updated to Editor as well as the full screen and view source plugins. -===== Usage ===== @@ -61,7 +59,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the Breadcrumb plugin! You can click around in the editor and see the breadcrumb update. You can also click the buttons in the breadcrumb bar to select contents or activate the dropdown action menu. -======== Examples ======== @@ -113,7 +110,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/CollapsibleToolbar.rst b/dojox/editor/plugins/CollapsibleToolbar.rst index 81f006053..fc9e95055 100644 --- a/dojox/editor/plugins/CollapsibleToolbar.rst +++ b/dojox/editor/plugins/CollapsibleToolbar.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/CollapsibleToolbar: +======================================= dojox.editor.plugins.CollapsibleToolbar ======================================= @@ -12,7 +13,6 @@ dojox.editor.plugins.CollapsibleToolbar Have you ever wanted to collapse the editor toolbar out of the way? This is desirable in cases where the editor occupies a small section of a page and the toolbar has wrapped, limiting the editing area. If this is a situation your users encounter, then this plugin is for you. -======== Features ======== @@ -23,14 +23,12 @@ Once required in and enabled, this plugin provides the following features to dij * The button works perfectly in high-contrast mode, * Styles for Tundra, Nihilo, and soria themes. -=========== Limitations =========== * This plugin should be instantiated as the first plugin in the plugins list to ensure that it adapts the toolbar before other plugins modify it (such as FindReplace does). -===== Usage ===== @@ -62,7 +60,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the CollapsibleToolbar plugin! You can click the collapse icon to collapse the toolbar, and the expand icon to bring it back -======== Examples ======== @@ -114,7 +111,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/ColorTableCell.rst b/dojox/editor/plugins/ColorTableCell.rst index 399ce8a13..cd9604ad4 100644 --- a/dojox/editor/plugins/ColorTableCell.rst +++ b/dojox/editor/plugins/ColorTableCell.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/ColorTableCell: +======================================================== dojox.editor.plugins.ColorTableCell (Under Construction) ======================================================== @@ -12,13 +13,11 @@ dojox.editor.plugins.ColorTableCell (Under Construction) Have you ever wanted to pick a color for the background of the table cells in the document? This plug-in is for you. -======== Features ======== Once required in and enabled, this plugin provides the user with the ability to set the background color of the table cells. -===== Usage ===== @@ -57,7 +56,6 @@ Then just declare the plugin and configure it as follows. And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the ColorTableCell plugin! -============== User Interface ============== @@ -80,19 +78,16 @@ Click **Set** button to set the color or click **Cancel** button to cancel the s .. image :: Result.png -=================== A11Y Considerations =================== All fields within the setting dialog can be accessed with the keyboard. -=========== Limitations =========== In IE, we have to press and drag the mouse to select the cell (just like what we do to select a piece of text), which is quite different from that of the other browsers. -======== Examples ======== @@ -145,7 +140,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/FindReplace.rst b/dojox/editor/plugins/FindReplace.rst index d1e65a6c8..5f1d93984 100644 --- a/dojox/editor/plugins/FindReplace.rst +++ b/dojox/editor/plugins/FindReplace.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/FindReplace: +================================ dojox.editor.plugins.FindReplace ================================ @@ -12,7 +13,6 @@ dojox.editor.plugins.FindReplace Have you ever wanted to know how node you were in while editing some rich text? Have you ever wanted to be sure the entire element was deleted, not just its content? If so, then this plugin is for you. -======== Features ======== @@ -21,13 +21,11 @@ Once required in and enabled, this plugin provides the following features to dij * The ability to find text with modifiers of matching case and searching backwards from current position. * The ability to replace text, with a modifier to replace all occurrences in the document past the current position. -=========== Limitations =========== * This plugin does not work in Opera. -===== Usage ===== @@ -59,7 +57,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the FindReplace plugin! To display the find/replace toolbar, click the find/replace toggle button in the main toolbar. The find/replace toolbar will then appear beneath the main toolbar. -============== User Interface ============== @@ -106,13 +103,11 @@ Enter the text to be replaced in **Find** text field and enter the replacement t .. image :: ReplaceAll.png -=================== A11Y Considerations =================== All fields within the **FindReplace** toolbar can be accessed with the keyboard. -======== Examples ======== @@ -165,7 +160,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/InsertAnchor.rst b/dojox/editor/plugins/InsertAnchor.rst index 334948127..167e659d0 100644 --- a/dojox/editor/plugins/InsertAnchor.rst +++ b/dojox/editor/plugins/InsertAnchor.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/InsertAnchor: +================================= dojox.editor.plugins.InsertAnchor ================================= @@ -12,7 +13,6 @@ dojox.editor.plugins.InsertAnchor Have you ever wanted to insert a named location in your document (anchor), that people can link to using urls and hashes? If so, then this plugin is for you! -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * CSS styling in the edit view that indicates where anchors are The styles do not appear outside of the editor. -===== Usage ===== @@ -54,7 +53,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the InsertAnchor plugin! You can use the button insert and edit anchors in your page. -======== Examples ======== @@ -108,7 +106,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/InsertEntity.rst b/dojox/editor/plugins/InsertEntity.rst index 3627c2fb2..28ee90b4b 100644 --- a/dojox/editor/plugins/InsertEntity.rst +++ b/dojox/editor/plugins/InsertEntity.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/InsertEntity: +================================= dojox.editor.plugins.InsertEntity ================================= @@ -12,7 +13,6 @@ dojox.editor.plugins.InsertEntity Have you ever wanted to easily insert the copyright symbol, the trademark symbol, or any of a variety of mathematical symbols into the document you're editing in the dijit.Editor? If so, then this plugin is for you! This plugin provides a subset of entity characters that can be inserted into your documents. The symbols provided are primarily the non-ascii 8859 characters and a large set of greek symbols used in mathematics. -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * Keyboard hotkey: CTRL-SHIFT-S for inserting a symbol at the current location in the editor. (Note that this is a similar keybind to those used by commercial word processors, so it will hopefully be familiar and easy to pick up.). * A key-navigable grid of symbols to select the one to insert. -===== Usage ===== @@ -54,7 +53,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the InsertEntity plugin! You can use the button or hotkey to insert entity characters as you desire. -=========== Limitations =========== @@ -66,7 +64,6 @@ Something to be aware of is that if you also use the :ref:`dojox.editor.plugins. The above configures prettyprint to escape all the same entities that the InsertEntity plugin can insert. -======== Examples ======== @@ -122,7 +119,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/LocalImage.rst b/dojox/editor/plugins/LocalImage.rst index b543230a1..e0da46263 100644 --- a/dojox/editor/plugins/LocalImage.rst +++ b/dojox/editor/plugins/LocalImage.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/LocalImage: +==================================================== dojox.editor.plugins.LocalImage (Under Construction) ==================================================== @@ -12,7 +13,6 @@ dojox.editor.plugins.LocalImage (Under Construction) Have you ever wanted to insert not only online images but also images on your computer? This plug-in is for you. -======== Features ======== @@ -23,7 +23,6 @@ Once required in and enabled, this plugin provides the following features to dij * Edit the image when it is selected. -===== Usage ===== @@ -70,8 +69,7 @@ And that's it. The editor instance you can reference by 'dijit.byId("editor")' i Configurable Options -------------------- -======================== ================= ============ ======================= =================================================================================== -Argument Name Data Type Optional Default Value Description +======================== ================= ============ ======================= Argument Name Data Type Optional Default Value Description ======================== ================= ============ ======================= =================================================================================== name String False localimage The name of this plugin. It should always be "localimage". uploadable Boolean True False Indicate if the plugin supports insert an image from the local file. @@ -136,7 +134,6 @@ All the information should be wrapper within a -======== See Also ======== diff --git a/dojox/editor/plugins/NormalizeStyle.rst b/dojox/editor/plugins/NormalizeStyle.rst index 9ce9e8f85..83518a0d4 100644 --- a/dojox/editor/plugins/NormalizeStyle.rst +++ b/dojox/editor/plugins/NormalizeStyle.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/NormalizeStyle: +=================================== dojox.editor.plugins.NormalizeStyle =================================== @@ -14,7 +15,6 @@ Have you ever encountered a situation where the editor was inconsistent about ho This plugin is 'headless', meaning it adds no toolbar button nor does it require any work to get decent output from it. All you do is load it and register it as an extraPlugin for your editor and you're good to go. Calls to get the value of the editor (editor.getValue() or editor.attr("value")) will return HTML that has hopefully been processed and 'standardized'. -======== Features ======== @@ -24,7 +24,6 @@ This plugin cleans up the output from dijit.Editor in the following ways: * Uses 'internal editor format' when putting content in, meaning it coverts to CSS or semantic, based on which the native RTE code works best with. * Very useful when paired with :ref:`dojox.editor.plugins.PrettyPrint `. -===== Usage ===== @@ -70,7 +69,6 @@ How do I configure the options? Glad you asked. You do it where you declare th -======== Examples ======== @@ -181,7 +179,6 @@ Configured css mode -======== See Also ======== diff --git a/dojox/editor/plugins/PageBreak.rst b/dojox/editor/plugins/PageBreak.rst index 1b4535d86..72db15083 100644 --- a/dojox/editor/plugins/PageBreak.rst +++ b/dojox/editor/plugins/PageBreak.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/PageBreak: +============================== dojox.editor.plugins.PageBreak ============================== @@ -12,7 +13,6 @@ dojox.editor.plugins.PageBreak Have you ever wanted to pull your hair out when printing an HTML document because it would page break at bad locations? There is actually a little-known CSS style that allows **you** to set a point at which printing should page break the document, the 'page-break-after: always' style. This feature can be important when editing documents on the web, so it's very useful in some cases to be able to insert a page break on demand. This plugin provides such a function to the dijit.Editor. -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * Keyboard hotkey: CTRL-SHIFT-ENTER for inserting a page break at the current location in the editor. (Note that this is a similar keybind to those used by commercial word processors, so it will hopefully be familiar and easy to pick up.). * Dynamic styling in the page to make the document appear broken into two pages at that point. Also provides @media CSS so that the styling is not printed (via a print plugin), only that the document page breaks when encountered. -===== Usage ===== @@ -54,13 +53,11 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the PageBreak plugin! You can use the button or hotkey to insert page breaks as you desire. -=========== Limitations =========== The page break plugin only has one limitation coded into it, it will not allow page breaks to be inserted in block elements like
    and
      , because it tends to make the page view look a bit odd. -======== Examples ======== @@ -114,7 +111,6 @@ Basic Usage
-======== See Also ======== diff --git a/dojox/editor/plugins/PasteFromWord.rst b/dojox/editor/plugins/PasteFromWord.rst index d2026c01a..c35eb920a 100644 --- a/dojox/editor/plugins/PasteFromWord.rst +++ b/dojox/editor/plugins/PasteFromWord.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/PasteFromWord: +================================== dojox.editor.plugins.PasteFromWord ================================== @@ -14,7 +15,6 @@ Have you ever pasted in content from Microsoft Word or similar programs into the This plugin provides a new toolbar button that opens a dialog where you can paste in content from word processors like Word. Filters are then applied to the content to strip out a lot of the extraneous HTML, classes and other nonsense that make the pasted content poor to work with. The cleaned up content can then be pasted into the dijit.Editor much more safely -======== Features ======== @@ -24,7 +24,6 @@ This plugin provides the following * An input dialog for pasting content from Word Processors for processing before being injected into the dijit Editor. * It makes use of dojox.html.format to also try to clean up and normalize the HTML as much as possible. -===== Usage ===== @@ -75,7 +74,6 @@ How do I configure the options? Glad you asked. You do it where you declare th -======== Examples ======== @@ -132,7 +130,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/PrettyPrint.rst b/dojox/editor/plugins/PrettyPrint.rst index 18bba253d..0a16b4c3d 100644 --- a/dojox/editor/plugins/PrettyPrint.rst +++ b/dojox/editor/plugins/PrettyPrint.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/PrettyPrint: +================================ dojox.editor.plugins.PrettyPrint ================================ @@ -14,7 +15,6 @@ Have you ever wanted to pull your hair out because the content from dijit.Editor This plugin is 'headless', meaning it adds no toolbar button nor does it require any work to get decent output from it. All you do is load it and register it as an extraPlugin for your editor and you're good to go. Calls to get the value of the editor (editor.getValue() or editor.attr("value")) will return decently formatted HTML. -======== Features ======== @@ -28,7 +28,6 @@ This plugin cleans up the output from dijit.Editor in the following ways: * Configurable encoding entity characters in the TEXT elements of the document. * All done automatically, no toolbar buttons, no extra user actions required. -===== Usage ===== @@ -91,7 +90,6 @@ How do I configure the options? Glad you asked. You do it where you declare th -======== Examples ======== @@ -201,7 +199,6 @@ Configured indent and line length -======== See Also ======== diff --git a/dojox/editor/plugins/Preview.rst b/dojox/editor/plugins/Preview.rst index fbc1b2e45..8c739de68 100644 --- a/dojox/editor/plugins/Preview.rst +++ b/dojox/editor/plugins/Preview.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/Preview: +============================ dojox.editor.plugins.Preview ============================ @@ -12,7 +13,6 @@ dojox.editor.plugins.Preview Have you ever wanted to see how the contents of the editor would look outside the editor or styled with a different set of CSS styles. If so, then this plugin is for you! This plugin provides a 'preview' capability, a way to view the contents of the editor outside the editable frame and with different styles applied. -======== Features ======== @@ -21,7 +21,6 @@ Once required in and enabled, this plugin provides the following features to dij * Button with icon in toolbar for previewing the content outside of the editor framedocument. * The ability to define a set of CSS styles or stylesheets to apply to the content in the preview view. -===== Usage ===== @@ -53,14 +52,12 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the Preview plugin! -====================== Configuring CSS styles ====================== The CSS styling is configured in the plugin instantiation. It can take two optional parameters, *styles* and *stylesheets* to define a set of CSS styles and/or stylesheets to import into the preview when it is rendered. Please note that to use stylesheets, you *must* pass full urls to the stylesheets, such as **http://example.com/foo.css**, for it to be able to properly load them. -======== Examples ======== @@ -215,7 +212,6 @@ Applying stylesheets to preview content -======== See Also ======== diff --git a/dojox/editor/plugins/ResizeTableColumn.rst b/dojox/editor/plugins/ResizeTableColumn.rst index 9b637b96f..c3493b139 100644 --- a/dojox/editor/plugins/ResizeTableColumn.rst +++ b/dojox/editor/plugins/ResizeTableColumn.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/ResizeTableColumn: +=========================================================== dojox.editor.plugins.ResizeTableColumn (Under Construction) =========================================================== @@ -12,13 +13,11 @@ dojox.editor.plugins.ResizeTableColumn (Under Construction) Have you ever wanted to resize the width of the table column by dragging the edge of the table's column in the editor's document? This plug-in is for you. -======== Features ======== Once required in and enabled, this plugin provides the users with the ability to resize the width of the table column by dragging the edge of the column in the editor. -===== Usage ===== @@ -52,7 +51,6 @@ Then just declare the plugin and configure it as follows. And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the ResizeTableColumn plugin! -============== User Interface ============== @@ -65,13 +63,11 @@ ResizeTableColumn plugin is a plugin for dijit.Editor, which provides the users .. image :: ResizeTableColumn.png -=========== Limitations =========== None. -======== Examples ======== @@ -124,7 +120,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/SafePaste.rst b/dojox/editor/plugins/SafePaste.rst index 5bed803de..521224f86 100644 --- a/dojox/editor/plugins/SafePaste.rst +++ b/dojox/editor/plugins/SafePaste.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/SafePaste: +================================== dojox.editor.plugins.SafePaste ================================== @@ -14,7 +15,6 @@ Have you ever worried about users pasting in script tags or the like into editor This plugin extends the 'PasteFromWord' plugin. This one adds paste interception and halts native paste events. A dialog is presented where the user must paste the content. The content is processed and then injected into the main editor body. The dialog is required because browser security does not allow JavaScript to access clipboard contents directly, it has to be browser-native inserted into the dialog first. The dialog scripts out script tags, any user-requested tags, and removes all the app-specific stuff, such as classes, styles, and such from Microsoft Word. -======== Features ======== @@ -25,7 +25,6 @@ This plugin provides the following * It makes use of dojox.html.format to also try to clean up and normalize the HTML as much as possible. * If this plugin is used, the PasteFromWord plugin is not required. -===== Usage ===== @@ -79,7 +78,6 @@ How do I configure the options? Glad you asked. You do it where you declare th -======== Examples ======== @@ -135,7 +133,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/Save.rst b/dojox/editor/plugins/Save.rst index 0358268b0..6808f38f3 100644 --- a/dojox/editor/plugins/Save.rst +++ b/dojox/editor/plugins/Save.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/Save: +========================= dojox.editor.plugins.Save ========================= @@ -12,7 +13,6 @@ dojox.editor.plugins.Save Have you ever wanted a simple toolbar based 'Save' action for the editor that just posts the content back to some URL? If so, then this plugin is for you! This plugin provides a 'save' capability, a simple toolbar action for saving the editor contents by POSTing the content to a remote URL. -======== Features ======== @@ -21,7 +21,6 @@ Once required in and enabled, this plugin provides the following features to dij * Button with icon in toolbar for saving the content by POSTing it back to a designated URL. * Designed to be simple and easily extendable. -===== Usage ===== @@ -53,7 +52,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the basic Save plugin! When you click the save button, the content is sent via xhrPort to the url 'myRemoteSaveService'. -=========== Limitations =========== @@ -61,7 +59,6 @@ Limitations * When extending the plugin, you will need to assign a new custom name to it, such as 'mySave', because of how the plugin infrastructure of Editor loads the plugins. It uses a publish/subscribe mechanism and each plugin definition needs a unique name. -======== Examples ======== @@ -187,7 +184,6 @@ Customizing a save -======== See Also ======== diff --git a/dojox/editor/plugins/ShowBlockNodes.rst b/dojox/editor/plugins/ShowBlockNodes.rst index 366663bc1..53ec99c79 100644 --- a/dojox/editor/plugins/ShowBlockNodes.rst +++ b/dojox/editor/plugins/ShowBlockNodes.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/ShowBlockNodes: +=================================== dojox.editor.plugins.ShowBlockNodes =================================== @@ -12,7 +13,6 @@ dojox.editor.plugins.ShowBlockNodes Have you ever wanted to see what the HTML layout being generated by the editor was? Not the source view, but just a nice 'hint' to how the document is being structured in HTML in terms of its block node layout. If so, then this plugin is for you! -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * Keyboard hotkey: CTRL-SHIFT-F9 for toggling the ShowBlockNodes on and off. * Dynamic styling in the page to enable/disable the showing of the block nodes. It does not affect or alter any of the HTML within the actual editor body, making it safe to use. -===== Usage ===== @@ -54,7 +53,6 @@ You also need to include the CSS for it. For example: And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the ShowBlockNodes plugin! You can use the button or hotkey to toggle the mode as you desire.. -======== Examples ======== @@ -108,7 +106,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/SpellCheck.rst b/dojox/editor/plugins/SpellCheck.rst index 1bf0e1bc4..afc98bb94 100644 --- a/dojox/editor/plugins/SpellCheck.rst +++ b/dojox/editor/plugins/SpellCheck.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/SpellCheck: +==================================================== dojox.editor.plugins.SpellCheck (Under Construction) ==================================================== @@ -12,7 +13,6 @@ dojox.editor.plugins.SpellCheck (Under Construction) Have you ever wanted to make sure that your edited content was spelled correctly? You could always have a dictionary available but, otherwise, this plug-in is for you. -======== Features ======== @@ -29,7 +29,6 @@ Once required in and enabled, this plugin provides the following features to dij * Interactive spell check which provides the same features through a context menu on unrecognized words as they are typed. -===== Usage ===== @@ -75,8 +74,7 @@ And that's it. The editor instance you can reference by 'dijit.byId("editor")' i Configurable Options -------------------- -======================== ================= ============ ======================= ============================================================================= -Argument Name Data Type Optional Default Value Description +======================== ================= ============ ======================= Argument Name Data Type Optional Default Value Description ======================== ================= ============ ======================= ============================================================================= name String False SpellCheck The name of this plugin. It should always be "spellcheck". url String False The url of the speck check service. @@ -136,7 +134,6 @@ The callbackName gets from the "callback" parameter in the request. And you shou dojo.io.script.jsonp_dojoIoScript1._jsonpCallback({response:[{"text":"spellcheck","suggestion":[]},{"text":"porterstemmer","suggestion":[]},{"text":"i","suggestion":[]},{"text":"errir","suggestion":["terror"]},{"text":"thi","suggestion":["hit","the","thin","this","tie"]},{"text":"wrng","suggestion":["warn","wrong"]},{"text":"txt","suggestion":["tax"]}]}); -============== User Interface ============== @@ -296,19 +293,16 @@ If there is more than one parser, the first registered one wins. An example foll sp.parser = new dojox.editor.plugins._SpellCheckParser(); }); -=================== A11Y Considerations =================== All fields within the Batch Spell Check dialog can be accessed with the keyboard. -=========== Limitations =========== None. -======== Examples ======== @@ -361,7 +355,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/StatusBar.rst b/dojox/editor/plugins/StatusBar.rst index 79730e3c9..183812863 100644 --- a/dojox/editor/plugins/StatusBar.rst +++ b/dojox/editor/plugins/StatusBar.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/StatusBar: +============================== dojox.editor.plugins.StatusBar ============================== @@ -12,7 +13,6 @@ dojox.editor.plugins.StatusBar Have you ever wanted a status bar on the editor to display things like 'saving' and so on? Have you ever wanted a resize handle on the editor that lets you resize it? If so, then this plugin if for you. -======== Features ======== @@ -22,7 +22,6 @@ Once required in and enabled, this plugin provides the following features to dij * Resize handler that allows users to resize the editor. It can be disabled, when used inside a layout container that will handle resizing of the editor. -===== Usage ===== @@ -67,7 +66,6 @@ And that's it. The editor instance you can reference by 'dijit.byId("editor")' dojo.publish("someEditor_statusBar", ["Some message"]); -======== Examples ======== @@ -119,7 +117,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/editor/plugins/TablePlugins.rst b/dojox/editor/plugins/TablePlugins.rst index 1277ece28..716fc580b 100644 --- a/dojox/editor/plugins/TablePlugins.rst +++ b/dojox/editor/plugins/TablePlugins.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/TablePlugins: +================================= dojox.editor.plugins.TablePlugins ================================= @@ -19,7 +20,6 @@ A series of plugins that give the Editor the ability to create and edit HTML tab Any or all of the plugins may be used, although they tend to work together so it would usually be all of them with the exception of the Table Contextmenu which adds right-click functionality to a table and could be used alone with Insert Table. -======= Example ======= diff --git a/dojox/editor/plugins/TextColor.rst b/dojox/editor/plugins/TextColor.rst index 4d6216cd1..dc5803e94 100644 --- a/dojox/editor/plugins/TextColor.rst +++ b/dojox/editor/plugins/TextColor.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/TextColor: +============================== dojox.editor.plugins.TextColor ============================== @@ -14,7 +15,6 @@ dojox.editor.plugins.TextColor Have you wanted a better text color selection plugin that allows for colors that span the entire RGB color space instead of the selected colors provided by :ref:`the dijit TextColor Plugin ` If so, then this plugin is for you. The dijit._editor.plugins.TextColor plugin provides two action buttons on the editor toolbar that make use of the dojox.widget.ColorPicker instead of the dijit.ColorPalette for color selection. -======== Features ======== @@ -30,7 +30,6 @@ Once required in and enabled, this plugin provides the following features to dij hiliteColor - Enable the text background color plugin. -===== Usage ===== @@ -61,14 +60,12 @@ Once it has been required in, all you have to do is include it in the list of ex And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the dojox variant of the TextColor plugin! You can use the buttons to alter the colors of selected text. -=========== Limitations =========== * The dojox.widget.ColorPicker has some CSS issues when combined with certain themes on certain browsers. For example, claro theme on Google Chrome renders a bit off. * The plugin is **not** A11Y (accessibility) compliant since the dojox.widget.ColorPicker is not A11Y compliant. -======== Examples ======== @@ -225,7 +222,6 @@ Basic Usage: Both foreground and background color buttons together -======== See Also ======== diff --git a/dojox/editor/plugins/ToolbarLineBreak.rst b/dojox/editor/plugins/ToolbarLineBreak.rst index b5393ae56..ba7d9f7f5 100644 --- a/dojox/editor/plugins/ToolbarLineBreak.rst +++ b/dojox/editor/plugins/ToolbarLineBreak.rst @@ -1,5 +1,6 @@ .. _dojox/editor/plugins/ToolbarLineBreak: +===================================== dojox.editor.plugins.ToolbarLineBreak ===================================== @@ -12,14 +13,12 @@ dojox.editor.plugins.ToolbarLineBreak Have you ever wanted to force the editor toolbar to line break/wrap to a new line? I've often found myself with that wish, particularly when there are a lot of buttons/icons enabled in the toolbar. It provides a visual way to separate the toolbar into 'sections', much like how you can use the dijit.ToolbarSeparator to put a vertical separator bar into the editor toolbar. -======== Features ======== Once required in and enabled, this plugin provides the following features to dijit.Editor. * A plugin that can be declared multiple times in your 'plugins' or 'extraPlugins' options of Editor that lets you wrap the toolbar at the indicated points -===== Usage ===== @@ -42,20 +41,17 @@ Once it has been required in, all you have to do is include it in the list of ex And that's it. Every point in that definition where '||' is encountered, the plugin inserts a 'line break' into the toolbar between the indicated plugin buttons. Note you can also use it inside the 'plugins=""' definition of editor too. -=========== Limitations =========== The background images of the toolbar need to be able to handle line-wrapping toolbars for the effect to look reasonable. All the provided themes of dojo work reasonably well for a several line toolbar. -=================== AllY Considerations =================== From a key nav A11Y perspective, the toolbar line break plugin works just like the ToolbarSeparator, it doesn't impact the key nav. Left and right arrow keys will still move between the buttons fine. -======== Examples ======== @@ -105,7 +101,6 @@ Basic Usage -======== See Also ======== diff --git a/dojox/embed.rst b/dojox/embed.rst index 216e5c3b7..4891f03c9 100644 --- a/dojox/embed.rst +++ b/dojox/embed.rst @@ -1,5 +1,6 @@ .. _dojox/embed: +=========== dojox.embed =========== diff --git a/dojox/embed/Flash.rst b/dojox/embed/Flash.rst index 0133e35d4..964dea567 100644 --- a/dojox/embed/Flash.rst +++ b/dojox/embed/Flash.rst @@ -1,5 +1,6 @@ .. _dojox/embed/Flash: +================= dojox.embed.Flash ================= @@ -14,7 +15,6 @@ dojox.embed.Flash Base functionality to insert a flash movie into a document on the fly. -============ Introduction ============ @@ -78,7 +78,6 @@ However this is an old and not very user friendly method. By using codebase and This method uses two object tags. First object tag is for IE, second is for other browsers. -===== Usage ===== @@ -161,7 +160,6 @@ In constructor of dojox.embed.Flash there is params variable. For flash followin * wmode - ("transparent" | "opaque" | "window") -======== Examples ======== @@ -205,7 +203,6 @@ Declarative example -======== See also ======== diff --git a/dojox/embed/Object.rst b/dojox/embed/Object.rst index 5e085d839..8b8c49c8e 100644 --- a/dojox/embed/Object.rst +++ b/dojox/embed/Object.rst @@ -1,5 +1,6 @@ .. _dojox/embed/Object: +================== dojox.embed.Object ================== @@ -14,14 +15,12 @@ dojox.embed.Object TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/embed/Quicktime.rst b/dojox/embed/Quicktime.rst index b5d0f32f0..b85170a1f 100644 --- a/dojox/embed/Quicktime.rst +++ b/dojox/embed/Quicktime.rst @@ -1,5 +1,6 @@ .. _dojox/embed/Quicktime: +===================== dojox.embed.Quicktime ===================== @@ -14,14 +15,12 @@ dojox.embed.Quicktime TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/encoding.rst b/dojox/encoding.rst index 9236d51ee..e584b0943 100644 --- a/dojox/encoding.rst +++ b/dojox/encoding.rst @@ -1,5 +1,6 @@ .. _dojox/encoding: +============== dojox.encoding ============== diff --git a/dojox/encoding/ascii85.rst b/dojox/encoding/ascii85.rst index 5d34c1587..6390cdcc8 100644 --- a/dojox/encoding/ascii85.rst +++ b/dojox/encoding/ascii85.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/ascii85: +====================== dojox.encoding.ascii85 ====================== @@ -14,14 +15,12 @@ dojox.encoding.ascii85 TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/encoding/base64.rst b/dojox/encoding/base64.rst index 6031172fd..c60747e9e 100644 --- a/dojox/encoding/base64.rst +++ b/dojox/encoding/base64.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/base64: +===================== dojox.encoding.base64 ===================== diff --git a/dojox/encoding/bits.rst b/dojox/encoding/bits.rst index 211519fa5..95c6e83e7 100644 --- a/dojox/encoding/bits.rst +++ b/dojox/encoding/bits.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/bits: +=================== dojox.encoding.bits =================== @@ -14,14 +15,12 @@ dojox.encoding.bits TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/encoding/compression.rst b/dojox/encoding/compression.rst index bb457d245..242eb686a 100644 --- a/dojox/encoding/compression.rst +++ b/dojox/encoding/compression.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/compression: +========================== dojox.encoding.compression ========================== @@ -14,14 +15,12 @@ dojox.encoding.compression TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/encoding/crypto.rst b/dojox/encoding/crypto.rst index 8c17540ba..96a976b3a 100644 --- a/dojox/encoding/crypto.rst +++ b/dojox/encoding/crypto.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/crypto: +===================== dojox.encoding.crypto ===================== diff --git a/dojox/encoding/crypto/SimpleAES.rst b/dojox/encoding/crypto/SimpleAES.rst index 4c66f4002..8bb089cff 100644 --- a/dojox/encoding/crypto/SimpleAES.rst +++ b/dojox/encoding/crypto/SimpleAES.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/crypto/SimpleAES: +=============================== dojox.encoding.crypto.SimpleAES =============================== diff --git a/dojox/encoding/digests.rst b/dojox/encoding/digests.rst index 22eaf226d..219f5155c 100644 --- a/dojox/encoding/digests.rst +++ b/dojox/encoding/digests.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/digests: +====================== dojox.encoding.digests ====================== diff --git a/dojox/encoding/easy64.rst b/dojox/encoding/easy64.rst index 08505a560..1f76fec5d 100644 --- a/dojox/encoding/easy64.rst +++ b/dojox/encoding/easy64.rst @@ -1,5 +1,6 @@ .. _dojox/encoding/easy64: +===================== dojox.encoding.easy64 ===================== @@ -14,14 +15,12 @@ dojox.encoding.easy64 TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/flash.rst b/dojox/flash.rst index 037fc1dfb..e4b849bee 100644 --- a/dojox/flash.rst +++ b/dojox/flash.rst @@ -1,5 +1,6 @@ .. _dojox/flash: +=========== dojox.flash =========== @@ -14,14 +15,12 @@ dojox.flash TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -50,7 +48,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/form.rst b/dojox/form.rst index 207935f15..d97920468 100644 --- a/dojox/form.rst +++ b/dojox/form.rst @@ -1,12 +1,12 @@ .. _dojox/form: +================== dojox.form project ================== The dojox.form project provides additional form-related widgets beyond :ref:`dijit.form ` functionality. -================= Available Widgets ================= diff --git a/dojox/form/BusyButton.rst b/dojox/form/BusyButton.rst index 2f95ff573..319c4d8d6 100644 --- a/dojox/form/BusyButton.rst +++ b/dojox/form/BusyButton.rst @@ -1,5 +1,6 @@ .. _dojox/form/BusyButton: +===================== dojox.form.BusyButton ===================== @@ -13,14 +14,12 @@ dojox.form.BusyButton BusyButton is a simple widget which provides implementing more user friendly form submission. -============ Introduction ============ When a form gets submitted by a user, many time it is recommended to disable the submit buttons to prevent double submission. BusyButton provides a simple set of features for this purpose -======== Examples ======== @@ -161,7 +160,6 @@ The last example uses a little bit of trickery to create a button which is disab -============== Known Problems ============== diff --git a/dojox/form/CheckedMultiSelect.rst b/dojox/form/CheckedMultiSelect.rst index c3d2140ac..8e99c1fcb 100644 --- a/dojox/form/CheckedMultiSelect.rst +++ b/dojox/form/CheckedMultiSelect.rst @@ -1,5 +1,6 @@ .. _dojox/form/CheckedMultiSelect: +============================= dojox.form.CheckedMultiSelect ============================= @@ -13,21 +14,18 @@ dojox.form.CheckedMultiSelect A multi-select widget (similar to html select with multiple=true) that uses check boxes. -============ Introduction ============ This widget provides a more user-friendly mechanism for multi-selects (HTML select tags with multiple=true). -===== Usage ===== The CheckedMultiSelect is designed to replace existing HTML select elements with minimal effort. You can also create them programmatically. -======== Examples ======== diff --git a/dojox/form/DateTextBox.rst b/dojox/form/DateTextBox.rst index 32f506851..6261cd976 100644 --- a/dojox/form/DateTextBox.rst +++ b/dojox/form/DateTextBox.rst @@ -1,5 +1,6 @@ .. _dojox/form/DateTextBox: +====================== dojox.form.DateTextBox ====================== @@ -14,14 +15,12 @@ dojox.form.DateTextBox TODO: short summary of the component/class/method -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -49,7 +47,6 @@ Declarative example TODO: example -====================== Problems and Solutions ====================== @@ -66,7 +63,6 @@ The dojox.form.MonthTextBox only returns an integer value representing the selec The above DateTextBox will print e.g. "November 2011" in the text box (localised according to the current locale) and return as its 'value' attribute (dijit.byId('dtb2').get('value')) a Date object for the first day in the selected month. -======== See also ======== diff --git a/dojox/form/DropDownSelect.rst b/dojox/form/DropDownSelect.rst index 1c10066c3..09fd7a819 100644 --- a/dojox/form/DropDownSelect.rst +++ b/dojox/form/DropDownSelect.rst @@ -1,5 +1,6 @@ .. _dojox/form/DropDownSelect: +========================= dojox.form.DropDownSelect ========================= @@ -13,25 +14,21 @@ dojox.form.DropDownSelect A styleable drop down select box (similar to html select element) -============== Migration Note ============== As of version 1.4, dojox.form.DropDownSelect has been deprecated, as it has now been moved to :ref:`dijit.form.Select `. Please update your code! -============ Introduction ============ HTML Select tags are problematic when it comes to styling - they are not very styleable, not to mention nearly impossible to get a consistent cross-browser widget. This widget aims to resolve that issue. -===== Usage ===== The DropDownSelect is designed to replace existing HTML select elements with minimal effort. You can also create them programmatically. -======== Examples ======== diff --git a/dojox/form/DropDownStack.rst b/dojox/form/DropDownStack.rst index 4bc4942dc..ff89f0473 100644 --- a/dojox/form/DropDownStack.rst +++ b/dojox/form/DropDownStack.rst @@ -1,5 +1,6 @@ .. _dojox/form/DropDownStack: +======================== dojox.form.DropDownStack ======================== diff --git a/dojox/form/FileInput.rst b/dojox/form/FileInput.rst index cd4fd7c0f..6e8fd563e 100644 --- a/dojox/form/FileInput.rst +++ b/dojox/form/FileInput.rst @@ -1,5 +1,6 @@ .. _dojox/form/FileInput: +==================== dojox.form.FileInput ==================== @@ -13,7 +14,6 @@ The FileInput class provides a foundation for a series of FileInput widgets: Fil Unless you have a clinical aversion to Flash, it is recommended you use the newer :ref:`FileUploader ` and provided in the DojoX Form project. -============ Introduction ============ @@ -37,7 +37,6 @@ The three types are described as: * Auto - An extension on base FileInput which will submit the file after a period of time after selection, giving the user a moment to cancel if necessary. * Blind - An extension on FileInputAuto which removes the input functionality, and provides only a button to trigger the file selection dialog. -======== See also ======== diff --git a/dojox/form/FilePickerTextBox.rst b/dojox/form/FilePickerTextBox.rst index 3a6c45e9c..f02dea167 100644 --- a/dojox/form/FilePickerTextBox.rst +++ b/dojox/form/FilePickerTextBox.rst @@ -1,5 +1,6 @@ .. _dojox/form/FilePickerTextBox: +============================ dojox.form.FilePickerTextBox ============================ @@ -14,14 +15,12 @@ dojox.form.FilePickerTextBox A dijit._FormWidget that adds a dojox.widget.FilePicker to a text box as a dropdown -============ Introduction ============ The file picker text box allows for easy selecting of a file from the server - and makes it embeddable into a form -===== Usage ===== @@ -45,7 +44,6 @@ Additional attr value You can call widget.attr("pathValue") to get (or set) the value of the widget - using "string" format (ie. "/path/to/file.txt") instead of using the item. Items in the "constraints" parameter will be passed in to the file picker as creation parameters. -======== Examples ======== diff --git a/dojox/form/FileUploader.rst b/dojox/form/FileUploader.rst index 5fa660c56..ae095a0cf 100644 --- a/dojox/form/FileUploader.rst +++ b/dojox/form/FileUploader.rst @@ -1,5 +1,6 @@ .. _dojox/form/FileUploader: +======================= dojox.form.FileUploader ======================= @@ -12,7 +13,6 @@ dojox.form.FileUploader Handles multiple file uploading to a server. DEPRECATED: dojox.form.FileUploader is no longer supported and will be removed in 2.0. Suggested that you use :ref:`dojox.form.Uploader ` instead. -===== Usage ===== @@ -57,7 +57,6 @@ Dojo Version 1.6.0 dojox.form.FileUploader is now deprecated. Use :ref:`dojox.form.Uploader ` instead. -=============== IMPORTANT NOTES =============== @@ -79,7 +78,6 @@ Another limitation with using Flash is passing data back and forth. There is a p Currently the only workaround is to *don't do that*. -===================== Updating Your Release ===================== @@ -98,7 +96,6 @@ and optionally: Note that if you are moving these files into Dojo 1.2 or less, you will have to change some of the code in the FileUploader to not use the 1.3 html method dojo.destroy() and replace it with the previous version of dojo._destroyElement() -====================================== FileUploader Functionality 1.3.2 - 1.5 ====================================== @@ -299,7 +296,6 @@ Because of the complex nature of the FileUploader code (or more accurately, the **devMode**: Changing this parameter to true will set the opacity of the HTML upload button to 100% and remove transparency from the Flash upload button. This helps to determine of the button is being positioned correctly. -=========== Server Side =========== @@ -490,7 +486,6 @@ More references to this issue: - http://wiki.modxcms.com/index.php/What_is_mod_security_and_how_does_it_affect_me - http://www.modsecurity.org/documentation/modsecurity-apache/1.9.3/html-multipage/06-special_features.html -===== Demos ===== diff --git a/dojox/form/ListInput.rst b/dojox/form/ListInput.rst index 98fddb900..440e47d2e 100644 --- a/dojox/form/ListInput.rst +++ b/dojox/form/ListInput.rst @@ -1,5 +1,6 @@ .. _dojox/form/ListInput: +====================== dojox.form.ListInput ====================== @@ -15,7 +16,6 @@ dojox.form.ListInput The ListInput widget allow you to create a list of element. It's like the "to" field on hotmail. -============ Introduction ============ @@ -28,7 +28,6 @@ When page is submitted, you can choose to post all the data or just the valid it The left and right arrows are used to re-edit an entry. -======== Examples ======== @@ -87,6 +86,5 @@ Programmatic example @import "{{baseUrl}}dojox/form/resources/ListInput.css"; -============= Accessibility ============= diff --git a/dojox/form/Manager.rst b/dojox/form/Manager.rst index 1bc813537..c022e5ab7 100644 --- a/dojox/form/Manager.rst +++ b/dojox/form/Manager.rst @@ -1,5 +1,6 @@ .. _dojox/form/Manager: +================== dojox.form.Manager ================== @@ -11,7 +12,6 @@ dojox.form.Manager .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ This class is the widget implementing the :ref:`form manager `. -===== Usage ===== diff --git a/dojox/form/MultiComboBox.rst b/dojox/form/MultiComboBox.rst index 78d9125d2..55e0cd50d 100644 --- a/dojox/form/MultiComboBox.rst +++ b/dojox/form/MultiComboBox.rst @@ -1,5 +1,6 @@ .. _dojox/form/MultiComboBox: +======================== dojox.form.MultiComboBox ======================== @@ -9,13 +10,11 @@ dojox.form.MultiComboBox .. contents:: :depth: 2 -============ Introduction ============ This widget is an experimental extension to :ref:`ComboBox ` to allow "tag" style input using a datastore using a delimiter. -===== Usage ===== @@ -37,7 +36,6 @@ No additional CSS is required. A `delimiter` variable can be set to indicate which key triggers a new value. It defaults to "," (comma) but can be any character. -======== See also ======== diff --git a/dojox/form/PasswordValidator.rst b/dojox/form/PasswordValidator.rst index 6cb76e7f0..7f07f2ff2 100644 --- a/dojox/form/PasswordValidator.rst +++ b/dojox/form/PasswordValidator.rst @@ -1,5 +1,6 @@ .. _dojox/form/PasswordValidator: +============================ dojox.form.PasswordValidator ============================ @@ -14,14 +15,12 @@ dojox.form.PasswordValidator A dijit._FormWidget that simplifies the "Old/New/Validate" password mechanism found on many web pages. -============ Introduction ============ Many web page use a 3-input mechanism for changing/updating passwords, where the user enters in their old password, their new password, and then validates their new password. This widget is intended as a way to simplify that process - and provide the user with feedback along the way. -===== Usage ===== @@ -57,7 +56,6 @@ pwCheck Security The pwCheck function of this widget will be called to validate the old (current) password. Please do not put this check in the actual javascript code (or HTML page) - as this is horribly insecure. -======== Examples ======== diff --git a/dojox/form/RangeSlider.rst b/dojox/form/RangeSlider.rst index 2bdfefe1c..c0abef116 100644 --- a/dojox/form/RangeSlider.rst +++ b/dojox/form/RangeSlider.rst @@ -1,5 +1,6 @@ .. _dojox/form/RangeSlider: +====================== dojox.form.RangeSlider ====================== @@ -14,14 +15,12 @@ dojox.form.RangeSlider The RangeSlider is a descendant of :ref:`dijit.form.Slider ` that allows a selection of a range of values. -============ Introduction ============ The RangeSlider differs from the :ref:`dijit.form.Slider ` by providing two handles that allow you to select a range of values across the scale. There is the **dojox.form.HorizontalRangeSlider** and the **dojox.form.VerticalRangeSlider** which provide a horizontal and vertical version respectively. -===== Usage ===== @@ -37,8 +36,7 @@ The RangeSlider is used in the same fashion as most dijit Form Widgets. Here are some of the constructor parameters: -=================== ==================== ============================================================================= -Parameter Type Description +=================== ==================== Parameter Type Description =================== ==================== ============================================================================= value array Initial values of the slider (``[0,100]``) showButtons boolean Whether to show or not buttons at each end of the slider (``true``) @@ -48,7 +46,6 @@ intermediateChanges boolean If fractional parts between steps are discreteValues integer Number of "steps" in the slider. For example if ``discreteValues`` is ``3``, you'll have 3 steps: ``minimum``, ``maximum`` and a value in the middle =================== ==================== ============================================================================= -======== Examples ======== @@ -157,13 +154,11 @@ Declarative horizontal example **NOTE** In declarative mode, the value of the attribute ``value`` is specified as a comma delimited string and not as an array (e.g. ``value="2,6"`` and not ``value="[2,6]"``. -============= Accessibility ============= TODO: provide accessibility information -======== See also ======== diff --git a/dojox/form/Rating.rst b/dojox/form/Rating.rst index f8faf0e8b..d6f1c7207 100644 --- a/dojox/form/Rating.rst +++ b/dojox/form/Rating.rst @@ -1,5 +1,6 @@ .. _dojox/form/Rating: +=================== dojox.widget.Rating =================== @@ -14,7 +15,6 @@ dojox.widget.Rating This widget allows users to rate items. -===== Usage ===== @@ -23,7 +23,6 @@ By default it shows three stars. The star images are provided with dojox. This is a form widget, which means that you can simply embed it inside a dojo form, which submits the value automatically too. But it doesn't require to be inside a form. -======== Examples ======== diff --git a/dojox/form/TimeSpinner.rst b/dojox/form/TimeSpinner.rst index 998b54c4c..d500a1ea5 100644 --- a/dojox/form/TimeSpinner.rst +++ b/dojox/form/TimeSpinner.rst @@ -1,5 +1,6 @@ .. _dojox/form/TimeSpinner: +====================== dojox.form.TimeSpinner ====================== @@ -14,7 +15,6 @@ dojox.form.TimeSpinner This widget is the same as dijit.form.NumberSpinner, but for the time component of a date object instead. -============ Introduction ============ @@ -22,7 +22,6 @@ Introduction * Furthermore, when you hold down the buttons, the spinning accelerates to make coarser adjustments easier. -======== Examples ======== @@ -55,7 +54,6 @@ Declarative example -======== See also ======== diff --git a/dojox/form/Uploader.rst b/dojox/form/Uploader.rst index 7758bf5fc..9ac9f7f97 100644 --- a/dojox/form/Uploader.rst +++ b/dojox/form/Uploader.rst @@ -1,5 +1,6 @@ .. _dojox/form/Uploader: +======================= dojox.form.Uploader ======================= @@ -14,7 +15,6 @@ A widget that adds functionality to a standard HTML file input which allows file **The dojox.form.Uploader is an improvement upon, and replaces the dojox.form.FileUploader**. The multiple problems created by Flash are avoided because it is not used in Mozilla and Webkit browsers. Support for FileUploader will cease as of 1.6, but the code will remain until 2.0 for backwards compatibility. -======== Features ======== @@ -36,7 +36,6 @@ The Uploader mimics the functionality of HTML5 file inputs, so some features ava File mask (restricting the selection to certain file types) is in the HTML5 spec but missing from browser functionality. It is not supported. -===== Usage ===== @@ -68,7 +67,6 @@ The Flash plugin will use a SWF to upload in non-HTML5 browsers. All other brows These problems do not occur in IE. -===== Setup ===== @@ -149,7 +147,6 @@ When using a plugin, the following methods will be available: - **upload** This method uploads the files and any data passed as an argument. - **submit** This method uploads the files and if a form element is passed as an argument, it is converted into a JavaScript object. -=========== Server Side =========== @@ -242,7 +239,6 @@ For non-PHP devs, this translates into a JSON string, wrapped in a textarea, ret If you are having problems getting *onComplete* to fire, look at this code first. Often the problem is the server side code is not catching the field name for whatever reason (perhaps the client and server names don't match) and the code is falling to the end of the page and returning a textarea when it shouldn't. -======== Examples ======== diff --git a/dojox/form/ValidationTextarea.rst b/dojox/form/ValidationTextarea.rst index 4c2a93509..caea9388c 100644 --- a/dojox/form/ValidationTextarea.rst +++ b/dojox/form/ValidationTextarea.rst @@ -1,5 +1,6 @@ .. _dojox/form/ValidationTextarea: +============================= dojox.form.ValidationTextarea ============================= diff --git a/dojox/form/manager/_ClassMixin.rst b/dojox/form/manager/_ClassMixin.rst index d8ac03d6c..5d3b1c297 100644 --- a/dojox/form/manager/_ClassMixin.rst +++ b/dojox/form/manager/_ClassMixin.rst @@ -1,5 +1,6 @@ .. _dojox/form/manager/_ClassMixin: +============================== dojox.form.manager._ClassMixin ============================== @@ -11,7 +12,6 @@ dojox.form.manager._ClassMixin .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ This class is the component of the form manager. It should be used together with The mixin provides commonly used methods to add/remove a CSS class, or detect its presence. It operates only on form nodes and attached nodes (see :ref:`controlled elements ` for more classification details). -====================== Methods and properties ====================== @@ -95,7 +94,6 @@ Example: removeClass("redBg", {lastName: 1}). removeClass("blackBorder"); -==== Tips ==== diff --git a/dojox/form/manager/_DisplayMixin.rst b/dojox/form/manager/_DisplayMixin.rst index e942e6a19..d5b50e8d1 100644 --- a/dojox/form/manager/_DisplayMixin.rst +++ b/dojox/form/manager/_DisplayMixin.rst @@ -1,5 +1,6 @@ .. _dojox/form/manager/_DisplayMixin: +================================ dojox.form.manager._DisplayMixin ================================ @@ -11,7 +12,6 @@ dojox.form.manager._DisplayMixin .. contents:: :depth: 3 -============ Introduction ============ @@ -21,7 +21,6 @@ The mixin provides commonly used methods to show/hide attached nodes (see :ref:` This mixin is modeled after :ref:`\_EnableMixin `. -====================== Methods and properties ====================== @@ -149,7 +148,6 @@ There are three ways to use this method: fm.hide(); -===== Usage ===== diff --git a/dojox/form/manager/_EnableMixin.rst b/dojox/form/manager/_EnableMixin.rst index 1b9478c6e..752b3f9da 100644 --- a/dojox/form/manager/_EnableMixin.rst +++ b/dojox/form/manager/_EnableMixin.rst @@ -1,5 +1,6 @@ .. _dojox/form/manager/_EnableMixin: +=============================== dojox.form.manager._EnableMixin =============================== @@ -11,7 +12,6 @@ dojox.form.manager._EnableMixin .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ This class is the component of the form manager. It should be used together with The mixin provides commonly used methods to enable/disable form elements. It operates only on form widgets collected by :ref:`\_Mixin ` and form nodes collected by :ref:`\_NodeMixin ` (see :ref:`controlled elements ` for more details). -====================== Methods and properties ====================== @@ -147,7 +146,6 @@ There are three ways to use this method: fm.disable(); -===== Usage ===== diff --git a/dojox/form/manager/_FormMixin.rst b/dojox/form/manager/_FormMixin.rst index 5b13bdc34..7609ed385 100644 --- a/dojox/form/manager/_FormMixin.rst +++ b/dojox/form/manager/_FormMixin.rst @@ -1,5 +1,6 @@ .. _dojox/form/manager/_FormMixin: +============================= dojox.form.manager._FormMixin ============================= @@ -11,7 +12,6 @@ dojox.form.manager._FormMixin .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ This class is the component of the form manager. It should be used together with If the widget is based on ```` element, this mixin provides the enhanced functionality to reset and submit the form using the standard browser form submitting process. ``onreset`` and ``onsubmit`` events are processed automatically. -====================== Methods and properties ====================== @@ -131,7 +130,6 @@ startup This is the standard method of any widget. It is responsible for starting up the widget after it was created and the DOM was parsed. For more details, see :ref:`dijit._Widget `. -==== Tips ==== diff --git a/dojox/form/manager/_Mixin.rst b/dojox/form/manager/_Mixin.rst index fad0b2b2c..4f6f55d39 100644 --- a/dojox/form/manager/_Mixin.rst +++ b/dojox/form/manager/_Mixin.rst @@ -1,5 +1,6 @@ .. _dojox/form/manager/_Mixin: +========================= dojox.form.manager._Mixin ========================= @@ -11,7 +12,6 @@ dojox.form.manager._Mixin .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ This class is the main component of the form manager, which provides the initial On startup this mixin inspects its body and registers all found form widgets, and attached nodes (by ``data-dojo-attach-point``). Additionally it provides some low-level properties and methods to handle controlled elements. -====================== Methods and properties ====================== @@ -293,7 +292,6 @@ destroy This is the standard method of any widget. It is responsible for tearing up internal widget structures preparing the widget for the garbage collection. Usually it detaches event handlers, and kills references to DOM nodes. For more details, see :ref:`dijit._Widget `. -==================== Additional functions ==================== @@ -334,7 +332,6 @@ dojox.form.manager._keys This function takes an object and returns an array of all keys. It is very similar to :ref:`dojox.lang.functional.object.keys() `. It is defined there only to reduce the dependency on other packages. -=============== Technical notes =============== diff --git a/dojox/form/manager/_NodeMixin.rst b/dojox/form/manager/_NodeMixin.rst index 0ec1c59c5..3dbfd3f99 100644 --- a/dojox/form/manager/_NodeMixin.rst +++ b/dojox/form/manager/_NodeMixin.rst @@ -1,5 +1,6 @@ .. _dojox/form/manager/_NodeMixin: +============================= dojox.form.manager._NodeMixin ============================= @@ -11,7 +12,6 @@ dojox.form.manager._NodeMixin .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ This class defines low-level primitives for form nodes. It is complimentary to a On startup this mixin inspects its body and registers all found form nodes (````, `` -======== See Also ======== diff --git a/dojox/html/entities/encode.rst b/dojox/html/entities/encode.rst index b5e0769b6..941fa97f6 100644 --- a/dojox/html/entities/encode.rst +++ b/dojox/html/entities/encode.rst @@ -1,5 +1,6 @@ .. _dojox/html/entities/encode: +========================== dojox.html.entities.encode ========================== @@ -16,7 +17,6 @@ A flexible function for encoding defined UTF-8 characters into an entity encodin This function will use the entity encodings for HTML and LATIN-1 as default encodings when called. Users can over-ride the encoding map used by providing a new encoding map as the second parameter to the encode function. -======== Examples ======== @@ -95,7 +95,6 @@ Encoding custom entities in a text string -======== See Also ======== diff --git a/dojox/html/format.rst b/dojox/html/format.rst index bacaca41b..20959c2fe 100644 --- a/dojox/html/format.rst +++ b/dojox/html/format.rst @@ -1,5 +1,6 @@ .. _dojox/html/format: +================= dojox.html.format ================= @@ -16,13 +17,11 @@ Have you ever wanted to format some HTML that came out of a textarea? Or the di **dojox.html.format** package offers additional HTML helper functions for formatting HTML text. -======== Features ======== This package was created as a general purpose helper library for formatting HTML text markup. It currently contains one function, 'prettyPrint', which is intended to take a fragment of HTML text (usually the innerHTML of a document body) and format it so it is human readable. -=========== Usage Notes =========== @@ -36,7 +35,6 @@ Usage Notes * Internet Explorer does not always keep -========================================== Creating A Custom Calendar By Mixing Views ========================================== @@ -192,7 +189,6 @@ As the calendar consists of a combination of views, it is possible to mix these -======== See also ======== diff --git a/dojox/widget/ColorPicker.rst b/dojox/widget/ColorPicker.rst index 61c8ede70..402e2ddf9 100644 --- a/dojox/widget/ColorPicker.rst +++ b/dojox/widget/ColorPicker.rst @@ -1,5 +1,6 @@ .. _dojox/widget/ColorPicker: +======================== dojox.widget.ColorPicker ======================== @@ -13,13 +14,11 @@ dojox.widget.ColorPicker A Photoshop-like HSV ColorPicker widget. -============ Introduction ============ This ColorPicker adds many options to the standard :ref:`ColorPalette ` available in Dijit. -===== Usage ===== @@ -36,7 +35,6 @@ And Require the module: dojo.require("dojox.widget.ColorPicker"); -======== Examples ======== @@ -109,7 +107,6 @@ A ColorPicker within a DropDownButton -===== Notes ===== diff --git a/dojox/widget/Dialog.rst b/dojox/widget/Dialog.rst index c5b98ce79..e3a1f28a6 100644 --- a/dojox/widget/Dialog.rst +++ b/dojox/widget/Dialog.rst @@ -1,5 +1,6 @@ .. _dojox/widget/Dialog: +=================== dojox.widget.Dialog =================== @@ -11,13 +12,11 @@ dojox.widget.Dialog This is an extension to the :ref:`dojox.widget.DialogSimple ` providing additional sizing options, animations, and styling. -============ Introduction ============ This widget's usage is nearly identical to the Dijit Dialog. show() and hide() change the display state, attr("title", "new title") will manipulate the title (if visible), and so on. The difference comes in the creation parameters set. -===== Usage ===== @@ -34,7 +33,6 @@ And to require the module in: dojo.require("dojox.widget.Dialog"); -======== Examples ======== @@ -48,13 +46,11 @@ Resize an existing Dialog: dlg.layout(); //starts the resize -===== Notes ===== * An API change between 1.2 and 1.3 exists: the property ``fixedSized`` in 1.2 was renamed to ``sizeToViewport`` in 1.3 for clarity -======== See also ======== diff --git a/dojox/widget/DialogSimple.rst b/dojox/widget/DialogSimple.rst index 73926a8b8..9a531cd11 100644 --- a/dojox/widget/DialogSimple.rst +++ b/dojox/widget/DialogSimple.rst @@ -1,5 +1,6 @@ .. _dojox/widget/DialogSimple: +========================= dojox.widget.DialogSimple ========================= @@ -10,7 +11,6 @@ This is an incredibly simple widget providing a stock :ref:`dijit.Dialog ` -===== Usage ===== @@ -27,7 +27,6 @@ No additional CSS is required. Remember to load the stock themeName.css file. Is }, 2000); }); -======== See Also ======== diff --git a/dojox/widget/DynamicTooltip.rst b/dojox/widget/DynamicTooltip.rst index 231fdf401..95d95beb4 100644 --- a/dojox/widget/DynamicTooltip.rst +++ b/dojox/widget/DynamicTooltip.rst @@ -1,5 +1,6 @@ .. _dojox/widget/DynamicTooltip: +=========================== dojox.widget.DynamicTooltip =========================== @@ -13,14 +14,12 @@ dojox.widget.DynamicTooltip An **experimental** addition to standard :ref:`dijit.Tooltip ` functionality allowing remotely loaded content to appear. -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -34,7 +33,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -49,7 +47,6 @@ Declarative example TODO: example -======== See also ======== diff --git a/dojox/widget/FilePicker.rst b/dojox/widget/FilePicker.rst index 6055ceed1..3269a45c6 100644 --- a/dojox/widget/FilePicker.rst +++ b/dojox/widget/FilePicker.rst @@ -1,5 +1,6 @@ .. _dojox/widget/FilePicker: +======================== dojox.widget.FilePicker ======================== @@ -14,13 +15,11 @@ dojox.widget.FilePicker A specialized version of RollingList that handles file information -============ Introduction ============ The file picker extends the rolling list to add file-specific styling (folder/file icons), as well as the concept of file system hierarchy. -===== Usage ===== @@ -31,13 +30,11 @@ Creating a file picker is similar to creating a rolling list. In addition to th * ``New in 1.3`` **selectDirectories** whether or not you want to allow selecting of directories * ``New in 1.3`` **selectFiles** whether or not you want to allow selecting of files -===================== Additional attr value ===================== You can call widget.attr("pathValue") to get (or set) the value of the widget - using "string" format (ie. "/path/to/file.txt") instead of using the item -======== Examples ======== diff --git a/dojox/widget/FisheyeList.rst b/dojox/widget/FisheyeList.rst index 8ebd52970..92f854691 100644 --- a/dojox/widget/FisheyeList.rst +++ b/dojox/widget/FisheyeList.rst @@ -1,5 +1,6 @@ .. _dojox/widget/FisheyeList: +======================== dojox.widget.FisheyeList ======================== @@ -14,14 +15,12 @@ dojox.widget.FisheyeList A menu similar to the fish eye menu on the Mac OS. -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -35,7 +34,6 @@ TODO: how to use the component/class/method -======== Examples ======== @@ -55,7 +53,6 @@ Widget Demonstration http://demos.dojotoolkit.org/demos/fisheye/ -======== See also ======== diff --git a/dojox/widget/FisheyeLite.rst b/dojox/widget/FisheyeLite.rst index 544de89dc..2fa4de046 100644 --- a/dojox/widget/FisheyeLite.rst +++ b/dojox/widget/FisheyeLite.rst @@ -1,5 +1,6 @@ .. _dojox/widget/FisheyeLite: +======================== dojox.widget.FisheyeLite ======================== @@ -14,7 +15,6 @@ dojox.widget.FisheyeLite A lightweight Fisheye effect component which animates during mouse movement over the widget. -============ Introduction ============ @@ -24,7 +24,6 @@ This widget currently works by passing key/value pairs of css properties and rat In Dojo 1.3, passing an object as a named property allows better definition of the end values. The default behavior is still to multiply by ratio, but now one is able to specify a fixed end:, start: or unit: value to be passed directly to the animation. -===== Usage ===== @@ -45,7 +44,6 @@ New in Dojo 1.3, you can optionally specify an object (instead of a multiplier) new dojox.widget.FisheyeLite({ properties: { left: { end:100, unit:"px" } } }, "someNode"); -======== Examples ======== @@ -117,7 +115,6 @@ This widget is one of the few official widgets which utilize the optional parame // make a new, different fisheye effect on someId: fish = new dojox.widget.FisheyeLite({}, "someId"); -======== See also ======== diff --git a/dojox/widget/Loader.rst b/dojox/widget/Loader.rst index c94c191a0..c569652c4 100644 --- a/dojox/widget/Loader.rst +++ b/dojox/widget/Loader.rst @@ -1,5 +1,6 @@ .. _dojox/widget/Loader: +=================== dojox.widget.Loader =================== @@ -13,7 +14,6 @@ dojox.widget.Loader ``DEPRECATED:`` A Small example on listening to global Ajax activity. This widget will be demoted to :ref:`dojo-c ` in future versions and should not be used as anything but an example implementation. -======== See also ======== diff --git a/dojox/widget/Pager.rst b/dojox/widget/Pager.rst index d28312266..1c4b7e316 100644 --- a/dojox/widget/Pager.rst +++ b/dojox/widget/Pager.rst @@ -1,5 +1,6 @@ .. _dojox/widget/Pager: +================== dojox.widget.Pager ================== @@ -12,14 +13,12 @@ dojox.widget.Pager A Pager, displaying a list of sized nodes. -============ Introduction ============ TODO: introduce the component/class/method -===== Usage ===== @@ -32,7 +31,6 @@ Usage This Widget uses dojo.data, Dojo's uniform and consistent data access layer. -======== Examples ======== @@ -74,7 +72,6 @@ Declarative example: Horizontal Pager -======== See also ======== diff --git a/dojox/widget/Portlet.rst b/dojox/widget/Portlet.rst index fe7d09c40..11ee873f5 100644 --- a/dojox/widget/Portlet.rst +++ b/dojox/widget/Portlet.rst @@ -1,5 +1,6 @@ .. _dojox/widget/Portlet: +==================== dojox.widget.Portlet ==================== @@ -14,7 +15,6 @@ dojox.widget.Portlet The dojox.widget.Portlet is an enhanced version of the dijit.TitlePane widget, designed to be used in the dojox.layout.GridContainer. -============ Introduction ============ @@ -31,7 +31,6 @@ The settings types included are It is worth noting that this widget just implements one possible front end of a Portlet. The `JSR-168 standard `_ for Portlets contains a lot more than this. A full Portlet implementation requires both server side and client side code. This widget only serves to present the Portlet on the client side. -===== Usage ===== @@ -54,7 +53,6 @@ Usage -======== Examples ======== @@ -290,7 +288,6 @@ This examples shows Portlets as they are intended to be used, inside a dojox.lay -======== See also ======== diff --git a/dojox/widget/Rotator.rst b/dojox/widget/Rotator.rst index c263132a0..9525f2ca2 100644 --- a/dojox/widget/Rotator.rst +++ b/dojox/widget/Rotator.rst @@ -23,8 +23,7 @@ The Rotator does not rely on :ref:`Dijit `. It is designed to be a Usage ===== -================ ====== ====================================================================== -Parameter Type Description +================ ====== Parameter Type Description ================ ====== ====================================================================== transition String The name of a function that is passed two panes nodes and a duration, then returns a dojo.Animation object. The default value is "dojox.widget.rotator.swap". transitionParams String Parameters for the transition. The string is read in and eval'd as an object. If the duration is absent, the default value will be used. @@ -318,8 +317,7 @@ This allows you to publish to this topic and control the Rotator. It will invoke Parameters ---------- -================ ======== ====================================================================== -Parameter Type Description +================ ======== Parameter Type Description ================ ======== ====================================================================== action String The name of a method of the Rotator to run such as "prev", "next", and "go". If the action is not a valid method of the Rotator or its subclass, then a warning is thrown to the console. args Anything One or more arguments to pass to the action. If the action is "go", then you may pass in the number of the pane you want to go to. @@ -381,8 +379,7 @@ By subscribing to this topic, you can hook into various events fired by the Rota Parameters ---------- -================ ==================== ====================================================================== -Parameter Type Description +================ ==================== Parameter Type Description ================ ==================== ====================================================================== type String The type of notification. rotator dojox.widget.Rotator The instance of the Rotator. diff --git a/dojox/widget/rotator/Controller.rst b/dojox/widget/rotator/Controller.rst index d1864dfaa..3371332a1 100644 --- a/dojox/widget/rotator/Controller.rst +++ b/dojox/widget/rotator/Controller.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/Controller: +=============================== dojox.widget.rotator.Controller =============================== @@ -12,7 +13,6 @@ dojox.widget.rotator.Controller A controller that manipulates a :ref:`dojox.widget.Rotator ` or :ref:`dojox.widget.AutoRotator `. -============ Introduction ============ @@ -29,12 +29,10 @@ You may specify any of these controls in any order. You may also have multiple The Controller's DOM node may also be styled for positioning or other styled preferences. -===== Usage ===== -========== ======= ====================================================================== -Parameter Type Description +========== ======= Parameter Type Description ========== ======= ====================================================================== rotator string The name of an instance of a Rotator widget defined by data-dojo-id. commands string A comma-separated list of commands. The default value is "prev,play/pause,info,next". @@ -42,8 +40,7 @@ commands string A comma-separated list of commands. The default value is "p The "commands" parameter accepts the following commands: -============= ============================================================================ -Command Name Description +============= Command Name Description ============= ============================================================================ prev An icon button to go to the previous pane. next An icon button to go to the next pane. @@ -52,7 +49,6 @@ info Displays the current and total panes. (ie "1 / 4") titles Displays each pane's title as a tab. (ie "Home Services Contact Blog") ============= ============================================================================ -======== Examples ======== @@ -185,7 +181,6 @@ Declarative example

Prev, Numbers, Next

-======== See also ======== diff --git a/dojox/widget/rotator/Fade.rst b/dojox/widget/rotator/Fade.rst index 71e7f91d5..c5c2adc83 100644 --- a/dojox/widget/rotator/Fade.rst +++ b/dojox/widget/rotator/Fade.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/Fade: +========================= dojox.widget.rotator.Fade ========================= @@ -12,7 +13,6 @@ dojox.widget.rotator.Fade A fade and cross-fade transition for a :ref:`dojox.widget.Rotator ` or :ref:`dojox.widget.AutoRotator `. -===== Usage ===== @@ -25,7 +25,6 @@ These functions are invoked by the rotator and may be different per pane. Each function is passed an object containing the "transitionParams" along with the rotator's current and next pane which are to be panned, then returns a dojo.Animation object describing the animated sequence. -======== Examples ======== @@ -153,7 +152,6 @@ Example using cross-fade transition. -======== See also ======== diff --git a/dojox/widget/rotator/Pan.rst b/dojox/widget/rotator/Pan.rst index 57633ecf2..e170a6bfd 100644 --- a/dojox/widget/rotator/Pan.rst +++ b/dojox/widget/rotator/Pan.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/Pan: +======================== dojox.widget.rotator.Pan ======================== @@ -12,7 +13,6 @@ dojox.widget.rotator.Pan A pan and continuous pan transition for a :ref:`dojox.widget.Rotator ` or :ref:`dojox.widget.AutoRotator `. -===== Usage ===== @@ -43,7 +43,6 @@ If the parameter "wrap" is set to true, it will pan to the next pane using the s A continuous pan will use the target pane's duration to pan all intermediate panes. To use the target's pane duration for each intermediate pane, then set the "quick" parameter to "false". -======== Examples ======== @@ -172,7 +171,6 @@ Example using different pan directions for each pane. -======== See also ======== diff --git a/dojox/widget/rotator/Slide.rst b/dojox/widget/rotator/Slide.rst index 56ed81f3f..8b6619d85 100644 --- a/dojox/widget/rotator/Slide.rst +++ b/dojox/widget/rotator/Slide.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/Slide: +========================== dojox.widget.rotator.Slide ========================== @@ -12,7 +13,6 @@ dojox.widget.rotator.Slide A slide transition for a :ref:`dojox.widget.Rotator ` or :ref:`dojox.widget.AutoRotator `. -===== Usage ===== @@ -27,7 +27,6 @@ These functions are invoked by the rotator and may be different per pane. Each function is passed an object containing the "transitionParams" along with the rotator's current and next pane which are to be panned, then returns a dojo.Animation object describing the animated sequence. -======== Examples ======== @@ -156,7 +155,6 @@ Example of a different slide direction for each pane. -======== See also ======== diff --git a/dojox/widget/rotator/ThumbnailController.rst b/dojox/widget/rotator/ThumbnailController.rst index ec50589b1..6e65ba2bb 100644 --- a/dojox/widget/rotator/ThumbnailController.rst +++ b/dojox/widget/rotator/ThumbnailController.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/ThumbnailController: +======================================== dojox.widget.rotator.ThumbnailController ======================================== @@ -12,7 +13,6 @@ dojox.widget.rotator.ThumbnailController A controller that manipulates a :ref:`dojox.widget.Rotator ` or :ref:`dojox.widget.AutoRotator ` by displaying thumbnails for each pane. -============ Introduction ============ @@ -22,17 +22,13 @@ You may have multiple Controllers tied to a single Rotator instance. The size of the thumbnails and the style of the selected thumbnail is controlled using CSS. The Controller's DOM node may also be styled for positioning or other styled preferences. -===== Usage ===== -========== ======= ====================================================================== -Parameter Type Description -========== ======= ====================================================================== -rotator string The name of an instance of a Rotator widget defined by data-dojo-id. +========== ======= Parameter Type Description +========== ======= rotator string The name of an instance of a Rotator widget defined by data-dojo-id. ========== ======= ====================================================================== -======== Examples ======== @@ -165,7 +161,6 @@ Declarative example

Prev, Numbers, Next

-======== See also ======== diff --git a/dojox/widget/rotator/Wipe.rst b/dojox/widget/rotator/Wipe.rst index 5c8fff267..9b330bd16 100644 --- a/dojox/widget/rotator/Wipe.rst +++ b/dojox/widget/rotator/Wipe.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/Wipe: +========================= dojox.widget.rotator.Wipe ========================= @@ -12,7 +13,6 @@ dojox.widget.rotator.Wipe A wipe transition for a :ref:`dojox.widget.Rotator ` or :ref:`dojox.widget.AutoRotator `. -===== Usage ===== @@ -27,7 +27,6 @@ These functions are invoked by the rotator and may be different per pane. Each function is passed an object containing the "transitionParams" along with the rotator's current and next pane which are to be panned, then returns a dojo.Animation object describing the animated sequence. -======== Examples ======== @@ -156,7 +155,6 @@ Example of a different wipe direction for each pane. -======== See also ======== diff --git a/dojox/widget/rotator/index.rst b/dojox/widget/rotator/index.rst index 8ffd18053..d0db1f1fd 100644 --- a/dojox/widget/rotator/index.rst +++ b/dojox/widget/rotator/index.rst @@ -1,5 +1,6 @@ .. _dojox/widget/rotator/index: +==================== dojox.widget.rotator ==================== @@ -12,7 +13,6 @@ dojox.widget.rotator This is a collection of transitions and a :ref:`dojox.widget.Rotator ` controller. -================= Available Widgets ================= diff --git a/dojox/wire.rst b/dojox/wire.rst index c2062b68e..f88e15b85 100644 --- a/dojox/wire.rst +++ b/dojox/wire.rst @@ -1,5 +1,6 @@ .. _dojox/wire: +========== dojox.wire ========== diff --git a/dojox/xml.rst b/dojox/xml.rst index d261a59a8..c0d04b7bc 100644 --- a/dojox/xml.rst +++ b/dojox/xml.rst @@ -1,5 +1,6 @@ .. _dojox/xml: +========= dojox.xml ========= @@ -13,7 +14,6 @@ dojox.xml The goal of DojoX XML Utilities is provide differing XML utilities for use in various places in a consolidated package to eliminate code duplication. Currently this includes a native JS DomParser that converts XML to a JS object tree. It also includes several general utility XML functions, such as a function to construct new XML Doms in a browser independent fashion, produce XML text from an XML DOM, and do things such as getting all the text content under a node in a browser agnostic way. -============================================================ Generic XML Text to DOM parser and XML DOM utility functions ============================================================ @@ -66,7 +66,6 @@ Example 1: Generic XML DOM Parser and utilities
-======================================== Generic XML DOM to JS Object tree parser ======================================== diff --git a/key-links.rst b/key-links.rst index 6a7c0433c..e36a681ca 100644 --- a/key-links.rst +++ b/key-links.rst @@ -1,5 +1,6 @@ .. _key-links: +========= Key Links ========= @@ -8,14 +9,12 @@ Key Links Here's a collection of current and useful Dojo demos and tutorials to help you get started with Dojo: -=============== Getting Started =============== * `SitePen Dojo QuickStart Guide `_, SitePen * `Hello Dojo `_, SitePen and Sam Foster, mozilla, Dojo Committer -===== Demos ===== @@ -29,7 +28,6 @@ Demos * `JavaScript Dojo API Docs `_, JavaScript-based documentation viewer, by Uxebu * `Toura Mulberry `, Toura -==== Core ==== @@ -69,7 +67,6 @@ Core * `Using MD5 Digests to Make Long Get Requests `_, SitePen and Dustin Machi, Dojo Committer * `Demystifying Deferreds `_, SitePen and Dustin Machi, Dojo Committer -===== Dijit ===== @@ -92,7 +89,6 @@ Dijit * `Extending Dojo Widgets `_, Heather Koyuk, Dojo User * `Styling Dijit Form Elements `_, SitePen and Mike Wilcox, Dojo Committer -===== DojoX ===== @@ -151,7 +147,6 @@ Data, JSON, and RPC * `Deterministic Client/Server Interaction `_, Kris Zyp, SitePen, Dojo Committer -============= Miscellaneous ============= @@ -184,7 +179,6 @@ Miscellaneous * `A Dojo Plugin Pattern `_, Peter Higgins, Adconion, Dojo Project Lead -========= Utilities ========= @@ -200,7 +194,6 @@ Utilities * `Patching Dojo `_, SitePen and Sam Foster, Dojo Committer -==================== Dojo Goodness Series ==================== @@ -218,7 +211,6 @@ Dojo Goodness Series * `GFX Foo with FX `_ -=============== Books/Magazines =============== @@ -232,7 +224,6 @@ Books/Magazines * `Dojo: The JavaScript Toolkit with Industrial-Strength Mojo `_, Linux Journal, July, 2008, Matthew Russell, Zaffra, Dojo Contributor -===== Tests ===== @@ -240,7 +231,6 @@ Tests * `Dojo Sandbox `_ -============= Presentations ============= @@ -257,7 +247,6 @@ Presentations * `0 to Production with Dojo `_ - SpringOne America 2008 with Peter Higgins -===== Blogs ===== @@ -274,7 +263,6 @@ There are many blogs exclusively or partly devoted to dojo. * `dojotdg.com `_ - Companion blog for "Dojo: The Definitive Guide" by author Matthew Russell -======== See also ======== diff --git a/loader/legacy.rst b/loader/legacy.rst index eac4bd8a0..01a93c669 100644 --- a/loader/legacy.rst +++ b/loader/legacy.rst @@ -1,5 +1,6 @@ .. _loader/legacy: +============================ The Dojo Loader Legacy Modes ============================ @@ -10,7 +11,6 @@ The Dojo Loader Legacy Modes .. contents:: :depth: 3 -============ Introduction ============ @@ -19,7 +19,6 @@ is customary with Dojo, support for existing v1.x APIs, including the legacy loa ``dojo.provide``, and the rest) is fully supported until version 2.0. This document describes the legacy API and how it coexists with the AMD API. -============== The Legacy API ============== @@ -307,7 +306,6 @@ can do this and we're quite proud of this feature. That concludes a fast and furious review of legacy mode. I devoted more than a chapter to this system in :ref:`my book` if you want a more-gentle presentation. -================== Modes of Operation ================== diff --git a/quickstart/ajax.rst b/quickstart/ajax.rst index 0b525a52e..36c48b718 100644 --- a/quickstart/ajax.rst +++ b/quickstart/ajax.rst @@ -1,5 +1,6 @@ .. _quickstart/ajax: +============= AJAX and Dojo ============= @@ -16,7 +17,6 @@ Dojo provides a solid set of battle-tested XHR wrapper functions to allow you to The XMLHTTP request object (XHR for short) is one of the basic building blocks for constructing responsive Ajax-drive interactions. By allowing you to retrieve data on the user's behalf without refreshing the whole page the XHR object provides tremendous, but cross-browser XHR usage is beset by memory leaks, divergent APIs, a lack of built-in form encoding from JavaScript, and painful corner cases when de-serializing response data. -=========== XHR Options =========== @@ -81,7 +81,6 @@ Dojo < 1.7 Introduced was the load: function, which is explained in the XHR Callbacks section below. -============= XHR Callbacks ============= @@ -151,7 +150,6 @@ Dojo < 1.7 Alternately, you can "use plain :ref:`Deferred's `" to register callbacks. They are slightly more difficult to work with, but the concept is the same. -=========== dojo.xhrGet =========== @@ -161,7 +159,6 @@ xhrGet will create an Ajax request using the HTTP GET method, returning some dat For complete details and examples, see the :ref:`dojo.xhrGet documentation `. -============ dojo.xhrPost ============ @@ -170,7 +167,6 @@ xhrPost will create an Ajax request using the HTTP POST method and is usually us For complete details and examples, see the :ref:`dojo.xhrPost documentation `. -=========== dojo.xhrPut =========== @@ -178,7 +174,6 @@ xhrPut will create an Ajax request using the HTTP PUT method and is usually used For complete details and examples, see the :ref:`dojo.xhrPut documentation `. -============== dojo.xhrDelete ============== diff --git a/quickstart/arrays.rst b/quickstart/arrays.rst index 136535b34..0e092b98a 100644 --- a/quickstart/arrays.rst +++ b/quickstart/arrays.rst @@ -1,5 +1,6 @@ .. _quickstart/arrays: +=============== Arrays and Dojo =============== @@ -11,7 +12,6 @@ Arrays and Dojo Dojo comes with a bunch of useful methods to deal with arrays, a few more than you get from your browser by default. -============ dojo.indexOf ============ @@ -56,7 +56,6 @@ dojo.indexOf lets you easily determine the index of an element in an array. It l
-================ dojo.lastIndexOf ================ @@ -101,7 +100,6 @@ dojo.lastIndexOf lets you easily determine the last index of an element in an ar
-============ dojo.forEach ============ @@ -210,7 +208,6 @@ To break the forEach-Loop you should use dojo.some -=========== dojo.filter =========== @@ -281,7 +278,6 @@ Say you have an array of people with a last name. You would like to filter those -======== dojo.map ======== @@ -344,7 +340,6 @@ Another great function provided by Dojo is dojo.map. dojo.map lets you run a fun For complete documentation and more examples please check the :ref:`dojo.map documentation ` -========= dojo.some ========= @@ -394,7 +389,6 @@ Now your bank policies only allow you to give each client one credit over 1 mill
-========== dojo.every ========== diff --git a/quickstart/back.rst b/quickstart/back.rst index 09bb90e70..b67055d98 100644 --- a/quickstart/back.rst +++ b/quickstart/back.rst @@ -1,5 +1,6 @@ .. _quickstart/back: +===================== Back buttons and Dojo ===================== diff --git a/quickstart/browser-sniffing.rst b/quickstart/browser-sniffing.rst index 175c4b8ed..08352adac 100644 --- a/quickstart/browser-sniffing.rst +++ b/quickstart/browser-sniffing.rst @@ -1,5 +1,6 @@ .. _quickstart/browser-sniffing: +============================= Browser (User Agent) Sniffing ============================= @@ -69,7 +70,6 @@ Each variable is only defined if the specified browser is being used. For exampl ... } -============================================================ Example 1 - UA sniffing in Dojo 1.7 with AMD and the has API ============================================================ @@ -130,7 +130,6 @@ Here's a live sample to show how it works, when using AMD and minimal base depen
-========================================== Example 2 - Pre Dojo 1.7-style UA sniffing ========================================== @@ -187,7 +186,6 @@ This example has the same result, but loads more code because it's using the ful -======== See also ======== diff --git a/quickstart/cross-domain.rst b/quickstart/cross-domain.rst index acb7e6c73..86d9891d8 100644 --- a/quickstart/cross-domain.rst +++ b/quickstart/cross-domain.rst @@ -1,5 +1,6 @@ .. _quickstart/cross-domain: +================= Cross-Domain Dojo ================= @@ -12,7 +13,6 @@ Cross-Domain Dojo How to use Dojo's cross-domain distributions -============ Introduction ============ @@ -24,7 +24,6 @@ Advantages Disadvantages ------------- -====================================== Using a cross-domain Dojo distribution ====================================== CDN or a custom build? @@ -86,7 +85,6 @@ Multiple modules (dojo.io.iframe, dijit.Editor, dojo.back) require this to prope **dojox.flash.Info()**: It uses document.write() which will cause problems if dojox.flash is loaded via dojo.require(). -============= Usage example ============= @@ -115,7 +113,6 @@ Usage example
Hello, world!
-============================ Using CDN with Local modules ============================ diff --git a/quickstart/custom-builds.rst b/quickstart/custom-builds.rst index c27149a4a..801a41473 100644 --- a/quickstart/custom-builds.rst +++ b/quickstart/custom-builds.rst @@ -1,5 +1,6 @@ .. _quickstart/custom-builds: +==================================== Custom Builds ==================================== @@ -14,7 +15,6 @@ Custom Builds How to use Dojo's custom build system to package your code for optimal runtime performance. This guide briefly covers many common usages and parameters. See the :ref:`full build documentation ` for all the details. -============ Introduction ============ diff --git a/quickstart/data.rst b/quickstart/data.rst index 36312e043..010a73731 100644 --- a/quickstart/data.rst +++ b/quickstart/data.rst @@ -1,5 +1,6 @@ .. _quickstart/data: +=================== Datastores and Dojo =================== @@ -10,7 +11,6 @@ Datastores and Dojo .. contents:: :depth: 2 -================== What is dojo.data? ================== diff --git a/quickstart/data/usingdatastores.rst b/quickstart/data/usingdatastores.rst index 3b485d432..b3624b89a 100644 --- a/quickstart/data/usingdatastores.rst +++ b/quickstart/data/usingdatastores.rst @@ -1,5 +1,6 @@ .. _quickstart/data/usingdatastores: +================ Using Datastores ================ @@ -40,7 +41,6 @@ Datastores provide access to data through a standardized interface for talking t * :ref:`FAQ (frequent questions about using dojo.data) ` -======== See also ======== diff --git a/quickstart/data/usingdatastores/faq.rst b/quickstart/data/usingdatastores/faq.rst index 31edc4a74..9af2c6410 100644 --- a/quickstart/data/usingdatastores/faq.rst +++ b/quickstart/data/usingdatastores/faq.rst @@ -1,5 +1,6 @@ .. _quickstart/data/usingdatastores/faq: +============= dojo.data FAQ ============= @@ -8,14 +9,12 @@ dojo.data FAQ This section is intended as a point to put answers to the common questions posed by users of dojo.data. -==================================================================================================================== Question 1: I called fetch() on a datastore and the return value from the fetch function doesn't have my data! Why? ==================================================================================================================== Because the dojo.data API is asynchronous be definition. The return value from fetch will generally not have any data on it. It's intended as a point for stores to store an abort() function for a request and a place for stores to put internal cache details and the like. It is not intended to hand back data items. Data items are always returned through the callbacks to fetch(). -========================================================================================================================================== Question 2: I introspected items from ItemFileReadStore using javascript associative map walking and it has all these '_' variables! Why? ========================================================================================================================================== @@ -27,7 +26,6 @@ All store access should go through the :ref:`dojo.data.api.Read ` of the ItemFileWriteStore docs. -================================================================================================================================================================================= Question 9: In one of my items in ItemFileReadStore I defined an attribute value as a JavaScript object. When I access it through store.getValue(), it has been modified. Why? ================================================================================================================================================================================= @@ -167,7 +159,6 @@ attributes on it should also be accessed through store functions, such as getVal If you want to prevent ItemFileReadStore from converting Object types into data store items, you will need to use a custom type map, and define your object as a specific type that can be serialized to and from JSON using the custom type formatters. See the :ref:`custom types ` documentation for more details. -================================================================================================================================================================================================================================== Question 10: In one of my items in ItemFileReadStore I defined an attribute value as a JavaScript object, but I didn't set an identifier. The store blows up with an error about no identifier when fetching. Why does it care? ================================================================================================================================================================================================================================== diff --git a/quickstart/data/usingdatastores/fetchmultiple.rst b/quickstart/data/usingdatastores/fetchmultiple.rst index 94318ef5a..d6ce90d6a 100644 --- a/quickstart/data/usingdatastores/fetchmultiple.rst +++ b/quickstart/data/usingdatastores/fetchmultiple.rst @@ -1,12 +1,12 @@ .. _quickstart/data/usingdatastores/fetchmultiple: +====================================== **Fetching multiple items and values** ====================================== .. contents:: :depth: 3 -=========================== Working with Multiple Items =========================== @@ -52,7 +52,6 @@ The following example code fragment returns all items: That's great, but what is more useful is seeing a completely functional example. In the following example, clicking a button retrieves a list of items and displays them. Please note that this is a simple example using ItemFileReadStore, but the concepts it presents applies to all Data Stores. -=================== Functional Examples =================== @@ -137,7 +136,6 @@ Loading all items through callbacks -========================== Working with Lots of Items ========================== @@ -189,7 +187,6 @@ The following code fragment loads all items and streams them back into the page: Now, to demonstrate this concept in a functional example. In the following example, clicking a button retrieves a list of items and displays them. Please note that this is a simple example using ItemFileReadStore, but the concepts it presents applies to all Data Stores. -========================== Functional onItem Examples ========================== diff --git a/quickstart/data/usingdatastores/fetchsingle.rst b/quickstart/data/usingdatastores/fetchsingle.rst index 1125f8efb..662c7cb3f 100644 --- a/quickstart/data/usingdatastores/fetchsingle.rst +++ b/quickstart/data/usingdatastores/fetchsingle.rst @@ -1,5 +1,6 @@ .. _quickstart/data/usingdatastores/fetchsingle: +====================== Selecting single items ====================== @@ -25,7 +26,6 @@ For this example, we'll assume the following simple data source: { name: 'pepper', aisle: 'Spices', price: 1.01 } ]} -======== Examples ======== diff --git a/quickstart/data/usingdatastores/filteringitems.rst b/quickstart/data/usingdatastores/filteringitems.rst index b3d1ce132..e11fbf73b 100644 --- a/quickstart/data/usingdatastores/filteringitems.rst +++ b/quickstart/data/usingdatastores/filteringitems.rst @@ -1,12 +1,12 @@ .. _quickstart/data/usingdatastores/filteringitems: +=========================== Selecting (Filtering) items =========================== .. contents:: :depth: 3 -======== Querying ======== @@ -68,7 +68,6 @@ Once we have constructed the query, we pass it to fetch() along with the other p ... }); -==================================== Case sensitivity and other modifiers ==================================== @@ -86,7 +85,6 @@ That's great, but what if I don't care about case sensitivity? Dojo.data also p So,in general, any option that would affect the behavior of a query, such as making it case insensitive or doing a deep scan where it scans a hierarchy of items instead of just the top level items (the deep:true option), in a store belongs in the queryOptions argument. -===================== Flexible store syntax ===================== @@ -96,7 +94,6 @@ Therefore, the dojo.data API defines basic guidelines and syntax stores that can **Note:** dojo.data recommends that stores generally use the dojo.data.ItemFileReadStore syntax, because it is fairly generic, works well in javascript, and can be mapped into other native syntaxes easily. Nearly all, if not all, datastores provided in the dojox.data module use the exact same syntax and will under the covers map it to the native syntaxes needed by the back-end services that provide the data store query and return (for remote data stores), and in-memory datastores, such as dojo.data.ItemFileReadStore work well with the structured JavaScript format. -======== Examples ======== diff --git a/quickstart/data/usingdatastores/lazyloading.rst b/quickstart/data/usingdatastores/lazyloading.rst index c2144359e..83b1927f6 100644 --- a/quickstart/data/usingdatastores/lazyloading.rst +++ b/quickstart/data/usingdatastores/lazyloading.rst @@ -1,12 +1,12 @@ .. _quickstart/data/usingdatastores/lazyloading: +============================================== Hierarchical data and access through dojo.data ============================================== .. contents:: :depth: 3 -================= Hierarchical data ================= @@ -65,7 +65,6 @@ Lets take a look at an example hierarchy built up with references in dojo.data.I There are two things to notice about the above structure. The first is that yes, it is still a flat list of data items to feed to dojo.data.ItemFileReadStore. But, as you can see, there is a special attribute, *_reference* that is used to point to another item in the list. These references, when processed by ItemFileReadStore, will establish the relationships in the data. This means that when you call store.getValues(item, children), the array returned is an array of the actual items pointed to. So, if you then try to visualize it, you can see how the Tree of hierarchy is formed from the references. Below is an example of using dijit.Tree with the above dataset to construct and display a tree. -========================== Hierarchical data examples ========================== @@ -289,7 +288,6 @@ Sample code: Detecting child items //Call the fetch of the toplevel continent items. store.fetch({query: {type: "continent"}, onComplete: gotContinents}); -============ Lazy-Loading ============ diff --git a/quickstart/data/usingdatastores/pagination.rst b/quickstart/data/usingdatastores/pagination.rst index 1ea3989dc..d13508a1f 100644 --- a/quickstart/data/usingdatastores/pagination.rst +++ b/quickstart/data/usingdatastores/pagination.rst @@ -1,5 +1,6 @@ .. _quickstart/data/usingdatastores/pagination: +=========== Paging Data =========== @@ -10,7 +11,6 @@ As shown in the other datastore sections, the fetch method of the Read API can q The paging mechanism is used by specifying a start parameter in the fetch arguments. The start parameter says where, in the full list of items, to start returning items. The index 0 is the first item in the collection. The second argument you specify is the count argument. This option tells dojo.data how many items, starting at start, to return in a request. If start isn't specified, it is assumed to be 0. If count isn't specified, it is assumed to return all the items starting at start until it reaches the end of the collection. With this mechanism, you can implement simple paging easily. -======================= Pagination general flow ======================= @@ -83,7 +83,6 @@ The following example code fragment shows the general flow with Pagination: request = store.fetch({onComplete: itemsLoaded, start: 0, count: pageSize}); -=================== Functional Examples =================== diff --git a/quickstart/data/usingdatastores/simple.rst b/quickstart/data/usingdatastores/simple.rst index a0f41f5a7..7643fb6bb 100644 --- a/quickstart/data/usingdatastores/simple.rst +++ b/quickstart/data/usingdatastores/simple.rst @@ -1,5 +1,6 @@ .. _quickstart/data/usingdatastores/simple: +==================== A Simple Data Source ==================== @@ -8,7 +9,6 @@ A Simple Data Source A data source is what the name implies, a source that provides data to something. In the case of a data store, a data source is where the data store obtains its data. A data source can be a database, a REST service, or even a JSON file. For introductory purposes, we will look at the most simple data source available, a javascript object. -======== Examples ======== diff --git a/quickstart/data/usingdatastores/sorting.rst b/quickstart/data/usingdatastores/sorting.rst index 6651b6686..203bd6b18 100644 --- a/quickstart/data/usingdatastores/sorting.rst +++ b/quickstart/data/usingdatastores/sorting.rst @@ -1,12 +1,12 @@ .. _quickstart/data/usingdatastores/sorting: +======= Sorting ======= .. contents:: :depth: 3 -============= Sorting Items ============= @@ -29,7 +29,6 @@ For compound sorts, you can define as many sort keys as you want. The order in t {attribute: "name", descending: false} ]; -======== Examples ======== diff --git a/quickstart/data/usingdatastores/terminology.rst b/quickstart/data/usingdatastores/terminology.rst index 16c27e03e..0de53b5b9 100644 --- a/quickstart/data/usingdatastores/terminology.rst +++ b/quickstart/data/usingdatastores/terminology.rst @@ -1,5 +1,6 @@ .. _quickstart/data/usingdatastores/terminology: +=========== Terminology =========== @@ -8,7 +9,6 @@ Terminology The following words and phrases are used within the dojo.data quickstart and store documentation. Where possible, these terms have been related to their equivalent database concept. Before reading the rest of the quickstart, it is highly recommended that you familiarize yourself with the following terms. -===== Terms ===== diff --git a/quickstart/debugging.rst b/quickstart/debugging.rst index bb67ff879..3aa1bcbc3 100644 --- a/quickstart/debugging.rst +++ b/quickstart/debugging.rst @@ -1,5 +1,6 @@ .. _quickstart/debugging: +================== Debugging Tutorial ================== diff --git a/quickstart/doh.rst b/quickstart/doh.rst index fbe289abb..7eeac35bc 100644 --- a/quickstart/doh.rst +++ b/quickstart/doh.rst @@ -1,5 +1,6 @@ .. _quickstart/doh: +===== D.O.H ===== diff --git a/quickstart/dojo-basics.rst b/quickstart/dojo-basics.rst index 7b59ff752..8494e94a9 100644 --- a/quickstart/dojo-basics.rst +++ b/quickstart/dojo-basics.rst @@ -1,5 +1,6 @@ .. _quickstart/dojo-basics: +========================= Functions used Everywhere ========================= @@ -15,7 +16,6 @@ Functions used Everywhere It would be near impossible to explain any one aspect of the Dojo Toolkit without first explaining a few simple functions that appear literally *everywhere* within the codebase. These are dojo-fundamentals, and should be memorized if possible. -============ dojo.require ============ @@ -35,7 +35,6 @@ It may seem painful to require all modules, but Dojo rewards by: * Allowing you to build streamlined versions of Dojo. If you use dijit.Dialog a lot, you can build a custom version of dojo that loads dijit.Dialog quickly. ``dojo.require`` knows whether the function is already loaded, and so you don't have to change any of your code. -========== dojo.ready ========== @@ -59,7 +58,6 @@ That example passes an anonymous function. You can pass named functions as well: Notice we didn't call ``dojo.ready(init());`` ... The additional () causes the named-function to execute immediately, and ``dojo.ready`` expects a function. -========= dojo.byId ========= @@ -77,7 +75,6 @@ This is more or less an alias to ``document.getElementById``. Simply pass ``dojo Note: in some cases (in *lesser* browsers), ``document.getElementById`` doesn't actually return the Node you desire. ``dojo.byId`` normalizes this, and is the recommended way of accessing nodes byId. ``dojo.byId`` is similar to Prototype's ``$("someId")``, and jQuery's ``$("#someId")`` syntax, though Dojo uses a safely-namespaced function for it's query engine: ``dojo.query("#someId")`` (see: :ref:`dojo.query `) to avoid conflicts. -========== dijit.byId ========== @@ -99,7 +96,6 @@ dijit.byId ``dijit.byId`` returns an reference to that particular Dijit instance, and allows you to call methods and set properties. Each Dijit has several fundamental methods and properties defined by :ref:`dijit._Widget `, and adds in additional specific methods depending on the type of Dijit. -========== dojo.query ========== @@ -119,7 +115,6 @@ The returned object of a ``dojo.query()`` call is an instance of :ref:`dojo.Node Read more about :ref:`dojo.query `... -============ dojo.forEach ============ @@ -182,7 +177,6 @@ does the same thing. But that's not all! *New in 1.0*, you can collapse the fun Ay carumba! That's a lot of functionality in a tiny 1-line package. Once you get used to the syntax, you'll never want to go back. This only scratches the surface of how useful ``dojo.forEach`` can be. There is an excellent DojoCookie about `forEach `_ on DojoCampus. -============ dojo.connect ============ @@ -238,7 +232,6 @@ The Dojo event system allows you to connect to DOM elements or nodes or plain Ja ``dojo.connect`` is a *lot* more powerful than can be described on the surface. See the :ref:`full rundown ` for more examples and use-cases. -======== See also ======== diff --git a/quickstart/dom.rst b/quickstart/dom.rst index 1a71820e7..f9d49259b 100644 --- a/quickstart/dom.rst +++ b/quickstart/dom.rst @@ -1,5 +1,6 @@ .. _quickstart/dom: +============= DOM Utilities ============= @@ -11,13 +12,11 @@ DOM Utilities .. contents:: :depth: 2 -============ Introduction ============ Dojo provides a host of DOM utility functions. This guide covers combined usage of :ref:`dojo.style `, :ref:`dojo.create `, :ref:`dojo.attr `, and a number of other base utilities for DOM convenience. -======================== Locating and Using Nodes ======================== @@ -152,7 +151,6 @@ It is very common to see the special global 'document' used throughout JavaScrip They have identical length in characters, but by using ``dojo.doc`` you are able to ensure your code will execute in switched contexts, such as iframes and popups. To switch the context for code that uses ``dojo.doc``, ``dojo.body()``, and ``dojo.global`` see the documentation for :ref:`dojo.setContext `. -================== Manipulating Nodes ================== @@ -212,7 +210,6 @@ Node placement Where a node exists in the DOM is important. -============== Creating Nodes ============== @@ -220,8 +217,7 @@ Basic Nodes ----------- The DOM document contains functions for creating each of the basic DOM node types. -========= ====================== -Type Function +========= Type Function ========= ====================== element createElement(tagName) text createTextNode(data) @@ -256,7 +252,6 @@ In order to destroy a single node or a list of nodes, Dojo Toolkit provides the * dojo._destroyElement(node); -======== See also ======== diff --git a/quickstart/events.rst b/quickstart/events.rst index f2fdd7530..5bfadcfa6 100644 --- a/quickstart/events.rst +++ b/quickstart/events.rst @@ -1,5 +1,6 @@ .. _quickstart/events: +========================== JavaScript events and Dojo ========================== @@ -28,7 +29,6 @@ Dojo's event system is flexible and gives you a few options for connecting your * how to enjoy event-based programming -================== Simple Connections ================== @@ -304,7 +304,6 @@ This issue doesn't exist when calling methods on object, for example: In this case calling myFunc() will call the new object.method(), which will then call bar(). -================ The Event Object ================ @@ -339,7 +338,6 @@ Dojo normalizes the following methods with an event object: Additionally, :ref:`dojo.stopEvent(event) ` will prevent both default behavior any any propagation (bubbling) of an event. -==================== Page Load and Unload ==================== @@ -353,7 +351,6 @@ Dojo has three functions recommended for registering code to run on page load an Like dojo.connect(), these methods are useful because multiple pieces of code calling :ref:`dojo.ready(func) ` etc. won't overwrite each other. -================== Topic Based Events ================== @@ -408,7 +405,6 @@ To disconnect someObject.bar from its topic, you use ``dojo.unsubscribe``, just dojo.unsubscribe(topics[1]); -================= Events with Dijit ================= diff --git a/quickstart/gettingstarted.rst b/quickstart/gettingstarted.rst index cc14188b7..532599d9e 100644 --- a/quickstart/gettingstarted.rst +++ b/quickstart/gettingstarted.rst @@ -1,5 +1,6 @@ .. _quickstart/gettingstarted: +====================================== Getting started with some simple steps ====================================== @@ -22,7 +23,6 @@ Dojo's now included on your page, no install, no fuss. So what do you get for al As the example below shows, animations, event handling, and a wealth of other utilities are instantly available: -======= Example ======= @@ -56,7 +56,6 @@ Example click here to see how it works -======== See also ======== diff --git a/quickstart/helloworld.rst b/quickstart/helloworld.rst index 35fa67d88..427a41166 100644 --- a/quickstart/helloworld.rst +++ b/quickstart/helloworld.rst @@ -1,5 +1,6 @@ .. _quickstart/helloworld: +============= Hello, World! ============= diff --git a/quickstart/index.rst b/quickstart/index.rst index 94596debf..70834f216 100644 --- a/quickstart/index.rst +++ b/quickstart/index.rst @@ -1,5 +1,6 @@ .. _quickstart/index: +=============== Getting started =============== @@ -16,7 +17,6 @@ Getting started * :ref:`Licensing ` * :ref:`Why Choose Dojo? ` -============ Installation ============ @@ -25,7 +25,6 @@ Installation * :ref:`Local installation guide ` -================== Base Functionality ================== @@ -60,14 +59,12 @@ Internationalization * :ref:`Internationalization (i18n) ` -========== Animations ========== * :ref:`FX / Animations ` -======= Widgets ======= @@ -83,7 +80,6 @@ Widget developers notes: * :ref:`Layout Widget Hierarchies ` -====================== Stores and Data Stores ====================== @@ -103,28 +99,24 @@ Other Information * :ref:`Implementing RESTful Services Server-Side ` -============= Drag and Drop ============= * is the DnD tutorial ready for take off? -======== Charting ======== * :ref:`dojox.charting ` -========================= Dojo Toolkit Architecture ========================= * Todo -============================= Testing, Debugging and Tuning ============================= @@ -145,7 +137,6 @@ Tuning * :ref:`Tuning your installation with Custom Builds ` -======== See also ======== diff --git a/quickstart/install.rst b/quickstart/install.rst index 4a81042ed..01da6babf 100644 --- a/quickstart/install.rst +++ b/quickstart/install.rst @@ -1,5 +1,6 @@ .. _quickstart/install: +=============== Installing Dojo =============== @@ -14,13 +15,11 @@ Good news! Dojo's just a bunch of files on disk so it doesn't require any specia * Install the `latest release `_ on your server * Install directly from :ref:`source control ` -================= Use Dojo from CDN ================= This method is quick and painless! You simply load Dojo through `` -================= Sending Responses ================= diff --git a/quickstart/internationalization/globalization-guidelines/index.rst b/quickstart/internationalization/globalization-guidelines/index.rst index 71dd28c4b..0857b3765 100644 --- a/quickstart/internationalization/globalization-guidelines/index.rst +++ b/quickstart/internationalization/globalization-guidelines/index.rst @@ -1,5 +1,6 @@ .. _quickstart/internationalization/globalization-guidelines/index: +======================== Globalization Guidelines ======================== @@ -11,7 +12,6 @@ Globalization Guidelines .. contents:: :depth: 2 -======== Overview ======== @@ -24,7 +24,6 @@ Dojo addressed the globalization features at the very beginning of its developme Use the following guidelines to implement internationalization. -=========================================================================================================== :ref:`Encoding Guidelines ` =========================================================================================================== @@ -37,7 +36,6 @@ Use the following guidelines to implement internationalization. * :ref:`You must set Content-Type in an HTTP response header if the response is not encoded in UTF-8. ` -=============================================================================================================================================== :ref:`Locale and Resource Bundle Guidelines ` =============================================================================================================================================== @@ -47,7 +45,6 @@ Use the following guidelines to implement internationalization. * :ref:`You may make a build to include resource bundles in the locales that you use. ` -============================== String Manipulation Guidelines ============================== @@ -63,7 +60,6 @@ String Manipulation Guidelines * You must check the return value of String.charAt() when the string contains surrogates. -==================================== Formatting and Validation Guidelines ==================================== @@ -73,7 +69,6 @@ Formatting and Validation Guidelines * You should not hard-code patterns and locales when formatting data. -======================== Dijit Widgets Guidelines ======================== diff --git a/quickstart/internationalization/globalization-guidelines/locale-and-resource-bundle-guidelines.rst b/quickstart/internationalization/globalization-guidelines/locale-and-resource-bundle-guidelines.rst index 02ab1cfe7..9f74ea31e 100644 --- a/quickstart/internationalization/globalization-guidelines/locale-and-resource-bundle-guidelines.rst +++ b/quickstart/internationalization/globalization-guidelines/locale-and-resource-bundle-guidelines.rst @@ -1,5 +1,6 @@ .. _quickstart/internationalization/globalization-guidelines/locale-and-resource-bundle-guidelines: +==================================================== Globalization Guidelines: Locale and Resource Bundle ==================================================== @@ -11,7 +12,6 @@ Globalization Guidelines: Locale and Resource Bundle .. contents:: :depth: 2 -====================== Locale Setting in Dojo ====================== @@ -36,7 +36,6 @@ If dojoConfig.locale is undefined, Dojo will consult the browser's navigator obj ... -===================== Resource Bundle Files ===================== @@ -45,8 +44,7 @@ You must always use resource bundles to store the strings displayed to users. Dojo introduces resource bundle into JavaScript. If you are familiar with Java resource bundle, you can find that Dojo resource bundle is very similar to Java resource bundle. The following table shows a summary of the differences between Java and Dojo: -================= ================================ =================================================== -Resource bundle: Java Dojo +================= ================================ Resource bundle: Java Dojo ================= ================================ =================================================== File Format Properties file JSON file Locale Identifier Suffix of file name Directory name @@ -89,7 +87,6 @@ And in Dojo (4 directories and 6 files): The fallback strategy in Dojo is the same as that in Java. -===================== Using Resource Bundle ===================== @@ -147,7 +144,6 @@ Code block B: The first method is preferred as it is less brittle. -====== Builds ====== @@ -159,7 +155,6 @@ You may make a build to include resource bundles in the locales that you use Resource bundles can either be included in a build or be used without a build. If you use resource bundles without a build, the first request for each resource bundle will generate N+1 HTTP requests when it searches the server for values, where N is the number of segments in the target locale. For example, a call of dojo.requireLocalization("my.app", "bar") in the "zh-cn" locale looks for "bar.js" first in the "zh-cn", then in "zh", and finally in the root. Without optimization, some of these requests might result in harmless HTTP 404 errors (page not found) if a variant does not need to override any definitions from its parent. -=========== Translation =========== diff --git a/quickstart/internationalization/index.rst b/quickstart/internationalization/index.rst index 4f14f94bc..62198a34e 100644 --- a/quickstart/internationalization/index.rst +++ b/quickstart/internationalization/index.rst @@ -1,5 +1,6 @@ .. _quickstart/internationalization/index: +=========================== Internationalization (i18n) =========================== diff --git a/quickstart/internationalization/number-and-currency-formatting.rst b/quickstart/internationalization/number-and-currency-formatting.rst index 16bd641fa..fc6678653 100644 --- a/quickstart/internationalization/number-and-currency-formatting.rst +++ b/quickstart/internationalization/number-and-currency-formatting.rst @@ -1,5 +1,6 @@ .. _quickstart/internationalization/number-and-currency-formatting: +=============================================== Cultural conventions: Date, Number and Currency =============================================== @@ -11,7 +12,6 @@ Cultural conventions: Date, Number and Currency .. contents:: :depth: 2 -=============== Dates and Times =============== @@ -62,7 +62,6 @@ Special patterns may be specified may be used to provide custom formats, however Also available under :ref:`dojo.cldr.supplemental ` are routines to provide the first day of the week and the start and end of the weekend, according to local custom. -====================== Numbers and currencies ====================== @@ -117,7 +116,6 @@ dojo.currency Note: handling of Hindi and Arabic style numerals is planned for 1.0, but not yet implemented. -============== Locale support ============== diff --git a/quickstart/internationalization/resource-bundling.rst b/quickstart/internationalization/resource-bundling.rst index d67f235cb..3e3d4aca9 100644 --- a/quickstart/internationalization/resource-bundling.rst +++ b/quickstart/internationalization/resource-bundling.rst @@ -1,5 +1,6 @@ .. _quickstart/internationalization/resource-bundling: +============================= Translatable Resource bundles ============================= @@ -11,7 +12,6 @@ Translatable Resource bundles .. contents:: :depth: 2 -============ Introduction ============ @@ -22,7 +22,6 @@ The methods used in Dojo to substitute localized resources are intended for Dojo The translation task in a Dojo application is limited to anything which appears in the DOM, that is anything which is visible on the web page. It's unacceptable to hard-code an English string and have that appear to users, no matter how unlikely it is to appear. Debug or console message however, for the time being, are not localized as a matter of policy. There are no guidelines on console messages at the present time. They are generally discouraged in production code. -================== Localizing Strings ================== @@ -61,7 +60,6 @@ The root happens to have the English translation, which also acts as a fallback Translation subdirectories are searched and mixed in such a way that variants can specify overrides for some or all of their parent locale. Because the search requires looking for translations under both the language as well as variants, sometimes a 404 will occur; this is normal and can be optimized at build time. -======== See also ======== diff --git a/quickstart/internationalization/specifying-locale.rst b/quickstart/internationalization/specifying-locale.rst index 1706d244d..766030d0a 100644 --- a/quickstart/internationalization/specifying-locale.rst +++ b/quickstart/internationalization/specifying-locale.rst @@ -1,5 +1,6 @@ .. _quickstart/internationalization/specifying-locale: +=================== Specifying a Locale =================== @@ -11,14 +12,12 @@ Specifying a Locale .. contents:: :depth: 2 -================= What is a Locale? ================= Localization is driven by a *locale*, a short string often supplied by the host environment, which conforms to `RFC 3066 `_ used in the HTML specification. It consists of short identifiers, typically two characters long which are case-insensitive. Note that Dojo uses dash separators like the RFC, not underscores like Java (e.g. "en-us", not "en_US"). Typically country codes are used in the optional second identifier, and additional variants may be specified. For example, Japanese is "ja"; Japanese in Japan is "ja-jp". Notice that the lower case is intentional -- while Dojo will often convert all locales to lowercase to normalize them, it is the lowercase that must be used when defining your resources. -============================== How does Dojo find the locale? ============================== @@ -29,14 +28,12 @@ The user's locale may easily be overridden on a page prior to the Dojo bootstrap Once Dojo is loaded, it is not possible to change the locale for the page. -===================================== What about deprecated locale support? ===================================== Several locales used since the early days of the Internet `have been deprecated `_ in favor of new codes. These include 'iw' for Hebrew in favor of 'he'. Also, 'in' in favor of 'id' for Indonesian, 'no' in favor of 'nb' Norwegian Bokmål (to differentiate from Nynorsk), and 'ji' became 'yi' for Yiddish. Dojo tries to adhere to the latest specifications. Unfortunately, some applications still use the deprecated codes, most notably the JDK. The best practice when dealing with these technologies is to run a transformation on the string before assigning to dojoConfig.locale to assure that the new locale codes are used. -=================================== Using many locales at the same time =================================== diff --git a/quickstart/introduction/history.rst b/quickstart/introduction/history.rst index 9b2f44bfe..2f0bab32f 100644 --- a/quickstart/introduction/history.rst +++ b/quickstart/introduction/history.rst @@ -1,5 +1,6 @@ .. _quickstart/introduction/history: +======================= A Brief History of Dojo ======================= diff --git a/quickstart/introduction/licensing.rst b/quickstart/introduction/licensing.rst index d9df0cb1d..f6e32c315 100644 --- a/quickstart/introduction/licensing.rst +++ b/quickstart/introduction/licensing.rst @@ -1,5 +1,6 @@ .. _quickstart/introduction/licensing: +============== Dojo licensing ============== diff --git a/quickstart/introduction/whydojo.rst b/quickstart/introduction/whydojo.rst index 75139e7ab..92a3d6e4c 100644 --- a/quickstart/introduction/whydojo.rst +++ b/quickstart/introduction/whydojo.rst @@ -1,5 +1,6 @@ .. _quickstart/introduction/whydojo: +================ Why Choose Dojo? ================ diff --git a/quickstart/layoutWidgetHierarchies.rst b/quickstart/layoutWidgetHierarchies.rst index a4e003967..c77f75315 100644 --- a/quickstart/layoutWidgetHierarchies.rst +++ b/quickstart/layoutWidgetHierarchies.rst @@ -1,5 +1,6 @@ .. _quickstart/layoutWidgetHierarchies: +=========================================================================== Layout Widget Hierarchies: isLayoutContainer and dijit.layout._LayoutWidget =========================================================================== :Status: Contributed @@ -11,7 +12,6 @@ Layout Widget Hierarchies: isLayoutContainer and dijit.layout._LayoutWidget Often developers will build a hierarchy of layout related widgets. For example, a :ref:`dijit.layout.BorderContainer ` will contain a few :ref:`dijit.layout.TabContainer `'s, each of which has multiple :ref:`dijit.layout.ContentPane `'s, each of which contains some other widgets like :ref:`dijit.form.TextBox ` and :ref:`dijit.form.Button `. -======== resize() ======== The main widget method for dealing with layout is resize(). Resize() serves two main purposes: @@ -23,7 +23,6 @@ Resize() can only be called when a widget is visible. When a widget is hidden Both layout widgets and their children need to support the resize() method. (One exception: ContentPane children do not need a resize() method unless they do JS sizing). See below for more details. -================= isLayoutContainer ================= Widgets that define an isLayoutContainer attribute extend the isContainer contract (see :ref:`Widget Hierarchies `), and in addition promise to: @@ -47,7 +46,6 @@ Since javascript sizing doesn't work until a widget has been made visible, child This is important because it means that the appropriate interfaces (addChild(), attr("content", ...)) must be used so that the parent knows about the child. If the child DOM is added directly to the parent's DOM, the parent won't know about it, and it won't call resize() -========================== dijit.layout._LayoutWidget ========================== Most layout widgets extend dijit.layout._LayoutWidget. _LayoutWidget implements the isLayoutContainer contract specified above, with some helper functions. @@ -60,7 +58,6 @@ dijit.layout._LayoutWidget children ----------------------------------- Children of a :ref:`dijit.layout._LayoutWidget ` need to implement the resize(size) method which sets the size of the widget (and does any necessary JS size calculations). -======================== dijit.layout.ContentPane ======================== Since dijit.layout.ContentPane `_ is often used in layout widget hierarchies, it implements the isLayoutContainer interface. When the ContentPane itself is made visible, it calls resize() on each top level widget child. @@ -69,7 +66,6 @@ It doesn't extend :ref:`dijit.layout._LayoutWidget ` One common use for ContentPane is to contain a single layout widget. In this case (assuming that doLayout was not set to false), the ContentPane resizes it's single child to match it's own size. -====== Naming ====== The naming of these classes is unfortunate, but difficult to change for back-compat reasons. diff --git a/quickstart/module-returns.rst b/quickstart/module-returns.rst index 5825331d9..b95cb3dd9 100644 --- a/quickstart/module-returns.rst +++ b/quickstart/module-returns.rst @@ -1,5 +1,6 @@ .. _quickstart/module-returns: +================== AMD Module Returns ================== @@ -10,12 +11,10 @@ This page documents the new locations for Dojo methods, that have traditionally Each section below corresponds to a single AMD module, listing the methods returned along with their pre-AMD location. -================ dojo/_base/array ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.forEach dojo/_base/array array.forEach dojo.map dojo/_base/array array.map @@ -25,44 +24,35 @@ dojo.some dojo/_base/array dojo.indexOf dojo/_base/array array.indexOf ===================================================== ============================ ==================================== -================== dojo/_base/declare ================== -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax -===================================================== ============================ ==================================== -dojo.declare dojo/_base/declare declare +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ dojo.declare dojo/_base/declare declare ===================================================== ============================ ==================================== -=================== dojo/_base/Deferred =================== -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.Deferred dojo/_base/Deferred Deferred dojo.when dojo/_base/Deferred Deferred.when ===================================================== ============================ ==================================== -================ dojo/_base/event ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.fixEvent dojo/_base/event event.fix dojo.stopEvent dojo/_base/event event.stop ===================================================== ============================ ==================================== -================ dojo/_base/fx ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo._Line dojo/_base/fx fx._Line dojo.Animation dojo/_base/fx fx.Animation @@ -74,12 +64,10 @@ dojo.animateProperty dojo/_base/fx dojo.anim dojo/_base/fx fx.anim ===================================================== ============================ ==================================== -================= dojo/_base/kernel ================= -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.deprecated dojo/_base/kernel kernel.deprecated dojo.experimental dojo/_base/kernel kernel.experimental @@ -87,12 +75,10 @@ dojo.version dojo/_base/kernel ===================================================== ============================ ==================================== -================ dojo/_base/lang ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.extend dojo/_base/lang lang.extend dojo._hitchArgs dojo/_base/lang lang._hitchArgs @@ -111,12 +97,10 @@ dojo.setObject dojo/_base/lang ===================================================== ============================ ==================================== -================ dojo/_base/sniff ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.isOpera dojo/_base/sniff has("opera") dojo.isAIR dojo/_base/sniff has("air") @@ -138,23 +122,19 @@ dojo.isQuirks dojo/_base/sniff dojo.isIos dojo/_base/sniff has("ios") ===================================================== ============================ ==================================== -================= dojo/_base/unload ================= -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.addOnUnload dojo/_base/unload unload.addOnUnload dojo.addOnWindowUnload dojo/_base/unload unload.addOnWindowUnload ===================================================== ============================ ==================================== -================= dojo/_base/window ================= -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.global dojo/_base/window window.global dojo.doc dojo/_base/window window.doc @@ -164,12 +144,10 @@ dojo.withGlobal dojo/_base/window dojo.withDoc dojo/_base/window window.withDoc ===================================================== ============================ ==================================== -================ dojo/_base/xhr ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.contentHandlers dojo/_base/xhr xhr.contentHandlers dojo._ioSetArgs dojo/_base/xhr xhr._ioSetArgs @@ -184,24 +162,20 @@ dojo.xhrDelete dojo/_base/xhr dojo._xhrObj dojo/_base/xhr xhr._xhrObj ===================================================== ============================ ==================================== -================ dojo/dom ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.byId dojo/dom dom.byId dojo.isDescendant dojo/dom dom.isDescendant dojo.setSelectable dojo/dom dom.setSelectable ===================================================== ============================ ==================================== -================ dojo/dom-attr ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.attr(node, attr) dojo/dom-attr attr.get(node, attr) dojo.attr(node, attr, val) dojo/dom-attr attr.set(node, attr, val) @@ -209,12 +183,10 @@ dojo.hasAttr dojo/dom-attr dojo.removeAttr dojo/dom-attr attr.remove ===================================================== ============================ ==================================== -================ dojo/dom-class ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.addClass dojo/dom-class domClass.add dojo.hasClass dojo/dom-class domClass.contains @@ -223,12 +195,10 @@ dojo.replaceClass dojo/dom-class dojo.toggleClass dojo/dom-class domClass.toggle ===================================================== ============================ ==================================== -================== dojo/dom-construct ================== -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.toDom dojo/dom-construct construct.toDom dojo.place dojo/dom-construct construct.place @@ -237,12 +207,10 @@ dojo.empty dojo/dom-construct dojo.destroy dojo/dom-construct construct.destroy ===================================================== ============================ ==================================== -================ dojo/dom-form ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.fieldToObject dojo/dom-form form.fieldToObject dojo.formToObject dojo/dom-form form.formToObject @@ -251,12 +219,10 @@ dojo.formToJson dojo/dom-form ===================================================== ============================ ==================================== -================= dojo/dom-geometry ================= -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo._getPadExtents dojo/dom-geometry geometry.getPadExtents dojo._getBorderExtents dojo/dom-geometry geometry.getBorderExtents @@ -278,12 +244,10 @@ dojo._getIeDocumentElementOffset dojo/dom-geometry dojo._fixIeBiDiScrollLeft dojo/dom-geometry geometry.fixIeBiDiScrollLeft ===================================================== ============================ ==================================== -================ dojo/dom-style ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.style(node, attr) dojo/dom-style style.get(node, attr) dojo.style(node, attr, val) dojo/dom-style style.set(node, attr, val) @@ -292,87 +256,67 @@ dojo.getComputedStyle dojo/dom-style dojo._toPixelValue dojo/dom-style style.toPixelValue ===================================================== ============================ ==================================== -================ dojo/io-query ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.queryToObject dojo/io-query ioQuery.queryToObject dojo.objectToQuery dojo/io-query ioQuery.objectToQuery ===================================================== ============================ ==================================== -================ dojo/json ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.fromJson dojo/json json.parse dojo.toJson dojo/json json.stringify ===================================================== ============================ ==================================== -================ dojo/keys ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax -===================================================== ============================ ==================================== -dojo.keys dojo/keys keys +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ dojo.keys dojo/keys keys ===================================================== ============================ ==================================== -================ dojo/NodeList ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax -===================================================== ============================ ==================================== -dojo.NodeList dojo/NodeList NodeList +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ dojo.NodeList dojo/NodeList NodeList ===================================================== ============================ ==================================== -================ dojo/on ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.connect(node,"onclick",cb) dojo/on on(node,"click",cb) dojo.publish("/foo", [1,2,3]) dojo/on on.emit("/foo", 1, 2, 3) dojo.subscribe("/foo", callback) dojo/on on("/foo", callback) ===================================================== ============================ ==================================== -================ dojo/ready ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax -===================================================== ============================ ==================================== -dojo.addOnLoad dojo/ready ready +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ dojo.addOnLoad dojo/ready ready ===================================================== ============================ ==================================== -================ dojo/_Url ================ -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax -===================================================== ============================ ==================================== -dojo._Url dojo/_Url _Url +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ dojo._Url dojo/_Url _Url ===================================================== ============================ ==================================== -====================== TODO ====================== -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.window dojo/window window dojo.Color dojo/_base/Color Color @@ -401,12 +345,10 @@ dojo.config dojo/_base/config dojo.moduleUrl("dijit", "foo.template.html) require require.toUrl("dijit/foo/template.html") ===================================================== ============================ ==================================== -====================== Removed/Orphaned/Misc. ====================== -===================================================== ============================ ==================================== -1.x syntax 2.0 module 2.0 syntax +===================================================== ============================ 1.x syntax 2.0 module 2.0 syntax ===================================================== ============================ ==================================== dojo.isString(val) typeof val == "string" dojo.isArray(val) val instanceof Array diff --git a/quickstart/multiversion.rst b/quickstart/multiversion.rst index b90ef3d17..fa19de76f 100644 --- a/quickstart/multiversion.rst +++ b/quickstart/multiversion.rst @@ -1,5 +1,6 @@ .. _quickstart/multiversion: +==================================== Multiple Versions of Dojo on a Page ==================================== @@ -11,7 +12,6 @@ Multiple Versions of Dojo on a Page Dojo has some special configuration and build options to allow more than one version of Dojo to be used on a web page. -============ Introduction ============ diff --git a/quickstart/numbersDates.rst b/quickstart/numbersDates.rst index c2e06b901..1617ba922 100644 --- a/quickstart/numbersDates.rst +++ b/quickstart/numbersDates.rst @@ -1,5 +1,6 @@ .. _quickstart/numbersDates: +====================================================== Parsing, Formatting, and Validating: Dates and Numbers ====================================================== diff --git a/quickstart/oop.rst b/quickstart/oop.rst index dc53c6268..7f58374da 100644 --- a/quickstart/oop.rst +++ b/quickstart/oop.rst @@ -1,5 +1,6 @@ .. _quickstart/oop: +============= OOP with Dojo ============= diff --git a/quickstart/rest.rst b/quickstart/rest.rst index 077baaaf9..77cb0b32c 100644 --- a/quickstart/rest.rst +++ b/quickstart/rest.rst @@ -1,5 +1,6 @@ .. _quickstart/rest: +========================================== Implementing a RESTful Service Server-Side ========================================== :Status: Contributed @@ -13,7 +14,6 @@ You find yourself banging your head against the wall, because you hear all the " First you have to accept what REST is and isn't. Then you have to understand how Dojo uses REST and then finally you can consider what you need to do to implement REST on the server side. While this tutorial will try to be generic, my current service side language of choice is PHP, so most of my server side explanations will likely be in the context of PHP. -========================== Basics of RESTful Services ========================== @@ -125,7 +125,6 @@ OPTIONS While not currently implemented in either of the JSON REST consumers in Dojo, some RESTful implementations use the HTTP verb ``OPTIONS`` to provide information about what verbs can be supplied for a specific URI. This would allow a consumer to determine if a resource could be added, updated or deleted. -============= Dojo and REST ============= @@ -283,7 +282,6 @@ Would return something like: There is a lot more you can do with referencing, but viewing the :ref:`dojox.json.ref ` page is the best way to get a complete picture. Just remember that your references should contain a relative URI to the appropriate information. -========================== Server-Side Implementation ========================== @@ -319,7 +317,6 @@ HTTP Headers Sent Converting between SQL and REST ------------------------------- -===================================== Combining It and Other Considerations ===================================== diff --git a/quickstart/topics.rst b/quickstart/topics.rst index 0956ba80b..d66a71a05 100644 --- a/quickstart/topics.rst +++ b/quickstart/topics.rst @@ -1,5 +1,6 @@ .. _quickstart/topics: +================= Dojo Topic System ================= diff --git a/quickstart/widgetHierarchies.rst b/quickstart/widgetHierarchies.rst index ee09c0bbb..9ff7d04fe 100644 --- a/quickstart/widgetHierarchies.rst +++ b/quickstart/widgetHierarchies.rst @@ -1,5 +1,6 @@ .. _quickstart/widgetHierarchies: +================================================================ Widget Hierarchies: isContainer, dijit._Container, and startup() ================================================================ :Status: Contributed @@ -23,7 +24,6 @@ Widgets that define the isContainer flag are meant to contain other widgets. Th Since isContainer widgets promise to call startup() on their children, the parser (:ref:`dojo.parser `) will ***not*** call startup on those widgets. This allows the parent widget to do processing both before and after the child widget is started. Therefore, when adding child widgets to a parent widget, be sure to use the proper API, so that the parent knows the child exists. -================ dijit._Container ================ @@ -35,7 +35,6 @@ All of the widgets named \*\*\*Container (ex: :ref:`dijit.layout.TabContainer `, on the other hand, defines isContainer but does not extend dijit._Container (since it contains rich text rather than a simple list of widgets). -================ dijit._Contained ================ diff --git a/quickstart/writingWidgets.rst b/quickstart/writingWidgets.rst index 8a1aca2e0..ed466dfc7 100644 --- a/quickstart/writingWidgets.rst +++ b/quickstart/writingWidgets.rst @@ -1,5 +1,6 @@ .. _quickstart/writingWidgets: +======================= Writing Your Own Widget ======================= :Status: Contributed @@ -16,7 +17,6 @@ No problem! Dijit components are extensible, so you can make changes without tou You can also create Dijit classes from scratch. Again, you can do this either through markup - using the dijit.Declaration data-dojo-type attribute - or through dojo.declare. -===================== Starting From Scratch ===================== @@ -155,7 +155,6 @@ Now let's write a widget that performs some javascript. We'll setup an onclick postCreate() is called after buildRendering() is finished, and is typically used for connections etc. that can't be done until the DOM tree has been created. -================= Templated Widgets ================= OK, we've seen how to create a widget based directly on the :ref:`dijit._WidgetBase ` class. In practice though, this isn't done very often, as it's rather cumbersome to create a complicated DOM structure by hand. There's a mixin called :ref:`dijit._TemplatedMixin ` that makes all of this easier. _TemplatedMixin implements buildRendering() for you, and all you have to do is specify a template i.e, an HTML fragment, that specifies the DOM for the widget. @@ -226,7 +225,6 @@ So, putting that all together the source becomes: press me -========== Attributes ========== @@ -447,7 +445,6 @@ eg: Had the ``multiplier`` member been defined in ``postCreate``, the initial automated value setting done by attr() would fail. -========== Containers ========== @@ -492,7 +489,6 @@ Having said all that, now we define the widget, referencing this template via th -========================= Creating extension points ========================= Let's say you've written a widget, and when the user clicks on it, something happens. What you want is for the programmer using the widget to be able to either *change* what happens, or have something happen in addition, without having to edit your widget. @@ -566,7 +562,6 @@ Closing words: 2) How can you find the plain old js methods to override or "connect" to (in the dojo sense of dojo.connect)? Well, that can be painful. First, you have to look inside the widget. Or inside its ancestors/superclasses. Or theirs. Or theirs. Not fun. Second, they aren't named consistently. Sometimes _ means private, sometimes it means protected. (TODO: move to separate page?) -============================= Useful self-scoping functions ============================= @@ -578,7 +573,6 @@ There are two sets of functions available to all widgets which simplify connecti These functions operate similar to their dojo.* counterparts - with two exceptions. First, the target function will always be executed within the scope of the widget. Second, these connections/subscriptions will be cleaned up during the destroy() lifecycle phase of the widget. -============= Accessibility ============= @@ -587,7 +581,6 @@ These pages list how to make your widgets accessible to people with poor/no visi * :ref:`Creating Accessible Widgets ` * :ref:`Testing Widgets for Accessibility ` -============================ Alternate Templating Engines ============================ @@ -601,7 +594,6 @@ There's an alternate template syntax for widgets which lets you have conditional * `just a proposal` -======== See also ======== diff --git a/quickstart/writingWidgets/a11y.rst b/quickstart/writingWidgets/a11y.rst index 8077f49e5..9b1d85803 100644 --- a/quickstart/writingWidgets/a11y.rst +++ b/quickstart/writingWidgets/a11y.rst @@ -1,5 +1,6 @@ .. _quickstart/writingWidgets/a11y: +=========================== Creating Accessible Widgets =========================== diff --git a/quickstart/writingWidgets/a11yTesting.rst b/quickstart/writingWidgets/a11yTesting.rst index 2806c3f33..98a1efbf2 100644 --- a/quickstart/writingWidgets/a11yTesting.rst +++ b/quickstart/writingWidgets/a11yTesting.rst @@ -1,5 +1,6 @@ .. _quickstart/writingWidgets/a11yTesting: +================================= Testing Widgets for Accessibility ================================= diff --git a/quickstart/writingWidgets/example.rst b/quickstart/writingWidgets/example.rst index e4ceee6b6..cc85898eb 100644 --- a/quickstart/writingWidgets/example.rst +++ b/quickstart/writingWidgets/example.rst @@ -1,5 +1,6 @@ .. _quickstart/writingWidgets/example: +============================== Building a widget from scratch ============================== diff --git a/releasenotes/1.1.rst b/releasenotes/1.1.rst index 1ae3696ff..2dd399d5c 100644 --- a/releasenotes/1.1.rst +++ b/releasenotes/1.1.rst @@ -1,5 +1,6 @@ .. _releasenotes/1.1: +====================== Dojo 1.1 release notes ====================== @@ -10,7 +11,6 @@ Dojo 1.1 is backwards compatible with Dojo 1.0 but there are many new features, Here is the list of bugs fixed in 1.1.0 and 1.1.1. Note that many of those bug reports aren't bugs in 1.0, but rather just refactoring work, enhancements, or bugs that appeared after the 1.0 release. -======= Gotchas ======= @@ -115,7 +115,6 @@ See #6104 * dijitVerticalSliderIncrementIcon → dijitSliderIncrementIconV * dijitVerticalSliderDecrementIcon → dijitSliderDecrementIconV -==== Core ==== @@ -186,7 +185,6 @@ Adobe AIR support Thanks to Adobe's financial sponsorship and the hard work of SitePen and Chris Barber, Dojo now provides strong support for AIR in addition to Dojo's existing integration with Google Gears via dojox.offline -===== Dijit ===== @@ -246,7 +244,6 @@ Miscellaneous * Bidi: All widgets should now be BiDi-compliant and mirror properly when dir=rtl is set on the document * A11y - basically everything except Grid accessible -===== Dojox ===== @@ -322,7 +319,6 @@ Updated: * Lightbox -=================== Util (buildscripts) =================== @@ -338,7 +334,6 @@ Dojo 1.1 supports the following new build options: * There are new build options associated with multiversion support. See the Multiversion Book Page for more information. * Rhino builds: You can now do custom builds that target Rhino as the host environment, instead of the browser. See the example build file to see how to specify the Rhino host environment. -============================================ What browsers are supported by this release? ============================================ diff --git a/releasenotes/1.2.rst b/releasenotes/1.2.rst index 7e6928a5b..f6c3b487b 100644 --- a/releasenotes/1.2.rst +++ b/releasenotes/1.2.rst @@ -1,5 +1,6 @@ .. _releasenotes/1.2: +======================== Dojo 1.2.0 Release Notes ======================== @@ -8,14 +9,12 @@ Dojo 1.2.0 Release Notes These are the release notes for the Dojo Toolkit V1.2 release -======================= Backwards compatibility ======================= Dojo Toolkit V1.2 comes with a lot of new features and some changes/deprecations. The important message is, that most of the parts in Dojo Toolkit V1.2 are backwards compatible with Dojo Toolkit V1.0 and Dojo Toolkit V1.1. There are only a few details to be considered. See the section "Migration issues" below for details. Dojo core and related libraries -====================== Dojo Core Enhancements ====================== @@ -64,7 +63,6 @@ dojo.html.set() * feature added to use ContentPane like functionality outside of ContentPane. -================== Dijit Enhancements ================== @@ -160,7 +158,6 @@ Tooltip * made arrow smaller -================== DojoX enhancements ================== @@ -207,7 +204,6 @@ dojox.html o Toggle sheets on and off (based on the W3C spec). -========================== New/Enhanced DojoX Widgets ========================== @@ -283,7 +279,6 @@ dojox.xml.widgetParser * See also [#5766] for details. -==================== new Dojo data stores ==================== @@ -344,7 +339,6 @@ dojox.data.ServiceStore * Fetches are routed through the service and the returned results are used as the data behind the API. * See also the blog post and [#5987] for details. -===================== new Datastore Helpers ===================== @@ -381,7 +375,6 @@ dojox.rpc.OfflineRest/dojox.rpc.LocalStorageRest * dojox.rpc.OfflineRest provides auto-synchronization and caching of data for REST based applications. In particular, it is built for JsonRestStore to be used in offline mode, and it will save all data changes locally and synchronize/persist the changes to the server when connectivity is available. -========================== new DojoX Projects/Modules ========================== @@ -446,7 +439,6 @@ dojox.secure.sandbox * Provides support for loading web pages, JSON, and scripts from other domains using XHR (and XHR plugins) with a safe subset library and sandboxed access to the DOM. -==== Util ==== @@ -464,7 +456,6 @@ DOH: unit test framework * A doh.robot package has been added to allowing writing of unit tests for visual components like DnD and widgets. * There are also a few examples of those tests within dijit/tests/form/robot, etc. -================ Migration issues ================ @@ -538,7 +529,6 @@ Change Log/List of fixed bugs * Here is the list of bugs fixed in 1.2. * Note that many of those bug reports aren't bugs in 1.0 or 1.1, but rather just refactoring work, enhancements, or bugs that appeared after the 1.1 release. -============================================ What browsers are supported by this release? ============================================ diff --git a/releasenotes/1.3.rst b/releasenotes/1.3.rst index a100ae3aa..6dc02cd99 100644 --- a/releasenotes/1.3.rst +++ b/releasenotes/1.3.rst @@ -1,5 +1,6 @@ .. _releasenotes/1.3: +======================= Dojo 1.3 Release Notes ======================= @@ -8,7 +9,6 @@ These are the release notes for the Dojo Toolkit 1.3 release. .. contents:: :depth: 3 -============================== Enhanced Cross Browser support ============================== @@ -33,7 +33,6 @@ What browsers are supported by this release? * Konqueror 3.5+ (Dojo Core only) -=================================================== Enhancements within Dojo core and related libraries =================================================== @@ -76,7 +75,6 @@ dojo.query * ``query.js`` can now be used standalone for easy integration into other toolkits -================== Dijit Enhancements ================== @@ -131,7 +129,6 @@ Dialog * Dialog was refactored so all dialogs share a single DialogUnderlay, stored in dijit.\_underlay rather than this.\_underlay. The change should be transparent unless you happen to be subclassing from dijit.Dialog. -================== DojoX Enhancements ================== @@ -147,7 +144,6 @@ DojoX Enhancements * dojox.charting.DataChart - Connects a Data Store to DojoX Charts -==== Util ==== @@ -163,7 +159,6 @@ DOH enhancements * DOH progress bars no longer go beyond 100%, and clicking on a test header or error range will bring you to the relevant test or log info. -================ Migration issues ================ @@ -208,7 +203,6 @@ dojox.regexp missing dojox.regexp = dojox.validate.regexp is a quick shim to make any code using dojox.regexp functions use the new namespace. -============================= Change Log/List of fixed bugs ============================= diff --git a/releasenotes/1.4.rst b/releasenotes/1.4.rst index a3c7bf42f..9de672bf1 100644 --- a/releasenotes/1.4.rst +++ b/releasenotes/1.4.rst @@ -1,12 +1,12 @@ .. _releasenotes/1.4: +======================= Dojo 1.4 Release Notes ======================= .. contents:: :depth: 3 -=============== Browser support =============== @@ -18,7 +18,6 @@ The following browsers are supported. If a browser is not supported, it still ma * Latest Opera (Opera 10) (Dojo core only). * Keyboard now supported in all supported browsers (previously it didn't work on Safari and on Chrome) -==== Dojo ==== @@ -169,7 +168,6 @@ dojo.safeMixin * A companion for :ref:`dojo.declare `. It is similar to :ref:`dojo.mixin ` but decorates copied methods compatibly with :ref:`dojo.declare `. -====== Dijit ====== @@ -349,7 +347,6 @@ dijit.popup ~~~~~~~~~~~ dijit.popup.prepare() was renamed to moveOffScreen() for clarity about what the function actually does. -===== DojoX ===== @@ -570,7 +567,6 @@ dojox.widget.DataPresentation * See also :ref:`dojox.widget.DataPresentation ` -==== Util ==== @@ -587,14 +583,12 @@ Checkstyle * See also :ref:`util.checkstyle ` -========= Bug fixes ========= The `full list of bug fixes `_ is located in the bug database. -========= Upgrading ========= diff --git a/releasenotes/1.5.rst b/releasenotes/1.5.rst index 1342109e8..e70ebec44 100644 --- a/releasenotes/1.5.rst +++ b/releasenotes/1.5.rst @@ -1,12 +1,12 @@ .. _releasenotes/1.5: +====================== Dojo 1.5 Release Notes ====================== .. contents:: :depth: 3 -=============== Browser support =============== @@ -19,7 +19,6 @@ The following browsers are supported. If a browser is not supported, it still ma * Opera 10.50 and later (Dojo core only) -========= Dojo Core ========= @@ -86,7 +85,6 @@ See also: * `Stateful blog post `_ -===== Dijit ===== @@ -319,7 +317,6 @@ changes to widget.get('property'); // new since 1.5 -===== DojoX ===== @@ -452,7 +449,6 @@ Mobile dojox.mobile is set of lightweight widgets designed specifically for mobile plans, with themes for iPhone and android. It supports buttons, on/off switch, lists "tab container", etc -==== Util ==== @@ -463,7 +459,6 @@ Build System/buildscripts * Updated cldr scripts to use CLDR version 1.8 (see dojo.cldr) -========= Migration ========= @@ -557,8 +552,7 @@ Alternately you can manually update the names as per the tables below. Spinner: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitSpinnerUpArrowHover .dijitUpArrowButton .dijitSpinner .dijitUpArrowButtonHover .dijitSpinnerUpArrowActive .dijitUpArrowButton .dijitSpinner .dijitUpArrowButtonActive @@ -568,8 +562,7 @@ Old New ComboButton: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitComboButtonHover .dijitButtonContents .dijitComboButton .dijitButtonContentsHover .dijitComboButtonActive .dijitButtonContents .dijitComboButton .dijitButtonContentsActive @@ -582,8 +575,7 @@ Other changes occurred to CSS selectors to standardize the names, as follows: Accordion: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitAccordionFocused .dijitAccordionTitleFocused The accordion title is focused, not the pane contents .dijitAccordionTitle-hover .dijitAccordionTitleHover @@ -594,8 +586,7 @@ In addition, the accordion layout was changed so that every pane is surrounded b TabContainer: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitTab .closeButton .dijitTabCloseButton .dijitTab .closeButton-hover .dijitTabCloseButtonHover close button for individual tab @@ -610,16 +601,13 @@ Old New Dialog: -====================================================== ============================================= =========== -Old New Description -====================================================== ============================================= =========== -.dijitDialogCloseIcon-hover .dijitDialogCloseIconHover +====================================================== ============================================= Old New Description +====================================================== ============================================= .dijitDialogCloseIcon-hover .dijitDialogCloseIconHover ====================================================== ============================================= =========== Tree: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitTreeNodeHover .dijitTreeRowHover on the TreeNode.rowNode domNode .dijitTreeNodeSelected .dijitTreeRowSelected @@ -628,17 +616,14 @@ Old New TitlePane: -====================================================== ============================================= =========== -Old New Description -====================================================== ============================================= =========== -.dijitTitlePaneTitle-hover .dijitTitlePaneTitleHover +====================================================== ============================================= Old New Description +====================================================== ============================================= .dijitTitlePaneTitle-hover .dijitTitlePaneTitleHover ====================================================== ============================================= =========== InlineEditBox: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitInlineEditBoxDisplayMode-hover .dijitInlineEditBoxDisplayModeHover .dijitInlineEditBoxDisplayMode-disabled .dijitInlineEditBoxDisplayModeDisabled equivalent to a plain
or , clicking has no effect @@ -646,8 +631,6 @@ Old New Editor: -====================================================== ============================================= =========== -Old New Description -====================================================== ============================================= =========== -.RichTextEditable .dijitEditor editor's root node +====================================================== ============================================= Old New Description +====================================================== ============================================= .RichTextEditable .dijitEditor editor's root node ====================================================== ============================================= =========== diff --git a/releasenotes/1.5_ja.rst b/releasenotes/1.5_ja.rst index 7743f2481..e2c94654b 100644 --- a/releasenotes/1.5_ja.rst +++ b/releasenotes/1.5_ja.rst @@ -8,7 +8,6 @@ Dojo 1.5 リリース・ノート .. contents:: :depth: 3 -==================== サポートするブラウザ ==================== @@ -20,7 +19,6 @@ Dojo 1.5 リリース・ノート * Opera 10.50 またはそれ以降 (Dojo core のみ) -========= Dojo Core ========= @@ -87,7 +85,6 @@ dojo.Stateful * `Stateful blog post `_ -===== Dijit ===== @@ -320,7 +317,6 @@ Tree widget.get('property'); // new since 1.5 -===== DojoX ===== @@ -453,7 +449,6 @@ Mobile dojox.mobileはモバイル向けに特別にデザインされた軽量ウィジェットの集まりです。iPhoneとAndroid用のテーマが提供されます。ボタン、スイッチ、リスト、タブコンテナ等がサポートされています。 -==== Util ==== @@ -464,7 +459,6 @@ Util * cldrスクリプトを更新し、CLDR version 1.8を使うようになりました。(詳細はdojo.cldrを参照) -================ マイグレーション ================ @@ -556,8 +550,7 @@ Dijit CSS Spinner: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitSpinnerUpArrowHover .dijitUpArrowButton .dijitSpinner .dijitUpArrowButtonHover .dijitSpinnerUpArrowActive .dijitUpArrowButton .dijitSpinner .dijitUpArrowButtonActive @@ -567,8 +560,7 @@ Old New ComboButton: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitComboButtonHover .dijitButtonContents .dijitComboButton .dijitButtonContentsHover .dijitComboButtonActive .dijitButtonContents .dijitComboButton .dijitButtonContentsActive @@ -581,8 +573,7 @@ Old New Accordion: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitAccordionFocused .dijitAccordionTitleFocused The accordion title is focused, not the pane contents .dijitAccordionTitle-hover .dijitAccordionTitleHover @@ -593,8 +584,7 @@ Old New TabContainer: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitTab .closeButton .dijitTabCloseButton .dijitTab .closeButton-hover .dijitTabCloseButtonHover close button for individual tab @@ -609,16 +599,13 @@ Old New Dialog: -====================================================== ============================================= =========== -Old New Description -====================================================== ============================================= =========== -.dijitDialogCloseIcon-hover .dijitDialogCloseIconHover +====================================================== ============================================= Old New Description +====================================================== ============================================= .dijitDialogCloseIcon-hover .dijitDialogCloseIconHover ====================================================== ============================================= =========== Tree: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitTreeNodeHover .dijitTreeRowHover on the TreeNode.rowNode domNode .dijitTreeNodeSelected .dijitTreeRowSelected @@ -627,17 +614,14 @@ Old New TitlePane: -====================================================== ============================================= =========== -Old New Description -====================================================== ============================================= =========== -.dijitTitlePaneTitle-hover .dijitTitlePaneTitleHover +====================================================== ============================================= Old New Description +====================================================== ============================================= .dijitTitlePaneTitle-hover .dijitTitlePaneTitleHover ====================================================== ============================================= =========== InlineEditBox: -====================================================== ============================================= =========== -Old New Description +====================================================== ============================================= Old New Description ====================================================== ============================================= =========== .dijitInlineEditBoxDisplayMode-hover .dijitInlineEditBoxDisplayModeHover .dijitInlineEditBoxDisplayMode-disabled .dijitInlineEditBoxDisplayModeDisabled equivalent to a plain
or , clicking has no effect @@ -645,8 +629,6 @@ Old New Editor: -====================================================== ============================================= =========== -Old New Description -====================================================== ============================================= =========== -.RichTextEditable .dijitEditor editor's root node +====================================================== ============================================= Old New Description +====================================================== ============================================= .RichTextEditable .dijitEditor editor's root node ====================================================== ============================================= =========== diff --git a/releasenotes/1.6.rst b/releasenotes/1.6.rst index 0792ea6a0..964087de8 100644 --- a/releasenotes/1.6.rst +++ b/releasenotes/1.6.rst @@ -1,12 +1,12 @@ .. _releasenotes/1.6: +====================== Dojo 1.6 Release Notes ====================== .. contents:: :depth: 3 -=============== Browser support =============== @@ -17,7 +17,6 @@ The following browsers are supported. If a browser is not supported, it still ma * IE6, IE7, IE8 (Dojo 1.6.1+ supports IE9) * Opera 10.50 and later (Dojo core only) -========= Dojo Base ========= @@ -65,7 +64,6 @@ The global djConfig object used to define runtime configuration options has been var dojoConfig = { parseOnLoad:true } -========= Dojo Core ========= @@ -147,7 +145,6 @@ Two new methods are added to Dojo core, which can be used to improve performance * dojo._getMarginSize, a private method that returns the width and height of a node, and is a lightweight alternative to dojo.marginBox. -===== Dijit ===== @@ -238,7 +235,6 @@ a11y -===== DojoX ===== @@ -325,7 +321,6 @@ An HTML5 file input that handles multiple file selections, upload progress, and * :ref:`Uploader ` -==== Util ==== @@ -333,7 +328,6 @@ Build ----- The build now supports auto-generation of profiles from HTML files with the new htmlFiles and htmlDir build parameters. -========= Migration ========= diff --git a/releasenotes/1.7.rst b/releasenotes/1.7.rst index bd7298284..ad3556411 100644 --- a/releasenotes/1.7.rst +++ b/releasenotes/1.7.rst @@ -1,12 +1,12 @@ .. _releasenotes/1.7: +====================== Dojo 1.7 Release Notes ====================== .. contents:: :depth: 3 -============= Documentation ============= @@ -16,7 +16,6 @@ Considerable effort has been put into making Dojo 1.7's documentation better tha `API Docs (1.7 Draft) `_ -=============== Browser support =============== @@ -38,7 +37,6 @@ Mobile (dojox/mobile) TODO: Link to page with specific vendor device models tested on -========= Dojo Base ========= @@ -129,7 +127,6 @@ dojo.connect ------------ This has been refactored to use the new dojo/on module for event handling. See `dojo/on`_ below for more information. -========= Dojo Core ========= @@ -223,7 +220,6 @@ dojo/touch is based on :ref:`dojo/on ` and the following sample usage c Please refer to :ref:`dojo/touch doc ` for more details. -===== Dijit ===== @@ -288,7 +284,6 @@ ComboBox, FilteringSelect These classes have been enhanced to accept a :ref:`dojo.store ` (the new store API) for the store parameter. The old :ref:`dojo.data API ` is still supported. -===== DojoX ===== @@ -417,7 +412,6 @@ OpenLayers Maps - Allow user to place georeferenced widgets on the map. - Use of AMD module format. -==== Util ==== @@ -429,7 +423,6 @@ The Build Tools have been completely reimplemented in Dojo 1.7, to take full adv :ref:`Build Tool Reference Guide (1.7 Draft) ` -========= Migration ========= diff --git a/releasenotes/1.8.rst b/releasenotes/1.8.rst index aaf6b9367..4f502139f 100644 --- a/releasenotes/1.8.rst +++ b/releasenotes/1.8.rst @@ -1,5 +1,6 @@ .. _releasenotes/1.8: +====================== Dojo 1.8 Release Notes ====================== @@ -9,7 +10,6 @@ Dojo 1.8 Release Notes :depth: 3 -=============== Browser support =============== @@ -31,18 +31,15 @@ Mobile (dojox/mobile) TODO: Link to page with specific vendor device models tested on -========= Dojo Base ========= -========= Dojo Core ========= Parser ------ -===== Dijit ===== _WidgetBase @@ -96,16 +93,13 @@ Tree - persist=true flag also saves (and restores) selected Tree nodes (`#14058 `_) - New expandAll()/collapseAll() methods for expanding/collapsing all the nodes in a Tree dynamically (`#14287 `_) -===== DojoX ===== -==== Util ==== -========= Migration ========= diff --git a/todo.rst b/todo.rst index 3b1190628..7173480fe 100644 --- a/todo.rst +++ b/todo.rst @@ -1,5 +1,6 @@ .. _todo: +============== Docu Wiki ToDo ============== @@ -11,7 +12,6 @@ Starting with V1.3 each new feature needs a proper documentation at docs.dojocam The following pages need more love: -========= Dojo Core ========= @@ -32,7 +32,6 @@ Dojo Core needed: full page -===== Dijit ===== @@ -41,7 +40,6 @@ Dijit needed: full page -===== DojoX ===== @@ -178,7 +176,6 @@ DojoX add changes from http://trac.dojotoolkit.org/changeset/20698 (allow the line stroke style to be customized) -================================== Integration with Dojo ================================== diff --git a/util/checkstyle.rst b/util/checkstyle.rst index c278b18e6..1cb46dd26 100644 --- a/util/checkstyle.rst +++ b/util/checkstyle.rst @@ -1,5 +1,6 @@ .. _util/checkstyle: +=============== util.checkstyle =============== @@ -11,14 +12,12 @@ util.checkstyle .. contents:: :depth: 2 -============ Introduction ============ Checkstyle is a command line tool that generates a report of all JavaScript files that violate :ref:`the Dojo code style guidelines `. It also includes an interactive online tool to automatically fix most style guide issues. -===================== Usage of Command Line ===================== @@ -44,7 +43,6 @@ Show Checkstyle help checkstyle help -==================== Usage of Online Tool ==================== diff --git a/util/doctools.rst b/util/doctools.rst index 7dce730c4..c29738b3e 100644 --- a/util/doctools.rst +++ b/util/doctools.rst @@ -1,5 +1,6 @@ .. _util/doctools: +======================== Dojo Documentation Tools ======================== @@ -13,7 +14,6 @@ Dojo Documentation Tools Dojo uses a specially crafted, highly readable inline documentation format and distributes the PHP-based code parser used to collect the information. -============ Introduction ============ diff --git a/util/doctools/generate.rst b/util/doctools/generate.rst index 7225bc4f8..3492781d3 100644 --- a/util/doctools/generate.rst +++ b/util/doctools/generate.rst @@ -1,5 +1,6 @@ .. _util/doctools/generate: +============================ Generating API Documentation ============================ @@ -13,13 +14,11 @@ Generating API Documentation Running the doctools parser to extract API documentation data -============ Introduction ============ In :ref:`Dojo Inline Documentation ` we detailed the markup syntax and conventions available to document your API inline in your code. These inline docs can be extracted using the doctools parser - a php-based script available in util/docscripts in your svn checkout of the Dojo Toolkit. The parser generates xml and/or json of the entirety of the configured namespaces (dojo, dijit and dojox by default). -=================== Defining Namespaces =================== @@ -31,13 +30,11 @@ The namespaces are defined in util/docscripts/modules, using a simple properties The path is relative to the directory docscripts directory (the directory generate.php is located in). You may also use an fully qualified, absolute path to your namespace's directory. -============= Sanity Checks ============= For quick sanity checks of your docs you can load up util/docscripts/_browse2.php in your browser to run the parser over a single file at a time. -============ Parser Usage ============ @@ -72,7 +69,6 @@ Use the ``outfile`` argument to place the output in the directory/file of your c Parsing a large codebase (like dojo/dijit/dojox) may take several minutes. -======== See Also ======== diff --git a/util/doctools/markup.rst b/util/doctools/markup.rst index 67a1d99ab..cb7fdf475 100644 --- a/util/doctools/markup.rst +++ b/util/doctools/markup.rst @@ -1,5 +1,6 @@ .. _util/doctools/markup: +========================= Dojo Inline Documentation ========================= @@ -13,13 +14,11 @@ Dojo Inline Documentation Syntax, keywords and guidelines for Dojo's inline API documentation format -============ Introduction ============ API documentation takes the form of comment blocks, typically with one or more keywords. Function parameters may also be hinted inline and return values also indicated inline. -=========== Using a Key =========== @@ -41,7 +40,6 @@ Formatting: Each keyword should be on a line by itself, with a space before and The parser will keep reading content as part of the specified key until it sees a completely blank line, or another keyword. Although our formatting convention requires that keywords exist on a separate line, if any of these keywords occur at the beginning of a line, the parser will start reading the text following it and save it as part of that key's content. This means that you should be careful about what word you use to start a line. For example, "summary" shouldn't start a line unless the content that follows is the summary. -========================================== Using Markdown ========================================== @@ -49,7 +47,6 @@ You can use `Markdown `_ in To indicate a code block, indent the code block using a single tab. The parser considers the | (pipe) character to indicate the start of a line. You must use | followed by a tab in order to indicate a code block. In Markdown, to indicate an inline piece of code, surround the code with backticks. eg `
`. -=================== General Information =================== @@ -67,7 +64,6 @@ These keys provide descriptions for the function or object: * **example**: A writeup of an example. Uses Markdown syntax, so use Markdown syntax to indicate code blocks from any normal text. This key can occur multiple times. -===== Tags ===== @@ -116,7 +112,6 @@ A Note The current API tools (for displaying the documentation) not only assumes that any variable beginning with a _prefix is considered private, but also assumes that any method beginning with the phrase "on" is an event handler (i.e. onFoo, onClick, onmouseover). -==================== Method-Specific Tags ==================== @@ -150,7 +145,6 @@ Method-Specific Tags ... } -============================ General Function Information ============================ @@ -169,7 +163,6 @@ General Function Information } -================== Object Information ================== @@ -188,7 +181,6 @@ Has no description of what it returns // but, you're insured, right? } -======================================== Function Assembler Information (declare) ======================================== @@ -215,7 +207,6 @@ For example: } ); -========== Parameters ========== @@ -256,7 +247,6 @@ If you want to also add a summary, you can do so in the initial comment block. I } -========= Variables ========= @@ -285,7 +275,6 @@ Instance variables, prototype variables and external variables can all be define -================= Tagging Variables ================= @@ -317,7 +306,6 @@ Variables can be tagged by placing them in a whitespace-separated format before -============================== Variable Comments in an Object ============================== @@ -333,7 +321,6 @@ The parser takes the comments in between object values and applies the same rule // Another simple value } -============ Return Value ============ @@ -365,7 +352,6 @@ Note: The return type should be on the same line as the return statement. The fi } -============================ Documentation-Specific Code ============================ @@ -401,7 +387,6 @@ Doing this allows us to see syntax highlighting in our text editor, and we can w The trade-off is that it's harder to maintain documentation-only files. It's a good idea to only have one of these per the namespace depth you're at. eg in the same directory that the file you're documenting is. We'll see an example of its use in the next section. -=================== Documenting a kwArg =================== @@ -432,7 +417,6 @@ To associate this object with the originating function, do this: Since we didn't do a ``dojo.require`` on module._arg, it won't get included, but the documentation parser will still provide a link to it, allowing the user to see its functionality. This pseudo object may also be included in-line using the ``/*===== =====*/`` syntax. For an example of how to do this inline, see "dojo.__FadeArgs" pseudo code in dojo/_base/fx.js, used to document ``dojo.fadeIn()`` and ``dojo.fadeOut()`` -========================================== Which Documentation-Specific Syntax To Use ========================================== @@ -440,14 +424,12 @@ Documenting in another file reduces the chance that your code will break code pa There are many situations where you can't do this, in which case you should use the inline-comment syntax. There is also a fear that people will forget to keep documentation in sync as they add new invisible mixed in fields. If this is a serious concern, you can also use the inline comment syntax. -=========================== Validating your docs markup =========================== If you are a developer who has marked their code up using this syntax and want to test to make sure it is correct, you can run the doctool yourself locally. :ref:`See Generating API Documentation `. There is also a tool to quickly view simple parsing found in util/docscripts/_browse.php -======== See Also ======== diff --git a/util/doctools/viewer.rst b/util/doctools/viewer.rst index bdd30c89e..a8d74504c 100644 --- a/util/doctools/viewer.rst +++ b/util/doctools/viewer.rst @@ -1,5 +1,6 @@ .. _util/doctools/viewer: +=============================== Viewing the Generated API Docs =============================== @@ -13,13 +14,11 @@ Viewing the Generated API Docs Setup and population of the viewer app with API data -============ Introduction ============ Running the api docs extraction/generation tool (generate.php) produces either json or xml output - this is the raw data. To format and process this data into useful, browsable documentation you need a viewer application. This page steps you through the process to setup a web app like `dojotoolkit.org/api `_ and how to populate it with your docs data -============= Prerequisites ============= @@ -36,7 +35,6 @@ Our viewer app is going to end up in a directory called 'api', which for the pur If you point your browser at http://localhost/test.php (or whatever hostname you are using) you should see the PHP info page. Confirm the **xsl** module is available and enabled. -=================== Get the viewer code =================== @@ -48,7 +46,6 @@ We're going to get a copy of the code behind dojotoolkit.org/api and customize t That should create the 'api' sub-directory, and fill it with a load of php files and other assets. Note, we're doing an export here, not a checkout, so its divorced from the SVN copy. That means its yours to change, but if you prefer you can use svn checkout for those parts you want to be able to update with any changes from the remote repository. -==================== Configure the Viewer ==================== @@ -78,7 +75,6 @@ to read: Now, you can point your browser at http://localhost/api/, (or whatever hostname you are using) and you should see a working API viewer. -==================== Import API Data ==================== @@ -100,7 +96,6 @@ note that this directory MUST be writable (this is the caching mechanism for the That's it! Navigate back to /api/ and you should see your code's API in the viewer. -====================== Customizing the Viewer ====================== @@ -115,7 +110,6 @@ That value is referring to a subdirectory name of the 'themes' directory. Peek i -======== See Also ======== diff --git a/util/doh.rst b/util/doh.rst index bef53648c..c783b2d39 100644 --- a/util/doh.rst +++ b/util/doh.rst @@ -1,5 +1,6 @@ .. _util/doh: +============================= D.O.H: Dojo Objective Harness ============================= @@ -9,7 +10,6 @@ D.O.H: Dojo Objective Harness .. contents:: :depth: 3 -======== Overview ======== @@ -63,7 +63,6 @@ D.O.H. resides in the utils project of the dojo toolkit. Users can find it expl * **Robot.html**: HTML file used to bootstrap in the DOH Robot for tests that require synthetic user input. * **LICENSE**: The license that governs D.O.H. -================================== That's great, but how do I use it? ================================== Okay, that's wonderful! It's a unit test environment that's flexible. So ... how the heck does someone use it? Well, lets start small. The first thing we can do is look at using the browser runner to run a small set of unit tests in dojo. This is done just by loading runner.html in a web browser. What runner.html does is load runner.js and _browserRunner.js. This defines a global object, 'doh', that has numerous test registration and assertion functions that can be used by unit tests. Runner.html also does something else, if no module URL was provided for it to load tests from, the runner.html will automatically load the file: *dojo/tests/module.js*. All that file does is use the dojo module loading system to load in all the test files for core dojo. It then just executes all the currently registered tests and displays the results in the browser. @@ -157,7 +156,6 @@ What a performance fixture does is the following: You can also look at how to write performance tests by looking at: dojox/gfx/tests/performance/\* in your extract of Dojo 1.4 or development trunk. -========= Reference ========= @@ -385,7 +383,6 @@ Async performance test fixtures are just like synchronous performance test fixtu -======== See also ======== diff --git a/util/dohrobot.rst b/util/dohrobot.rst index 1ad9896c1..7e6c38408 100644 --- a/util/dohrobot.rst +++ b/util/dohrobot.rst @@ -1,5 +1,6 @@ .. _util/dohrobot: +========= DOH Robot ========= @@ -9,7 +10,6 @@ DOH Robot doh.robot adds an API to the Dojo Object Harness (DOH) unit test framework that enables testers to automate their UI tests using real, cross-platform, system-level input events. This document describes the value of doh.robot for unit and accessibility testing, and how to get started using it. -=============================== The challenge of Web UI testing =============================== @@ -17,13 +17,11 @@ Web UI testing frameworks like Selenium and Windmill already contain browser aut But the problem with synthetic events is that browsers don't trust synthetic events enough to let them execute their default action. For example, if you create a synthetic Tab keypress (expecting the browser to shift focus to the next element in the tab order), the focus won't actually move, because the browser doesn't trust the synthetic keypress enough to allow it to execute its default action. In a worse case, if you have a widget with onmouseover and onmousedown events, you would expect that the user would not be able to trigger the onmousedown without first triggering the onmouseover. But with synthetic events, this sort of common sense fails; you can easily send a click to an element without registering mouse movement over it, never mind the onmouseout from the previous element and the *hundreds* of onmousemoves a real user would generate in between. The result is that existing Web UI frameworks fail to support the testing of common requirements of Web applications like keyboard accessibility, and can be frustrating to deal with when you have to manually dispatch synthetic mouse events that would fire automatically for a human tester. -============================= What doh.robot can do for you ============================= We designed the doh.robot to enhance the DOH runner's ability to drive unit tests. Like other test frameworks, doh.robot provides testers with an API that enables them to simulate user interaction. However, we took a different approach to dispatching events: instead of using synthetic events, we used the cross-browser and cross-platform Java applet technology to place real events on the native event queue, as if a real person performed the action. This means that when you use doh.robot to execute your unit tests, browsers will trust the events doh.robot creates from your commands and will handle any and all contingent events for you. So when you tell doh.robot to send a Tab keypress, you can fully expect the Tab to move focus to the next element in the Tab order, as if a real user pressed Tab. And when you tell doh.robot to click an element, you can fully expect to get the onmouseover before the onmousedown, as well as all of those hundreds of onmousemoves a real user would generate in between. When you use the DOH test runner in conjunction with doh.robot, you can easily automate and report the results of numerous accessibility and UI unit tests that would otherwise require manual, visual inspection by a real person. -============ The 3 robots ============ @@ -46,7 +44,6 @@ dijit.robot dijit.robot is the final extension to the doh.robot packaged with dijit. You load it using dojo.require("dijit.robot"). It further augments the dojo.robot's mouse handling with dijit's cross-browser automatic scrolling. If you are concerned about writing tests that involve scrolling a lot of elements into view, dijit.robot is the best way to ensure that elements are always in view for the mouse to click them. -================= The doh.robot API ================= @@ -91,7 +88,6 @@ duration Several doh.robot methods also take a duration parameter. The duration tells doh.robot approximately how much time it should take to execute the command. For example, calling doh.robot.typeKeys("dij", 500, 1800) will instruct doh.robot to start typing dij after 500ms and to wait (1800 ms)/(3 chars) = 600 ms/char before each keypress. As with the delay parameter, doh.robot automatically sequences calls to account for the duration, so you don't have to add the duration into the next command's delay; doh.robot will add it in for you at runtime. -======================= Writing doh.robot tests ======================= @@ -141,7 +137,6 @@ You write doh.robot tests like deferred DOH tests. DOh's deferred test model ind You can see what the concrete implementation of this flow looks like in the runTest function above. You store the doh.Deferred in a variable called d. Next, you write the robot commands themselves: the mouse moves to 30,30 on the screen, clicks the left mouse button, and types " again". Between each command, the robot waits 500ms. After about another second has elapsed, the test asserts that everything worked. You tell DOH a test passed in the Deferred model by calling d.callback(true). You tell DOH that something bad happened by calling d.errback and pass a new Error with the problem description. You can also do some visual formatting to indicate whether the test passed, for users running the test standalone (like you). Finally, you return the doh.Deferred object to the runTest function, signaling the DOH runner to wait for this test to finish. -====================================== dojo.robot and dijit.robot's value-add ====================================== @@ -218,7 +213,6 @@ Where as the simple mouseMove needs to know ahead of time where to move on the p This would cause the mouse to click the middle of the textbox before it starts typing. The dojo.robot tries to scroll the element into view using the browser's native scrollIntoView function so that no matter where the element is, even if it is presently off the screen, the dojo.robot can scroll it in and click it. But this approach still has one problem: native scrollIntoView does not work consistently across all browsers. Enter dijit.robot: dijit.robot enhances the dojo.robot with dijit's scrollIntoView algorithm, making scrollIntoView view consistent across all browsers. It's trivial to use this feature: just swap dojo.require("dojo.robot") with dojo.require("dijit.robot") and everything will start scrolling correctly automatically. -==================== dojox.robot.recorder ==================== @@ -246,7 +240,6 @@ Here are some example tests modeling common UI interactions. These tests were ge * http://archive.dojotoolkit.org/nightly/dojotoolkit/dojo/tests/dnd/robot/test_dnd.html (drag and drop of elements into containers) -================================================ Separating Robot Test Code From Application Code ================================================ diff --git a/util/shrinksafe/index.rst b/util/shrinksafe/index.rst index 02f21065c..c186cfff2 100644 --- a/util/shrinksafe/index.rst +++ b/util/shrinksafe/index.rst @@ -1,5 +1,6 @@ .. _util/shrinksafe/index: +========== ShrinkSafe ========== @@ -13,7 +14,6 @@ ShrinkSafe ShrinkSafe is a standalone Java-based JavaScript compressor which utilizes Rhino to parse code and safely shorten the results. ShrinkSafe renames local references to short names prefixed with an underscore. This saves bytes on the wire and also provides some obfuscation of the code. It also eliminates whitespace and comments when generating the new code. Global references and property names remain unchanged such that external references to the compressed code should be safe. -================ Getting the Code ================ @@ -22,7 +22,6 @@ While ShrinkSafe is available as an `online service `_ by selecting the ``-shrinksafe`` archive. -===== Usage ===== @@ -49,14 +48,12 @@ ShrinkSafe uses the encoding settings for the JVM, which may vary depending on y java -jar -Dfile.encoding=UTF8 shrinksafe.jar -===================== Developer information ===================== ShrinkSafe has its own jar file, ``shrinksafe.jar``, which utilizes an unmodified Rhino jar, ``js.jar``. Note that the linkage requires the same version of Rhino used to build the shrinksafe.jar. In versions prior to Dojo 1.3, ShrinkSafe was bundled into Rhino by way of patch, and shipped as ``custom_rhino.jar``. -========== Known bugs ========== @@ -64,7 +61,6 @@ Known bugs * Forward references are not always resolved properly. See `ticket #3241 `_ * ShrinkSafe appears to not handle '$super' in this code. See `ticket #5436 `_ -======== See also ========