[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Consistent formating long descriptions as input data (Was: RFC: Better formatting for long descriptions)

On Tue, 21 Apr 2009, Don Armstrong wrote:

There's no point to defining rules without a working implementation,
because we don't know what the rules should be.

So I tried to do an implementation for the tasks pages of Blends which
works for unordered lists as discussed here and I also made sure that
URLs will be handled by markdown correctly (just used
  re.sub('<*([fh]t?tp://[-./\w?=~;&]+)>*', '[\\1](\\1)', line)
for the input).

Once there is a
working implementation that works for a reasonable majority of the
descriptions, we can define rules based on the implementation, and
then file bugs against those few descriptions which are problematic
according to the rules.

This implementation shows that markdown needs at least one more
preprocessing step: Concerning the "other reasons" for verbatim
printing, which means if you are not in a list but there are more
than one space in the beginning of a line, replace the first space
by a tab or four spaces.  This needs a leading empty line as well
as the lists as I found.  If you are interested I have a Python
implementation of this which works (at least for the cases I
observed - see the links below).  In case we might accept markdown
as a standard it might make sense to move this to python-apt or
something like this.

What you appear to be calling the next step (getting a working
implementation) is actually the first step from my perspective (and is
presumably shared by others.)

I perfectly respect your opinion even if I do not share it myself
but I hope we might meet in the middle of both ends.

On Tue, 21 Apr 2009, Holger Levsen wrote:

Perfect is the enemy of good.

... so I hope you like the stuff. ;-)

For comparison of the change you might like to compare two links
which show a working list and a working verbatim text one page:

  http://debian-med.alioth.debian.org/tasks/bio#fastlink  (old)
  http://debian-med.debian.net/tasks/bio#fastlink         (new)

Looking at these pages we might consider defining another preformating
rule to enable description lists - but I guess we might run another
bunch of circles if we continue on the road I started to go.

You might be interested in comparing Debian Edu

  http://blends.alioth.debian.org/edu/tasks               (old)
  http://blends.debian.net/edu/tasks                      (new)

Nitpicking comment: Please note that I do NOT like the currently used
CSS style for the lists.  The design was done by David Paleino for the
general page navigation (where it looks cute) but I would change it
definitely for the description layout.  I delay this a bit until the
other parts of the code which are using the style are adapted first.

Kind regards


PS: Thanks to Raphael Hertzog python-markdown was installed on alioth
    immediately after my request.  I'd like to use this chance to say
    thanks to those admins publicly.


Reply to: