Re: [Plone-docs] Should we upgrade structured text to HTML?

[Alexander L. <li...@pl...>]

On Wed, 23 Aug 2006 02:36:12 -0700, Jean Jordaan  
<je...@up...> wrote:

> Thanks :-)  A slew of bug reports at e.g. Plone and
>   http://sourceforge.net/tracker/?group_id=38414&atid=422030
> would be even more useful.

SF.net bug trackers are too painful for me this week. ;)

Feel free to report them or help getting patches in.

> If the first in the document is this:
>
> ==================================
> Stappe vir die maak van 'n release
> ==================================
>
> then I get the title class. I don't think that's too bad as a convention.

Yup, that's acceptable. I still think it should be "rest-title" or  
something that would avoid namespace collisions with the rest of your CSS.

> That's what they're supposed to do. If you're using them for a sequence
> of email addresses, or for a poem, you *want* every thing (address or  
> line)
> to be a seperate element. To get blocks, I use :: at the end of a line,  
> and
> get:
>
> <p>Deploy:</p>
> <pre class="literal-block">tmp $ scp CremeNG-1.0.18.tar.gz
> up...@em...:~/distfiles/
> upfront@diepdink upfront $ scp distfiles/CremeNG-1.0.18.tar.gz \
>   emss.de:~/distfiles/
> </pre>


>> OMFG. What is going on here? teletype tag, with class "docutils literal"
>> and with a SPAN WITH CLASS "PRE" AROUND EACH ELEMENT? WTF?
>
> If I convert to XML instead of to HTML, I get e.g.:
>
>   <literal>rel-1_0- branch</literal>
>
> which tells me that at least the reSt parsing is sane, but the HTML
> representation is lame.

Yup, it's the HTML representation I *do* have a beef with, and the reason  
for my ranting in the first place. Even Structured Text (STX) gets these  
things right. :)

> which got me:
>
> """
> <p>sadfasdf</p>
> <blockquote>
>
> asdfsadf
> asdfasdf</blockquote>
> <p>asdfasdf</p>
> """

Much saner (still wrong IIRC - I think it needs a p tag in the blockquote  
in XHTML, it may just be in Strict mode, though). Why does it not do this  
on my page on plone.org?

> <table class="docutils" border="1">
> <colgroup>
> <col width="37%"><col width="32%"><col width="32%">

Why is it inserting visual formatting like borders and column widths?

> Sure it's picky about lining things up, but I don't think that can really
> be avoided.

That's OK, I probably mis-pasted.

> <table class="docinfo" frame="void" rules="none">
> <col class="docinfo-name"><col class="docinfo-content">
> <tbody valign="top">
> <tr><th class="docinfo-name">Author:</th>
> <td>Tony J. (Tibs) Ibbs,
> David Goodger</td></tr>
> <tr><th class="docinfo-name">Author:</th>
> <td>(and sundry other good-natured folks)</td></tr>
>
> The chicken is that field names matter. In your case "Author list" wasn't
> recognized, and in the original example, "Dedication" isn't recognized,  
> so
> I substituted Author for the sake of markup.

Still doesn't explain the frame/rules stuff. And why are some field names  
recognised, and not others? Where is this list defined?

> Errors are written to stdout, so the converter should be able to see that
> there's problems and fail validation:
>
> jean@blommie ~ $ rst2html.py work/tmp/demo.rst > /dev/null
> work/tmp/demo.rst:4: (WARNING/2) Title underline too short.

So then Plone should really show a validation error instead of saving the  
content when errors like this show up.


-- 
_____________________________________________________________________

      Alexander Limi · Chief Architect · Plone Solutions · Norway

  Consulting · Training · Development · http://www.plonesolutions.com
_____________________________________________________________________

       Plone Co-Founder · http://plone.org · Connecting Content
   Plone Foundation · http://plone.org/foundation · Protecting Plone