OxJS: Add Example Browser

rlx commented

2012-01-18 15:12:16 +00:00

Owner

This would be integrated in Ox.DocPage / Ox.DocPanel. Each Widget would have a documentation tab and an examples tab, which itself would have the one state that is Documentation + Source Code and one state that is the actual Demo, in an iframe, ideally with an expandable events log panel. Examples would be in /documentation/Ox.WidgetName/Example Name/Example Name.js (+ eventual json files etc) and parsed similarly to the documentation. An initial comment in the JS would serve as the introduction.

This would be integrated in Ox.DocPage / Ox.DocPanel. Each Widget would have a documentation tab and an examples tab, which itself would have the one state that is Documentation + Source Code and one state that is the actual Demo, in an iframe, ideally with an expandable events log panel. Examples would be in /documentation/Ox.WidgetName/Example Name/Example Name.js (+ eventual json files etc) and parsed similarly to the documentation. An initial <OxDoc> comment in the JS would serve as the introduction.

rlx added the

oxjs

label 2012-01-18 15:12:16 +00:00

rlx self-assigned this 2012-01-18 15:12:16 +00:00

rlx added the

major

enhancement

labels 2012-01-18 15:12:16 +00:00

rlx added this to the 12.03 milestone 2012-02-01 14:00:16 +00:00

rlx commented

2012-04-01 21:23:01 +00:00

Author

Owner

The following is more practical:

/examples/name_of_the_example/index.html

Title derived from

The following is more practical: /examples/name_of_the_example/index.html Title derived from <title> Widgets derived from <meta name="keywords"> Examples browser like /readme browser An example is its source code, with text as comments. One can run it, but this happens in a new tab. In the <DocPanel>, the examples for each widgets are listed (inline, as part of the <DocPage>) Maybe rename what is now called "examples" to "tests".

rlx added the

fixed

label 2012-04-19 10:20:07 +00:00

rlx closed this issue

2012-04-19 10:20:07 +00:00

OxJS: Add Example Browser #257