Modded Wiki

Module:Documentation: Difference between revisions

← Older edit
mNo edit summary
m 1 revision imported
Tags: Mobile edit Mobile web edit
 
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
local p = {}
local p = {}


local defaultDocPage = 'doc'
-- Load modules (language wikis exclusive)
local docPreload = 'Template:Documentation/preload'
-- ...
local docStyle = 'Module:Documentation/styles.css'


local static = require( 'Module:Static' )
-- 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


local i18n = {
-- format strings, should not be translated
-- format strings, should not be translated
commonInternalLink = '[[%s]]',
commonInternalLink = '[[%s]]',
Line 13: Line 18:
commonExternalLink = '[%s]',
commonExternalLink = '[%s]',
commonExternalLinkWithName = '[%s %s]',
commonExternalLinkWithName = '[%s %s]',
commonCategory = 'Category:%s', -- translate if your language prefers localized name, although remain it untouched most likely not affect anything
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
-- translate following types if your language displays differ
pageType_page = 'page',
pageType_template = 'template',
pageType_template = 'template',
pageType_module = 'module',
pageType_module = 'module',
pageType_widget = 'widget',
pageType_stylesheet = 'stylesheet',
pageType_stylesheet = 'stylesheet',
pageType_script = 'script',
pageType_script = 'script',
pageType_json = 'JSON',
pageType_message = 'message',
pageType_message = 'message',


Line 29: Line 46:


-- name of different type of links, change them if necessary
-- name of different type of links, change them if necessary
linkTextPurge = mw.getCurrentFrame():callParserFunction( 'int:smw_purge' ):lower(),
linkTextPurge = mw.message.new( 'smw_purge' ):plain():lower(),
linkTextView = mw.getCurrentFrame():callParserFunction( 'int:view' ):lower(),
linkTextView = mw.message.new( 'view' ):plain():lower(),
linkTextEdit = mw.getCurrentFrame():callParserFunction( 'int:edit' ):lower(),
linkTextEdit = mw.message.new( 'edit' ):plain():lower(),
linkTextHistory = mw.getCurrentFrame():callParserFunction( 'int:history_short' ):lower(),
linkTextHistory = mw.message.new( 'history_short' ):plain():lower(),
linkTextCreate = mw.getCurrentFrame():callParserFunction( 'int:create' ):lower(),
linkTextCreate = mw.message.new( 'create' ):plain():lower(),


-- strings used in p.create(): contents shown when using {{docc}} or {{subst:docc}}
-- strings used in p.create(): contents shown when using {{docc}} or {{subst:docc}}
createOutputFormat = '%s%s', -- overall format
createOutputFormat = '%s%s', -- overall format
createSplitDocPagePrompt = '\n<!-- Put categories/interwikis on the documentation page -->', -- this string will shown when a separate documentation page will be created
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
createNoSubstCategory = 'Pages with templates requiring substitution', -- tracking category for using {{docc}} without substitution


-- strings used in p.docPage(): contents shown in documentation page
-- strings used in p.docPage(): contents shown in documentation page
docPagePrompt = 'This is the documentation page. It %s be transcluded into the main %s page. 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
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 = 'will', -- word used when code page is a module page
docPagePromptWill = 'is', -- word used when code page is a module page
docPagePromptShould = 'should', -- word used when code is not 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
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
docPageCategory = 'Documentation pages', -- tracking category for documentation pages
Line 59: Line 76:
}
}


-- 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 function getType( namespace, page )
local pageType = 'template'
local pageType = 'page'
 
if namespace == 'Template' then
if namespace == 'Module' then
pageType = 'template'
elseif namespace == 'Module' then
pageType = 'module'
pageType = 'module'
elseif namespace == 'Widget' then
elseif page.fullText:gsub( '/' .. i18n.defaultDocPage .. '$', '' ):find( '%.css$' ) then
pageType = 'widget'
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then
pageType = 'stylesheet'
pageType = 'stylesheet'
elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.js$' ) then
elseif page.fullText:gsub( '/' .. i18n.defaultDocPage .. '$', '' ):find( '%.js$' ) then
pageType = 'script'
pageType = 'script'
elseif page.fullText:gsub( '/' .. i18n.defaultDocPage .. '$', '' ):find( '%.json$' ) then
pageType = 'json'
elseif namespace == 'MediaWiki' then
elseif namespace == 'MediaWiki' then
pageType = 'message'
pageType = 'message'
end
end
return pageType
end


return pageType
local function getDisplayType( pageType )
return i18n[ 'pageType_' .. pageType ] or i18n.pageType_page
end
end


-- Creating a documentation page or transclusion through {{subst:docc}}
-- Exported functions
function p.create( f )
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()
local page = mw.title.getCurrentTitle()
local page = mw.title.getCurrentTitle()
local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage
local docPage = args.page or i18n.commonNamespacedPageWithSub:format( page.nsText, page.baseText, i18n.defaultDocPage )
 
local out
local out
if not args.content and tostring( page ) == docPage then
if not args.content and tostring( page ) == docPage then
-- local pageType = mw.ustring.lower( args.type or getType( page.nsText, page ) )
local pageType = mw.ustring.lower( args.type or getType( page.nsText, page ) )
-- local pageTypeDisplay = i18n[ 'pageType_' .. pageType ] or i18n.pageTypeTemplate
local pageTypeDisplay = getDisplayType( pageType )
out = f:preprocess( '{{subst:' .. docPreload .. '}}' )
out = f:preprocess( mw.title.new( i18n.defaultPreload ):getContent():gsub( '$1' , pageTypeDisplay ) )
-- out = out:gsub( '$1' , pageTypeDisplay )
else
else
local templateArgs = {}
local templateArgs = {}
Line 106: Line 140:
out = f:preprocess( out )
out = f:preprocess( out )
if not args.nocat then
if not args.nocat then
out = out .. i18n.commonInternalLink:format( i18n.commonCategory:format( i18n.createNoSubstCategory ) )
out = out .. i18n.commonInternalLink:format( i18n.commonNamespacedPage:format( i18n.namespaceCategory, i18n.createNoSubstCategory ) )
end
end
end
end
Line 113: Line 147:
end
end


-- Header on the documentation page
function p.docPage( f ) -- Header on the documentation page
function p.docPage( f )
local args = require( 'Module:ProcessArgs' ).merge( true )
local args = require( 'Module:ProcessArgs' ).merge( true )
local badDoc = args.baddoc
local badDoc = args.baddoc


mw.logObject( badDoc, 'Module:Documentation: badDoc' )
if badDoc then
if badDoc then
static.badDoc = '1'
static.Documentation.badDoc = '1'
end
end


Line 126: Line 158:


local subpage = page.subpageText
local subpage = page.subpageText
if subpage == 'sandbox' or subpage == 'testcases' then
if subpage == i18n.defaultSandboxPage or subpage == i18n.defaultTestCasePage then
page = page.basePageTitle
page = page.basePageTitle
end
end


local docPage = mw.title.new( args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage )
local docPage = mw.title.new( args.page or i18n.commonNamespacedPageWithSub:format( page.nsText, page.baseText, i18n.defaultDocPage ) )
mw.logObject( docPage, 'Module:Documentation: docPage' )
mw.logObject( page, 'Module:Documentation: page' )
if docPage ~= page then return end
if docPage ~= page then return end


local namespace = page.nsText
local namespace = page.nsText
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
local pageTypeDisplay = i18n[ 'pageType_' .. pageType ] or i18n.pageTypeTemplate
local pageTypeDisplay = getDisplayType( pageType )


local body = mw.html.create( 'div' ):addClass( 'documentation' )
local body = mw.html.create( 'div' ):addClass( 'documentation' )
body
body
:addClass( badDoc and 'documentation-badDoc' or '' )
:addClass( badDoc and 'documentation-badDoc' or '' )
:tag( 'div' )
:tag( 'div' ):addClass( 'documentation-header-tools' )
:attr( 'id', 'documentation-header-tools' )
:wikitext( i18n.linkBar:format( i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialPurge, page.fullText ), i18n.linkTextPurge ) ) ) )
:wikitext( i18n.linkBar:format( i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( 'Special:Purge/' .. page.fullText, i18n.linkTextPurge ) ) ) )
:done()
:done()
:wikitext( i18n.docPagePrompt:format( pageType == 'module' and i18n.docPagePromptWill or i18n.docPagePromptShould, pageTypeDisplay ) )
: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
body:wikitext( i18n.docPageBadDocPrompt:format( pageTypeDisplay ) )
body:wikitext( i18n.docPageBadDocPrompt:format( pageTypeDisplay ) )
end
end
if not ( args.nocat or namespace == 'User' ) then
if not ( args.nocat or namespace == i18n.namespaceUser ) then
body:wikitext( i18n.commonInternalLink:format( i18n.commonCategory:format( i18n.docPageCategory ) ) )
body:wikitext( i18n.commonInternalLink:format( i18n.commonNamespacedPage:format( i18n.namespaceCategory, i18n.docPageCategory ) ) )
end
end


mw.logObject( body, 'Module:Documentation: body' )
return loadStyles( i18n.defaultStyles ) .. tostring( body )
 
return mw.getCurrentFrame():extensionTag{ name = "templatestyles", args = { src = docStyle } } .. tostring( body )
end
end


-- Wrapper around the documentation on the main page
function p.page( f ) -- 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
-- mw.text.trim uses mw.ustring.gsub, which silently fails on large strings
local function trim( s )
local function trim( s )
Line 169: Line 195:
local page = mw.title.getCurrentTitle()
local page = mw.title.getCurrentTitle()
local subpage = page.subpageText
local subpage = page.subpageText
if subpage == 'sandbox' or subpage == 'testcases' then
if subpage == i18n.defaultSandboxPage or subpage == i18n.defaultTestCasePage then
page = page.basePageTitle
page = page.basePageTitle
end
end
Line 181: Line 207:
docPage = page
docPage = page
else
else
docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/' .. defaultDocPage )
docPage = mw.title.new( args.page or i18n.commonNamespacedPageWithSub:format( namespace, page.text, i18n.defaultDocPage ) )
noDoc = args.nodoc or not docPage.exists
noDoc = args.nodoc or not docPage.exists
end
end
local badDoc = args.baddoc
local badDoc = args.baddoc
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
local pageTypeDisplay = getDisplayType( pageType )


if not docText and not noDoc then
if not docText and not noDoc then
docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } )
docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } )
if static.badDoc and static.badDoc == '1' then
if static.Documentation.badDoc and static.Documentation.badDoc == '1' then
mw.logObject( static, 'static' )
badDoc = 1
badDoc = 1
end
end
 
if docText == '' then
if docText == '' then
docText = nil
docText = nil
Line 208: Line 234:
if noDoc then
if noDoc then
docClass = 'documentation-noDoc'
docClass = 'documentation-noDoc'
message = i18n.pageNoDocPrompt:format( pageType, pageType )
message = i18n.pageNoDocPrompt:format( pageTypeDisplay, pageTypeDisplay )
if not ( args.nocat or namespace == 'User' ) then
if not ( args.nocat or namespace == i18n.namespaceUser ) then
category = i18n.pageNoDocCategory:format( pageType )
category = i18n.pageNoDocCategory:format( pageTypeDisplay )
if not mw.title.new( i18n.commonCategory:format( category ) ).exists then
if not mw.title.new( i18n.commonNamespacedPage:format( i18n.namespaceCategory, category ) ).exists then
category = i18n.pageNoDocCategoryDefault
category = i18n.pageNoDocCategoryDefault
end
end
Line 217: Line 243:
elseif badDoc then
elseif badDoc then
docClass = 'documentation-badDoc'
docClass = 'documentation-badDoc'
message = i18n.pageBadDocPrompt:format( pageType )
message = i18n.pageBadDocPrompt:format( pageTypeDisplay )
if not ( args.nocat or namespace == 'User' ) then
if not ( args.nocat or namespace == i18n.namespaceUser ) then
category = i18n.pageBadDocCategory:format( pageType )
category = i18n.pageBadDocCategory:format( pageTypeDisplay )
if not mw.title.new( i18n.commonCategory:format( category ) ).exists then
if not mw.title.new( i18n.commonNamespacedPage:format( i18n.namespaceCategory, category ) ).exists then
category = i18n.pageBadDocCategoryDefault
category = i18n.pageBadDocCategoryDefault
end
end
Line 226: Line 252:
end
end


-- Generates the [view][edit][history][refresh] or [create][refresh] links
-- Generates the link bar
local links = mw.html.create( 'span' )
local links = mw.html.create( 'span' ):addClass( 'documentation-header-tools' )
:attr( 'id', 'documentation-header-tools' )


local linkList = {}
local linkList = {}
if not noDoc and page ~= docPage then
if not noDoc then
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( docPage.fullText, i18n.linkTextView ) ) )
if page ~= docPage then
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( 'Special:EditPage/' .. docPage.fullText, i18n.linkTextEdit ) ) )
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( docPage.fullText, i18n.linkTextView ) ) )
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( 'Special:PageHistory/' .. docPage.fullText, i18n.linkTextHistory ) ) )
end
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialEdit, docPage.fullText ), i18n.linkTextEdit ) ) )
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialHistory, docPage.fullText ), i18n.linkTextHistory ) ) )
else
else
table.insert( linkList, i18n.linkFormat:format( i18n.commonExternalLinkWithName:format( docPage:canonicalUrl{ action = 'edit', preload = 'Template:Documentation/preload' }, i18n.linkTextCreate ) ) )
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( 'Special:Purge/' .. docPage.fullText, i18n.linkTextPurge ) ) )
table.insert( linkList, i18n.linkFormat:format( i18n.commonInternalLinkPipe:format( i18n.commonNamespacedPageWithSub:format( i18n.namespaceSpecial, i18n.specialPurge, docPage.fullText ), i18n.linkTextPurge ) ) )
links:wikitext( i18n.linkBar:format( table.concat( linkList, i18n.linkSeparator ) ) )
links:wikitext( i18n.linkBar:format( table.concat( linkList, i18n.linkSeparator ) ) )


Line 249: Line 276:


header
header
:node( links )
:tag( 'span' )
:tag( 'span' )
:addClass('documentation-header-title' )
:addClass( 'documentation-header-title' )
:wikitext( i18n.pageDocHeaderTitle )
:wikitext( i18n.pageDocHeaderTitle )
header
        :node( links )


local codePages = {
local codePages = {
Line 280: Line 308:


if category then
if category then
body:wikitext( f:expandTemplate{ title = 'Translation category', args = { category, project = '0' } } )
body:wikitext( pageCategoryHandler( category ) )
end
end


Line 288: Line 316:
end
end


return mw.getCurrentFrame():extensionTag{ name = "templatestyles", args = { src = docStyle } } .. tostring( body ) .. tostring( anchor )
return loadStyles( i18n.defaultStyles ) .. tostring( body ) .. tostring( anchor )
end
end


return p
return p
Retrieved from "https://modded.wiki/w/Module:Documentation"