You are here: Foswiki>Tasks Web>Item5215 (01 Feb 2013, GeorgeClark)Edit Attach

Item5215: Add unit test for deprecated definition list syntax.

pencil
Priority: Low
Current State: Closed
Released In: 1.1.7
Target Release: patch
Applies To: Engine
Component: Documentation, UnitTestContrib
Branches: Release01x01 trunk
Reported By: TWiki:Main.ChrisFLewis
Waiting For:
Last Change By: GeorgeClark
When using a colon in a list item that spans multiple-lines, the colon will incorrectly force a line-break.

This code:
   * This is a list that will break%BR%
   Dates: 01/01/08 - 02/02/08

   * This is a list that will render correctly, as it doesn't have a colon.%BR%
   Dates 01/01/08 - 02/02/08

Creates:
  • This is a list that will break
Dates
1/01/08 - 2/02/08

  • This is a list that will render correctly, as it doesn't have a colon.
    Date 1/01/08 - 2/02/08

This behaviour isn't mentioned in TWiki:TWiki/TextFormattingRules, so I can only assume it's a bug.

-- TWiki:Main/ChrisFLewis - 06 Jan 2008

This is actually an undocumented legacy feature. TWiki used to have this definition for definition lists: Three spaces, term, colon, space, defintion. Your example with "Date" matches that pattern.

See old syntax defined at http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules?rev=51

We need to support legacy content (there are tens of millions of pages out there.)

Workaround: Add one or two more spaces before "date".

-- TWiki:Main.PeterThoeny - 06 Jan 2008

re-opening, as there are 3 spaces before the "date".

-- SvenDowideit - 07 Jan 2008

even presuming that we should continue to support this format, it would then need to be documented, and a unit test added.

So either way, it needs actioning.

-- TWiki:Main.SvenDowideit - 07 Jan 2008

  • This is a list that will not break
    Dates: 01/01/08 - 02/02/08

This bug is about one space more or less, right? We have more than one problem with spaces in TWiki. frown, sad smile IMHO this one doesn't classify as release blocker.

-- TWiki:Main.FranzJosefGigler - 07 Jan 2008

It is documented also in the current TextFormattingRules and clearly marked as deprecated syntax.

Adding a unit test. Noone will argue against that. Maybe it is already there? Like the doc. But it is for sure not a release blocker now we know that it is properly documented.

Changed the headline to the current nature of the bug.

-- TWiki:Main.KennethLavrsen - 07 Jan 2008

I came here to report this as a bug, but it seems that it's a known issue. However, contrary to Kenneth's claim that it's clearly documented and marked as deprecated does not appear to be the case at present (otherwise, I wouldn't be here trying to report it as a bug). The TextFormattingRules topic only state:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

I think that legacy support is fine, but it should be documented in TextFormattingRules.

-- MyqLarson - 03 Jan 201

Documentation has been updated, and a unit test added. I missed this for 1.1.7-RC2, but it will be in the final release.

-- GeorgeClark - 07 Jan 2013

ItemTemplate edit

Summary Add unit test for deprecated definition list syntax.
ReportedBy TWiki:Main.ChrisFLewis
Codebase 1.1.6, trunk
SVN Range
AppliesTo Engine
Component Documentation, UnitTestContrib
Priority Low
CurrentState Closed
WaitingFor
Checkins distro:9c51612888ac distro:ff848e26c527
TargetRelease patch
ReleasedIn 1.1.7
CheckinsOnBranches Release01x01 trunk
trunkCheckins distro:ff848e26c527
Release01x01Checkins distro:9c51612888ac
Topic revision: r11 - 01 Feb 2013, GeorgeClark
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy