(英語版 874266に更新 : classを追加) |
細 (en:1710802) |
||
(2人の利用者による、間の4版が非表示) | |||
1行目: | 1行目: | ||
local p = {} |
local p = {} |
||
+ | local defaultDocPage = 'doc' |
||
local getType = function( namespace, page ) |
local getType = function( namespace, page ) |
||
5行目: | 6行目: | ||
if namespace == 'Module' then |
if namespace == 'Module' then |
||
pageType = 'モジュール' |
pageType = 'モジュール' |
||
− | elseif |
+ | elseif namespace == 'Widget' then |
+ | pageType = 'ウィジェット' |
||
+ | elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then |
||
pageType = 'スタイルシート' |
pageType = 'スタイルシート' |
||
− | elseif page.fullText:gsub( '/ |
+ | elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.js$' ) then |
pageType = 'スクリプト' |
pageType = 'スクリプト' |
||
elseif namespace == 'MediaWiki' then |
elseif namespace == 'MediaWiki' then |
||
20行目: | 23行目: | ||
local args = require( 'モジュール:ProcessArgs' ).norm() |
local args = require( 'モジュール:ProcessArgs' ).norm() |
||
local page = mw.title.getCurrentTitle() |
local page = mw.title.getCurrentTitle() |
||
− | local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/ |
+ | local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage |
local out |
local out |
||
55行目: | 58行目: | ||
-- Header on the documentation page |
-- Header on the documentation page |
||
function p.docPage( f ) |
function p.docPage( f ) |
||
− | local args = require( ' |
+ | local args = require( 'モジュール:ProcessArgs' ).merge( true ) |
local badDoc = args.baddoc |
local badDoc = args.baddoc |
||
if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then |
if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then |
||
78行目: | 81行目: | ||
:tag( 'div' ) |
:tag( 'div' ) |
||
:css( 'float', 'right' ) |
:css( 'float', 'right' ) |
||
− | :wikitext( '[[', page:fullUrl( 'action=purge' ), ' |
+ | :wikitext( '[[', page:fullUrl( 'action=purge' ), ' キャッシュ破棄]]' ) |
:done() |
:done() |
||
:wikitext( |
:wikitext( |
||
'これは、メイン', pageType, 'ページに参照される', |
'これは、メイン', pageType, 'ページに参照される', |
||
− | pageType == 'モジュール |
+ | pageType == 'モジュール' and 'であろう' or 'べきである', |
'解説ページです。', |
'解説ページです。', |
||
'詳細については[[テンプレート:Documentation]]を参照してください' |
'詳細については[[テンプレート:Documentation]]を参照してください' |
||
) |
) |
||
if badDoc then |
if badDoc then |
||
− | body:wikitext( "<br>'''この", pageType, "の解説には、 |
+ | body:wikitext( "<br>'''この", pageType, "の解説には、追加の情報が必要とされています。'''" ) |
end |
end |
||
if not ( args.nocat or namespace == 'User' ) then |
if not ( args.nocat or namespace == 'User' ) then |
||
98行目: | 101行目: | ||
-- 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( 'モジュール:ProcessArgs' ).merge( true ) |
local args = require( 'モジュール:ProcessArgs' ).merge( true ) |
||
local page = mw.title.getCurrentTitle() |
local page = mw.title.getCurrentTitle() |
||
local namespace = page.nsText |
local namespace = page.nsText |
||
− | local docText = |
+ | local docText = trim( args.content or '' ) |
if docText == '' then docText = nil end |
if docText == '' then docText = nil end |
||
109行目: | 117行目: | ||
docPage = page |
docPage = page |
||
else |
else |
||
− | docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/ |
+ | docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/' .. defaultDocPage ) |
noDoc = args.nodoc or not docPage.exists |
noDoc = args.nodoc or not docPage.exists |
||
end |
end |
||
117行目: | 125行目: | ||
if not docText and not noDoc then |
if not docText and not noDoc then |
||
f:callParserFunction( '#dplvar:set', '$doc noheader', '1' ) |
f:callParserFunction( '#dplvar:set', '$doc noheader', '1' ) |
||
− | docText = |
+ | docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } ) |
if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then |
if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then |
||
badDoc = 1 |
badDoc = 1 |
||
150行目: | 158行目: | ||
elseif badDoc then |
elseif badDoc then |
||
colour = 'F9F2EA' |
colour = 'F9F2EA' |
||
− | message = "'''この" .. pageType .. "の解説には、 |
+ | message = "'''この" .. pageType .. "の解説には、情報の追加が必要とされています。'''\n" |
if not ( args.nocat or namespace == 'User' ) then |
if not ( args.nocat or namespace == 'User' ) then |
||
category = '不適切な解説を含む' .. pageType |
category = '不適切な解説を含む' .. pageType |
||
if not mw.title.new( 'カテゴリ:' .. category ).exists then |
if not mw.title.new( 'カテゴリ:' .. category ).exists then |
||
− | category = '不適切な |
+ | category = '不適切な内容を含むページ' |
end |
end |
||
end |
end |
||
165行目: | 173行目: | ||
} |
} |
||
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 .. '|閲覧]]' ) |
end |
end |
||
links = mw.html.create( 'span' ) |
links = mw.html.create( 'span' ) |
||
199行目: | 207行目: | ||
:wikitext( '解説' ) |
:wikitext( '解説' ) |
||
+ | local codePages = { |
||
− | if not noDoc and pageType ~= 'template' and pageType ~= 'message' then |
||
+ | ['モジュール'] = true, |
||
+ | ['スタイルシート'] = true, |
||
+ | ['スクリプト'] = 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|コードへ移動 ↴]]' ) |
end |
end |
||
226行目: | 239行目: | ||
if category then |
if category then |
||
− | body:wikitext( f:expandTemplate{ title = ' |
+ | body:wikitext( f:expandTemplate{ title = 'Translation category', args = { category, project = '0' } } ) |
end |
end |
||
2020年11月28日 (土) 03:45時点における版
このモジュールは {{Documentation}}
を実装しています。
依存関係
[閲覧 | 編集 | 履歴 | キャッシュ破棄]上記の解説は、モジュール:Documentation/docから参照されています。
local p = {}
local defaultDocPage = 'doc'
local getType = function( namespace, page )
local pageType = 'テンプレート'
if namespace == 'Module' then
pageType = 'モジュール'
elseif namespace == 'Widget' then
pageType = 'ウィジェット'
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then
pageType = 'スタイルシート'
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.js$' ) then
pageType = 'スクリプト'
elseif namespace == 'MediaWiki' then
pageType = 'メッセージ'
end
return pageType
end
-- Creating a documentation page or transclution through {{subst:doc}}
function p.create( f )
local args = require( 'モジュール: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:テンプレート: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 .. '[[カテゴリ:テンプレートの置換を必要とするページ]]'
end
end
return out
end
-- Header on the documentation page
function p.docPage( f )
local args = require( 'モジュール: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' ), ' キャッシュ破棄]]' )
:done()
:wikitext(
'これは、メイン', pageType, 'ページに参照される',
pageType == 'モジュール' and 'であろう' or 'べきである',
'解説ページです。',
'詳細については[[テンプレート:Documentation]]を参照してください'
)
if badDoc then
body:wikitext( "<br>'''この", pageType, "の解説には、追加の情報が必要とされています。'''" )
end
if not ( args.nocat or namespace == 'User' ) then
body:wikitext( '[[カテゴリ:解説ページ]]' )
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( 'モジュール: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 = '編集'
local preload = ''
local colour = 'EAF4F9'
local message
local category
if noDoc then
action = '作成'
preload = '&preload=テンプレート:Documentation/preload'
colour = 'F9EAEA'
message = "'''この" .. pageType .. "には解説がありません。" ..
"もしあなたがこの" .. pageType .. "を使用する方法を知っている場合は、解説ページを作成してください。'''"
if not ( args.nocat or namespace == 'User' ) then
category = '解説のない' .. pageType
if not mw.title.new( 'カテゴリ:' .. category ).exists then
category = '解説のないページ'
end
end
elseif badDoc then
colour = 'F9F2EA'
message = "'''この" .. pageType .. "の解説には、情報の追加が必要とされています。'''\n"
if not ( args.nocat or namespace == 'User' ) then
category = '不適切な解説を含む' .. pageType
if not mw.title.new( 'カテゴリ:' .. category ).exists then
category = '不適切な内容を含むページ'
end
end
end
local links = {
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
'[' .. docPage:fullUrl( 'action=history' ) .. ' 履歴]',
'[' .. page:fullUrl( 'action=purge' ) .. ' キャッシュ破棄]'
}
if not noDoc and page ~= docPage then
table.insert( links, 1, '[[' .. docPage.fullText .. '|閲覧]]' )
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( '解説' )
local codePages = {
['モジュール'] = true,
['スタイルシート'] = true,
['スクリプト'] = true,
}
if not noDoc and codePages[pageType] then
header
:tag( 'span' )
:css( 'white-space', 'nowrap' )
:wikitext( '[[#the-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( '上記の解説は、[[', 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 ~= 'テンプレート' and pageType ~= 'メッセージ' then
anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' )
end
return tostring( body ) .. tostring( anchor )
end
return p