Module:Documentation

Module documentation[edit] [purge]

This documentation is transcluded from Module:Documentation/doc.

Implements Template:Documentation for templates and modules.

---

-- <nowiki>

local p = {}

function p.doc( frame )
    local title = mw.title.getCurrentTitle()
    local args = frame:getParent().args
    local page = args[1] or mw.ustring.gsub( title.fullText, '/doc$', '' )
    local ret, cats, ret1, ret2
    local onModule = title.namespace == 828
    
    -- subpage header
    if title.subpageText == 'doc' then
        ret = mw.html.create( 'table' )
            :addClass( 'messagebox' )
            :addClass( 'info' )
            :tag( 'tr' )
                :tag( 'td' )
                    :css( 'width', '40px' )
                    :wikitext( '[[File:Template-info.png|35px|center|link=]]' )
                    :done()
                :tag( 'td' )
                    :tag( 'b' )
                        :wikitext( 'This is a documentation subpage for [[' .. page .. ']].' )
                        :done()
                    :tag( 'div' )
                        :css({ ['font-size'] = '0.85em', ['line-height'] = '1.4em' })
                        :wikitext(
                        	string.format(
                        		'It contains usage information, categories, and other content that is not part of the original %s page.',
                        	    onModule and 'module' or 'template'
                        	)
                    	)
                        :done()
                    :done()
                :done()
            :done()

        if title.namespace == 10 then
            cats = '[[Category:Template documentation|' .. title.baseText .. ']]'
        elseif title.namespace == 828 then
        	cats = '[[Category:Module documentation|' .. title.baseText .. ']]'
        else
        	cats = ''
        end
        
        return tostring( ret ) .. cats
    end
    
    -- template header
    -- don't use mw.html as we aren't closing the main div tag
    ret1 = '<div class="documentation">'

    ret2 = mw.html.create( nil )
        :tag('div')
            :addClass( 'doc-header' )
            :tag( 'span' )
                :addClass( 'doc-title' )
                :wikitext( string.format('%s documentation', onModule and 'Module' or 'Template') )
                :done()
            :tag( 'span' )
                :addClass( 'doc-editlinks' )
                :addClass( 'plainlinks' )
                :wikitext(
                    '[[' .. tostring( mw.uri.fullUrl( page .. '/doc', {action='edit'} ) ) .. ' edit]] ' ..
                    '[<span class="jsPurgeLink">[' .. tostring( mw.uri.fullUrl( title.fullText, {action='purge'} ) ) .. ' purge]</span>]'
                )
                :done()
            :done()
        :tag( 'div' )
            :addClass( 'doc-transclusion' )
            :wikitext( 'This documentation is transcluded from [[' .. page .. '/doc]].' )
            :done()
        
    return ret1 .. tostring( ret2 )
end

return p

-- </nowiki>