dojo / docs

Dojo 1 - reference Documentation.

dojo

This is the foundation package for the Dojo 1 Toolkit. While still being maintained, new development is primarily focused on modern Dojo.

Checkout the Dojo framework website or if you want a more detailed technical status and overview, checkout the Dojo roadmap.

This package is sometimes referred to as the “core”, it contains the most generally applicable sub-packages and modules. The dojo package covers a wide range of functionality like Ajax, DOM manipulation, class-type programming, events, promises, data stores, drag-and-drop and internationalization libraries.

Installing

Installation instructions are available at dojotoolkit.org/download.

Getting Started

If you are starting out with Dojo, the following resources are available to you:

• Tutorials

• Reference Guide

• API Documentation

• Community Forum

What to Use Dojo For and When to Use It

The following is a brief sampling of some of the areas where Dojo may prove to be the right tool for your next project:

• For keeping your code fast and maintainable, Dojo offers an asynchronous module definition (AMD) loader -- encapsulating pieces of code into useful units, loading small JavaScript files only when they are needed, and loading files separately even when they are dependent on one another.

• When you want to easily extend existing classes, share functionality among a number of classes, and maximize code reuse, Dojo provides class-like inheritance and “mixins.”

• For creating advanced and customizable user interfaces out of refined, efficient, and modular pieces, Dojo’s Dijit framework offers several dozen enterprise-ready widgets -- including buttons, textboxes, form widgets with built-in validation, layout elements, and much more -- along with themes to lend them a consistent look. All of this is available for mobile environments as well.

• For working with advanced vector graphics, Dojo’s GFX API can render graphics in a wide variety of formats, with support for seamless manipulation (skewing, rotating, resizing), gradients, responding to mouse events, and more.

• The dojox/charting library supports powerful data visualization and dynamic charting, including a variety of 2D plots and animated charting elements.

• When you need feature-rich, lightweight, and mobile-friendly grids/tables, Dojo offers the dgrid widget, along with customizable default themes and accompanying features such as in-cell editing, row/cell selection, column resizing/reordering, keyboard handling, pagination, and more.

• Dojo is the officially supported framework for the ArcGIS API for JavaScript, one of the most widely used enterprise-grade APIs for web mapping and spatial analysis -- learning to use Dojo will open doors to creating richer web mapping applications using that API.

License and Copyright

The Dojo Toolkit (including this package) is dual licensed under BSD 3-Clause and AFL. For more information on the license please see the License Information. The Dojo Toolkit is Copyright (c) 2005-2018, JS Foundation. All rights reserved.

docs's Issues

1.6 branch

Hello,

as discussed on IRC meeting on wednesday, should we open a 1.6 branch for reference guide according to this guide:
http://www.bitflop.com/document/116
?

Images?

Should reference guide provide images?

https://raw.github.com/dojo/docs/master/dojo/position.rst

This line seems a bit "problematic" I think:
background: url(http://livedocs.dojotoolkit.org/dojo/frame.png) no-repeat;

Is there any example for declarative build?

I have tried the declarative buildSystem follow the reference-guide:
https://dojotoolkit.org/reference-guide/1.8/build/transforms/depsDeclarative.html

But it does not work.

How to contribute to dojo-docs

Hello, I haven't found any info on how to contribute to documentation of Dojo. Can somebody please describe a little bit on this issue? Are pull requests over Github accepted?

What are the purposes of 1.7 and master branches and how to correctly contribute to latest documentation and not to old deprecated examples.

Thank you for your help.

dojocampus.org 404 errors

Hello,

At the moment dojocampus.org seems to be inactive. It contained a lot of usefull information.

Can we sort of copy+paste and refactor examples and some stuff from dojocampus and remove those missing links from documentation?

What am I thinking. For instance:

https://github.com/dojo/docs/blob/master/dojo/data/ItemFileReadStore.rst
contains link to:
http://dojocampus.org/content/2009/01/31/refeshing-an-itemfilereadstore
(although this example has this already described in it sort of)

Can we use some internet archive to retrieve this content back and include it in reference guide? It will not hurt anybodies feelings?

I believe we should centralize this kind of informations and have usefull info in reference guide.

documentation FilteringSelect queryExpr with formatter example

Maybe it can be useful to others:
One can enrich queryExpr with formatter

example:
queryExpr:'${0:String.toUpperCase}*'

<select data-dojo-type="dijit.form.FilteringSelect" ....data-dojo-props=".,queryExpr:'${0:String.toUpperCase}*'," ..../>

Dojo reference documentation style guide, how to contribute etc

Though it may seem trivial I'm missing something like this:
http://dojotoolkit.org/community/styleGuide

specially for reference documentation. It is not my intention to force new contributors to follow style guides for documentation and scare them away, however dojo/doc project is huge and as important as is dojo source. Therefore for best and fastest maintaining probably should follow some guidelines.

I see some major progress and development on this topic and would prefer to leave it for main developers to make something out of it and integrate in the current dojotoolkit.org/get-involved page:

http://oksoclap.com/wqp2YpEMKS

Maybe this is even a topic for two different parts:

• reference documentation style guide
• how to contribute (rstwiki, livedocs.dojotoolkit.org etc)

New users could have some problems with fastest integration in community and contributing to this reference guide.

Thank you for great efforts so far.

Broken link to alex.dojotoolkit.org on community page

This page:
https://dojotoolkit.org/community/
Has a broken link (DNS not found) to this URL:
http://alex.dojotoolkit.org/2008/06/why-do-i-need-to-sign-this/

Apologies if this is the wrong repo. Also - would love to read the content of that document, so pointers to where it really lives appreciated!

Update Dojo contributor process documentation

The info at https://dojotoolkit.org/reference-guide/1.10/developer/rules.html is terribly out of date. Need to update this for Dojo 1.x and newer Dojo.

examples broken on IE9

Hello, parndt noted that examples are not working in IE9:
http://dojo-toolkit.33424.n3.nabble.com/dijit-Samples-on-dojotoolkit-org-does-not-run-td3687380.html

Just for getting some insite infos about code running the examples in the dojotoolkit.org.

Codeglass:
https://github.com/nonken/Codeglass
for 1.6 docs

CodeglassMini for 1.7?
Where can we find the source code?

What would be the best plan for documentation on dojotoolkit.org and that it will not break legacy examples and will work with search engine? (or is it already in progress and just have to wait a bit)?

Thank you, regards. Peter.

old dojox.storage documentation is broken

@spaceone commented on Mon Sep 18 2017

https://dojotoolkit.org/reference-guide/1.10/dojox/storage.html says to use the deprecated:
dojo.addOnLoad() and the example aren't even working. It seems dojo.addOnLoad is never called.

Could you upgrade the documentation to reflect an modern state?
At least say a word that https://github.com/SitePen/dstore/blob/master/docs/Stores.md could be used instead? Or how to use dojox/storage/LocalStorageProvider as an AMD module?

---

@dylans commented on Tue Sep 26 2017

Note that this repo is for Dojo 2... so I'm going to move this issue to the dojo/docs repo where we'd be happy to accept a pull request to get this landed.

500 error at ItemFileReadStore

Hm, obviously something went wrong:
http://livedocs.dojotoolkit.org/dojo/data/ItemFileReadStore

It has probably something to do with copy pasting from dojocampus.