Modded Wiki

Module:Documentation: Difference between revisions

← Older editNewer edit →
Undo revision 719582 by Powup333 (talk) ?
Use mw.html to improve code readability; add jump link to the code on appropriate pages (module, css and js); and namespace variables
Line 1: Line 1:
local p = {}
local p = {}
local getType = function( namespace, page )
local pageType = 'template'
if namespace == 'Module' then
pageType = 'module'
elseif page.fullText:find( '%.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:find( '%.js$' ) then
pageType = 'script'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end
return pageType
end
-- Creating a documentation page or transclution through {{subst:doc}}
-- Creating a documentation page or transclution through {{subst:doc}}
function p.create( f )
function p.create( f )
Line 19: Line 35:
end
end
out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}\n<!-- Put categories/interwiki on the documentation page -->'
out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}' ..
'<!-- Put categories/interwiki on the documentation page -->'
out = out:gsub( '|}}', '}}' )
out = out:gsub( '|}}', '}}' )
end
end
Line 37: Line 54:
local args = require( 'Module:ProcessArgs' ).merge( true )
local args = require( 'Module:ProcessArgs' ).merge( true )
local badDoc = args.baddoc
local badDoc = args.baddoc
if f:callParserFunction( '#dplvar:noheader' ) == '1' then
if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then
if badDoc then
if badDoc then
f:callParserFunction( '#dplvar:set', 'baddoc', '1' )
f:callParserFunction( '#dplvar:set', '$doc bad', '1' )
end
end
return ''
return
end
end
local page = mw.title.getCurrentTitle()
local page = mw.title.getCurrentTitle()
local namespace = args.type or page.nsText
local namespace = args.type or page.nsText
local pageType = 'template'
local pageType = getType( namespace, page )
if namespace == 'Module' then
pageType = 'module'
elseif page.fullText:find( '.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:find( '.js$' ) then
pageType = 'script'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end
local colour = 'EAF4F9'
local body = mw.html.create( 'div' )
local message = ''
body
:css{
['margin-bottom'] = '0.8em',
padding = '0.8em 1em 0.7em',
['background-color'] = '#' .. ( badDoc and 'F9F2EA' or 'EAF4F9' ),
border = '1px solid #AAA'
}
:tag( 'div' )
:css( 'float', 'right' )
:wikitext( '[[', page:fullUrl( 'action=purge' ), ' purge]]' )
:done()
:wikitext(
'This is the documentation page, it ',
pageType == 'module' and 'will' or 'should',
' be transcluded into the main ', pageType, ' page. ',
'See [[Template:Documentation]] for more information'
)
if badDoc then
if badDoc then
colour = 'F9F2EA'
body:wikitext( "'''This ", pageType, "'s documentation needs improving or additional information.'''" )
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''"
end
end
local certainty = 'should'
if pageType == 'module' then
certainty = 'will'
end
local category = ''
if not args.nocat then
if not args.nocat then
category = '[[Category:Documentation pages]]'
body:wikitext( '[[Category:Documentation pages]]' )
end
end
local out = table.concat( {
return body
'<div style="margin-bottom:0.8em;padding:0.8em 1em 0.7em;background-color:#' .. colour .. ';border:1px solid #AAA">',
'<div style="float:right">[[' .. page:fullUrl( 'action=purge' ) .. ' purge]]</div>',
'<p style="margin: 0">This is the documentation page, it ' .. certainty .. ' be transcluded into the main ' .. pageType .. ' page. See [[Template:Documentation]] for more information.</p>',
message,
'</div>',
category
}, '\n' )
return mw.text.trim( out )
end
end


Line 94: Line 101:
local noDoc = args.nodoc or not docPage.exists
local noDoc = args.nodoc or not docPage.exists
local badDoc = args.baddoc
local badDoc = args.baddoc
local pageType = 'template'
local pageType = getType( namespace, page )
if namespace == 'Module' then
pageType = 'module'
elseif page.fullText:find( '.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:find( '.js$' ) then
pageType = 'script'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end
local docText = ''
local docText
if not noDoc then
if not noDoc then
f:callParserFunction( '#dplvar:set', 'noheader', '1' )
f:callParserFunction( '#dplvar:set', '$doc noheader', '1' )
docText = mw.text.trim( f:expandTemplate{ title = ':' .. docPage.fullText }  )
docText = mw.text.trim( f:expandTemplate{ title = ':' .. docPage.fullText }  )
if f:callParserFunction( '#dplvar:baddoc' ) == '1' then
if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then
badDoc = 1
badDoc = 1
end
end
if docText == '' then
if docText == '' then
docText = nil
noDoc = 1
noDoc = 1
else
else
Line 123: Line 122:
local preload = ''
local preload = ''
local colour = 'EAF4F9'
local colour = 'EAF4F9'
local message = ''
local message
local category = ''
local category
if noDoc then
if noDoc then
action = 'create'
action = 'create'
preload = '&preload=Template:Documentation/preload'
preload = '&preload=Template:Documentation/preload'
colour = 'F9EAEA'
colour = 'F9EAEA'
message = "'''This " .. pageType .. " has no documentation. If you know how to use this " .. pageType .. ", please create it.'''"
message = "'''This " .. pageType .. " has no documentation. " ..
"If you know how to use this " .. pageType .. ", please create it.'''"
if not args.nocat then
if not args.nocat then
if mw.title.new( 'Category:' .. pageType .. 's with no documentation' ).exists then
category = 'Category:' .. pageType .. 's with no documentation'
category = '[[Category:' .. pageType .. 's with no documentation]]'
if not mw.title.new( category ).exists then
else
category = 'Category:Pages with no documentation'
category = '[[Category:Pages with no documentation]]'
end
end
end
end
Line 141: Line 140:
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n"
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n"
if not args.nocat then
if not args.nocat then
if mw.title.new( 'Category:' .. pageType .. 's with bad documentation' ).exists then
category = 'Category:' .. pageType .. 's with bad documentation'
category = '[[Category:' .. pageType .. 's with bad documentation]]'
if not mw.title.new( category ).exists then
else
category = 'Category:Pages with bad documentation'
category = '[[Category:Pages with bad documentation]]'
end
end
end
end
Line 153: Line 151:
'[' .. page:fullUrl( 'action=purge' ) .. ' purge]'
'[' .. page:fullUrl( 'action=purge' ) .. ' purge]'
}
}
local footer = ''
if not noDoc then
if not noDoc then
table.insert( links, 1, '[[' .. docPage.fullText .. '|view]]' )
table.insert( links, 1, '[[' .. docPage.fullText .. '|view]]' )
footer = table.concat( {
'<div style="margin:0.7em -1em -0.7em;background-color:#EAF4F9;border-top:1px solid #AAA;padding:0.8em 1em 0.7em;clear:both">\n',
'<div style="float:right">' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. ']</div>\n',
'<p style="margin:0">The above documentation is transcluded from [[' .. docPage.fullText .. ']].</p>\n',
'</div>\n'
} )
end
end
links = mw.html.create( 'span' )
:css( 'float', 'right' )
:wikitext( mw.text.nowiki( '[' ), table.concat( links, ' | ' ), mw.text.nowiki( ']' ) )
local out = {
local body = mw.html.create( 'div' )
'<div style="background-color:#' .. colour .. ';border:1px solid #AAA;padding:0.8em 1em 0.7em;margin-top:1em;clear:both">\n',
body:css{
'<div style="margin:-0.8em -1em 0.8em;padding: 0.8em 1em 0.7em;background-color:#EAF4F9;border-bottom:1px solid #AAA">\n',
['background-color'] = '#' .. colour,
'<div style="float:right">' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. ']</div>\n',
border = '1px solid #AAA',
'<span style="font-weight:bold;font-size:130%">Documentation</span>',
padding = '0.8em 1em 0.7em',
'</div>\n',
['margin-top'] = '1em',
message,
clear = 'both'
docText,
footer,
'</div>\n',
category
}
}
return mw.text.trim( table.concat( out ) )
local header = mw.html.create( 'div' )
:css{
margin = '-0.8em -1em 0.8em',
padding = '0.8em 1em 0.7em',
['background-color'] = '#EAF4F9',
['border-bottom'] = 'inherit'
}
header
:node( links )
:tag( 'span' )
:css{
['font-weight'] = 'bold',
['font-size'] = '130%',
['margin-right'] = '1em',
['line-height'] = '1'
}
:wikitext( 'Documentation' )
if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
header
:tag( 'span' )
:css( 'white-space', 'nowrap' )
:wikitext( '[[#the-code|Jump to code ↴]]' )
end
body
:node( header ):done()
:wikitext( message )
:wikitext( docText )
if not noDoc then
body
:tag( 'div' )
:css{
margin = '0.7em -1em -0.7em',
['background-color'] = '#EAF4F9',
['border-top'] = 'inherit',
padding = '0.8em 1em 0.7em',
clear = 'both'
}
:node( links )
:wikitext( 'The above documentation is transcluded from [[', docPage.fullText, ']].' )
end
if category then
body:wikitext( '[[', category, ']]' )
end
local anchor = ''
if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' )
end
return tostring( body ) .. tostring( anchor )
end
end
return p
return p
Retrieved from "https://modded.wiki/w/Module:Documentation"