jLocale : support multiline rendering in strings

[Julien]

Sometimes, when we have to translate quite long texts, we may need line breaks in it.

Right now, we cannot insert \n in strings, because it won't be treated as a line break.

We already have the ability to write strings on multiple lines in the properties files, like this

mystring = This a string that will be returned\
on one line, even if it's declared on 2 lines in the property file

but the string is still returned in 1 single line.

I propose the following syntax (
at end of line) to get the string returned with a line break :

mystring = This a string that will be returned\\
with a line break

The jlocale html plugin will also be updated to render <br /> at line breaks.

[laurentj]

I don't like this syntax. I prefer a support of classical escaped characters like \n, \r, \t etc..

[Julien]

Ok for that syntax.

I think supporting \n is enough about this ticket's description, no ?

The patch would basically do something like :

$str = str_replace('\n',"\n",$str);

and the jlocale html plugin will use nl2br() PHP function to get a <br /> tag.

[Julien]

patch for handling \n in strings and getting <br /> tags with html jlocale plugin for jtpl

[laurentj]

The replacement of '\n' by "\n" should be done during the load of the ressource file, so it doesn't need to do this replacement each time we want to get the string.

I would like also a unit test on this new feature.

[Julien]

Replying to laurentj:

The replacement of '\n' by "\n" should be done during the load of the ressource file, so it doesn't need to do this replacement each time we want to get the string.

Ok for that, no problem

I would like also a unit test on this new feature.

Ok, so I'll write a test for testing '\n' to "\n" conversion.

[Julien]

improved patch and unit test

[Julien]

Here's the new patch. I also added a unit test, but I'm not really sure I did what you wanted to (I'm a beginner with unit tests). Don't hesitate to correct me if I'm wrong.

[laurentj]

The replacement should be done at two lines: 123 and 133, not at line 141.

  str_replace(array('\#','\n'),array('#',"\n") ....);

So add a test with a multi-line string ;-)

[Julien]

fixed patch for multiline strings in properties files

[Julien]

Thanks for the report, I actually missed that line :(

So here's the new patch, with a new unit-test.

[laurentj]

patch is ok, thanks :-)

[Julien]

commited

[laurentj]

not in 1.0.x branch !

[laurentj]

remove your patch from 1.0.x branch please

[Julien]

removed the patch in 1.0.x

sorry for that :(

[laurentj]

Doc is ok ​http://jelix.org/articles/fr/manuel-1.1/locales#passage-a-la-ligne