Ringobot log - RingoJS IRC channel: #ringojs on irc.freenode.net
2010-08-30:
[7:26] <oberhamsi> had to add this line to get static, aliased files to be served http://github.com/oberhamsi/ringojs/commit/6ed2004e33[7:26] <oberhamsi> it's a security thing, but we should probably have an config option for it - or can it be set in jetty xml although we don't construct servlet their?
[8:52] <hannesw> Still here :)
[8:54] <hannesw> oberhamsi what is the aliases servlet parameter about?
[8:54] <hannesw> http://github.com/oberhamsi/ringojs/commit/6ed2004e33bdabadd7c93415ca6d72c02ea6d005
[8:58] <hannesw> working on non-promise async http responses today
[9:09] <oberhamsi> hannesw, it's about this http://docs.codehaus.org/display/JETTY/How+to+enable+serving+aliased+files
[9:09] <oberhamsi> for me: i want to serve symlinked files in static/
[9:10] <hannesw> I see. and this works?
[9:10] <oberhamsi> it works.
[9:10] <hannesw> I think I'll be switching most apps to static middleware for file serving
[9:10] <oberhamsi> i haven't tried that. which app does that for example?
[9:11] <hannesw> none so far
[9:12] <hannesw> but I'd like to use it for skeleton app and for demo app
[9:12] <hannesw> i much prefer it to the /static servlet
[9:14] <oberhamsi> okay, that solves my aliased problem. i like it, we have more control over how static gets served
[9:14] <earl> would be nice and somewhat more self-contained
[9:15] <hannesw> yes
[9:19] <oberhamsi> hannesw, how did you render apidocs with ringojs.org base.html? just moved the skin there? i want to improve that
[9:19] <hannesw> oberhamsi what do you mean? in previous dynamic setup?
[9:20] <oberhamsi> no right now, why does it not use jsdoc/skins/base.html
[9:20] <hannesw> I guess because it is rendered from within the ringojs.org app, and skin extends "skins/base.html"
[9:20] <hannesw> so it happens "naturally"
[9:21] <hannesw> the thing that's missing is the navigation bar - ringojs.org/skins/base.html has some convention for including that, but i forgot
[9:21] <oberhamsi> okay, i'll see what i can do
[9:21] <hannesw> i guess to render with ringos.org skin you'd have to prepend ringojs.org to module path
[9:22] <hannesw> require.paths.unshift(ringojsOrgHome)
[9:23] <hannesw> BTW, some differences between old and new jsdoc:
[9:23] <hannesw> http://ringojs.org/api/master/ringo/promise/
[9:23] <hannesw> http://ringojs.at/api/master/ringo/promise
[9:24] <hannesw> example is not rendered anymore
[9:24] <oberhamsi> arg i just noticed jsdoc is running without stylesheets
[9:24] <hannesw> and deferred is rendered as class
[9:24] <hannesw> yes but that's not the problem... -^
[9:25] <oberhamsi> okay example, i wanna fix the style problems first
[9:25] <hannesw> great!
[9:28] <earl> so i guess i leave the old stuff running for a while, to compare for other differences :) ?
[9:41] <oberhamsi> jsdoc works with any base.html as long as it does <% render %> menu & content subkins http://github.com/oberhamsi/ringojs/commit/4cafae61688
[9:41] <oberhamsi> works on my machine in ringojs.org setup
[9:46] <hannesw> oberhamsi cool, looks good!
[9:52] <oberhamsi> hannesw, thanks.. don't like the duplication much, but works for now
[9:52] <oberhamsi> example rendering fixed.. hehe trivial http://github.com/oberhamsi/ringojs/commit/42fc914080e94d
[9:53] <hannesw> you could fix duplication with another inheritance layer, but not really worth it :)
[9:53] <hannesw> great!
[10:53] <oberhamsi> promise docs now display correctly
[10:54] <oberhamsi> promise module is an odd case. and subclasses in general are something i didn't consider, they'll need more work to display correctly in all cases
[11:03] <hannesw> oberhamsi what do you mean by subclass?
[11:03] <hannesw> defer is really just an object with properties
[11:04] <oberhamsi> deferred.promise
[11:06] <oberhamsi> hannesw, hm...
[11:07] <oberhamsi> i think it's still wrong, but at least it looks like it did in old version
[11:08] <oberhamsi> here shouldn't deferred be a class Deferred http://ringojs.at/api/master/ringo/promise, then it can have a property promise
[11:13] <oberhamsi> okay this all doesn't make much sense. i'll show you how it looks simple and plain with two classes Deferred and Promise
[11:24] <oberhamsi> hannesw, like so http://i38.tinypic.com/205v86.jpg
[11:25] <hannesw> hm, that's ok, i guess
[11:26] <hannesw> yes, i just merged it, and it looks good now
[11:26] <oberhamsi> okay cool
[11:26] <hannesw> I like that the classes are called "deferred" and "deferred.promise"
[11:27] <oberhamsi> i didn't like that
[11:27] <oberhamsi> we can do Deferred.Promise if you insist :)
[11:28] <hannesw> i actually like lower case
[11:28] <hannesw> because there's no such constructor around
[11:28] <oberhamsi> yes, but it's strange to document instances imo
[11:28] <hannesw> why? you have to document them
[11:29] <hannesw> pushing your changes to github...
[11:29] <ringostarr> 6ed2004 Simon Oberhammer: allow serving aliased static files
[11:29] <ringostarr> 4cafae6 Simon Oberhammer: jsdoc base.html easier to replace, must only provide content & menu render.
[11:29] <ringostarr> 42fc914 Simon Oberhammer: jsdoc display an item's example as <pre> code
[11:29] <ringostarr> c1da25f Simon Oberhammer: jsdocserializer respects subclasses, e.g.: deferred.promise
[11:29] <ringostarr> b937e31 Simon Oberhammer: remove obsolete return
[11:29] <hannesw> btw, did you look at the git pull issue?
[11:30] <oberhamsi> i guess what earl said would fix it.. issue the two commands instead of simple git pull, didn't try though
[11:30] <hannesw> ringojs.org git repo is updated, but files are not changed but rather left in their old state and marked as dirty...
[11:31] <oberhamsi> i don't like that at all http://ringojs.org/api/master/ringo/promise/index.html
[11:31] <oberhamsi> imo it's much cleaner to document the classes involved
[11:32] <oberhamsi> You end up doing that in the text: "The deferred is a JavaScript object with two properties: a promise object and a resolve function."
[11:32] <hannesw> oberhamsi that's the old broken version
[11:32] <oberhamsi> oh okay
[11:33] <hannesw> what's the easiest way to trigger a rebuild?
[11:33] <oberhamsi> 6ed2004 not sure we want that... it's a security problem at least on windows boxes
[11:34] <hannesw> really? windows doesn't have symlinks
[11:34] <oberhamsi> jetty wiki says so.. it's more about this expansion of 8.3 files ... like C:/Program~1/
[11:34] <oberhamsi> and other stuff i didn't get
[11:34] <oberhamsi> rebuild: cd to ringojs.org app directory
[11:34] <oberhamsi> startup ringo
[11:35] <oberhamsi> include('jsdoc/doc')
[11:35] <ringostarr> 42fc914 Simon Oberhammer: jsdoc display an item's example as <pre> code
[11:35] <ringostarr> c1da25f Simon Oberhammer: jsdocserializer respects subclasses, e.g.: deferred.promise
[11:35] <ringostarr> b937e31 Simon Oberhammer: remove obsolete return
[11:35] <hannesw> ok, master jsdoc is updated: http://ringojs.org/api/master/ringo/promise/index.html
[11:35] <hannesw> side bar is positioned too low...
[11:36] <earl> ew, index.html ...
[11:36] <oberhamsi> trigger re-render: renderRepository(webHookConfig.jsdoc.repository, webHookCofnig.jsdoc.exportDirectory)
[11:36] <hannesw> and @example is rendered on each function now
[11:37] <hannesw> but we're getting there
[11:37] <earl> even on those which don't have an @example ..
[11:37] <oberhamsi> yep i fixed that in one of last comments
[11:37] <oberhamsi> *commits
[11:37] <oberhamsi> arg... or not..
[11:38] <oberhamsi> now i did push.. you cherrypicked :) http://github.com/oberhamsi/ringojs/commit/ca07975cd
[11:38] <oberhamsi> ah crap but with stylesheet that needs another fix.. hold on
[11:45] <robi42> hm, should static docs generator replace markdown with markup?
[11:47] <robi42> (for example, links)
[11:50] <hannesw> yes, but for [xxx][target] to work we'd have to override Markdown.resolveLink()
[11:50] <hannesw> and i don't know if that's a good idea
[11:50] <robi42> ok
[11:51] <hannesw> rewriting the links as [xxx](target) should work as well
[11:52] <oberhamsi> yes i noticed that... [xx](#bla) works
[11:52] <robi42> alright, so that's easily fixable then :)
[11:53] <hannesw> not sure, maybe we should resolve [xxx][function] - maybe we need to do that for cross-module links?
[11:53] <hannesw> something to consider
[11:54] <robi42> are there any cross-module links currently?
[11:55] <hannesw> oberhamsi should we undo the alias/static commit?
[11:55] <oberhamsi> hannesw, yes pls undo
[11:55] <robi42> ah, http://ringojs.org/api/master/fs/index.html seems to link to fs-base (broken)
[11:55] <oberhamsi> robi42, you can do relative links like [Skins](../skin/) ... but that's not perfect
[11:57] <oberhamsi> cross module would be nice, also for @see
[11:58] <hannesw> One idea:
[11:58] <hannesw> Add @fileOverview comments to all modules that don't have them
[11:59] <ringostarr> ca07975 Simon Oberhammer: jsdoc drop example heading
[11:59] <ringostarr> 91fcb92 Simon Oberhammer: improve promise jsdoc api
[11:59] <ringostarr> 927ce52 Hannes Walln?fer: Revert "allow serving aliased static files"
[12:16] <ringostarr> 78f9d9b Simon Oberhammer: jsdoc extract example into subskin for clean rendering
[12:16] <ringostarr> 33ca9e4 Simon Oberhammer: jsdoc menu not css forced down; prettier in ringojs.org context
[12:17] <ringostarr> 927ce52 Hannes Walln?fer: Revert "allow serving aliased static files"
[12:17] <ringostarr> 78f9d9b Simon Oberhammer: jsdoc extract example into subskin for clean rendering
[12:17] <ringostarr> 33ca9e4 Simon Oberhammer: jsdoc menu not css forced down; prettier in ringojs.org context
[12:26] <ringostarr> 927ce52 Hannes Walln?fer: Revert "allow serving aliased static files"
[12:26] <ringostarr> 78f9d9b Simon Oberhammer: jsdoc extract example into subskin for clean rendering
[12:26] <ringostarr> 33ca9e4 Simon Oberhammer: jsdoc menu not css forced down; prettier in ringojs.org context
[12:27] <ringostarr> 927ce52 Hannes Walln?fer: Revert "allow serving aliased static files"
[12:28] <ringostarr> 78f9d9b Simon Oberhammer: jsdoc extract example into subskin for clean rendering
[12:28] <ringostarr> 33ca9e4 Simon Oberhammer: jsdoc menu not css forced down; prettier in ringojs.org context
[13:36] <ringostarr> ff4b821 Simon Oberhammer: jsdoc includes style.css only in base to be embeddable in other base
[13:36] <ringostarr> f9e6097 Hannes Walln?fer: Revert "jsdoc menu not css forced down; prettier in ringojs.org context"
[13:39] <hannesw> this is the markdown render function that worked in 0.5:
[13:39] <hannesw> http://github.com/ringo/ringojs/blob/v0.5.0/apps/jsdoc/helpers.js#L216-222
[13:39] <hannesw> in case anybody wants to fix this
[14:10] <emilis_info> is there any convention for storing config values for specific modules?
[14:23] <ringostarr> d522f4d Hannes Walln?fer: Allow setting timeout for async JSGI via promise.timeout
[14:23] <ringostarr> 49826f4 Hannes Walln?fer: Major cleanup of Response helper class.
[14:52] <ringostarr> 8a6a1ce Hannes Walln?fer: First batch of missing @fileOverview docs.
[14:57] <ringostarr> 21956c4 Hannes Walln?fer: Jsdoc cleanup, hide Narwhal compatibility API.
[23:58] <ringostarr> 523995f Hannes Walln?fer: Some code reorg in ringo/jsgi in support of streaming async responses
[23:59] <ringostarr> 1339b8e Hannes Walln?fer: Implement AsyncResponse
