Merge lp:~widelands-dev/widelands/string-fixes into lp:widelands

[GunChleoc]

Fixed issues with trailing whitespaces in translatable strings, because they lead to translation mistakes
- Using localize_list in artifacts.lua.
- Got rid of trailing whitespace in _"Spare required: " string and added it back into the UI.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 3308. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/357809865.
Appveyor build 3115. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_string_fixes-3115.

[Benedikt Straub (nordfriese)]

Proofread the changes, everything looks good to me.
Tested the in-game help and played a quick artifacts game; it all works as it should.

review: Approve

[GunChleoc (gunchleoc)]

Thanks a lot for the review :)

@bunnybot merge

=== modified file 'data/scripting/richtext.lua'
--- data/scripting/richtext.lua	2018-03-15 02:38:55 +0000
+++ data/scripting/richtext.lua	2018-03-24 14:41:09 +0000
@@ -516,7 +516,7 @@
 --
 --    :arg items:              An array of strings
 --    :arg listtype:           The type of concatenation to use.
---                             Legal values are "&", "and", "or", and ";"
+--                             Legal values are "&", "and", "or", and ","
 --    :arg former_textdomain:  The textdomain to restore after running this function.
 --    :returns: The concatenated list string, using localized concatenation operators.
 --

=== modified file 'data/scripting/win_conditions/artifacts.lua'
--- data/scripting/win_conditions/artifacts.lua	2017-05-12 11:30:43 +0000
+++ data/scripting/win_conditions/artifacts.lua	2018-03-24 14:41:09 +0000
@@ -134,16 +134,11 @@
       local max_artifacts = _max(artifacts_per_team)
 
       local function _get_member_names(t)
-         local s = ""
+         local membernames = {}
          for idx, plr in ipairs(t) do
-            if s == "" then
-               s = plr.name
-            else
-               -- TRANSLATORS: This is used to seperate players’ names in a list, e.g. "Steve, Robert, David"
-               s = s .. _", " .. plr.name
-            end
+            table.insert(membernames, plr.name)
          end
-         return s
+         return localize_list(membernames, ",", "win_conditions")
       end
 
       local teams = {}

=== modified file 'data/tribes/scripting/help/building_help.lua'
--- data/tribes/scripting/help/building_help.lua	2018-01-10 16:21:50 +0000
+++ data/tribes/scripting/help/building_help.lua	2018-03-24 14:41:09 +0000
@@ -15,24 +15,6 @@
 --  =======================================================
 
 -- RST
--- .. function:: building_section_line(header, text, image)
---
---    Creates a line of h3 formatted text followed by normal text and an image.
---
---    :arg t1: header text.
---    :arg t2: in-line paragraphs text.
---    :arg image: image to be aligned right.
---    :returns: header followed by normal text and image.
---
-function building_section_line(header, text, image)
-   return
-      div("width=100%",
-         div("width=50%", p_font("size=13 color=D1D1D1", vspace(6) .. text .. space(6))) ..
-         div("width=*", p("align=right", vspace(6) .. img(image) .. vspace(12)))
-      )
-end
-
--- RST
 -- .. function:: dependencies_basic(images[, text = nil])
 --
 --    Creates a dependencies line of any length.
@@ -460,19 +442,11 @@
 
    -- Space required
    if (building_description.is_mine) then
-      result = result .. building_section_line(_"Space required:",_"Mine plot","images/wui/overlays/mine.png")
+      result = result .. plot_size_line("mine")
    elseif (building_description.is_port) then
-      result = result .. building_section_line(_"Space required:",_"Port plot","images/wui/overlays/port.png")
+      result = result .. plot_size_line("port")
    else
-      if (building_description.size == "small") then
-         result = result .. building_section_line(_"Space required:",_"Small plot","images/wui/overlays/small.png")
-      elseif (building_description.size == "medium") then
-         result = result .. building_section_line(_"Space required:",_"Medium plot","images/wui/overlays/medium.png")
-      elseif (building_description.size == "big") then
-         result = result .. building_section_line(_"Space required:",_"Big plot","images/wui/overlays/big.png")
-      else
-         result = result .. p(_"Space required:" .. _"Unknown")
-      end
+      result = result .. plot_size_line(building_description.size)
    end
 
    -- Enhanced from

=== modified file 'data/tribes/scripting/help/format_help.lua'
--- data/tribes/scripting/help/format_help.lua	2018-02-25 11:29:14 +0000
+++ data/tribes/scripting/help/format_help.lua	2018-03-24 14:41:09 +0000
@@ -37,6 +37,50 @@
       )
 end
 
+-- RST
+-- .. function:: plot_size_line(size)
+--
+--    Creates a line describing space required on the map.
+--    Consists of a header colored text, followed by normal text and an image.
+--
+--    :arg size: size key. Expected values are "mine", "port", "small, "medium", "big", "none".
+--    :returns: header followed by normal text and image if a space is required, or empty string.
+--
+function plot_size_line(size)
+   local text = ""
+   local image = ""
+   if (size == "mine") then
+      -- TRANSLATORS: Space on the map required for building a building there
+      text = _"Mine plot"
+      image = "images/wui/overlays/mine.png"
+   elseif (size == "port") then
+      -- TRANSLATORS: Space on the map required for building a building there
+      text = _"Port plot"
+      image = "images/wui/overlays/port.png"
+   elseif (size == "small") then
+      -- TRANSLATORS: Space on the map required for building a building there
+      text = _"Small plot"
+      image = "images/wui/overlays/small.png"
+   elseif (size == "medium") then
+      -- TRANSLATORS: Space on the map required for building a building there
+      text = _"Medium plot"
+      image = "images/wui/overlays/medium.png"
+   elseif (size == "big") then
+      -- TRANSLATORS: Space on the map required for building a building there
+      text = _"Big plot"
+      image = "images/wui/overlays/big.png"
+   else
+      return ""
+   end
+
+   return
+      div("width=100%",
+         div("float=right padding_l=6", p(img(image))) ..
+         -- TRANSLATORS: Space on the map required for building a building there
+         p(join_sentences(font("size=13 color=D1D1D1", _"Space required:"), text))
+      )
+end
+
 
 --  =======================================================
 --  ********** Helper functions for dependencies **********

=== modified file 'data/tribes/scripting/help/immovable_help.lua'
--- data/tribes/scripting/help/immovable_help.lua	2018-01-29 16:38:16 +0000
+++ data/tribes/scripting/help/immovable_help.lua	2018-03-24 14:41:09 +0000
@@ -42,14 +42,7 @@
    end
 
    -- Space required
-   local space_required = ""
-   if (immovable_description.size == "small") then
-      space_required = space_required .. image_line("images/wui/overlays/small.png", 1, _"Space required: " .. _"Small plot")
-   elseif (immovable_description.size == "medium") then
-      space_required = space_required .. image_line("images/wui/overlays/medium.png", 1, _"Space required: " .. _"Medium plot")
-   elseif (immovable_description.size == "big") then
-      space_required = space_required .. image_line("images/wui/overlays/big.png", 1, _"Space required: " .. _"Big plot")
-   end
+   local space_required = plot_size_line(immovable_description.size)
 
    if (buildcost ~= "" or space_required ~= "") then
       result = result .. h2(_"Requirements")