The Petit Planet Wiki

Module:Recipe: Difference between revisions

Browse history interactively
← Older edit

Eleiyas (talk | contribs)

3 user groups
11,636 edits
undo
mNo edit summary
No edit summary
 
(18 intermediate revisions by 2 users not shown)
Line 6: Line 6:
local param = {
local param = {
   sCharArg = 'character',
   sCharArg = 'character',
  sKitchArg = 'kitchenware',
   sTypeArg = 'type',
   sTypeArg = 'type',
   sSortArg = 'sort',
   sSortArg = 'sort',
Line 30: Line 31:
     sOut = sOut .. 's'
     sOut = sOut .. 's'
   end
   end
   return sOut
   return sOut
end
end


local function normalizeType(s)
local function normalizeText(s)
   return mw.ustring.lower(mw.text.trim(tostring(s or '')))
   return mw.ustring.lower(mw.text.trim(tostring(s or '')))
end
end
Line 41: Line 43:
end
end


local function joinDisplay(list, separator)
local function addUseCategory(category, name, quality, sort)
  local out = {}
if not name or tostring(name) == '' then
return
end
 
if quality and tostring(quality) ~= '' then
if sort and tostring(sort) ~= '' then
category:wikitext('[[Category:Uses ', quality, '-Quality ', name, '|', sort, ']]')
else
category:wikitext('[[Category:Uses ', quality, '-Quality ', name, ']]')
end
 
return
end


  for _, value in ipairs(list) do
if sort and tostring(sort) ~= '' then
    table.insert(out, '[[' .. value .. ']]')
category:wikitext('[[Category:Uses ', name, '|', sort, ']]')
  end
else
category:wikitext('[[Category:Uses ', name, ']]')
end
end


   return table.concat(out, separator or ' / ')
local function getCurrentPageName(args)
   return args[param.sPage] or args.page or mw.title.getCurrentTitle().text
end
end


local function joinFileNameParts(list)
local function getQualityClass(quality)
   return table.concat(list, ' & ')
  if not quality or tostring(quality) == '' then
    return nil
  end
 
   return 'card-quality-' .. normalizeText(quality)
end
end


Line 59: Line 81:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local function addRecipe(category, sAmt, sName, quality)
local function addRecipeCard(category, sAmt, sName, quality)
   local cardArgs = {
   local cardArgs = {
     name = sName,
     name = sName,
     text = sAmt,
     text = sAmt,
     show_caption = '1',
     show_caption = '1'
    mobile = 'bulleted'
   }
   }


Line 73: Line 94:
   local cardNode = Card._main(cardArgs)
   local cardNode = Card._main(cardArgs)


   category:wikitext(
   addUseCategory(
     '[[Category:Uses ',
     category,
     sName,
     sName,
     '|',
     quality,
     padLeft(tostring(sAmt or ''):gsub('%D', ''), 10),
     padLeft(tostring(sAmt or ''):gsub('%D', ''), 10)
    ']]'
   )
   )


Line 89: Line 109:
     text = sText or '',
     text = sText or '',
     show_caption = '1',
     show_caption = '1',
    mobile = 'bulleted',
     mini = '1'
     mini = '1'
   }
   }
Line 99: Line 118:
   local cardNode = Card._main(cardArgs)
   local cardNode = Card._main(cardArgs)


   if category and sName then
   addUseCategory(category, sName)
    category:wikitext('[[Category:Uses ', sName, ']]')
  end


   return cardNode
   return cardNode
end
local function addYieldCard(pageTitle, sYield)
  return Card._main({
    name = pageTitle,
    text = sYield,
    show_caption = '1'
  })
end
end


Line 111: Line 136:


local function renderHeader(args, output, category)
local function renderHeader(args, output, category)
   local header = output:tag('div'):addClass('recipe_header')
   local header = output:tag('div'):addClass('recipe-header')
 
   local sType = args[param.sTypeArg]
   local sType = args[param.sTypeArg]


   header:tag('span'):addClass('recipe_header_main')
   header:tag('span'):addClass('recipe-header-main')
     :tag('span'):addClass('mobileHide'):wikitext('<big>' .. sType .. '</big>'):done()
     :tag('span'):addClass('recipe-header-text'):wikitext('[[' .. sType .. ']]'):done()
    :tag('span'):addClass('mobileHide'):wikitext('<big>' .. sType .. '</big>'):done()
    :tag('span'):addClass('recipe_header_text'):wikitext('[[' .. sType .. ']]'):done()


   category:wikitext('[[Category:' .. sType .. ']]')
   category:wikitext('[[Category:' .. sType .. ']]')
Line 202: Line 224:
   end
   end


   header:tag('span'):addClass('recipe_header_sub')
   header:tag('span'):addClass('recipe-header-sub')
     :tag('span'):addClass('mobileHide'):wikitext(' for '):done()
     :tag('span'):wikitext(' for '):done()
    :tag('span'):addClass('hidden'):wikitext(' for '):done()
     :tag('span'):addClass('recipe-header-text'):wikitext(sTime):done()
     :tag('span'):addClass('recipe_header_text'):wikitext(sTime):done()
end
end


Line 215: Line 236:
   local sCharName = args[param.sCharArg]
   local sCharName = args[param.sCharArg]


   header:tag('span'):addClass('recipe_header_sub')
   header:tag('span'):addClass('recipe-header-sub')
     :tag('span'):addClass('mobileHide'):wikitext(' with '):done()
    :tag('span'):wikitext('[[File:' .. sCharName .. ' Icon.png|24x24px|link=' .. sCharName .. ']]'):done()
     :tag('span'):addClass('hidden'):wikitext('[[File:' .. sCharName .. ' Icon.png|24x24px|link=' .. sCharName .. ']]'):done()
     :tag('span'):addClass('recipe-header-text'):wikitext('[[' .. sCharName .. ']]'):done()
     :tag('span'):addClass('recipe_header_text'):wikitext('[[' .. sCharName .. ']]'):done()
end
 
local function renderKitchenwareHeader(args, header)
  if type(args[param.sKitchArg]) ~= 'string' then
     return
  end
 
  local sKitchName = args[param.sKitchArg]
 
  header:tag('span'):addClass('recipe-header-sub')
    :tag('span'):wikitext('[[File:' .. sKitchName .. ' Icon.png|24x24px|link=' .. sKitchName .. ']]'):done()
     :tag('span'):addClass('recipe-header-text'):wikitext('[[' .. sKitchName .. ']]'):done()
end
end


Line 224: Line 256:
-- Standard recipe rendering
-- Standard recipe rendering
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local function isRestrictedStandardParam(sKey)
  for _, keyParam in pairs(param) do
    if keyParam == sKey then
      return true
    end
  end
  return false
end


local function renderStandardYield(args, body)
local function renderStandardYield(args, body)
Line 230: Line 272:
   end
   end


   local sYield = args[param.sYieldArg] or '1'
   local sYield = args[param.sYieldArg] or nil
   local pageTitle = args.page or mw.title.getCurrentTitle().text
   local pageTitle = getCurrentPageName(args)


   local yieldCard = Card._main({
   local yieldCard = addYieldCard(pageTitle, sYield)
    name = pageTitle,
    text = sYield,
    show_caption = '1',
  })


   body
   body
     :tag('div'):addClass('recipe_body_icon')
     :tag('div'):addClass('recipe-body-icon')
       :wikitext('➜'):done()
       :wikitext('➜'):done()
     :tag('div'):addClass('recipe_body_yield')
     :tag('div'):addClass('recipe-body-yield')
       :node(yieldCard)
       :node(yieldCard)
  local itemText = require('Module:Item').main{
    [1] = pageTitle,
    [2] = '15',
    x = sYield
  }
end
end


Line 260: Line 292:
   renderCharacter(args, header)
   renderCharacter(args, header)


   local body = output:tag('div'):addClass('recipe_body')
   local body = output:tag('div'):addClass('recipe-body')


   local sSortDelim = param.sSortDelim
   local sSortDelim = param.sSortDelim
Line 270: Line 302:
   for sKey in string.gmatch(args[param.sSortArg] or '', '([^' .. sSortDelim .. ']+)') do
   for sKey in string.gmatch(args[param.sSortArg] or '', '([^' .. sSortDelim .. ']+)') do
     if type(args[sKey]) ~= 'nil' then
     if type(args[sKey]) ~= 'nil' then
       body:node(addRecipe(category, args[sKey], sKey))
       body:node(addRecipeCard(category, args[sKey], sKey))
       tArgsProcessed[sKey] = true
       tArgsProcessed[sKey] = true
     end
     end
Line 276: Line 308:


   for sKey, sVal in pairs(args) do
   for sKey, sVal in pairs(args) do
    local restricted = false
     if tArgsProcessed[sKey] ~= true and not isRestrictedStandardParam(sKey) then
 
       body:node(addRecipeCard(category, sVal, sKey))
    for _, keyParam in pairs(param) do
      if keyParam == sKey then
        restricted = true
      end
    end
 
     if tArgsProcessed[sKey] ~= true and not restricted then
       body:node(addRecipe(category, sVal, sKey))
     end
     end
   end
   end
Line 295: Line 319:


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Cooking recipe parsing
-- Cooking parsing
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local function getMaxCookingItemIndex(args)
  local maxIndex = 0
  for key, _ in pairs(args) do
    local index = tostring(key):match('^item_(%d+)')
    if index then
      index = tonumber(index)
      if index and index > maxIndex then
        maxIndex = index
      end
    end
  end
  return maxIndex
end


local function getCookingIngredient(args, index)
local function getCookingIngredient(args, index)
Line 303: Line 344:
   local ingredient = {
   local ingredient = {
     index = index,
     index = index,
     amount = args[prefix .. '_amount'] or '1',
     amount = args[prefix .. '_amount'] or nil,
     quality = args[prefix .. '_quality'],
     quality = args[prefix .. '_quality'],
     item = args[prefix],
     item = args[prefix],
Line 310: Line 351:
   }
   }


  -- |item_1_type = Fish
   if argExists(args, prefix .. '_type') then
   if argExists(args, prefix .. '_type') then
     table.insert(ingredient.types, args[prefix .. '_type'])
     table.insert(ingredient.types, args[prefix .. '_type'])
   end
   end


  -- |item_1_type_1 = Freshwater Fish
  -- |item_1_type_2 = Saltwater Fish
   local typeIndex = 1
   local typeIndex = 1


Line 324: Line 362:
   end
   end


  -- |item_1_option_1 = Rice
  -- |item_1_option_2 = Wheat
   local optionIndex = 1
   local optionIndex = 1


Line 334: Line 370:


   local hasIngredient =
   local hasIngredient =
     ingredient.item ~= nil
     argExists(args, prefix)
     or #ingredient.types > 0
     or #ingredient.types > 0
     or #ingredient.options > 0
     or #ingredient.options > 0
Line 345: Line 381:
end
end


local function getKitchenware(args)
--------------------------------------------------------------------------------
  local kitchenware = {}
-- Cooking type split-card helpers
--------------------------------------------------------------------------------


   if argExists(args, 'kitchenware') then
local function makeTypeIcon(typeName)
    table.insert(kitchenware, args.kitchenware)
   return '[[File:' .. typeName .. ' Icon.png|74x74px|link=' .. typeName .. ']]'
  end
end


   local index = 1
local function joinTypeCaption(types)
   local out = {}


   while argExists(args, 'kitchenware_' .. index) do
   for _, typeName in ipairs(types) do
     table.insert(kitchenware, args['kitchenware_' .. index])
     table.insert(out, '[[' .. typeName .. ']]')
    index = index + 1
   end
   end


   return kitchenware
   return table.concat(out, ' / ')
end
end


--------------------------------------------------------------------------------
local function renderCookingSplitTypeCard(category, body, ingredient)
-- Cooking recipe display
  local qualityClass = getQualityClass(ingredient.quality or 'Gray')
--------------------------------------------------------------------------------
 
  local container = body:tag('span')
    :addClass('card-container')
    :addClass('recipe-type-split-card')
 
  local wrapper = container:tag('span')
    :addClass('card-wrapper')
 
  local cardBody = wrapper:tag('span')
    :addClass('card-body')
 
  local imageContainer = cardBody:tag('span')
    :addClass('card-image-container')
    :addClass('recipe-type-split-image')
 
  imageContainer:tag('span')
    :addClass('recipe-type-split-half')
    :addClass('recipe-type-split-half-a')
    :wikitext(makeTypeIcon(ingredient.types[1]))
    :done()
 
  imageContainer:tag('span')
    :addClass('recipe-type-split-half')
    :addClass('recipe-type-split-half-b')
    :wikitext(makeTypeIcon(ingredient.types[2]))
    :done()
   
if qualityClass then
    imageContainer:addClass(qualityClass)
end


local function renderCookingTypeCard(category, body, ingredient)
  if tostring(ingredient.amount or '') ~= '' then
  local wrapper = body:tag('div')
    container:tag('span')
    :addClass('recipe_body_cooking_ingredient')
      :addClass('card-label')
    :addClass('recipe_body_cooking_type_card')
      :wikitext(tostring(ingredient.amount or '1'))
      :done()
  end


   local fileBase = joinFileNameParts(ingredient.types)
   container:tag('span')
  local fileName = 'Recipe ' .. fileBase .. ' Icon.png'
    :addClass('card-caption')
  local caption = joinDisplay(ingredient.types, ' / ')
    :wikitext(joinTypeCaption(ingredient.types))
    :done()


   for _, typeName in ipairs(ingredient.types) do
   for _, typeName in ipairs(ingredient.types) do
     category:wikitext('[[Category:Uses ', typeName, ']]')
     addUseCategory(category, typeName)
   end
   end
end
--------------------------------------------------------------------------------
-- Cooking display
--------------------------------------------------------------------------------


   local amountText = tostring(ingredient.amount or '1')
local function renderCookingSpecificItem(category, body, ingredient)
   body:node(addRecipeCard(
    category,
    ingredient.amount,
    ingredient.item,
    ingredient.quality
  ))
end


   local card = wrapper:tag('div')
local function renderCookingTypeFallback(category, body, ingredient)
     :addClass('card')
   local wrapper = body:tag('div')
     :addClass('recipe-type-card')
     :addClass('recipe-body-cooking-ingredient')
     :addClass('recipe-body-cooking-type-cards')


   if ingredient.quality then
   for _, typeName in ipairs(ingredient.types) do
     card:addClass('card-quality-' .. normalizeType(ingredient.quality))
     wrapper:node(addMiniCard(
      category,
      typeName,
      ingredient.amount,
      ingredient.quality
    ))
   end
   end
end


  card:tag('div')
local function renderCookingTypeCards(category, body, ingredient)
    :addClass('card-image')
  if #ingredient.types == 2 then
    :wikitext('[[File:' .. fileName .. '|64x64px|link=]]')
     renderCookingSplitTypeCard(category, body, ingredient)
 
   else
  card:tag('div')
     renderCookingTypeFallback(category, body, ingredient)
     :addClass('card-caption')
    :wikitext(caption)
 
   if amountText ~= '' then
     card:tag('div')
      :addClass('card-text')
      :wikitext(amountText)
   end
   end
end
end
Line 406: Line 487:
local function renderCookingOptionCards(category, body, ingredient)
local function renderCookingOptionCards(category, body, ingredient)
   local wrapper = body:tag('div')
   local wrapper = body:tag('div')
     :addClass('recipe_body_cooking_ingredient')
     :addClass('recipe-body-cooking-ingredient')
     :addClass('recipe_body_cooking_options')
     :addClass('recipe-body-cooking-option-cards')


   for _, itemName in ipairs(ingredient.options) do
   for _, itemName in ipairs(ingredient.options) do
     wrapper:node(addRecipe(category, ingredient.amount, itemName, ingredient.quality))
     wrapper:node(addMiniCard(
      category,
      itemName,
      ingredient.amount,
      ingredient.quality
    ))
   end
   end
end
end


local function renderCookingIngredient(category, body, ingredient)
local function renderCookingIngredient(category, body, ingredient)
  -- Specific item:
  -- |item_1 = Rice
   if ingredient.item then
   if ingredient.item then
     body:node(addRecipe(category, ingredient.amount, ingredient.item, ingredient.quality))
     renderCookingSpecificItem(category, body, ingredient)
     return
     return
   end
   end


  -- Multiple accepted specific items:
  -- |item_1_option_1 = Rice
  -- |item_1_option_2 = Wheat
   if #ingredient.options > 0 then
   if #ingredient.options > 0 then
     renderCookingOptionCards(category, body, ingredient)
     renderCookingOptionCards(category, body, ingredient)
Line 430: Line 511:
   end
   end


  -- Type-based ingredient:
  -- |item_1_type = Fish
  -- |item_1_type_1 = Freshwater Fish
  -- |item_1_type_2 = Saltwater Fish
   if #ingredient.types > 0 then
   if #ingredient.types > 0 then
     renderCookingTypeCard(category, body, ingredient)
     renderCookingTypeCards(category, body, ingredient)
     return
     return
   end
   end
end
local function renderKitchenwareIcon(body, kitchenware)
  body:tag('div')
    :addClass('recipe_body_icon')
    :addClass('recipe_body_kitchenware_icon')
    :wikitext('[[File:' .. kitchenware .. '_Icon.png|35x35px|link=' .. kitchenware .. ']]')
end
local function renderKitchenwareMiniCard(category, body, kitchenware)
  body:tag('div')
    :addClass('recipe_body_icon')
    :addClass('recipe_body_kitchenware_card')
    :node(addMiniCard(category, kitchenware, ''))
end
end


Line 459: Line 522:
   end
   end


   local sYield = args[param.sYieldArg] or '1'
   local sYield = args[param.sYieldArg] or nil
   local pageTitle = args.page or mw.title.getCurrentTitle().text
   local pageTitle = getCurrentPageName(args)
  local kitchenware = getKitchenware(args)


   local yieldCard = Card._main({
   local yieldCard = addYieldCard(pageTitle, sYield)
    name = pageTitle,
    text = sYield,
    show_caption = '1',
  })


   if #kitchenware == 0 then
   body
     body:tag('div')
     :tag('div'):addClass('recipe-body-icon')
      :addClass('recipe_body_icon')
       :wikitext('➜'):done()
       :wikitext('➜')
     :tag('div'):addClass('recipe-body-yield')
  elseif #kitchenware == 1 then
       :node(yieldCard)
    -- Default: icon mode.
    -- Change this to renderKitchenwareMiniCard(category, body, kitchenware[1])
    -- if you prefer mini-card kitchenware display.
    renderKitchenwareIcon(body, kitchenware[1])
 
    category:wikitext('[[Category:Uses ', kitchenware[1], ']]')
  else
     local wrapper = body:tag('div')
      :addClass('recipe_body_icon')
      :addClass('recipe_body_kitchenware_multi')
 
    for _, itemName in ipairs(kitchenware) do
       wrapper:node(addMiniCard(category, itemName, ''))
    end
  end
 
  body:tag('div')
    :addClass('recipe_body_yield')
    :node(yieldCard)
 
  local itemText = require('Module:Item').main{
    [1] = pageTitle,
    [2] = '15',
    x = sYield
  }
end
end


Line 506: Line 539:
   renderTime(args, header)
   renderTime(args, header)
   renderCharacter(args, header)
   renderCharacter(args, header)
  renderKitchenwareHeader(args, header)


   local body = output:tag('div')
   local body = output:tag('div')
     :addClass('recipe_body')
     :addClass('recipe-body')
     :addClass('recipe_body_cooking')
     :addClass('recipe-body-cooking')


  local ingredientIndex = 1
   local foundIngredient = false
   local foundIngredient = false
  local maxIndex = getMaxCookingItemIndex(args)


   while true do
   for index = 1, maxIndex do
     local ingredient = getCookingIngredient(args, ingredientIndex)
     local ingredient = getCookingIngredient(args, index)


     if not ingredient then
     if ingredient then
       break
       foundIngredient = true
      renderCookingIngredient(category, body, ingredient)
     end
     end
    foundIngredient = true
    renderCookingIngredient(category, body, ingredient)
    ingredientIndex = ingredientIndex + 1
   end
   end


Line 553: Line 583:
function p._main(args, frame)
function p._main(args, frame)
   local output = mw.html.create('div')
   local output = mw.html.create('div')
     :addClass('recipe_container')
     :addClass('recipe-container')


   local category = mw.html.create()
   local category = mw.html.create()
Line 564: Line 594:
     local sType = args[param.sTypeArg]
     local sType = args[param.sTypeArg]


     if normalizeType(sType) == 'cooking' then
     if normalizeText(sType) == 'cooking' then
       renderCookingRecipe(args, frame, output, category)
       renderCookingRecipe(args, frame, output, category)
     else
     else
Retrieved from "https://petitplanet.wiki/Module:Recipe"