This documentation is transcluded from Module:Documentation/doc. Changes can be proposed in the talk page.
Module:Documentation loads messages from Module:Documentation/i18n.json.
This module is designed to be language-neutral. All of the messages are saved in the i18n.json subpage.
This module is unused.
This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add
{{Documentation}}/{{No documentation}} to the calling template's or parent's module documentation.
| Function list |
|---|
| L 9 — p.doc |
Module:Documentation implements Template:Documentation for templates and modules.
local dependencyList = require( 'Module:DependencyList' )
local hatnote = require( 'Module:Hatnote' )._hatnote
local mbox = require( 'Module:Mbox' )._mbox
local SMWUtil = require("Module:SMWUtil")
local showProperty = SMWUtil.get
local askForPages = SMWUtil.askForPages
local p = {}
function p.doc( frame )
local title = mw.title.getCurrentTitle()
local args = frame:getParent().args
local page = args[1] or mw.ustring.gsub( title.fullText, '/[Dd]o[ck]u?$', '' )
local ret, cats, ret1, ret2, ret3
local pageType = title.namespace == 828 and "module" or "template"
-- subpage header
if title.subpageText == 'doc' then
ret = mbox(
"This is a documentation subpage for "..page..".",
"It contains usage information, categories, and other content that is not part of the [["..page.."|original "..pageType.."]].",
{ icon = 'WikimediaUI-Notice.svg' }
)
if title.namespace == 10 then -- Template namespace
cats = '[[Category:Template_documentation|' .. title.baseText .. ']]'
ret2 = dependencyList._main()
elseif title.namespace == 828 then -- Module namespace
cats = '[[Category:Module_documentation|' .. title.baseText .. ']]'
ret2 = dependencyList._main()
ret2 = ret2 .. require('Module:Module toc').main()
else
cats = ''
ret2 = ''
end
return tostring( ret ) .. ret2 .. cats
end
-- template header
-- don't use mw.html as we aren't closing the main div tag
ret1 = '<div class="documentation">'
ret2 = mw.html.create( nil )
:tag( 'div' )
:addClass( 'documentation-header' )
:tag( 'span' )
:addClass( 'documentation-title' )
:wikitext( pageType:gsub("^%l", string.upper).." documentation" )
:done()
:tag( 'span' )
:addClass( 'documentation-links plainlinks' )
:wikitext(
'[[' .. tostring( mw.uri.fullUrl( page .. '/doc', {action='view'} ) ) .. ' view]]' ..
'[[' .. tostring( mw.uri.fullUrl( page .. '/doc', {action='edit'} ) ) .. ' edit]]' ..
'[[' .. tostring( mw.uri.fullUrl( page .. '/doc', {action='history'} ) ) .. ' history]]' ..
'[<span class="jsPurgeLink">[' .. tostring( mw.uri.fullUrl( title.fullText, { action = 'purge' } ) ) .. ' purge]</span>]'
)
:done()
:done()
:tag( 'div' )
:addClass( 'documentation-subheader' )
:tag( 'span' )
:addClass( 'documentation-documentation' )
:wikitext( "This documentation is transcluded from [["..page.."/doc]]. Changes can be proposed in the talk page." )
:done()
:wikitext( frame:extensionTag{ name = 'templatestyles', args = { src = 'Module:Documentation/styles.css'} } )
:done()
ret3 = {}
--if args.drShared then
--- Message box (shared across box)
--table.insert( ret3,
-- mbox(
-- translate(
-- 'message_shared_across',
-- title.fullText,
-- mw.uri.encode( title.text, 'PATH' )
-- ),
-- translate(
-- 'message_shared_across_subtext',
-- pageType
-- ),
-- { icon = 'WikimediaUI-ArticleDisambiguation-ltr.svg' }
-- )
--)
--- Set category
--table.insert( ret3, '[[Category:' .. mw.ustring.format('category_shared_across' , pageType:gsub("^%l", string.upper) ) .. ']]' )
--end
if args.fromWikipedia then
table.insert( ret3,
mbox(
"'''"..title.fullText.."''' is imported from [https://en.wikipedia.org/wiki/"..mw.uri.encode( page, 'WIKI' ).." "..page.."] on Wikipedia.",
"This "..pageType.." is imported from the English Wikipedia. Although the visual appearance might be different, the functionality is identical. Please refer to the Wikipedia page for detailed documentation.",
{ icon = 'WikimediaUI-Logo-Wikipedia.svg' }
)
)
--- Set category
table.insert(ret3, '[[Category:' .. mw.ustring.format('category_from_wikipedia', pageType:gsub("^%l", string.upper)) .. ']]' )
end
if args.fromStarCitizen then
local link
if args.StarCitizenLink then
link = args.StarCitizenLink
else
link = "https://starcitizen.tools/"..mw.uri.encode( page, 'WIKI' ).." "..page
end
table.insert( ret3,
mbox(
"'''"..title.fullText.."''' is imported from ["..link.."] on StarCitizen.",
"This "..pageType.." is imported from StarCitizen. Although the visual appearance is similar, some functionality has been altered. Please refer to the Star Citizen page for detailed documentation.",
{ icon = 'StarCitizenAttribution.svg' }
)
)
--- Set category
table.insert(ret3, '[[Category:' .. string.format('%ss imported from Star Citizen', pageType:gsub("^%l", string.upper)) .. ']]' )
end
if args.usesSMW then
table.insert( ret3,
mbox(
"This "..pageType.." uses Semantic MediaWiki to automatically query and display article data.",
"To edit data for an article in this "..pageType..", edit the article's infobox! Refer to the [[Project:SMW Guide|SMW Guide]] and the [[smw:User manual|SMW user manual]] for more information.",
{ icon = 'SMW logo 2020.svg' }
)
)
--- Set category
table.insert(ret3, '[[Category:SMW Templates]]' )
end
if title.namespace == 828 then
-- Has config
if mw.title.new( title.fullText .. '/config.json', 'Module' ).exists then
table.insert( ret3,
mbox("'''"..title.fullText.."''' loads configuration from [["..title.fullText.."/config.json]].",
"This module can be configurated from the config.json subpage.",
{ icon = 'WikimediaUI-Settings.svg' }
)
)
end
-- Has localization
if mw.title.new( title.fullText .. '/i18n.json', 'Module' ).exists then
table.insert( ret3,
mbox(
"'''"..title.fullText.."''' loads messages from [["..title.fullText.."/i18n.json]].",
"This module is designed to be language-neutral. All of the messages are saved in the i18n.json subpage.",
{ icon = 'OOjs UI icon language-ltr.svg' }
)
)
end
-- Testcase page
if title.subpageText == 'testcases' then
table.insert( ret3,
hatnote(
"This is the test cases page for the module [[Module:"..title.baseText"..]].",
{ icon = 'WikimediaUI-LabFlask.svg' }
)
)
end
-- Sandbox page
if title.subpageText == 'Sandbox' then
table.insert( ret3,
hatnote(
"This is the Sandbox page for the module [[Module:"..title.baseText"..]].",
{ icon = 'OOjs_UI_icon_beta.svg' }
)
)
end
table.insert(ret3, mw.ustring.format('[[Category:%s]]', 'Module'))
end
--- Dependency list
table.insert( ret3, dependencyList._main( nil, args.category, args.isUsed ) )
-- Has templatestyles
if mw.title.new( title.fullText .. '/styles.css' ).exists then
table.insert( ret3,
hatnote(
"'''"..title.fullText.."''' loads styles from [["..title.fullText.."/styles.css]].",
{ icon = 'WikimediaUI-Palette.svg' }
)
)
end
-- Sandbox
local sandboxTitle = title.baseText .. '/Sandbox'
if mw.title.new( sandboxTitle, 'Module' ).exists then
table.insert( ret3,
mbox(
"'''"..title.fullText.."''' has a the Sandbox page [["..title.fullText.."/Sandbox]].",
"To Avoid disruption, any changes should be tested in the Sandbox. Changes can be added once fully tested.",
{ icon = 'OOjs_UI_icon_beta.svg' }
)
)
end
--- Module stats bar
if title.namespace == 828 then
table.insert( ret3, '<div class="documentation-modulestats">' )
-- Function list
table.insert( ret3, require( 'Module:Module toc' ).main() )
-- Unit tests
local testcaseTitle = title.baseText .. '/testcases'
if mw.title.new( testcaseTitle, 'Module' ).exists then
-- There is probably a better way :P
table.insert( ret3, frame:preprocess( '{{#invoke:' .. testcaseTitle .. '|run}}' ) )
end
table.insert( ret3, '</div>' )
end
return ret1 .. tostring( ret2 ) .. '<div class="documentation-content">' .. table.concat( ret3 )
end
return p