Module:Mw.html extension/doc

{{#invoke:Documentation|doc}} {{#invoke:Helper module|main}}

       :th('bar')
   :tr()
       :td('buz')
           :attr('data-sort-value', 10)
       :td{'N/A', class='table-na'}

</syntaxhighlight>

|fname12 = IF(cond) |ftype12 = boolean |fuse12 = Allows for if-blocks without breaking the chain. If the condition is true it is a no-op, if false everything inside the balanced IF-END block will be ignored. Can be nested. Ex.: <syntaxhighlight lang="lua"> mw.html.create('div')

   :IF(true)
       :wikitext('Conditional text')
   :END()
   :...

</syntaxhighlight> Note: This only prevents elements from being added to your html object, it does not protect against statements that throw errors. I.e <syntaxhighlight lang='lua'> mw.html.create('div')

   :IF(false)
       :wikitext(5 * nil) -- This will still throw an error
   :END()

</syntaxhighlight>

|fname13 = ELSEIF(cond) |ftype13 = boolean |fuse13 = Used together with IF().

|fname14 = ELSE() |ftype14 = N/A |fuse14 = Used together with IF().

|fname15 = END() |ftype15 = N/A |fuse15 = Used together with IF(). Make sure the IF-END tags are balanced, it wont throw an error if they are not.

|fname16 = exec(func, ...) |ftype16 = function, any |fuse16 = Call a function without breaking the chain. See module docs for more info.

|fname17 = addFunction(func, name) |ftype17 = function, string |fuse17 = Add a function to the mw.html class that can then be used on mw.html object. See module docs for more info. }}

Usage

For all functions other than addFunction() all you need to do is simply require this module: <syntaxhighlight lang="lua"> require('Module:Mw.html extension') local p = {}

function p.main()

   ...
   local tbl = mw.html.create('div')
       :IF(true)
           :wikitext('Conditional text')
       :ELSE()
           :wikitext('something else')
       :END()
       :addClassIf(true, 'wikitable')
       :tag('span)'
           :wikitext('normal wikitext')
       :done()
   ...

end

return p </syntaxhighlight>

You can mix the normal old functions with the newly added ones.

attrIf

This accepts either a name-value pair or a table

• :attrIf(true, 'data-sort-value', '0')
• :attrIf(true, {'data-sort-value' = '0', ...})

cssIf

This accepts either a name-value pair or a table similar to attrIf

exec

The first parameter of the function will have the current state of the mw.html object passed into it, usually we call this parameter self, the rest of the parameters can be anything you want. To not break the chaining the function must also return a mw.html object. Example: <syntaxhighlight lang="lua"> local function repNa(self, times)

   for i = 1,times do
       self:na()
   end
   return self

end </syntaxhighlight>

This function can then be used as follows <syntaxhighlight lang="lua"> mw.html.create('div'):exec(repNa, 5) </syntaxhighlight>

addFunction

The function you want to add has to be of the same structure as in exec(). Example: <syntaxhighlight lang="lua"> local htmlExtension = require('Module:Mw.html extension') local p = {}

local function repNa(self, times)

   for i = 1,times do
       self:na()
   end
   return self

end htmlExtension.addFunction(repNa, 'repNaName')

function p.main()

   ...
   local tbl = mw.html.create('div'):repNaName(5)
   ...

end

return p </syntaxhighlight>

tr, th and td

The following three tables are the same: <syntaxhighlight lang='lua'> local tbl = mw.html.create('table') tbl:tr{ class='sortable' }

       :th{'foo', attr={['data-sort-type']='number'}} -- or attr={'data-sort-type', 'number'}
       :th('bar')
           :IF(expression)
               :addClass('table-na')
           :END()
   :tr()
       :td('buz')
       :td{'N/A', class='table-na'}

local tbl2 = mw.html.create('table') tbl2:tag('tr')

       :addClass('sortable')
       :tag('th')
           :attr('data-sort-type', 'number')
           :wikitext('foo')
       :done()
       :tag('th')
           :wikitext('bar')
           :IF(expression)
               :addClass('table-na')
           :END()
       :done() -- This is needed because "tag('tr')" is used after this instead of "tr()"
   :done()
   :tag('tr')
       :tag('td')
           :wikitext('buz')
       :done()
       :tag('td')
           :wikitext('N/A')
           :addClass('table-na')

local tbl3 = mw.html.create('table') tbl3:tag('tr')

       :addClass('sortable')
       :tag('th')
           :attr('data-sort-type', 'number')
           :wikitext('foo')
       :th('bar')
           :IF(expression)
               :addClass('table-na')
           :END()
       :done()
   :done()
   :tag('tr')
       :td('buz')
       :td('N/A')
           :addClass('table-na')

</syntaxhighlight>