Module:Quote

Module documentation

[view] [edit] [history] [purge]

Main

Documentation

Usage

This module implements {{Quote}}.

Text above can be found here (edit)
Editors can experiment in this module's draft (create |  mirror) page.
Please add categories to the documentation subpage. Subpages of this module.

-- <nowiki>
local Quote = {}

local getArgs = require('Module:Arguments').getArgs
local i18n = require('Module:I18n').loadMessages('Quote')


-- =========================================================
-- Parameters
-- =========================================================

local function parameter(args, ...)
    local names = { ... }

    for _, name in ipairs(names) do
        local value = i18n:parameter(name, args)

        if value ~= nil and value ~= '' then
            return value
        end
    end

    return nil
end


-- =========================================================
-- Options
-- =========================================================

local function getOptions(args)

    local options = {
        classes = {},
        styles = {}
    }

    local extraClasses = parameter(args, 'class')

    if extraClasses then
        options.extraClasses = extraClasses
    end

    local extraStyles = parameter(args, 'style')

    if extraStyles then
        options.extraStyles = extraStyles
    end


    -- Alignment

    local align = parameter(args, 'align')

    if align then
        align = string.lower(align)

        if align == 'left' or align == 'right' then
            options.classes[#options.classes + 1] =
                'pp-quote--' .. align

            local width =
                parameter(args, 'width', 'quotewidth')

            if width then
                options.styles.width = width
            end
        end
    end

    return options
end


-- =========================================================
-- Build quote
-- =========================================================

local function build(quoteContents, quoteSource, options)

    local quote = mw.html.create('blockquote')
        :addClass('pp-quote')

    -- Alignment classes
    for _, className in ipairs(options.classes) do
        quote:addClass(className)
    end

    -- Extra classes
    if options.extraClasses then
        quote:addClass(options.extraClasses)
    end

    -- Explicit styles
    for property, value in pairs(options.styles) do
        quote:css(property, value)
    end

    if options.extraStyles then
        quote:cssText(options.extraStyles)
    end

    -- Quote content
    quote:node(quoteContents)

    -- Source
    if quoteSource and quoteSource ~= '' then
        quote
            :tag('div')
                :addClass('pp-quote__source')
                :wikitext(quoteSource)
                :done()
    end

    return quote
end


-- =========================================================
-- Normal quote
-- =========================================================

function Quote.quote(frame)

    local args = getArgs(frame)
    local options = getOptions(args)

    local quoteText =
        args[1]
        or parameter(args, 'quotetext', 'quote', 'text')
        or ''

    local person =
        args[2]
        or parameter(
            args,
            'person',
            'speaker',
            'personquoted'
        )

    local source =
        args[3]
        or parameter(
            args,
            'source',
            'quote_source'
        )


    -- Quote text
    local quoteContents = mw.html.create('div')
        :addClass('pp-quote__text')
        :wikitext(quoteText)


    -- Source
    local quoteSource

    if person and source then
        quoteSource = person .. ', ' .. source
    elseif person then
        quoteSource = person
    elseif source then
        quoteSource = source
    end


    return build(
        quoteContents,
        quoteSource,
        options
    )
end


-- =========================================================
-- Dialogue
-- =========================================================

function Quote.dialogue(frame)

    local args = getArgs(frame)
    local options = getOptions(args)

    local quoteContents = mw.html.create('div')
        :addClass('pp-quote__text')
        :addClass('pp-quote__text--dialogue')


    -- Dialogue lines
    for i = 1, #args, 2 do

        local speaker = args[i]
        local line = args[i + 1]

        if speaker and line then

            quoteContents
                :tag('div')
                    :addClass('pp-quote__line')

                    :tag('strong')
                        :addClass('pp-quote__speaker')
                        :wikitext(speaker .. ':')
                        :done()

                    :wikitext(' ' .. line)

                    :done()
        end
    end


    -- Dialogue source
    local context =
        parameter(args, 'context')

    local source =
        parameter(args, 'source')

    local quoteSource

    if context and source then
        quoteSource = context .. ', ' .. source
    elseif context then
        quoteSource = context
    elseif source then
        quoteSource = source
    end


    return build(
        quoteContents,
        quoteSource,
        options
    )
end


return Quote