Hi.
The base documentation for Nevow is very well written (it is very unfortunate that Donovan Preston no longer maintain Nevow).
Is this documentation up to date with the current versione of twisted?
What are the most important missing features?
As I can see: - more detailed documentation of IRequest. As an example 200, 404 and 500 return code are automatically generated by Nevow (when rendering a resource, when returning None by locateChildren and bu raising an exception in a renderer, ***what else?***
- documentation of interfaces like IContainer, ISession and IRenderer, ICanHandleException, IHand?, ...
- more detailed documentation about context (remember, ...)
- documentation for macro - documentation for fragments - documentation for guard
- some interfaces are not documented at all (as ISettable, IStatusMessage, ...)
All this stuff is explained in the examples but it can help a lot to have them organized in a better way.
Thanks Manlio Perillo
Manlio Perillo manlio_perillo@libero.it writes:
Hi.
The base documentation for Nevow is very well written (it is very unfortunate that Donovan Preston no longer maintain Nevow).
Is this documentation up to date with the current versione of twisted?
What are the most important missing features?
As I can see:
- more detailed documentation of IRequest. As an example 200, 404 and 500 return code are automatically generated
by Nevow (when rendering a resource, when returning None by locateChildren and bu raising an exception in a renderer, ***what else?***
- documentation of interfaces like IContainer, ISession and IRenderer,
ICanHandleException, IHand?, ...
more detailed documentation about context (remember, ...)
documentation for macro
documentation for fragments
documentation for guard
some interfaces are not documented at all
(as ISettable, IStatusMessage, ...)
All this stuff is explained in the examples but it can help a lot to have them organized in a better way.
I also have a few suggestions for fairly minor edits that would improve the comprehensibility of these docs. Where should I report those?
On Wed, 31 May 2006 13:48:06 -0500, David Abrahams dave@boost-consulting.com wrote:
[ list of Nevow items that could use some more documentation ]
I also have a few suggestions for fairly minor edits that would improve the comprehensibility of these docs. Where should I report those?
http://divmod.org/trac would be a good place.
L. Daniel Burr
"L. Daniel Burr" ldanielburr@mac.com writes:
On Wed, 31 May 2006 13:48:06 -0500, David Abrahams dave@boost-consulting.com wrote:
[ list of Nevow items that could use some more documentation ]
I also have a few suggestions for fairly minor edits that would improve the comprehensibility of these docs. Where should I report those?
http://divmod.org/trac would be a good place.
Problem is, without a login there (I presume that's the problem) I can't submit a ticket.
On Wed, 31 May 2006 15:10:58 -0500, David Abrahams dave@boost-consulting.com wrote:
"L. Daniel Burr" ldanielburr@mac.com writes:
On Wed, 31 May 2006 13:48:06 -0500, David Abrahams dave@boost-consulting.com wrote:
[ list of Nevow items that could use some more documentation ]
I also have a few suggestions for fairly minor edits that would improve the comprehensibility of these docs. Where should I report those?
http://divmod.org/trac would be a good place.
Problem is, without a login there (I presume that's the problem) I can't submit a ticket.
True, but the "register" link is right there, waiting for you ;)
Seriously, I know some people hate registration etc, but currently this is the only way to create tickets, and tickets are the best way to ensure that things like documentation improvements get some attention.
Hope this helps,
L. Daniel Burr
"L. Daniel Burr" ldanielburr@mac.com writes:
On Wed, 31 May 2006 15:10:58 -0500, David Abrahams dave@boost-consulting.com wrote:
"L. Daniel Burr" ldanielburr@mac.com writes:
On Wed, 31 May 2006 13:48:06 -0500, David Abrahams dave@boost-consulting.com wrote:
I also have a few suggestions for fairly minor edits that would improve the comprehensibility of these docs. Where should I report those?
http://divmod.org/trac would be a good place.
Problem is, without a login there (I presume that's the problem) I can't submit a ticket.
True, but the "register" link is right there, waiting for you ;)
Seriously, I know some people hate registration etc, but currently this is the only way to create tickets, and tickets are the best way to ensure that things like documentation improvements get some attention.
It's not that; it's just that I've set up 6 trac servers recently and never seen a "register" link on any of them, so I didn't know to look for it. :)
Thanks
David Abrahams ha scritto:
[...]
All this stuff is explained in the examples but it can help a lot to have them organized in a better way.
I also have a few suggestions for fairly minor edits that would improve the comprehensibility of these docs. Where should I report those?
I'm actually writing some more documents - a chapter on basic rendering (renderHTTP) - a chapter on authentication (HTTP Basic and guard) - a chapter on SSL setup (just stolen from PostgreSQL documentation) - a chapter on Nevow templating for dummies (aka HTML monkeys) - a chapter on macros and fragments
When ready I will submit a ticket. But please note that I'm not a doc writer (nor a Nevow expert) and this documents will contains more questions then answers.
Regards Manlio Perillo
On 26-May-06, at 7:16 AM, Manlio Perillo wrote:
Hi.
The base documentation for Nevow is very well written (it is very unfortunate that Donovan Preston no longer maintain Nevow).
Is this documentation up to date with the current versione of twisted?
What are the most important missing features?
As I can see:
- more detailed documentation of IRequest. As an example 200, 404 and 500 return code are automatically
generated by Nevow (when rendering a resource, when returning None by locateChildren and bu raising an exception in a renderer, ***what else?***
- documentation of interfaces like IContainer, ISession and IRenderer,
ICanHandleException, IHand?, ...
more detailed documentation about context (remember, ...)
documentation for macro
documentation for fragments
documentation for guard
some interfaces are not documented at all
(as ISettable, IStatusMessage, ...)
All this stuff is explained in the examples but it can help a lot to have them organized in a better way.
There are a few extra gems you can find from here: http://divmod.org/trac/wiki/TitleIndex
I am not a project contributor, but if you notice anything that could be better (like a page that serves as a comprehensive documentation index) please add it to the wiki.
Beau
Beau Hartshorne ha scritto:
[...] I am not a project contributor, but if you notice anything that could be better (like a page that serves as a comprehensive documentation index) please add it to the wiki.
Thanks.
A few comments:
- some links on http://divmod.org/trac/wiki/DivmodNevow/UsefulLinks are broken - http://divmod.org/trac/wiki/DivmodNevow/FuturePlans seems a bit old - http://divmod.org/trac/wiki/DivmodNevow/Auth need more works.
However I prefer printable and complete documentation.
Regards Manlio Perillo
On 31-May-06, at 1:05 PM, Manlio Perillo wrote:
Beau Hartshorne ha scritto:
[...] I am not a project contributor, but if you notice anything that could be better (like a page that serves as a comprehensive documentation index) please add it to the wiki.
Thanks.
A few comments:
- some links on http://divmod.org/trac/wiki/DivmodNevow/UsefulLinks
are broken
- http://divmod.org/trac/wiki/DivmodNevow/FuturePlans seems a bit old
- http://divmod.org/trac/wiki/DivmodNevow/Auth need more works.
However I prefer printable and complete documentation.
For printable and complete documentation, check out this page: http://divmod.org/trac/wiki/DivmodFanClub
Beau
-
Beau Hartshorne -
David Abrahams -
L. Daniel Burr -
Manlio Perillo