Maven Doxia

Improve the AptParser class

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Won't Fix
  • Affects Version/s: 1.0-alpha-8
  • Fix Version/s: None
  • Component/s: Core
  • Labels:
    None
  • Number of attachments :
    1

Description

This patch provides some improvements for the AptParser:

  • support of the pagebreak, ie ^L
  • support of tableHeaderCell() call
  • improve the tableCaption() call

Activity

Hide
Brett Porter added a comment -

Vincent, I don't understand this patch.

  • \f should continue to be supported, as that's the real CTRL-L. We can support a physical ^L as well, but that's not normally how it should worl.
  • I don't understand what was wrong with table header cells - they worked for me in APT in the past.
  • I don't understand why the caption is placed outside of the table instead of inside?
Show
Brett Porter added a comment - Vincent, I don't understand this patch.
  • \f should continue to be supported, as that's the real CTRL-L. We can support a physical ^L as well, but that's not normally how it should worl.
  • I don't understand what was wrong with table header cells - they worked for me in APT in the past.
  • I don't understand why the caption is placed outside of the table instead of inside?
Hide
Vincent Siveton added a comment -

Brett,

> - \f should continue to be supported, as that's the real CTRL-L. We can support a physical ^L as well, but that's not normally how it should worl.

Agree

> - I don't understand what was wrong with table header cells - they worked for me in APT in the past.

With APT, no table header cell will be rendered (like Xdoc).
See the differences on the tables:
XDOC
http://maven.apache.org/development-process.html (Best-Practice Documents part)
APT
http://maven.apache.org/download.html (Download Maven 2.0.3 part)

With this patch, some pages should be reviewed. For instance, http://maven.apache.org/ant-tasks.html (Task Reference part)

> - I don't understand why the caption is placed outside of the table instead of inside?

The caption is recognised as a line. I had got a java.lang.ClassCastException when using DOXIA-53.

Show
Vincent Siveton added a comment - Brett, > - \f should continue to be supported, as that's the real CTRL-L. We can support a physical ^L as well, but that's not normally how it should worl. Agree > - I don't understand what was wrong with table header cells - they worked for me in APT in the past. With APT, no table header cell will be rendered (like Xdoc). See the differences on the tables: XDOC http://maven.apache.org/development-process.html (Best-Practice Documents part) APT http://maven.apache.org/download.html (Download Maven 2.0.3 part) With this patch, some pages should be reviewed. For instance, http://maven.apache.org/ant-tasks.html (Task Reference part) > - I don't understand why the caption is placed outside of the table instead of inside? The caption is recognised as a line. I had got a java.lang.ClassCastException when using DOXIA-53.
Hide
Jason van Zyl added a comment -

You guys figure this out or shall we unschedule it for 1.0?

Show
Jason van Zyl added a comment - You guys figure this out or shall we unschedule it for 1.0?
Hide
Brett Porter added a comment -

I don't think the patch has been updated after the feedback, so it can be unscheduled.

Show
Brett Porter added a comment - I don't think the patch has been updated after the feedback, so it can be unscheduled.
Hide
Lukas Theussl added a comment -

I think this should be closed won't fix.

  • aptconvert doesn't recognize a physical ^L as a pagebreak, so it shouldn't be allowed
  • the order where a table caption is emitted is irrelevant for the parser (as long as it's the same for all parsers), it's the corresponding sinks that have to put the caption in the right place. We need to think to install a testing mechanism to ensure that all parsers emit events in the same order.
  • there is still something fishy about apt table parsing, but the above patch doesn't solve that for me, I will open a separate issue.
Show
Lukas Theussl added a comment - I think this should be closed won't fix.
  • aptconvert doesn't recognize a physical ^L as a pagebreak, so it shouldn't be allowed
  • the order where a table caption is emitted is irrelevant for the parser (as long as it's the same for all parsers), it's the corresponding sinks that have to put the caption in the right place. We need to think to install a testing mechanism to ensure that all parsers emit events in the same order.
  • there is still something fishy about apt table parsing, but the above patch doesn't solve that for me, I will open a separate issue.
Hide
Vincent Siveton added a comment -

As described

Show
Vincent Siveton added a comment - As described

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: