Module:Documentation : Différence entre versions
Sauter à la navigation
Sauter à la recherche
mcen>Majr (Don't show jump link on widgets) |
|||
Ligne 3 : | Ligne 3 : | ||
local getType = function( namespace, page ) | local getType = function( namespace, page ) | ||
− | local pageType = ' | + | local pageType = 'template' |
if namespace == 'Module' then | if namespace == 'Module' then | ||
pageType = 'module' | pageType = 'module' | ||
+ | elseif namespace == 'Widget' then | ||
+ | pageType = 'widget' | ||
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then | elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then | ||
pageType = 'stylesheet' | pageType = 'stylesheet' | ||
Ligne 25 : | Ligne 27 : | ||
local out | local out | ||
if not args.content and tostring( page ) == docPage then | if not args.content and tostring( page ) == docPage then | ||
− | out = f:preprocess( '{{subst: | + | out = f:preprocess( '{{subst:Template:Documentation/preload}}' ) |
else | else | ||
local templateArgs = {} | local templateArgs = {} | ||
Ligne 47 : | Ligne 49 : | ||
out = f:preprocess( out ) | out = f:preprocess( out ) | ||
if not args.nocat then | if not args.nocat then | ||
− | out = out .. '[[ | + | out = out .. '[[Category:Pages with templates requiring substitution]]' |
end | end | ||
end | end | ||
Ligne 79 : | Ligne 81 : | ||
:tag( 'div' ) | :tag( 'div' ) | ||
:css( 'float', 'right' ) | :css( 'float', 'right' ) | ||
− | :wikitext( '[[', page:fullUrl( 'action=purge' ), ' | + | :wikitext( '[[', page:fullUrl( 'action=purge' ), ' purge]]' ) |
:done() | :done() | ||
:wikitext( | :wikitext( | ||
− | ' | + | 'This is the documentation page, it ', |
− | pageType == 'module' and ' | + | 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 | ||
− | body:wikitext( "<br>''' | + | body:wikitext( "<br>'''This ", pageType, "'s documentation needs improving or additional information.'''" ) |
end | end | ||
− | if not ( args.nocat or namespace == ' | + | if not ( args.nocat or namespace == 'User' ) then |
− | body:wikitext( '[[ | + | body:wikitext( '[[Category:Documentation pages]]' ) |
end | end | ||
Ligne 136 : | Ligne 138 : | ||
end | end | ||
− | local action = ' | + | local action = 'edit' |
local preload = '' | local preload = '' | ||
local colour = 'EAF4F9' | local colour = 'EAF4F9' | ||
Ligne 142 : | Ligne 144 : | ||
local category | local category | ||
if noDoc then | if noDoc then | ||
− | action = ' | + | action = 'create' |
− | preload = '&preload= | + | preload = '&preload=Template:Documentation/preload' |
colour = 'F9EAEA' | colour = 'F9EAEA' | ||
− | message = "''' | + | message = "'''This " .. pageType .. " has no documentation. " .. |
− | " | + | "If you know how to use this " .. pageType .. ", please create it.'''" |
− | if not ( args.nocat or namespace == ' | + | if not ( args.nocat or namespace == 'User' ) then |
− | category = pageType .. ' | + | category = pageType .. 's with no documentation' |
− | if not mw.title.new( ' | + | if not mw.title.new( 'Category:' .. category ).exists then |
− | category = 'Pages | + | category = 'Pages with no documentation' |
end | end | ||
end | end | ||
elseif badDoc then | elseif badDoc then | ||
colour = 'F9F2EA' | colour = 'F9F2EA' | ||
− | message = "''' | + | message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n" |
− | if not ( args.nocat or namespace == ' | + | if not ( args.nocat or namespace == 'User' ) then |
− | category = pageType .. 's | + | category = pageType .. 's with bad documentation' |
− | if not mw.title.new( ' | + | if not mw.title.new( 'Category:' .. category ).exists then |
− | category = 'Pages | + | category = 'Pages with bad documentation' |
end | end | ||
end | end | ||
Ligne 166 : | Ligne 168 : | ||
local links = { | local links = { | ||
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']', | '[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']', | ||
− | '[' .. docPage:fullUrl( 'action=history' ) .. ' | + | '[' .. docPage:fullUrl( 'action=history' ) .. ' history]', |
− | '[' .. page:fullUrl( 'action=purge' ) .. ' | + | '[' .. page:fullUrl( 'action=purge' ) .. ' purge]' |
} | } | ||
if not noDoc and page ~= docPage then | if not noDoc and page ~= docPage then | ||
− | table.insert( links, 1, '[[' .. docPage.fullText .. '| | + | table.insert( links, 1, '[[' .. docPage.fullText .. '|view]]' ) |
end | end | ||
links = mw.html.create( 'span' ) | links = mw.html.create( 'span' ) | ||
Ligne 204 : | Ligne 206 : | ||
:wikitext( 'Documentation' ) | :wikitext( 'Documentation' ) | ||
− | if not noDoc and pageType | + | local codePages = { |
+ | module = true, | ||
+ | stylesheet = true, | ||
+ | script = true, | ||
+ | } | ||
+ | if not noDoc and codePages[pageType] then | ||
header | header | ||
:tag( 'span' ) | :tag( 'span' ) | ||
:css( 'white-space', 'nowrap' ) | :css( 'white-space', 'nowrap' ) | ||
− | :wikitext( '[[#the-code| | + | :wikitext( '[[#the-code|Jump to code ↴]]' ) |
end | end | ||
Ligne 227 : | Ligne 234 : | ||
} | } | ||
:node( links ) | :node( links ) | ||
− | :wikitext( ' | + | :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 | end | ||
local anchor = '' | local anchor = '' | ||
− | if not noDoc and pageType ~= ' | + | if not noDoc and pageType ~= 'template' and pageType ~= 'message' then |
anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' ) | anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' ) | ||
end | end | ||
− | + | return tostring( body ) .. tostring( anchor ) | |
− | |||
− | |||
− | |||
− | |||
− | return tostring( body ) .. tostring( anchor ) | ||
end | end | ||
return p | return p |
Version du 31 octobre 2018 à 12:34
[purge]
This is the documentation page, it will be transcluded into the main module page. See Template:Documentation for more informationThis module implements {{Documentation}}
.
Dependencies
ko:모듈:Documentation
pl:Moduł:Dokumentacja
ru:Модуль:Документация
zh:模块:Documentation
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 transclution through {{subst:doc}} 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/interwiki 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 namespace = page.nsText local pageType = mw.ustring.lower( args.type or getType( namespace, page ) ) local body = mw.html.create( 'div' ):addClass( 'documentation-header' ) 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 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 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 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 = 'edit' local preload = '' local colour = 'EAF4F9' local message local category if noDoc then action = 'create' preload = '&preload=Template:Documentation/preload' 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 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' ) .. ' history]', '[' .. page:fullUrl( 'action=purge' ) .. ' purge]' } if not noDoc and page ~= docPage then table.insert( links, 1, '[[' .. docPage.fullText .. '|view]]' ) end links = mw.html.create( 'span' ) :css( 'float', 'right' ) :wikitext( mw.text.nowiki( '[' ), table.concat( links, ' | ' ), mw.text.nowiki( ']' ) ) local body = mw.html.create( 'div' ):addClass( 'documentation' ) body: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' ) :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' ) local codePages = { module = true, stylesheet = true, script = true, } if not noDoc and codePages[pageType] 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 and page ~= docPage 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( 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