Issue #SCB2552 (Reopened) Preserve entered newlines when rendering wiki style

Hussayn Dabbous <[email protected]> Thu, 1 Jan 2009 23:01:00 +0100 (CET)
Newsgroups gmane.comp.java.scarab.issues
Message-ID <[email protected]>
Activity report on

  *Enhancement SCB2552 - Preserve entered newlines when rendering wiki style*

  Scarab Link: http://www.solitone.org/scarab/issues/id/SCB2552
  Module: Scarab


  Activity generated by Hussayn Dabbous ([email protected]) at 01/01/2009 22:48

  *Reasons for the changes*
  - I am not convinced that the provided solution is feasible, see my comment.


  *Attribute changes*
  - Status: Reopened (Resolved)

-------------------------------------------------------------------------------
  *Comments*
  - By Hussayn Dabbous - 01/01/2009 22:50 ---
  "I am about to add an embedded documentation for the wiki syntax into Scarab
within my attempt to clean up and extend Scarab's wiki-features"

  - By Hussayn Dabbous - 01/01/2009 22:48 ---
  "After digging into the Wiki engine myself, i get very unhappy with the solution
provided here.


1.) It breaks table implementations

I.e. the upcoming creole-1.0 table syntax will be :

|=table |= header|
|table   | row       |
|next    | row       |

When the generic \n duplicator enters the scene, the table will be rendered in a wrong way. 
In fact we will see 3 tables instead of one then.
The same is true regarding the allready built in radeox table macro. 
Your patch also breaks this macro.

2.) it breaks wiki-standards

For a comprehensive discussion about that, see http://www.wikicreole.org/wiki/Newlines

I am very concerned when it comes to derivations from the obvious. Yes, i often want to just hit a newline and get exactly that.
But i also want the exact oposite behaviour (ignore my newlines and render my stuff as one single paragraph without newlines).


Having said this, i now see, that the Scarab way is to implement different customizable engine syntaxes.
At this moment we do have 3 fixed ones and IMHO they should be well defined. And as far as i know, 
the 3 models do exactly what i describe here:

1.) plain text
Just print out the text as entered. no markup at all, except automatic hyperlinks to other 
issues on the same scarab instance

2.) pseudo HTML
convert text layout to html layout:

\n should be translated to <br/>
\n\n should be translated to a new <p>

Nothing else should be done in this mode.

3.) wiki
convert according to a wiki-syntax. I think our best bet is to use creole-1.0. Many wikis
are compliant to this standard and on top of it the standard seems to be the result of some
serious thinking about good syntaxes.


If we need something different, we should allow to add more wiki-syntaxes at some day
in the future. But for now i strongly opt for keeping with one standard. For me it makes much 
sense to make "Scarab creole-1.0 compliant" and advertise that on the Scarab home-page.
At least a first step towards stringent decisions and product modernising.
"

  - By Hussayn Dabbous - 01/01/2009 22:55 ---
  "There is one not trivial but fully working solution for your goal:
radeox can be configured to behave as wanted, i.e. treat \n as
newlines. This would work if the newline filter would be applied 
after the tables-filter. So when the tables get rendered, the needed
line breaks ("\n") are still at place. Later when the newline filter 
is applied, the tables are already rendered, hence all remaining plain text
will be rendered as expected.

this behaviour could be customized in the radeox configuration. So i 
opt strongly for implementing the standard and document how derivations
from the standard can be customized.
"

------------------------------------------------------
http://scarab.tigris.org/ds/viewMessage.do?dsForumId=458&dsMessageId=998851

To unsubscribe from this discussion, e-mail: [[email protected]].