733689 - Source-Code Documentation using mozmill-generated screenshots

Status: RESOLVED DUPLICATE of bug 506343

(Calendar :: General, enhancement)

Description

[Markus Adrario [:Taraman]]

This bug is to track development of a new way to document calendar-sourcecode.

The Idea is to use mozmill to generate html-pages with screenshots that contain links to the xul-sourcecode of the controls.
These pages can then be compiled during the build process to have automated up-to-date screenshots.

An example generated with this technique an be found here:
http://www.adrario.de/mozilla/doc/event-dialog.htm

At the moment this is early development.
If you want to try the latest patch, you can find it at:
hg.mozilla.org/users/Mozilla_Adrario.de/mq-patches/
The patch is called doc.diff

At the moment the path to save the screenshot has to be manually configured in calendar/documentation/doc-eventDialog.js

Comment 1

[Markus Adrario [:Taraman]]

updated the patch to have the save function available as method of the generated page.
the savePath has now to be configured in calDoc.jsm

included calendar-utils.js in the patch which was missing.

doc-eventDialog.js should now work in mozmill with the patch applied.

Comment 2

[Markus Adrario [:Taraman]]

I added a "test" to create a page for the month view.
With this some probles arise:
1.: the month view itself is not a window, but the screenshot function expects one. Workaround: use the whole TB-window.

2.: The monthview consists of custom bindings and the current function uses tag names to create the html-map. The custom bindings can't be accessed this way. Using box, hbox or vbox of which the view is composed is too general and gets no usable results.
I'll have to do some research on this.

I also moved the code to create the map into calDoc.jsm to be able to reuse it.

Comment 3

[Markus Adrario [:Taraman]]

So I started working on this again.
There is an update to the example page:
http://www.adrario.de/mozilla/doc/calendar-event-dialog.htm