Modul:Documentation: Perbedaan antara revisi

Loncat ke navigasi Loncat ke pencarian

Modul:Documentation (sunting)

Revisi per 22 September 2023 09.17

422 bita dihapus ,  2 tahun yang lalu
tidak ada ringkasan suntingan
(←Membuat halaman berisi '-- This module implements {{documentation}}. -- Get required modules. local getArgs = require('Modul:Arguments').getArgs -- Get the config table. local cfg = mw.loadData('Modul:Documentation/config') local p = {} -- Often-used functions. local ugsub = mw.ustring.gsub ---------------------------------------------------------------------------- -- Helper functions -- -- These are defined as local functions, but are made available in the p -- table for testing...')
Tidak ada ringkasan suntingan
Tag: Dikembalikan
Baris 2: Baris 2:


-- Get required modules.
-- Get required modules.
local getArgs = require('Modul:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')


-- Get the config table.
-- Get the config table.
local cfg = mw.loadData('Modul:Documentation/config')
local cfg = mw.loadData('Module:Documentation/config')
 
local i18n = mw.loadData('Module:Documentation/i18n')
local p = {}
local p = {}


Baris 32: Baris 33:
expectType = expectType or 'string'
expectType = expectType or 'string'
if type(msg) ~= expectType then
if type(msg) ~= expectType then
error('pesan: type galat in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-type', cfgKey, expectType, type(msg)), 2)
end
end
if not valArray then
if not valArray then
Baris 40: Baris 41:
local function getMessageVal(match)
local function getMessageVal(match)
match = tonumber(match)
match = tonumber(match)
return valArray[match] or error('pesan: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
return valArray[match] or error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-empty', '$' .. match, cfgKey), 4)
end
end


local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
return ret
end
end
Baris 80: Baris 82:
ret[#ret + 1] = select(i, ...)
ret[#ret + 1] = select(i, ...)
end
end
-- 'documentation-toolbar'
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
return '<span class="' .. message('toolbar-class') .. '">('
end
.. table.concat(ret, ' &#124; ') .. ')</span>'
end


p.makeToolbar = makeToolbar
p.makeToolbar = makeToolbar
Baris 112: Baris 112:


----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Entry points
-- Load TemplateStyles
----------------------------------------------------------------------------
----------------------------------------------------------------------------


function p.nonexistent(frame)
p.main = function(frame)
if mw.title.getCurrentTitle().subpageText == 'testcases' then
local parent = frame.getParent(frame)
return frame:expandTemplate{title = 'module test cases notice'}
local output = p._main(parent.args)
else
return frame:extensionTag{ name='templatestyles', args = { src= message('templatestyles-scr') } } .. output
return p.main(frame)
end
end
end


p.main = makeInvokeFunc('_main')
----------------------------------------------------------------------------
-- Main function
----------------------------------------------------------------------------


function p._main(args)
function p._main(args)
Baris 129: Baris 129:
-- This function defines logic flow for the module.
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
-- @args - table of arguments passed by the user
--
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
--]]
local env = p.getEnvironment(args)
local env = p.getEnvironment(args)
Baris 136: Baris 140:
:wikitext(p.protectionTemplate(env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:wikitext(p.sandboxNotice(args, env))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:tag('div')
-- 'documentation-container'
:attr('id', message('main-div-id'))
:addClass(message('container'))
:addClass(message('main-div-class'))
:newline()
:wikitext(p._startBox(args, env))
:tag('div')
:wikitext(p._content(args, env))
-- 'documentation'
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
-- 'documentation-clear'
:addClass(message('clear'))
:done()
:newline()
:done()
:wikitext(p._endBox(args, env))
:done()
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
:wikitext(p.addTrackingCategories(env))
-- 'Module:Documentation/styles.css'
return tostring(root)
return mw.getCurrentFrame():extensionTag (
'templatestyles', '', {src=cfg['templatestyles']
}) .. tostring(root)
end
end


Baris 296: Baris 288:
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
-- /testcases pages in talk space.
local subjectSpace = env.subjectSpace
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
Baris 359: Baris 350:
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-template' --> '[[w:Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[w:Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-compare-link-display' --> 'diff'
Baris 371: Baris 362:
local templateTitle = env.templateTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
and mw.title.equals(title, sandboxTitle)) then
return nil
return nil
end
end
Baris 381: Baris 371:
-- "This is the template sandbox for [[Template:Foo]] (diff)."
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local text = ''
local text = ''
local frame = mw.getCurrentFrame()
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
local pagetype
local pagetype
if subjectSpace == 10 then
if subjectSpace == 10 then
Baris 402: Baris 394:
local testcasesTitle = env.testcasesTitle
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.namespace == mw.site.namespaces.Module.id then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
Baris 417: Baris 409:
text = text .. makeCategoryLink(message('sandbox-category'))
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
omargs.text = text
omargs.class = message('sandbox-class')
local ret = '<div style="clear: both;"></div>'
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
ret = ret .. messageBox.main('ombox', omargs)
Baris 428: Baris 421:
-- 'protection-template' --> 'pp-template'
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels = env.protectionLevels
local title = env.title
local protectionLevels
local protectionTemplate = message('protection-template')
local namespace = title.namespace
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then
-- Don't display the protection template if we are not in the template or module namespaces.
return nil
end
protectionLevels = env.protectionLevels
if not protectionLevels then
if not protectionLevels then
return nil
return nil
end
end
local editProt = protectionLevels.edit and protectionLevels.edit[1]
local editLevels = protectionLevels.edit
local moveProt = protectionLevels.move and protectionLevels.move[1]
local moveLevels = protectionLevels.move
if editProt then
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then
-- The page is edit-protected.
-- The page is full-move protected, or full, template, or semi-protected.
return require('Module:Protection banner')._main{
local frame = mw.getCurrentFrame()
message('protection-reason-edit'), small = true
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
return require('Module:Protection banner')._main{
action = 'move', small = true
}
else
else
return nil
return nil
Baris 517: Baris 510:
data.docTitle = docTitle
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = message('view-link-display')
data.viewLinkDisplay = i18n['view-link-display']
data.editLinkDisplay = message('edit-link-display')
data.editLinkDisplay = i18n['edit-link-display']
data.historyLinkDisplay = message('history-link-display')
data.historyLinkDisplay = i18n['history-link-display']
data.purgeLinkDisplay = message('purge-link-display')
data.purgeLinkDisplay = i18n['purge-link-display']
-- Create link if /doc doesn't exist.
-- Create link if /doc doesn't exist.
local preload = args.preload
local preload = args.preload
Baris 533: Baris 526:
end
end
data.preload = preload
data.preload = preload
data.createLinkDisplay = message('create-link-display')
data.createLinkDisplay = i18n['create-link-display']
return data
return data
end
end
Baris 578: Baris 571:
--
--
-- Messages:
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-create-link-display' --> 'create'
--]=]
--]=]
Baris 602: Baris 597:
data.heading = heading
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
data.heading = i18n['template-namespace-heading']
elseif subjectSpace == 828 then -- Module namespace
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
data.heading = i18n['module-namespace-heading']
elseif subjectSpace == 6 then -- File namespace
elseif subjectSpace == 6 then -- File namespace
data.heading = message('file-namespace-heading')
data.heading = i18n['file-namespace-heading']
else
else
data.heading = message('other-namespaces-heading')
data.heading = i18n['other-namespaces-heading']
end
-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
else
-- 'documentation-heading'
data.headingClass = message('main-div-heading-class')
end
end
Baris 635: Baris 621:
local sbox = mw.html.create('div')
local sbox = mw.html.create('div')
sbox
sbox
-- 'documentation-startbox'
:addClass(message('header-div-class'))
:addClass(message('start-box-class'))
:tag('div')
:newline()
:addClass(message('heading-div-class'))
:tag('span')
:addClass(data.headingClass)
:cssText(data.headingStyleText)
:wikitext(data.heading)
:wikitext(data.heading)
local links = data.links
local links = data.links
if links then
if links then
sbox:tag('span')
sbox
:addClass(data.linksClass)
:tag('div')
:attr('id', data.linksId)
:addClass(data.linksClass)
:wikitext(links)
:attr('id', data.linksId)
:wikitext(links)
end
end
return tostring(sbox)
return tostring(sbox)
Baris 666: Baris 650:
local content = args.content
local content = args.content
if not content and docTitle and docTitle.exists then
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle}
end
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'  
local cbox = mw.html.create('div')
cbox
:addClass(message('content-div-class'))
:wikitext('\n' .. (content or '') .. '\n')
return tostring(cbox)
end
end


Baris 696: Baris 684:
-- @args - a table of arguments passed by the user
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
--]=]
--]=]
Baris 722: Baris 709:
end
end


-- Assemble the link box.
-- Assemble the footer text field.
local text = ''
local text = ''
if linkBox then
if linkBox then
Baris 732: Baris 719:
-- Add sandbox and testcases links.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'
text = text .. (p.makeExperimentBlurb(args, env) or '')
text = text .. '<br />'
if not args.content and not args[1] then
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- "Please add categories to the /doc subpage."
Baris 746: Baris 734:
end
end
end
end
 
local box = mw.html.create('div')
local ebox = mw.html.create('div')
-- 'documentation-metadata'
ebox
box:addClass(message('end-box-class'))
:addClass(message('footer-div-class'))
-- 'plainlinks'
:addClass(message('end-box-plainlinks'))
:wikitext(text)
:wikitext(text)
:done()
return tostring(ebox)
 
return '\n' .. tostring(box)
end
end


Baris 768: Baris 752:
-- 'history-link-display' --> 'history'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->  
-- 'transcluded-from-blurb' -->  
-- 'The above [[Wikipedia:Template documentation|documentation]]  
-- 'The above [[w:Wikipedia:Template documentation|documentation]]  
-- is [[Help:Transclusion|transcluded]] from $1.'
-- is [[w:Wikipedia:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
-- 'You might want to $1 a documentation page for this [[w:Wikipedia:Lua|Scribunto module]].'
--]=]
--]=]
local docTitle = env.docTitle
local docTitle = env.docTitle
if not docTitle then
if not docTitle or args.content then
return nil
return nil
end
end
Baris 784: Baris 768:
local docLink = makeWikilink(docTitle.prefixedText)
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message('edit-link-display')
local editDisplay = i18n['edit-link-display']
local editLink = makeUrlLink(editUrl, editDisplay)
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message('history-link-display')
local historyDisplay = i18n['history-link-display']
local historyLink = makeUrlLink(historyUrl, historyDisplay)
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
ret = message('transcluded-from-blurb', {docLink})
Baris 796: Baris 780:
-- /doc does not exist; ask to create it.
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createDisplay = i18n['create-link-display']
local createLink = makeUrlLink(createUrl, createDisplay)
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
ret = message('create-module-doc-blurb', {createLink})
Baris 869: Baris 853:
local mirrorPreload = message('mirror-link-preload')
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
Baris 883: Baris 864:
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
if testcasesTitle.contentModel == "Scribunto"  and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
else
local testcasesPreload
local testcasesPreload
Diperoleh dari "https://wiki.javasatu.com/wiki/Istimewa:MobileDiff/1859"

Menu navigasi