(Add margin-top; remove edit sections since they're broken in this version of scribunto) |
ItsPlantseed (talk | contribs) mNo edit summary |
||
(34 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
local p = {} |
local p = {} |
||
+ | local defaultDocPage = 'doc' |
||
⚫ | |||
+ | |||
+ | local getType = function( namespace, page ) |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
+ | return pageType |
||
⚫ | |||
+ | |||
⚫ | |||
function p.create( f ) |
function p.create( f ) |
||
local args = require( 'Module:ProcessArgs' ).norm() |
local args = require( 'Module:ProcessArgs' ).norm() |
||
− | page = mw.title.getCurrentTitle() |
+ | local page = mw.title.getCurrentTitle() |
− | + | local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage |
|
⚫ | |||
local out |
local out |
||
− | if |
+ | if not args.content and tostring( page ) == docPage then |
out = f:preprocess( '{{subst:Template:Documentation/preload}}' ) |
out = f:preprocess( '{{subst:Template:Documentation/preload}}' ) |
||
else |
else |
||
local templateArgs = {} |
local templateArgs = {} |
||
+ | for _, key in ipairs{ 'type', 'page', 'content' } do |
||
⚫ | |||
− | + | local val = args[key] |
|
+ | if val then |
||
⚫ | |||
+ | if key == 'content' then val = '\n' .. val .. '\n' end |
||
⚫ | |||
− | table.insert( templateArgs, ' |
+ | table.insert( templateArgs, key .. '=' .. val ) |
⚫ | |||
end |
end |
||
− | out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}} |
+ | out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}' |
out = out:gsub( '|}}', '}}' ) |
out = out:gsub( '|}}', '}}' ) |
||
+ | |||
⚫ | |||
+ | out = out .. '\n<!-- Put categories/interwikis on the documentation page -->' |
||
+ | end |
||
end |
end |
||
Line 37: | Line 60: | ||
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 |
+ | if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then |
if badDoc then |
if badDoc then |
||
− | f:callParserFunction( '#dplvar:set', ' |
+ | f:callParserFunction( '#dplvar:set', '$doc bad', '1' ) |
end |
end |
||
− | return |
+ | return |
end |
end |
||
local page = mw.title.getCurrentTitle() |
local page = mw.title.getCurrentTitle() |
||
− | local |
+ | local subpage = page.subpageText |
+ | if subpage == 'sandbox' or subpage == 'testcases' then |
||
⚫ | |||
+ | page = page.basePageTitle |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
end |
end |
||
+ | local namespace = page.nsText |
||
⚫ | |||
+ | local body = mw.html.create( 'div' ):addClass( 'documentation-header' ) |
||
⚫ | |||
+ | body |
||
⚫ | |||
+ | :addClass( badDoc and 'documentation-badDoc' or '' ) |
||
+ | :css{ |
||
+ | ['margin-bottom'] = '0.8em', |
||
+ | padding = '0.8em 1em 0.7em', |
||
+ | ['background-color'] = '#' .. ( badDoc and 'F9F2EA' or 'EAF4F9' ), |
||
+ | border = '1px solid #AAA' |
||
⚫ | |||
+ | :tag( 'div' ) |
||
+ | :attr( 'id', 'documentation-header-tools' ) |
||
+ | :css( 'float', 'right' ) |
||
+ | :wikitext( '[[', page:fullUrl( 'action=purge' ), ' ' .. f:preprocess('{{lc:{{int:purge}}}}') .. ']]' ) |
||
+ | :done() |
||
+ | :wikitext( |
||
+ | 'This is the documentation page. It ', |
||
⚫ | |||
+ | ' be transcluded into the main ', pageType, ' page. ', |
||
+ | 'See [[Template:Documentation]] for more information' |
||
+ | ) |
||
if badDoc then |
if badDoc then |
||
⚫ | |||
− | colour = 'F9F2EA' |
||
⚫ | |||
end |
end |
||
⚫ | |||
⚫ | |||
⚫ | |||
− | local certainty = 'should' |
||
− | if pageType == 'module' then |
||
− | certainty = 'will' |
||
⚫ | |||
⚫ | |||
⚫ | |||
− | if not args.nocat then |
||
⚫ | |||
end |
end |
||
+ | return body |
||
− | local out = table.concat( { |
||
− | '<div style="margin-bottom:0.8em;padding:0.8em 1em 0.7em;background-color:#' .. colour .. ';border:1px solid #AAA">', |
||
⚫ | |||
− | '<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>', |
||
⚫ | |||
− | '</div>', |
||
− | category |
||
− | }, '\n' ) |
||
⚫ | |||
− | return mw.text.trim( out ) |
||
end |
end |
||
-- Wrapper around the documentation on the main page |
-- Wrapper around the documentation on the main page |
||
function p.page( f ) |
function p.page( f ) |
||
+ | -- mw.text.trim uses mw.ustring.gsub, which silently fails on large strings |
||
+ | local function trim( s ) |
||
+ | return (s:gsub( '^[\t\r\n\f ]+', '' ):gsub( '[\t\r\n\f ]+$', '' )) |
||
+ | --return string.gsub( s, '^[\t\r\n\f ]*(.-)[\t\r\n\f ]*$', '%1' ) |
||
+ | end |
||
local args = require( 'Module:ProcessArgs' ).merge( true ) |
local args = require( 'Module:ProcessArgs' ).merge( true ) |
||
local page = mw.title.getCurrentTitle() |
local page = mw.title.getCurrentTitle() |
||
− | local |
+ | local subpage = page.subpageText |
+ | if subpage == 'sandbox' or subpage == 'testcases' then |
||
⚫ | |||
+ | page = page.basePageTitle |
||
⚫ | |||
⚫ | |||
− | local pageType = 'template' |
||
⚫ | |||
⚫ | |||
− | elseif page.fullText:find( '.css$' ) then |
||
− | pageType = 'stylesheet' |
||
− | elseif page.fullText:find( '.js$' ) then |
||
⚫ | |||
⚫ | |||
− | pageType = 'message' |
||
end |
end |
||
+ | local namespace = page.nsText |
||
+ | local docText = trim( args.content or '' ) |
||
+ | if docText == '' then docText = nil end |
||
− | local |
+ | local docPage |
− | + | local noDoc |
|
⚫ | |||
⚫ | |||
+ | docPage = page |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
+ | end |
||
⚫ | |||
+ | local pageType = mw.ustring.lower( args.type or getType( namespace, page ) ) |
||
⚫ | |||
+ | if not docText and not noDoc then |
||
⚫ | |||
⚫ | |||
⚫ | |||
badDoc = 1 |
badDoc = 1 |
||
end |
end |
||
if docText == '' then |
if docText == '' then |
||
⚫ | |||
noDoc = 1 |
noDoc = 1 |
||
⚫ | |||
⚫ | |||
end |
end |
||
+ | end |
||
+ | if docText then |
||
⚫ | |||
end |
end |
||
− | local action = 'edit' |
+ | local action = f:preprocess('{{lc:{{int:edit}}}}') |
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 = f:preprocess('{{lc:{{int:create}}}}') |
preload = '&preload=Template:Documentation/preload' |
preload = '&preload=Template:Documentation/preload' |
||
+ | docClass = 'documentation-noDoc' |
||
colour = 'F9EAEA' |
colour = 'F9EAEA' |
||
− | message = "'''This " .. pageType .. " has no documentation. |
+ | 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 or namespace == 'User' ) then |
|
− | + | category = pageType .. 's with no documentation' |
|
+ | if not mw.title.new( 'Category:' .. category ).exists then |
||
⚫ | |||
− | category = ' |
+ | category = 'Pages with no documentation' |
end |
end |
||
end |
end |
||
elseif badDoc then |
elseif badDoc then |
||
+ | docClass = 'documentation-badDoc' |
||
colour = 'F9F2EA' |
colour = 'F9F2EA' |
||
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 or namespace == 'User' ) then |
− | + | category = pageType .. 's with bad documentation' |
|
− | + | if not mw.title.new( 'Category:' .. category ).exists then |
|
⚫ | |||
⚫ | |||
⚫ | |||
end |
end |
||
end |
end |
||
Line 151: | Line 182: | ||
local links = { |
local links = { |
||
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']', |
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']', |
||
− | '[' .. |
+ | '[' .. docPage:fullUrl( 'action=history' ) .. ' ' .. f:preprocess('{{lc:{{int:history short}}}}') .. ']', |
⚫ | |||
} |
} |
||
+ | if not noDoc and page ~= docPage then |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
− | 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>\n' |
||
⚫ | |||
end |
end |
||
+ | links = mw.html.create( 'span' ) |
||
+ | :attr( 'id', 'documentation-header-tools' ) |
||
+ | :css( 'float', 'right' ) |
||
⚫ | |||
+ | local body = mw.html.create( 'div' ):addClass( 'documentation' ) |
||
− | local out = { |
||
+ | body |
||
− | '<div style="background-color:#' .. colour .. ';border:1px solid #AAA;padding:0.8em 1em 0.7em;margin-top:1em;clear:both">\n', |
||
+ | :addClass( docClass ) |
||
− | '<div style="margin:-0.8em -1em 0.8em;padding: 0.8em 1em 0.7em;background-color:#EAF4F9;border-bottom:1px solid #AAA">\n', |
||
+ | :css{ |
||
− | '<div style="float:right">' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. ']</div>\n', |
||
+ | ['background-color'] = '#' .. colour, |
||
− | '<span style="font-weight:bold;font-size:130%">Documentation</span>', |
||
+ | border = '1px solid #AAA', |
||
− | '</div>\n', |
||
+ | padding = '0.8em 1em 0.7em', |
||
− | message, |
||
+ | ['margin-top'] = '1em', |
||
⚫ | |||
+ | clear = 'both' |
||
− | footer, |
||
− | '</div>\n', |
||
− | category |
||
} |
} |
||
+ | local header = mw.html.create( 'div' ) |
||
− | return mw.text.trim( table.concat( out ) ) |
||
+ | :addClass( 'documentation-header-top' ) |
||
+ | :css{ |
||
+ | margin = '-0.8em -1em 0.8em', |
||
+ | padding = '0.8em 1em 0.7em', |
||
+ | ['background-color'] = '#EAF4F9', |
||
+ | ['border-bottom'] = 'inherit' |
||
+ | } |
||
⚫ | |||
+ | header |
||
+ | :node( links ) |
||
+ | :tag( 'span' ) |
||
+ | :attr( 'id', 'documentation-header-title' ) |
||
+ | :css{ |
||
+ | ['font-weight'] = 'bold', |
||
+ | ['font-size'] = '130%', |
||
+ | ['margin-right'] = '1em', |
||
+ | ['line-height'] = '1' |
||
⚫ | |||
+ | :wikitext( 'Documentation' ) |
||
+ | |||
⚫ | |||
+ | module = true, |
||
+ | stylesheet = true, |
||
+ | script = true, |
||
+ | } |
||
+ | if not noDoc and codePages[pageType] then |
||
+ | header |
||
+ | :tag( 'span' ) |
||
+ | :attr( 'id', 'documentation-jump-to-code' ) |
||
+ | :css( 'white-space', 'nowrap' ) |
||
+ | :wikitext( '[[#the-code|Jump to code ↴]]' ) |
||
+ | end |
||
+ | |||
+ | body |
||
+ | :node( header ):done() |
||
⚫ | |||
+ | :wikitext( docText ) |
||
+ | |||
+ | if not noDoc and page ~= docPage then |
||
+ | body |
||
+ | :tag( 'div' ) |
||
+ | :addClass( 'documentation-header-bottom' ) |
||
+ | :css{ |
||
+ | margin = '0.7em -1em -0.7em', |
||
+ | ['background-color'] = '#EAF4F9', |
||
+ | ['border-top'] = 'inherit', |
||
+ | padding = '0.8em 1em 0.7em', |
||
+ | clear = 'both' |
||
+ | } |
||
+ | :node( links ) |
||
⚫ | |||
+ | end |
||
+ | |||
⚫ | |||
+ | body:wikitext( f:expandTemplate{ title = 'Translation category', args = { category, project = '0' } } ) |
||
+ | end |
||
+ | |||
⚫ | |||
+ | 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 |
Revision as of 22:28, 11 July 2021
This module implements {{Documentation}}
.
Dependencies
[view | edit | history | purge]The above documentation is transcluded from Module:Documentation/doc.
local p = {}
local defaultDocPage = 'doc'
local getType = function( namespace, page )
local pageType = 'template'
if namespace == 'Module' then
pageType = 'module'
elseif namespace == 'Widget' then
pageType = 'widget'
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.js$' ) then
pageType = 'script'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end
return pageType
end
-- Creating a documentation page or transclusion through {{subst:docc}}
function p.create( f )
local args = require( 'Module:ProcessArgs' ).norm()
local page = mw.title.getCurrentTitle()
local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage
local out
if not args.content and tostring( page ) == docPage then
out = f:preprocess( '{{subst:Template:Documentation/preload}}' )
else
local templateArgs = {}
for _, key in ipairs{ 'type', 'page', 'content' } do
local val = args[key]
if val then
if key == 'content' then val = '\n' .. val .. '\n' end
table.insert( templateArgs, key .. '=' .. val )
end
end
out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}'
out = out:gsub( '|}}', '}}' )
if not args.content then
out = out .. '\n<!-- Put categories/interwikis on the documentation page -->'
end
end
if not mw.isSubsting() then
out = f:preprocess( out )
if not args.nocat then
out = out .. '[[Category:Pages with templates requiring substitution]]'
end
end
return out
end
-- Header on the documentation page
function p.docPage( f )
local args = require( 'Module:ProcessArgs' ).merge( true )
local badDoc = args.baddoc
if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then
if badDoc then
f:callParserFunction( '#dplvar:set', '$doc bad', '1' )
end
return
end
local page = mw.title.getCurrentTitle()
local subpage = page.subpageText
if subpage == 'sandbox' or subpage == 'testcases' then
page = page.basePageTitle
end
local namespace = page.nsText
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
local body = mw.html.create( 'div' ):addClass( 'documentation-header' )
body
:addClass( badDoc and 'documentation-badDoc' or '' )
:css{
['margin-bottom'] = '0.8em',
padding = '0.8em 1em 0.7em',
['background-color'] = '#' .. ( badDoc and 'F9F2EA' or 'EAF4F9' ),
border = '1px solid #AAA'
}
:tag( 'div' )
:attr( 'id', 'documentation-header-tools' )
:css( 'float', 'right' )
:wikitext( '[[', page:fullUrl( 'action=purge' ), ' ' .. f:preprocess('{{lc:{{int: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
body:wikitext( "<br>'''This ", pageType, "'s documentation needs improving or additional information.'''" )
end
if not ( args.nocat or namespace == 'User' ) then
body:wikitext( '[[Category:Documentation pages]]' )
end
return body
end
-- Wrapper around the documentation on the main page
function p.page( f )
-- mw.text.trim uses mw.ustring.gsub, which silently fails on large strings
local function trim( s )
return (s:gsub( '^[\t\r\n\f ]+', '' ):gsub( '[\t\r\n\f ]+$', '' ))
--return string.gsub( s, '^[\t\r\n\f ]*(.-)[\t\r\n\f ]*$', '%1' )
end
local args = require( 'Module:ProcessArgs' ).merge( true )
local page = mw.title.getCurrentTitle()
local subpage = page.subpageText
if subpage == 'sandbox' or subpage == 'testcases' then
page = page.basePageTitle
end
local namespace = page.nsText
local docText = trim( args.content or '' )
if docText == '' then docText = nil end
local docPage
local noDoc
if docText then
docPage = page
else
docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/' .. defaultDocPage )
noDoc = args.nodoc or not docPage.exists
end
local badDoc = args.baddoc
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
if not docText and not noDoc then
f:callParserFunction( '#dplvar:set', '$doc noheader', '1' )
docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } )
if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then
badDoc = 1
end
if docText == '' then
docText = nil
noDoc = 1
end
end
if docText then
docText = '\n' .. docText .. '\n'
end
local action = f:preprocess('{{lc:{{int:edit}}}}')
local preload = ''
local docClass = ''
local colour = 'EAF4F9'
local message
local category
if noDoc then
action = f:preprocess('{{lc:{{int:create}}}}')
preload = '&preload=Template:Documentation/preload'
docClass = 'documentation-noDoc'
colour = 'F9EAEA'
message = "'''This " .. pageType .. " has no documentation. " ..
"If you know how to use this " .. pageType .. ", please create it.'''"
if not ( args.nocat or namespace == 'User' ) then
category = pageType .. 's with no documentation'
if not mw.title.new( 'Category:' .. category ).exists then
category = 'Pages with no documentation'
end
end
elseif badDoc then
docClass = 'documentation-badDoc'
colour = 'F9F2EA'
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n"
if not ( args.nocat or namespace == 'User' ) then
category = pageType .. 's with bad documentation'
if not mw.title.new( 'Category:' .. category ).exists then
category = 'Pages with bad documentation'
end
end
end
local links = {
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
'[' .. docPage:fullUrl( 'action=history' ) .. ' ' .. f:preprocess('{{lc:{{int:history short}}}}') .. ']',
'[' .. page:fullUrl( 'action=purge' ) .. ' ' .. f:preprocess('{{lc:{{int:purge}}}}') .. ']'
}
if not noDoc and page ~= docPage then
table.insert( links, 1, '[[' .. docPage.fullText .. '|' .. f:preprocess('{{lc:{{int:view}}}}') .. ']]' )
end
links = mw.html.create( 'span' )
:attr( 'id', 'documentation-header-tools' )
:css( 'float', 'right' )
:wikitext( mw.text.nowiki( '[' ), table.concat( links, ' | ' ), mw.text.nowiki( ']' ) )
local body = mw.html.create( 'div' ):addClass( 'documentation' )
body
:addClass( docClass )
:css{
['background-color'] = '#' .. colour,
border = '1px solid #AAA',
padding = '0.8em 1em 0.7em',
['margin-top'] = '1em',
clear = 'both'
}
local header = mw.html.create( 'div' )
:addClass( 'documentation-header-top' )
:css{
margin = '-0.8em -1em 0.8em',
padding = '0.8em 1em 0.7em',
['background-color'] = '#EAF4F9',
['border-bottom'] = 'inherit'
}
header
:node( links )
:tag( 'span' )
:attr( 'id', 'documentation-header-title' )
:css{
['font-weight'] = 'bold',
['font-size'] = '130%',
['margin-right'] = '1em',
['line-height'] = '1'
}
:wikitext( 'Documentation' )
local codePages = {
module = true,
stylesheet = true,
script = true,
}
if not noDoc and codePages[pageType] then
header
:tag( 'span' )
:attr( 'id', 'documentation-jump-to-code' )
:css( 'white-space', 'nowrap' )
:wikitext( '[[#the-code|Jump to code ↴]]' )
end
body
:node( header ):done()
:wikitext( message )
:wikitext( docText )
if not noDoc and page ~= docPage then
body
:tag( 'div' )
:addClass( 'documentation-header-bottom' )
: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( f:expandTemplate{ title = 'Translation category', args = { category, project = '0' } } )
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
return p