phiggins42 / rstwiki Goto Github PK

Ticket for dealing with Dojo 2.0 Integration/Documentation

Redisplaying the same demo does not work on the current version of Safari.

The following code glass code does not work, with the script failing and throwing that it is missing an }:

.. code-example ::

  .. js ::

    require(["dojo/cldr/monetary", "dojo/dom", "dojo/on", "dojo/domReady!"],
    function(cldrMonetary, dom, on){
      on(dom.byId("monetaryButton"), "click", function(){
        // the ISO 4217 currency code for Euro:
        var iso = "EUR";
        // get monetary data:
        var cldrMonetaryData = cldrMonetary.getData(iso);

        // print out places:
        dom.byId("places").innerHTML = "Places: " + cldrMonetaryData.places;

        // print out round:
        dom.byId("round").innerHTML = "Round: " + cldrMonetaryData.round;
      });
    });

  .. html ::

    <button id="monetaryButton" type="button">Get Monetary data for EUR (Euro)</button>
    <div id="places"></div>
    <div id="round"></div>

While the following does work:

.. code-example ::

  .. js ::

    require(["dojo/cldr/monetary", "dojo/dom", "dojo/on", "dojo/domReady!"],
    function(cldrMonetary, dom, on){
      on(dom.byId("monetaryButton"), "click", function(){
        var iso = "EUR";
        var cldrMonetaryData = cldrMonetary.getData(iso);

        dom.byId("places").innerHTML = "Places: " + cldrMonetaryData.places;

        dom.byId("round").innerHTML = "Round: " + cldrMonetaryData.round;
      });
    });

  .. html ::

    <button id="monetaryButton" type="button">Get Monetary data for EUR (Euro)</button>
    <div id="places"></div>
    <div id="round"></div>

The only difference is the remove of the comments in the JS Code.

rstwiki should be able to serve up content only document for embedding in other solutions (e.g. API Viewer). The rendering should not contain only HTML markup.

As a developer, the most useful thing for me are code samples. Being able to quickly tinker with these code samples helps a ton. So I would like the ability to export the code samples in the Dojo documentation to a JSFiddle or JSBin or CodePen IO.

Eventually I would also like a directory of working Dojo code samples. I think this will help people who are new or unfamiliar with Dojo a lot.

See:

Display a Fiddle from POST: http://doc.jsfiddle.net/api/post.html

AngularJS JSFiddle Examples: https://github.com/angular/angular.js/wiki/JsFiddle-Examples

If a new file is added via the web interface, it doesn't get staged in the commit properly and therefore the push to GitHub fails.

The build process does not copy extra resources for codeglass examples, like JSON files, HTML files, etc.

Make the api-link directive work with new API Viewer

It's not clear that the website is a wiki that can be edited by people with a dojofoundation.com account from the main page. The only information showing how to register is shown after clicking on the "login" link, which usually wouldn't occur to people who don't have an account. I didn't know about it until wildbill told me how to do it on IRC.

Adding some text indicating that the docs can be improved and edited if you register would help a lot to improve participation and involvement.

Currently, when types are specified in returned XML, and they refer to other Dojo Types, it does not automatically link to those pages within the reference guide. It should.

It would be better the relative URLs in examples (shown when you press the "view source" button) didn't have "_static" and were relative to the dojo directory's parent, to eliminate the step of setting up a directory called _static on the user's machine.

(from @peller and http://bugs.dojotoolkit.org/ticket/12102)

I am having issues with rstwiki CodeGlass recent changes on Chrome 17. I get the following in the console:

Resource interpreted as Script but transferred with MIME type text/x-js: "http://livedocs.dojotoolkit.org/_static/dojo/dojo.js".

And the CodeGlass pane come up blank and I don't get any other indication that there is an issue. This is both my local installation and the livedocs one, but everything seems to be perfectly merry in FF10.

It appears that the built wiki, some examples aren't working in IE because IE complains:

SCRIPT5: Access is denied.

This is normally a XD issue, but I checked in the debug console on one example and it was clearly trying to load a local resource of ../../_static/js/dojo/parser.js. It could be that this is going "outside" of the "zone" that IE thinks is safe, and so I potentially need to play with the baseUrl of the configuration to get the loader to not traverse too high up the stack. Other browsers seem to handle this fine.

I also need to confirm if this is an issue on rstWiki (livedocs).

If there is no code (e.g. the directive is just "stubbed out") the directive should not generate a CodeGlassMini widget. This avoids confusion where there appears to be an example, but there really isn't any there.

When searching for "dojo/on" the search feature of Sphinx does not return any meaningful results. I personally have noticed this with other AMD package names as well. Don't know if there is anything that can be done. Will investigate.

When I try to "sphinx-build -b html -d build/doctrees source build/html 2> build/warnings.txt" , the console report the error as tile.

I the "baseUrl = "http://api/rpc/1.8dojo/on"" in src/dojo.py, I donnot know what it is meaing.

A single instance of rstwiki should be able to manage and serve up multiple repos at the same time, so the following would be possible:

• http://localhost:4200/dojo/parser
• http://localhost:4200/1.8/dojo/parser
• http://localhost:4200/1.7/dojo/parser

Where the first two would be off the same document repo, but the last one would point at a different document repo (which would be a different checked out branch of the same git repo).

It should support editing and pushing on both repos.

In code glass I am getting issues when it tries to parse :djConfig: options... It appears it does not accept strings.

I haven't taken a look yet to see why/how it is broken (as my python isn't that good).

The following works:

  .. code-example ::
    :djConfig: async: true

The following doesn't work:

  .. code-example ::
    :djConfig: extraLocale: "en-gb"

Nor:

  .. code-example ::
    :djConfig: extraLocale: 'en-gb'

In both cases it throws some sort of error about string termination.

It has been suggested that the quick search in the built wiki be moved higher up the sidebar.