Minimally required set of functionality
Kevin Dangoor
It seems to me that once pages can be added and edited, we can deploy
Docudo at Docudo.org and try it out. We're pretty close to that,
aren't we?
Kevin
--
Kevin Dangoor
Author of the Zesty News RSS newsreader
email: k...@blazingthings.com
company: http://www.BlazingThings.com
blog: http://www.BlueSkyOnMars.com
Mike Orr
>
> Hi,
>
> It seems to me that once pages can be added and edited, we can deploy
> Docudo at Docudo.org and try it out. We're pretty close to that,
> aren't we?
The main issue is how we're going to migrate existing pages if the
storage format changes. I haven't had a chance to see what's been
done this week so I don't know if this has stabilized.
--
Mike Orr <slugg...@gmail.com>
(m...@oz.net address is semi-reliable)
Mike Orr
> On 3/9/06, Kevin Dangoor <dan...@gmail.com> wrote:
> >
> > Hi,
> >
> > It seems to me that once pages can be added and edited, we can deploy
> > Docudo at Docudo.org and try it out. We're pretty close to that,
> > aren't we?
>
> The main issue is how we're going to migrate existing pages if the
> storage format changes. I haven't had a chance to see what's been
> done this week so I don't know if this has stabilized.
I actually had a use for this yesterday. I started an article
analyzing the code execution in TG, and I made it XHTML so it would
fit with the future documentation. As I was thinking about where to
put it so I could edit it from home and work, what the XHTML type
declaration was, and how boring it gets typing <p> and style=..., I
kept thinking, Docudo would do all this... but the Docudo site isn't
up yet.
I got the XHTML line by running:
tidy --asxhtml </dev/null >turbogears_anatomy.html
which gave me a well-formed empty document.
Joel Pearson
>>It seems to me that once pages can be added and edited, we can deploy
>>Docudo at Docudo.org and try it out. We're pretty close to that,
>>aren't we?
Mike Orr wrote:
> The main issue is how we're going to migrate existing pages if the
> storage format changes. I haven't had a chance to see what's been
> done this week so I don't know if this has stabilized.
I just committed some changes that address the storage format. A
document's category, state, and tags are now stored in the document's meta
tags. These fields can be edited, but only (as yet) using simple text
input fields with no validation. (The edit method can't validate them,
because it doesn't yet know what the allowed values are.) It's functional,
but strictly on a "simplest thing that could possibly work" basis. And the
program as a whole could use some serious help with the user interface to
make it more presentable.
How about storing the valid categories and states in the settings file?
For example:
docudo.category = 'tutorial reference contributed'.split()
docudo.category_default = 'contributed'
docudo.state = 'official unofficial draft imported'.split()
docudo.state_default = 'unofficial'
Other recent changes:
* Subversion and pysvn no longer required. Specifically, they're
required/used only when docudo.svn_direct_connect is set True.
* now replaced with   (until a more complete solution for HTML
entities is found.)
* started using the "file, document, page" terminology discussed
previously. However, only a few changes have been made, so right now the
code is perhaps even less consistent than before.
* The concept of a document is temporarily implemented using a dict; it
really should be implemented as an object, as previously suggested by Mike.
- Joel
--
Joel Pearson
jo...@pythonica.com
Kevin Dangoor
> I just committed some changes that address the storage format. A
> document's category, state, and tags are now stored in the document's meta
> tags. These fields can be edited, but only (as yet) using simple text
> input fields with no validation. (The edit method can't validate them,
> because it doesn't yet know what the allowed values are.) It's functional,
> but strictly on a "simplest thing that could possibly work" basis. And the
> program as a whole could use some serious help with the user interface to
> make it more presentable.
Hopefully, we can convince Karl or Richard to spruce up the appearance.
> How about storing the valid categories and states in the settings file?
> For example:
> docudo.category = 'tutorial reference contributed'.split()
> docudo.category_default = 'contributed'
> docudo.state = 'official unofficial draft imported'.split()
> docudo.state_default = 'unofficial'
The config files are changing from Python format. You'll still be able
to do a list with commas, eg:
docudo.category = tutorial, reference, contributed
Good changes. Thanks, Joel!
Let me know when to pull the trigger and set this up somewhere.
Steven Kryskalla
> * now replaced with   (until a more complete solution for HTML
> entities is found.)
I commited a module (clean.py, with a test in tests/test_clean.py) that
will handle conversion of the 252 named entities.
you can use it like this:
clean.convert_named_entities("<body><p>Hello World!</p><p>©
me 2006</p></body>")
and it will return:
"<body><p>Hello World!</p><p>© me 2006</p></body>"
Feel free to insert it wherever makes most sense in controllers.py
Steve
Joel Pearson
>>How about storing the valid categories and states in the settings file?
>>For example:
>>docudo.category = 'tutorial reference contributed'.split()
>>docudo.category_default = 'contributed'
>>docudo.state = 'official unofficial draft imported'.split()
>>docudo.state_default = 'unofficial'
Kevin Dangoor wrote:
> The config files are changing from Python format. You'll still be able
> to do a list with commas, eg:
>
> docudo.category = tutorial, reference, contributed
ConfigObj looks like a good choice. Am I correct in thinking that Docudo
should run on TG releases, rather than trying to follow the TG svn trunk?
If so, we would continue using the current config format for now,
upgrading it once ConfigObj appears in a TG release. (Looks easy enough.)
> Let me know when to pull the trigger and set this up somewhere.
Here's the minimum that needs to happen before I'd feel comfortable
putting Docudo in front of a live audience:
- significant improvement of the appearance and user interface
- add the new config variables, as shown above
- change edit to use widgets that display and validate using the new variables
- fix the HTML entity problem (whoa, Steve Kryskalla checked an entity
conversion module while I was typing that! Let's try that again... I need
a new car... rats, it didn't work this time... ;-)
- a first security review (Which inputs should be HTML-escaped? Which
methods should be exposed? Which inputs validated? etc.)
Also needed, but not required before going live:
- change the document dict into a document object
- some working tests
- change method and variable names to follow the file/document/page
terminology discussed previously
I won't be able to get back to this for most of a week, so I hope that
others will be able to jump in and keep things moving.
Joel Pearson
> I commited a module (clean.py, with a test in tests/test_clean.py) that
> will handle conversion of the 252 named entities.
>
> you can use it like this:
> clean.convert_named_entities("<body><p>Hello World!</p><p>©
> me 2006</p></body>")
>
> and it will return:
> "<body><p>Hello World!</p><p>© me 2006</p></body>"
>
> Feel free to insert it wherever makes most sense in controllers.py
>
> Steve
It looks good. Thanks!
Kevin Horn
I'm _hoping_ to get some time in the next week to catch up with all the changes and then to start helping out again. Sorry if I dropped off a while, but I've been moving, and it took me a while to find this group...as there's no real online "home" for Docudo yet.
Speaking of which, should there be one? Perhaps just a single page for now, mentioning what Docudo is, this mailing list, etc.? Just a thought.
Kevin H.
Kevin Dangoor
> putting Docudo in front of a live audience:
> - significant improvement of the appearance and user interface
> - add the new config variables, as shown above
> - change edit to use widgets that display and validate using the new variables
> - fix the HTML entity problem (whoa, Steve Kryskalla checked an entity
> conversion module while I was typing that! Let's try that again... I need
> a new car... rats, it didn't work this time... ;-)
> - a first security review (Which inputs should be HTML-escaped? Which
> methods should be exposed? Which inputs validated? etc.)
Actually, I really don't think any of that needs to be done before we
put it up at Docudo and use it to start documenting itself. We
wouldn't *announce* it anywhere, but the sooner we start using it, the
sooner the little irritants crop up and magically disappear :)
Kevin
Joel Pearson
> Actually, I really don't think any of that needs to be done before we
> put it up at Docudo and use it to start documenting itself. We
> wouldn't *announce* it anywhere, but the sooner we start using it, the
> sooner the little irritants crop up and magically disappear :)
Well, okay. But we're all sworn to secrecy about the Docudo site's
existence until the program at least *looks* better... :-)