Modded Wiki

Module:Documentation: Difference between revisions

← Older edit
No edit summary
m 1 revision imported
Tags: Mobile edit Mobile web edit
 
(139 intermediate revisions by 23 users not shown)
Line 1: Line 1:
local p = {}
local p = {}
-- Creating a documentation page or transclution through {{subst:doc}}
 
function p.create( f )
-- Load modules (language wikis exclusive)
-- ...
 
-- Customizable strings
local i18n = {
-- default settings, change when necessary
defaultDocPage = 'doc', -- documentation page suffix
defaultSandboxPage = 'sandbox', -- sandbox page suffix
defaultTestCasePage = 'testcases', -- testcases page suffix
defaultPreload = 'Template:Documentation/preload', -- page that stores qualified documentation page contents
defaultStyles = 'Module:Documentation/styles.css', -- stylesheet for this module when using TemplateStyles, remove or set to nil if your wiki not use this
 
-- format strings, should not be translated
commonInternalLink = '[[%s]]',
commonInternalLinkPipe = '[[%s|%s]]',
commonExternalLink = '[%s]',
commonExternalLinkWithName = '[%s %s]',
commonNamespacedPage = '%s:%s',
commonNamespacedPageWithSub = '%s:%s/%s',
 
-- namespace names, translate if your language prefers localized namespace name, although remain it untouched most likely not affect anything
namespaceCategory = 'Category',
namespaceSpecial = 'Special',
namespaceUser = 'User',
 
-- names of special pages, translate if your language prefers localized namespace name, although remain it untouched will still correctly linked to target page
specialPurge = 'Purge',
specialEdit = 'EditPage',
specialHistory = 'PageHistory',
 
-- translate following types if your language displays differ
pageType_page = 'page',
pageType_template = 'template',
pageType_module = 'module',
pageType_stylesheet = 'stylesheet',
pageType_script = 'script',
pageType_json = 'JSON',
pageType_message = 'message',
 
-- modify them if your wiki use different style to displaying links
linkBar = '%s', -- format used for whole link bar
linkFormat = mw.text.nowiki( '[' ) .. '%s' .. mw.text.nowiki( ']' ), -- format used for each individual links
linkSeparator = ' ', -- separator between links
 
-- name of different type of links, change them if necessary
linkTextPurge = mw.message.new( 'smw_purge' ):plain():lower(),
linkTextView = mw.message.new( 'view' ):plain():lower(),
linkTextEdit = mw.message.new( 'edit' ):plain():lower(),
linkTextHistory = mw.message.new( 'history_short' ):plain():lower(),
linkTextCreate = mw.message.new( 'create' ):plain():lower(),
 
-- strings used in p.create(): contents shown when using {{docc}} or {{subst:docc}}
createOutputFormat = '%s%s', -- overall format
createSplitDocPagePrompt = '\n<!-- Put categories/interwikis on the documentation page -->', -- this string is shown when a separate documentation page is created
createNoSubstCategory = 'Pages with templates requiring substitution', -- tracking category for using {{docc}} without substitution
 
-- strings used in p.docPage(): contents shown in documentation page
docPagePrompt = 'This is the documentation page. It %s transcluded into %s. See [[Template:Documentation]] for more information.', -- message shown as documentation header in documentation pages. Params: word used when page is a module or not; code page's type
docPagePromptWill = 'is', -- word used when code page is a module page
docPagePromptShould = 'should be', -- word used when code is not a module page
docPageBadDocPrompt = "<br>'''This %s's documentation needs improving or additional information.'''", -- additional message if a documentation page marked as baddoc
docPageCategory = 'Documentation pages', -- tracking category for documentation pages
 
-- strings used in p.page(): contents shown in code page
pageNoDocPrompt = "'''This %s has no documentation. If you know how to use this %s, please create it.'''", -- message shown when a separate documentation page is not exist, both parameters refers to page type
pageNoDocCategory = '%ss with no documentation', -- tracking category for pages without documentation, parameters refers to page type
pageNoDocCategoryDefault = 'Pages with no documentation', -- fallback tracking category for pages without documentation
pageBadDocPrompt = "'''This %s's documentation needs improving or additional information.'''\n", -- message shown when a documentation page marked as baddoc, both parameters refers to page type
pageBadDocCategory = '%ss with bad documentation', -- tracking category for pages marked as baddoc, parameters refers to page type
pageBadDocCategoryDefault = 'Pages with bad documentation', -- fallback tracking category for pages marked as baddoc
pageDocHeaderTitle = 'Documentation', -- message shown as the title of the documentation header
pageDocJumpToCode = 'Jump to code ↴', -- text of the link to jump to the code
pageDocHeaderBottom = 'The above documentation is transcluded from %s.', -- message shown as the bottom line of the documentation header
}
 
-- Customizable functions
local function pageCategoryHandler( category )
return mw.getCurrentFrame():expandTemplate{ title = 'translation category', args = { category, project = '0' } }
end
 
-- Load modules
local loadStyles = require( 'Module:TSLoader' ).call
 
local static = require( 'Module:Static' )
if not static.Documentation then
static.Documentation = {}
end
 
-- Internal functions
local function getType( namespace, page )
local pageType = 'page'
if namespace == 'Template' then
pageType = 'template'
elseif namespace == 'Module' then
pageType = 'module'
elseif page.fullText:gsub( '/' .. i18n.defaultDocPage .. '$', '' ):find( '%.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:gsub( '/' .. i18n.defaultDocPage .. '$', '' ):find( '%.js$' ) then
pageType = 'script'
elseif page.fullText:gsub( '/' .. i18n.defaultDocPage .. '$', '' ):find( '%.json$' ) then
pageType = 'json'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end
return pageType
end
 
local function getDisplayType( pageType )
return i18n[ 'pageType_' .. pageType ] or i18n.pageType_page
end
 
-- Exported functions
function p.create( f ) -- Creating a documentation page or transclusion through {{subst:docc}}
local args = require( 'Module:ProcessArgs' ).norm()
local args = require( 'Module:ProcessArgs' ).norm()
page = mw.title.getCurrentTitle()
local page = mw.title.getCurrentTitle()
namespace = args.type or page.nsText
local docPage = args.page or i18n.commonNamespacedPageWithSub:format( page.nsText, page.baseText, i18n.defaultDocPage )
docPage = mw.title.new( args.page or namespace .. ':' .. page.baseText .. '/doc' )
 
local out
local out
if page == docPage then
if not args.content and tostring( page ) == docPage then
out = f:preprocess( '{{subst:Template:Documentation/preload}}' )
local pageType = mw.ustring.lower( args.type or getType( page.nsText, page ) )
local pageTypeDisplay = getDisplayType( pageType )
out = f:preprocess( mw.title.new( i18n.defaultPreload ):getContent():gsub( '$1' , pageTypeDisplay ) )
else
else
local templateArgs = {}
local templateArgs = {}
if args.type then
for _, key in ipairs{ 'type', 'page', 'content', 'nodoc', 'baddoc' } do
table.insert( templateArgs, 'type=' .. args.type )
local val = args[ key ]
if val then
if key == 'content' then val = '\n' .. val .. '\n' end
table.insert( templateArgs, key .. '=' .. val )
end
end
end
if args.page then
out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}'
table.insert( templateArgs, 'page=' .. args.page )
end
out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}\n<!-- Put categories/interwiki on the documentation page -->'
out = out:gsub( '|}}', '}}' )
out = out:gsub( '|}}', '}}' )
out = i18n.createOutputFormat:format( out, args.content and '' or i18n.createSplitDocPagePrompt )
end
end
 
if not mw.isSubsting() then
if not mw.isSubsting() then
out = f:preprocess( out )
out = f:preprocess( out )
if not args.nocat then
if not args.nocat then
out = out .. '[[Category:Pages with templates requiring substitution]]'
out = out .. i18n.commonInternalLink:format( i18n.commonNamespacedPage:format( i18n.namespaceCategory, i18n.createNoSubstCategory ) )
end
end
end
end
 
return out
return out
end
end


-- Gateway function to page or docPage functions, depending on if viewing the documentation directly
function p.docPage( f ) -- Header on the documentation page
local args
local args = require( 'Module:ProcessArgs' ).merge( true )
local page
local badDoc = args.baddoc
local namespace
 
local docPage
if badDoc then
local pageType = 'template'
static.Documentation.badDoc = '1'
function p.doc( f )
args = require( 'Module:ProcessArgs' ).merge( true )
page = mw.title.getCurrentTitle()
namespace = args.type or page.nsText
docPage = mw.title.new( args.page or namespace .. ':' .. page.baseText .. '/doc' )
if namespace == 'Module' then
pageType = 'module'
elseif page.fullText:find( '.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:find( '.js$' ) then
pageType = 'script'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end
end
 
if page == docPage then
local page = mw.title.getCurrentTitle()
return p.docPage( f )
 
else
local subpage = page.subpageText
return p.page( f )
if subpage == i18n.defaultSandboxPage or subpage == i18n.defaultTestCasePage then
page = page.basePageTitle
end
end
end


-- Directly viewing the documentation page
local docPage = mw.title.new( args.page or i18n.commonNamespacedPageWithSub:format( page.nsText, page.baseText, i18n.defaultDocPage ) )
function p.docPage( f )
if docPage ~= page then return end
local badDoc = args.baddoc
 
local colour = 'EAF4F9'
local namespace = page.nsText
local message = ''
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
local pageTypeDisplay = getDisplayType( pageType )
 
local body = mw.html.create( 'div' ):addClass( 'documentation' )
body
:addClass( badDoc and 'documentation-badDoc' or '' )
:tag( 'div' ):addClass( 'documentation-header-tools' )
:wikitext( i18n.linkBar:format( i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialPurge, page.fullText ), i18n.linkTextPurge ) ) ) )
:done()
:wikitext( i18n.docPagePrompt:format( pageType == 'module' and i18n.docPagePromptWill or i18n.docPagePromptShould, i18n.commonInternalLink:format( i18n.commonNamespacedPage:format( namespace, page.baseText ) ) ) )
if badDoc then
if badDoc then
colour = 'F9F2EA'
body:wikitext( i18n.docPageBadDocPrompt:format( pageTypeDisplay ) )
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''"
end
end
if not ( args.nocat or namespace == i18n.namespaceUser ) then
local certainty = 'should'
body:wikitext( i18n.commonInternalLink:format( i18n.commonNamespacedPage:format( i18n.namespaceCategory, i18n.docPageCategory ) ) )
if pageType == 'module' then
end
certainty = 'will'
 
return loadStyles( i18n.defaultStyles ) .. tostring( body )
end
 
function p.page( f ) -- Wrapper around the documentation on the main page
-- 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
end
local args = require( 'Module:ProcessArgs' ).merge( true )
local category = ''
local page = mw.title.getCurrentTitle()
if not args.nocat then
local subpage = page.subpageText
category = '[[Category:Documentation pages]]'
if subpage == i18n.defaultSandboxPage or subpage == i18n.defaultTestCasePage then
page = page.basePageTitle
end
end
local namespace = page.nsText
local out = table.concat( {
local docText = trim( args.content or '' )
'<div style="margin-bottom:0.8em;padding:0.8em 1em 0.7em;background-color:#' .. colour .. ';border:1px solid #AAA">',
if docText == '' then docText = nil end
'<div style="float:right">[[' .. page:fullUrl( 'action=purge' ) .. ' purge]]</div>',
'<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>',
message,
'</div>',
category
}, '\n' )
return mw.text.trim( out )
end


-- Viewing the documentation on the main page
local docPage
function p.page( f )
local noDoc
docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/doc' )
if docText then
local noDoc = args.nodoc or not docPage.exists
docPage = page
else
docPage = mw.title.new( args.page or i18n.commonNamespacedPageWithSub:format( namespace, page.text, i18n.defaultDocPage ) )
noDoc = args.nodoc or not docPage.exists
end
local badDoc = args.baddoc
local badDoc = args.baddoc
local docText = ''
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
if not noDoc then
local pageTypeDisplay = getDisplayType( pageType )
docText = docPage:getContent()
 
badDoc = docText:match( '^%s*{{[Dd]ocumentation[^}]-|%s-baddoc%s-=%s-1%s-[^}]-}}' )
if not docText and not noDoc then
docText = mw.text.trim( f:preprocess( docText:gsub( '^%s*{{[Dd]ocumentation[^}]-}}', '' ) ) )
docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } )
if static.Documentation.badDoc and static.Documentation.badDoc == '1' then
badDoc = 1
end
 
if docText == '' then
if docText == '' then
docText = nil
noDoc = 1
noDoc = 1
else
docText = '\n' .. docText .. '\n'
end
end
end
end
if docText then
local action = 'edit'
docText = '\n' .. docText .. '\n'
local preload = ''
end
local colour = 'EAF4F9'
 
local message = ''
local docClass = ''
local category = ''
local message
local category
if noDoc then
if noDoc then
action = 'create'
docClass = 'documentation-noDoc'
preload = '&preload=Template:Documentation/preload'
message = i18n.pageNoDocPrompt:format( pageTypeDisplay, pageTypeDisplay )
colour = 'F9EAEA'
if not ( args.nocat or namespace == i18n.namespaceUser ) then
message = "'''This " .. pageType .. " has no documentation. If you know how to use this " .. pageType .. ", please create it.'''"
category = i18n.pageNoDocCategory:format( pageTypeDisplay )
if not args.nocat then
if not mw.title.new( i18n.commonNamespacedPage:format( i18n.namespaceCategory, category ) ).exists then
if mw.title.new( 'Category:' .. pageType .. 's with no documentation' ).exists then
category = i18n.pageNoDocCategoryDefault
category = '[[Category:' .. pageType .. 's with no documentation]]'
else
category = '[[Category:Pages with no documentation]]'
end
end
end
end
elseif badDoc then
elseif badDoc then
colour = 'F9F2EA'
docClass = 'documentation-badDoc'
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n"
message = i18n.pageBadDocPrompt:format( pageTypeDisplay )
if not args.nocat then
if not ( args.nocat or namespace == i18n.namespaceUser ) then
if mw.title.new( 'Category:' .. pageType .. 's with bad documentation' ).exists then
category = i18n.pageBadDocCategory:format( pageTypeDisplay )
category = '[[Category:' .. pageType .. 's with bad documentation]]'
if not mw.title.new( i18n.commonNamespacedPage:format( i18n.namespaceCategory, category ) ).exists then
else
category = i18n.pageBadDocCategoryDefault
category = '[[Category:Pages with bad documentation]]'
end
end
end
end
end
end
 
local links = {
-- Generates the link bar
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
local links = mw.html.create( 'span' ):addClass( 'documentation-header-tools' )
'[' .. page:fullUrl( 'action=purge' ) .. ' purge]'
 
}
local linkList = {}
local footer = ''
if not noDoc then
if not noDoc then
table.insert( links, 1, '[[' .. docPage.fullText .. '|view]]' )
if page ~= docPage then
footer = table.concat( {
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( docPage.fullText, i18n.linkTextView ) ) )
'<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',
end
'<div style="float:right">' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. ']</div>\n',
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialEdit, docPage.fullText ), i18n.linkTextEdit ) ) )
'<p style="margin:0">The above documentation is transcluded from [[' .. docPage.fullText .. ']].</p>\n',
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialHistory, docPage.fullText ), i18n.linkTextHistory ) ) )
'</div>\n'
else
} )
table.insert( linkList, i18n.linkFormat:format( i18n.commonExternalLinkWithName:format( docPage:canonicalUrl{ action = 'edit', preload = i18n.defaultPreload, preloadparams = pageTypeDisplay }, i18n.linkTextCreate ) ) )
end
end
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialPurge, docPage.fullText ), i18n.linkTextPurge ) ) )
local out = {
links:wikitext( i18n.linkBar:format( table.concat( linkList, i18n.linkSeparator ) ) )
'<div style="background-color:#' .. colour .. ';border:1px solid #AAA;padding:0.8em 1em 0.8em;clear:both">\n',
 
'<div style="margin:-0.8em -1em 0.8em;padding: 0.8em 1em 0.7em;background-color:#EAF4F9;border-bottom:1px solid #AAA">\n',
local body = mw.html.create( 'div' ):addClass( 'documentation' )
'<div style="float:right">' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. ']</div>\n',
body
'<span style="font-weight:bold;font-size:130%">Documentation</span>',
:addClass( docClass )
'</div>\n',
 
message,
local header = mw.html.create( 'div' )
docText,
:addClass( 'documentation-header-top' )
footer,
 
'</div>\n',
header
category
:tag( 'span' )
:addClass( 'documentation-header-title' )
:wikitext( i18n.pageDocHeaderTitle )
header
        :node( links )
 
local codePages = {
module = true,
stylesheet = true,
script = true,
}
}
if not noDoc and codePages[ pageType ] then
return mw.text.trim( table.concat( out ) )
header
:tag( 'span' )
:attr( 'id', 'documentation-jump-to-code' )
:wikitext( i18n.commonInternalLinkPipe:format( '#the-code', i18n.pageDocJumpToCode ) )
end
 
body
:node( header ):done()
:wikitext( message )
:wikitext( docText )
 
if not noDoc and page ~= docPage then
body
:tag( 'div' )
:addClass( 'documentation-header-bottom' )
:node( links )
:wikitext( i18n.pageDocHeaderBottom:format( i18n.commonInternalLink:format( docPage.fullText ) ) )
end
 
if category then
body:wikitext( pageCategoryHandler( category ) )
end
 
local anchor = ''
if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' )
end
 
return loadStyles( i18n.defaultStyles ) .. tostring( body ) .. tostring( anchor )
end
end
return p
return p
Retrieved from "https://modded.wiki/w/Module:Documentation"