zmdocument.lua

package.path = 'utf8.lua/?.lua;' .. package.path
utf8 = require 'utf8'

AUTHOR_MAX_SIZE    = 25
AUTHOR_MAX_DISPLAY = 11
AUTHOR_LINK        = ""
ARRAY_AUTHORS      = {}
ARRAY_AUTHORS_SIZE = 0
NUMBER_OF_COLUMNS  = 1

SPECIAL_CHARS      = {
   ['\\&'] = '(amp)', 
   ['\\_'] = '(und)',
   ['\\{'] = '(lbr)', 
   ['\\}'] = '(rbr)', 
   ['\\#'] = '(num)', 
   ['\\$'] = '(dol)', 
}

-- Dump the content of a table, usefull for debuging purpose
-- source: https://stackoverflow.com/a/27028488
function dump(o)
   if type(o) == 'table' then
      local s = '{ '
      for k,v in pairs(o) do
         if type(k) ~= 'number' then k = '"'..k..'"' end
         s = s .. '['..k..'] = ' .. dump(v) .. ','
      end
      return s .. '} '
   else
      return tostring(o)
   end
end

--  Split and Join a string into / from a table
--  source: http://www.wellho.net/resources/ex.php4?item=u105/spjo
function implode (delimiter, list)
   local len = #list
   local string = list[0]
   for i = 1, len do
      string = string .. delimiter .. list[i]
   end
   return string
end

-- Clean a string so that it makes a correct label for abbreviations (remove special characters)
-- input: input
function cleanSpecialCharacters(input)
   local r = input
   for w, e in pairs(SPECIAL_CHARS) do
      r = r:gsub(w, e)
   end
   return r
end

function cleanAbbrvLabel(input)
   tex.print(cleanSpecialCharacters(input))
end


--  Create array of authors which contains for all author
--  - name: default name
--  - display_name: short name (less than AUTHOR_MAX_SIZE) that will be displayed
function makeAuthorsArray (authors)
   ARRAY_AUTHORS = {}
   local index   = -1
   local tmp_name

   for word in string.gmatch (authors, '([^,]+)') do
      index = index + 1

      --  Trim
      tmp_name = string.format ("%s", word:match ("%s*(.+)%s*"))
      ARRAY_AUTHORS[index] = { name = tmp_name, display_name = tmp_name }

      --  Count number of backslash in string to remove it from the count of the size
      --  Note: this method no cover all backslash aspect (like command), it is just for simple escaped char
      local numberOfBackslash = 0
      for i in string.gmatch (ARRAY_AUTHORS[index].display_name, "\\") do
         numberOfBackslash = numberOfBackslash + 1
      end

      --  Limit size of display name to AUTHOR_MAX_SIZE
      if (utf8.len (ARRAY_AUTHORS[index].display_name) - numberOfBackslash) > AUTHOR_MAX_SIZE then
         ARRAY_AUTHORS[index].display_name = string.sub (ARRAY_AUTHORS[index].display_name, 0, AUTHOR_MAX_SIZE - 3) .. "..."
      end
   end

   ARRAY_AUTHORS_SIZE = index
end

--  Create the string with authors
--  If "all" parameter is not nil, this will include all authors
function createStrAuthors(all)
   all         = all or false
   local index = ARRAY_AUTHORS_SIZE

   if index > AUTHOR_MAX_DISPLAY and not all then
      index = AUTHOR_MAX_DISPLAY
   end

   local tab = {}

   for i = 0, index do
      local display_name = ARRAY_AUTHORS[i].display_name
      if all then
        display_name = ARRAY_AUTHORS[i].name
      end
      
      tab[i] = "\\href{" .. AUTHOR_LINK .. ARRAY_AUTHORS[i].name .. "}{\\color{titlePageAuthorColor}{" .. display_name .. "}}\\\\"
   end

   local strAuthors = implode (",", tab)

   if ARRAY_AUTHORS_SIZE > AUTHOR_MAX_DISPLAY and not all then
      strAuthors = strAuthors .. ", \\hyperlink{authorsList}{\\color{titlePageAuthorColor}{et " .. (ARRAY_AUTHORS_SIZE - AUTHOR_MAX_DISPLAY) 
      
      if (ARRAY_AUTHORS_SIZE - AUTHOR_MAX_DISPLAY) > 1 then
         strAuthors = strAuthors .. " autres auteurs"
      else
         strAuthors = strAuthors .. " autre auteur"
      end
         
      strAuthors = strAuthors .. ".}}\\\\"
   end

   return strAuthors
end

--  Display athors
--  If "all" parameter is not nil, this will display all authors
function displayAuthors (strAuthors)
   tex.print ("\\expandafter\\docsvlist\\expandafter{" .. strAuthors .. "}")
end

--  Return the number of authors can be displayed (lower or equal to AUTHOR_MAX_DISPLAY)
function getAuthorsNumberMaxDisplayed ()
   if ARRAY_AUTHORS_SIZE > AUTHOR_MAX_DISPLAY then
      return AUTHOR_MAX_DISPLAY
   else
      return ARRAY_AUTHORS_SIZE
   end
end

--  Format the author list and return the string
function formatAuthorsBase (authors, link, all)
   makeAuthorsArray (authors)
   AUTHOR_LINK = link
   
   return createStrAuthors(all) 
end

--  Format authors for displaying on cover
function formatAuthors (authors, link)
   local authorsByColumn = 5
   local authorsNumber = getAuthorsNumberMaxDisplayed ()

   NUMBER_OF_COLUMNS = math.ceil (authorsNumber / authorsByColumn)

   if NUMBER_OF_COLUMNS > 1 then
      tex.print ("\\begin{multicols}{" .. NUMBER_OF_COLUMNS .. "}")
   end

   displayAuthors (formatAuthorsBase(authors, link, false))

   if NUMBER_OF_COLUMNS > 1 then
      tex.print ("\\end{multicols}")
   end
end

--  Create page for display all authors, only if all authors are not displayed on cover
function makeAuthorsPage ()
   if ARRAY_AUTHORS_SIZE <= AUTHOR_MAX_DISPLAY then
      --  Displaying this page only if all authors are not displayed on cover
      return
   end
   
   tex.print ("\\section*{\\hypertarget{authorsList}{Auteurs}}")

   if NUMBER_OF_COLUMNS > 1 then
      tex.print ("\\begin{multicols}{" .. NUMBER_OF_COLUMNS .. "}")
   end

   displayAuthors (createStrAuthors(true))

   if NUMBER_OF_COLUMNS > 1 then
      tex.print ("\\end{multicols}\\newpage")
   end
end

local zmdocument = {}
zmdocument.formatAuthorsBase = formatAuthorsBase
zmdocument.cleanSpecialCharacters = cleanSpecialCharacters
return zmdocument