Re: XML conformance, docstrings and index-flavour

On Mon, 2003-08-18 at 19:16, Rune Morling wrote:
> First of all: Thanks for a great piece of software, I love it!

Thank you :)

> There are, however, a few issues which I feel should be adressed:

Show me your worst :)

> 1. Make all formatting in PyBlosxom and its plugins X(HT)ML conformant.
>    As the web matures and moves on to solid, non-ambigous XML-based
>    content, a (mini) CMS such as PyBlosxom should definitely output
>    XML too.

For the case of <br>s Will and myself has committed this in, though not
in the rc1 release. I'm not sure what else breaks XHTML compliance (I
know my site is 100% non-xhtml compliant)

> 2. Proper docstrings in plugins. Will and Wari (and others too) have
>    made a habit of including good docstrings in their code. It really
>    *IS* a sign of a job well done to take care of this. If you don't
>    care enough about your code to document it properly, then don't 
>    submit it either. As simple as that.

Thanks for the good word, we put that in so that:
1. We can read what we did a while ago
2. Other people can read it too :)

> 3. I'd really like to see an example index flavour included in the
>    main PyBlosxom distribution, seeing that it is so effective on
>    roughingIt. If this is not going to happen, would someone perhaps
>    walk me through setting up a decent index-flavour?

The index flavour is just a symlinked head and foot.html, and a very
stripped down version of story.html, see
http://roughingit.subtlehints.net/pyblosxom/coolStuff/index_flavour.html
for an example. This idea was not mine, Rael pioneered it :)


-------------------------------------------------------
This SF.Net email sponsored by: Free pre-built ASP.NET sites including
Data Reports, E-commerce, Portals, and Forums are available now.
Download today and enter to win an XBOX or Visual Studio .NET.
http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01