https://pdkb.chivanet.org/wiki/api.php?action=feedcontributions&feedformat=atom&user=JawitkienPublic Domain Knowledge Bank - User contributions [en]2026-05-05T14:04:55ZUser contributionsMediaWiki 1.29.1https://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation&diff=1945Module:Documentation2021-06-23T15:49:14Z<p>Jawitkien: </p>
<hr />
<div>-- This module implements {{documentation}}.<br />
<br />
-- Get required modules.<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
-- DJW 20210623 add extra dependency info.<br />
local dummy = require('Module:Documentation');<br />
<br />
-- Get the config table.<br />
local cfg = mw.loadData('Module:Documentation/config')<br />
<br />
local p = {}<br />
<br />
-- Often-used functions.<br />
local ugsub = mw.ustring.gsub<br />
<br />
----------------------------------------------------------------------------<br />
-- Helper functions<br />
--<br />
-- These are defined as local functions, but are made available in the p<br />
-- table for testing purposes.<br />
----------------------------------------------------------------------------<br />
<br />
local function message(cfgKey, valArray, expectType)<br />
--[[<br />
-- Gets a message from the cfg table and formats it if appropriate.<br />
-- The function raises an error if the value from the cfg table is not<br />
-- of the type expectType. The default type for expectType is 'string'.<br />
-- If the table valArray is present, strings such as $1, $2 etc. in the<br />
-- message are substituted with values from the table keys [1], [2] etc.<br />
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',<br />
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."<br />
--]]<br />
local msg = cfg[cfgKey]<br />
expectType = expectType or 'string' <br />
if type(msg) ~= expectType then<br />
error('message: (DJW)chk: Module;Documentation/config for cfg defn. type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)<br />
end<br />
if not valArray then<br />
return msg<br />
end<br />
<br />
local function getMessageVal(match)<br />
match = tonumber(match)<br />
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)<br />
end<br />
<br />
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)<br />
end<br />
<br />
p.message = message<br />
<br />
local function makeWikilink(page, display)<br />
if display then<br />
return mw.ustring.format('[[%s|%s]]', page, display)<br />
else<br />
return mw.ustring.format('[[%s]]', page)<br />
end<br />
end<br />
<br />
p.makeWikilink = makeWikilink<br />
<br />
local function makeCategoryLink(cat, sort)<br />
local catns = mw.site.namespaces[14].name<br />
return makeWikilink(catns .. ':' .. cat, sort)<br />
end<br />
<br />
p.makeCategoryLink = makeCategoryLink<br />
<br />
local function makeUrlLink(url, display)<br />
return mw.ustring.format('[%s %s]', url, display)<br />
end<br />
<br />
p.makeUrlLink = makeUrlLink<br />
<br />
local function makeToolbar(...)<br />
local ret = {}<br />
local lim = select('#', ...)<br />
if lim < 1 then<br />
return nil<br />
end<br />
for i = 1, lim do<br />
ret[#ret + 1] = select(i, ...)<br />
end<br />
-- 'documentation-toolbar'<br />
return '<span class="' .. message('toolbar-class') .. '">('<br />
.. table.concat(ret, ' &#124; ') .. ')</span>'<br />
end <br />
<br />
p.makeToolbar = makeToolbar<br />
<br />
----------------------------------------------------------------------------<br />
-- Argument processing<br />
----------------------------------------------------------------------------<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.<br />
if key == 'heading' or value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Entry points<br />
----------------------------------------------------------------------------<br />
<br />
function p.nonexistent(frame)<br />
if mw.title.getCurrentTitle().subpageText == 'testcases' then<br />
return frame:expandTemplate{title = 'module test cases notice'}<br />
else<br />
return p.main(frame)<br />
end<br />
end<br />
<br />
p.main = makeInvokeFunc('_main')<br />
<br />
function p._main(args)<br />
--[[<br />
-- This function defines logic flow for the module.<br />
-- @args - table of arguments passed by the user<br />
--]]<br />
local env = p.getEnvironment(args)<br />
local root = mw.html.create()<br />
root<br />
:wikitext(p._getModuleWikitext(args, env))<br />
:wikitext(p.protectionTemplate(env))<br />
:wikitext(p.sandboxNotice(args, env))<br />
:tag('div')<br />
-- 'documentation-container'<br />
:addClass(message('container'))<br />
:newline()<br />
:tag('div')<br />
-- 'documentation'<br />
:addClass(message('main-div-classes'))<br />
:newline()<br />
:wikitext(p._startBox(args, env))<br />
:wikitext(p._content(args, env))<br />
:tag('div')<br />
-- 'documentation-clear'<br />
:addClass(message('clear'))<br />
:done()<br />
:newline()<br />
:done()<br />
:wikitext(p._endBox(args, env))<br />
:done()<br />
:wikitext(p.addTrackingCategories(env))<br />
-- 'Module:Documentation/styles.css'<br />
return mw.getCurrentFrame():extensionTag (<br />
'templatestyles', '', {src=cfg['templatestyles']<br />
}) .. tostring(root)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Environment settings<br />
----------------------------------------------------------------------------<br />
<br />
function p.getEnvironment(args)<br />
--[[<br />
-- Returns a table with information about the environment, including title<br />
-- objects and other namespace- or path-related data.<br />
-- @args - table of arguments passed by the user<br />
--<br />
-- Title objects include:<br />
-- env.title - the page we are making documentation for (usually the current title)<br />
-- env.templateTitle - the template (or module, file, etc.)<br />
-- env.docTitle - the /doc subpage.<br />
-- env.sandboxTitle - the /sandbox subpage.<br />
-- env.testcasesTitle - the /testcases subpage.<br />
-- env.printTitle - the print version of the template, located at the /Print subpage.<br />
--<br />
-- Data includes:<br />
-- env.protectionLevels - the protection levels table of the title object.<br />
-- env.subjectSpace - the number of the title's subject namespace.<br />
-- env.docSpace - the number of the namespace the title puts its documentation in.<br />
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.<br />
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.<br />
-- <br />
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value<br />
-- returned will be nil.<br />
--]]<br />
<br />
local env, envFuncs = {}, {}<br />
<br />
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value<br />
-- returned by that function is memoized in the env table so that we don't call any of the functions<br />
-- more than once. (Nils won't be memoized.)<br />
setmetatable(env, {<br />
__index = function (t, key)<br />
local envFunc = envFuncs[key]<br />
if envFunc then<br />
local success, val = pcall(envFunc)<br />
if success then<br />
env[key] = val -- Memoise the value.<br />
return val<br />
end<br />
end<br />
return nil<br />
end<br />
}) <br />
<br />
function envFuncs.title()<br />
-- The title object for the current page, or a test page passed with args.page.<br />
local title<br />
local titleArg = args.page<br />
if titleArg then<br />
title = mw.title.new(titleArg)<br />
else<br />
title = mw.title.getCurrentTitle()<br />
end<br />
return title<br />
end<br />
<br />
function envFuncs.templateTitle()<br />
--[[<br />
-- The template (or module, etc.) title object.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local subpage = title.subpageText<br />
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then<br />
return mw.title.makeTitle(subjectSpace, title.baseText)<br />
else<br />
return mw.title.makeTitle(subjectSpace, title.text)<br />
end<br />
end<br />
<br />
function envFuncs.docTitle()<br />
--[[<br />
-- Title object of the /doc subpage.<br />
-- Messages:<br />
-- 'doc-subpage' --> 'doc'<br />
--]]<br />
local title = env.title<br />
local docname = args[1] -- User-specified doc page.<br />
local docpage<br />
if docname then<br />
docpage = docname<br />
else<br />
docpage = env.docpageBase .. '/' .. message('doc-subpage')<br />
end<br />
return mw.title.new(docpage)<br />
end<br />
<br />
function envFuncs.sandboxTitle()<br />
--[[<br />
-- Title object for the /sandbox subpage.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))<br />
end<br />
<br />
function envFuncs.testcasesTitle()<br />
--[[<br />
-- Title object for the /testcases subpage.<br />
-- Messages:<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))<br />
end<br />
<br />
function envFuncs.printTitle()<br />
--[[<br />
-- Title object for the /Print subpage.<br />
-- Messages:<br />
-- 'print-subpage' --> 'Print'<br />
--]]<br />
return env.templateTitle:subPageTitle(message('print-subpage'))<br />
end<br />
<br />
function envFuncs.protectionLevels()<br />
-- The protection levels table of the title object.<br />
return env.title.protectionLevels<br />
end<br />
<br />
function envFuncs.subjectSpace()<br />
-- The subject namespace number.<br />
return mw.site.namespaces[env.title.namespace].subject.id<br />
end<br />
<br />
function envFuncs.docSpace()<br />
-- The documentation namespace number. For most namespaces this is the<br />
-- same as the subject namespace. However, pages in the Article, File,<br />
-- MediaWiki or Category namespaces must have their /doc, /sandbox and<br />
-- /testcases pages in talk space.<br />
local subjectSpace = env.subjectSpace<br />
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then<br />
return subjectSpace + 1<br />
else<br />
return subjectSpace<br />
end<br />
end<br />
<br />
function envFuncs.docpageBase()<br />
-- The base page of the /doc, /sandbox, and /testcases subpages.<br />
-- For some namespaces this is the talk page, rather than the template page.<br />
local templateTitle = env.templateTitle<br />
local docSpace = env.docSpace<br />
local docSpaceText = mw.site.namespaces[docSpace].name<br />
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.<br />
return docSpaceText .. ':' .. templateTitle.text<br />
end<br />
<br />
function envFuncs.compareUrl()<br />
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
if templateTitle.exists and sandboxTitle.exists then<br />
local compareUrl = mw.uri.fullUrl(<br />
'Special:ComparePages',<br />
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}<br />
)<br />
return tostring(compareUrl)<br />
else<br />
return nil<br />
end<br />
end <br />
<br />
return env<br />
end <br />
<br />
----------------------------------------------------------------------------<br />
-- Auxiliary templates<br />
----------------------------------------------------------------------------<br />
<br />
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')<br />
<br />
function p._getModuleWikitext(args, env)<br />
local currentTitle = mw.title.getCurrentTitle()<br />
if currentTitle.contentModel ~= 'Scribunto' then return end<br />
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care<br />
local moduleWikitext = package.loaded["Module:Module wikitext"]<br />
if moduleWikitext then<br />
return moduleWikitext.main()<br />
end<br />
end<br />
<br />
function p.sandboxNotice(args, env)<br />
--[=[<br />
-- Generates a sandbox notice for display above sandbox pages.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'<br />
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'<br />
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'<br />
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'<br />
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'<br />
-- 'sandbox-notice-compare-link-display' --> 'diff'<br />
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'<br />
-- 'sandbox-notice-testcases-link-display' --> 'test cases'<br />
-- 'sandbox-category' --> 'Template sandboxes'<br />
--]=]<br />
local title = env.title<br />
local sandboxTitle = env.sandboxTitle<br />
local templateTitle = env.templateTitle<br />
local subjectSpace = env.subjectSpace<br />
if not (subjectSpace and title and sandboxTitle and templateTitle<br />
and mw.title.equals(title, sandboxTitle)) then<br />
return nil<br />
end<br />
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".<br />
local omargs = {}<br />
omargs.image = message('sandbox-notice-image')<br />
-- Get the text. We start with the opening blurb, which is something like<br />
-- "This is the template sandbox for [[Template:Foo]] (diff)."<br />
local text = ''<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('sandbox-notice-pagetype-template')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('sandbox-notice-pagetype-module')<br />
else<br />
pagetype = message('sandbox-notice-pagetype-other')<br />
end<br />
local templateLink = makeWikilink(templateTitle.prefixedText)<br />
local compareUrl = env.compareUrl<br />
if compareUrl then<br />
local compareDisplay = message('sandbox-notice-compare-link-display')<br />
local compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})<br />
else<br />
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})<br />
end<br />
-- Get the test cases page blurb if the page exists. This is something like<br />
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."<br />
local testcasesTitle = env.testcasesTitle<br />
if testcasesTitle and testcasesTitle.exists then<br />
if testcasesTitle.contentModel == "Scribunto" then<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})<br />
else<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})<br />
end<br />
end<br />
-- Add the sandbox to the sandbox category.<br />
omargs.text = text .. makeCategoryLink(message('sandbox-category'))<br />
<br />
-- 'documentation-clear'<br />
return '<div class="' .. message('clear') .. '"></div>'<br />
.. require('Module:Message box').main('ombox', omargs)<br />
end<br />
<br />
function p.protectionTemplate(env)<br />
-- Generates the padlock icon in the top right.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'protection-template' --> 'pp-template'<br />
-- 'protection-template-args' --> {docusage = 'yes'}<br />
local protectionLevels = env.protectionLevels<br />
if not protectionLevels then<br />
return nil<br />
end<br />
local editProt = protectionLevels.edit and protectionLevels.edit[1]<br />
local moveProt = protectionLevels.move and protectionLevels.move[1]<br />
if editProt then<br />
-- The page is edit-protected.<br />
return require('Module:Protection banner')._main{<br />
message('protection-reason-edit'), small = true<br />
}<br />
elseif moveProt and moveProt ~= 'autoconfirmed' then<br />
-- The page is move-protected but not edit-protected. Exclude move<br />
-- protection with the level "autoconfirmed", as this is equivalent to<br />
-- no move protection at all.<br />
return require('Module:Protection banner')._main{<br />
action = 'move', small = true<br />
}<br />
else<br />
return nil<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Start box<br />
----------------------------------------------------------------------------<br />
<br />
p.startBox = makeInvokeFunc('_startBox')<br />
<br />
function p._startBox(args, env)<br />
--[[<br />
-- This function generates the start box.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make<br />
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox<br />
-- which generate the box HTML.<br />
--]]<br />
env = env or p.getEnvironment(args)<br />
local links<br />
local content = args.content<br />
if not content or args[1] then<br />
-- No need to include the links if the documentation is on the template page itself.<br />
local linksData = p.makeStartBoxLinksData(args, env)<br />
if linksData then<br />
links = p.renderStartBoxLinks(linksData)<br />
end<br />
end<br />
-- Generate the start box html.<br />
local data = p.makeStartBoxData(args, env, links)<br />
if data then<br />
return p.renderStartBox(data)<br />
else<br />
-- User specified no heading.<br />
return nil<br />
end<br />
end<br />
<br />
function p.makeStartBoxLinksData(args, env)<br />
--[[<br />
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'view-link-display' --> 'view'<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'purge-link-display' --> 'purge'<br />
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'docpage-preload' --> 'Template:Documentation/preload'<br />
-- 'create-link-display' --> 'create'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local docTitle = env.docTitle<br />
if not title or not docTitle then<br />
return nil<br />
end<br />
if docTitle.isRedirect then <br />
docTitle = docTitle.redirectTarget<br />
end<br />
<br />
local data = {}<br />
data.title = title<br />
data.docTitle = docTitle<br />
-- View, display, edit, and purge links if /doc exists.<br />
data.viewLinkDisplay = message('view-link-display')<br />
data.editLinkDisplay = message('edit-link-display')<br />
data.historyLinkDisplay = message('history-link-display')<br />
data.purgeLinkDisplay = message('purge-link-display')<br />
-- Create link if /doc doesn't exist.<br />
local preload = args.preload<br />
if not preload then<br />
if subjectSpace == 6 then -- File namespace<br />
preload = message('file-docpage-preload')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
preload = message('module-preload')<br />
else<br />
preload = message('docpage-preload')<br />
end<br />
end<br />
data.preload = preload<br />
data.createLinkDisplay = message('create-link-display')<br />
return data<br />
end<br />
<br />
function p.renderStartBoxLinks(data)<br />
--[[<br />
-- Generates the [view][edit][history][purge] or [create] links from the data table.<br />
-- @data - a table of data generated by p.makeStartBoxLinksData<br />
--]]<br />
<br />
local function escapeBrackets(s)<br />
-- Escapes square brackets with HTML entities.<br />
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.<br />
s = s:gsub('%]', '&#93;')<br />
return s<br />
end<br />
<br />
local ret<br />
local docTitle = data.docTitle<br />
local title = data.title<br />
if docTitle.exists then<br />
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)<br />
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)<br />
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)<br />
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)<br />
ret = '[%s] [%s] [%s] [%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)<br />
else<br />
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)<br />
ret = '[%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, createLink)<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeStartBoxData(args, env, links)<br />
--[=[<br />
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.<br />
--<br />
-- Messages:<br />
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
-- 'template-namespace-heading' --> 'Template documentation'<br />
-- 'module-namespace-heading' --> 'Module documentation'<br />
-- 'file-namespace-heading' --> 'Summary'<br />
-- 'other-namespaces-heading' --> 'Documentation'<br />
-- 'testcases-create-link-display' --> 'create'<br />
--]=]<br />
local subjectSpace = env.subjectSpace<br />
if not subjectSpace then<br />
-- Default to an "other namespaces" namespace, so that we get at least some output<br />
-- if an error occurs.<br />
subjectSpace = 2<br />
end<br />
local data = {}<br />
<br />
-- Heading<br />
local heading = args.heading -- Blank values are not removed.<br />
if heading == '' then<br />
-- Don't display the start box if the heading arg is defined but blank.<br />
return nil<br />
end<br />
if heading then<br />
data.heading = heading<br />
elseif subjectSpace == 10 then -- Template namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')<br />
elseif subjectSpace == 6 then -- File namespace<br />
data.heading = message('file-namespace-heading')<br />
else<br />
data.heading = message('other-namespaces-heading')<br />
end<br />
<br />
-- Heading CSS<br />
local headingStyle = args['heading-style']<br />
if headingStyle then<br />
data.headingStyleText = headingStyle<br />
else<br />
-- 'documentation-heading'<br />
data.headingClass = message('main-div-heading-class')<br />
end<br />
<br />
-- Data for the [view][edit][history][purge] or [create] links.<br />
if links then<br />
-- 'mw-editsection-like plainlinks'<br />
data.linksClass = message('start-box-link-classes')<br />
data.links = links<br />
end<br />
<br />
return data<br />
end<br />
<br />
function p.renderStartBox(data)<br />
-- Renders the start box html.<br />
-- @data - a table of data generated by p.makeStartBoxData.<br />
local sbox = mw.html.create('div')<br />
sbox<br />
-- 'documentation-startbox'<br />
:addClass(message('start-box-class'))<br />
:newline()<br />
:tag('span')<br />
:addClass(data.headingClass)<br />
:cssText(data.headingStyleText)<br />
:wikitext(data.heading)<br />
local links = data.links<br />
if links then<br />
sbox:tag('span')<br />
:addClass(data.linksClass)<br />
:attr('id', data.linksId)<br />
:wikitext(links)<br />
end<br />
return tostring(sbox)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Documentation content<br />
----------------------------------------------------------------------------<br />
<br />
p.content = makeInvokeFunc('_content')<br />
<br />
function p._content(args, env)<br />
-- Displays the documentation contents<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
local content = args.content<br />
if not content and docTitle and docTitle.exists then<br />
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}<br />
end<br />
-- The line breaks below are necessary so that "=== Headings ===" at the start and end<br />
-- of docs are interpreted correctly.<br />
return '\n' .. (content or '') .. '\n' <br />
end<br />
<br />
p.contentTitle = makeInvokeFunc('_contentTitle')<br />
<br />
function p._contentTitle(args, env)<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
if not args.content and docTitle and docTitle.exists then<br />
return docTitle.prefixedText<br />
else<br />
return ''<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- End box<br />
----------------------------------------------------------------------------<br />
<br />
p.endBox = makeInvokeFunc('_endBox')<br />
<br />
function p._endBox(args, env)<br />
--[=[<br />
-- This function generates the end box (also known as the link box).<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
--]=]<br />
<br />
-- Get environment data.<br />
env = env or p.getEnvironment(args)<br />
local subjectSpace = env.subjectSpace<br />
local docTitle = env.docTitle<br />
if not subjectSpace or not docTitle then<br />
return nil<br />
end<br />
<br />
-- Check whether we should output the end box at all. Add the end<br />
-- box by default if the documentation exists or if we are in the<br />
-- user, module or template namespaces.<br />
local linkBox = args['link box']<br />
if linkBox == 'off'<br />
or not (<br />
docTitle.exists<br />
or subjectSpace == 2<br />
or subjectSpace == 828<br />
or subjectSpace == 10<br />
)<br />
then<br />
return nil<br />
end<br />
<br />
-- Assemble the link box.<br />
local text = ''<br />
if linkBox then<br />
text = text .. linkBox<br />
else<br />
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <br />
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then<br />
-- We are in the user, template or module namespaces.<br />
-- Add sandbox and testcases links.<br />
-- "Editors can experiment in this template's sandbox and testcases pages."<br />
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'<br />
if not args.content and not args[1] then<br />
-- "Please add categories to the /doc subpage."<br />
-- Don't show this message with inline docs or with an explicitly specified doc page,<br />
-- as then it is unclear where to add the categories.<br />
text = text .. (p.makeCategoriesBlurb(args, env) or '')<br />
end<br />
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"<br />
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.<br />
if printBlurb then<br />
text = text .. '<br />' .. printBlurb<br />
end<br />
end<br />
end<br />
<br />
local box = mw.html.create('div')<br />
-- 'documentation-metadata'<br />
box:attr('role', 'note')<br />
:addClass(message('end-box-class'))<br />
-- 'plainlinks'<br />
:addClass(message('end-box-plainlinks'))<br />
:wikitext(text)<br />
:done()<br />
<br />
return '\n' .. tostring(box)<br />
end<br />
<br />
function p.makeDocPageBlurb(args, env)<br />
--[=[<br />
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'transcluded-from-blurb' --> <br />
-- 'The above [[Wikipedia:Template documentation|documentation]] <br />
-- is [[Help:Transclusion|transcluded]] from $1.'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'create-link-display' --> 'create'<br />
-- 'create-module-doc-blurb' --><br />
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
--]=]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local ret<br />
if docTitle.exists then<br />
-- /doc exists; link to it.<br />
local docLink = makeWikilink(docTitle.prefixedText)<br />
local editUrl = docTitle:fullUrl{action = 'edit'}<br />
local editDisplay = message('edit-link-display')<br />
local editLink = makeUrlLink(editUrl, editDisplay)<br />
local historyUrl = docTitle:fullUrl{action = 'history'}<br />
local historyDisplay = message('history-link-display')<br />
local historyLink = makeUrlLink(historyUrl, historyDisplay)<br />
ret = message('transcluded-from-blurb', {docLink})<br />
.. ' '<br />
.. makeToolbar(editLink, historyLink)<br />
.. '<br />'<br />
elseif env.subjectSpace == 828 then<br />
-- /doc does not exist; ask to create it.<br />
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}<br />
local createDisplay = message('create-link-display')<br />
local createLink = makeUrlLink(createUrl, createDisplay)<br />
ret = message('create-module-doc-blurb', {createLink})<br />
.. '<br />'<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeExperimentBlurb(args, env)<br />
--[[<br />
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'sandbox-edit-link-display' --> 'edit'<br />
-- 'compare-link-display' --> 'diff'<br />
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'sandbox-create-link-display' --> 'create'<br />
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'<br />
-- 'mirror-link-display' --> 'mirror'<br />
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display'--> 'edit'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'testcases-create-link-display' --> 'create'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display' --> 'edit'<br />
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'<br />
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'<br />
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'<br />
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
local testcasesTitle = env.testcasesTitle<br />
local templatePage = templateTitle.prefixedText<br />
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then<br />
return nil<br />
end<br />
-- Make links.<br />
local sandboxLinks, testcasesLinks<br />
if sandboxTitle.exists then<br />
local sandboxPage = sandboxTitle.prefixedText<br />
local sandboxDisplay = message('sandbox-link-display')<br />
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)<br />
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}<br />
local sandboxEditDisplay = message('sandbox-edit-link-display')<br />
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)<br />
local compareUrl = env.compareUrl<br />
local compareLink<br />
if compareUrl then<br />
local compareDisplay = message('compare-link-display')<br />
compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
end<br />
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)<br />
else<br />
local sandboxPreload<br />
if subjectSpace == 828 then<br />
sandboxPreload = message('module-sandbox-preload')<br />
else<br />
sandboxPreload = message('template-sandbox-preload')<br />
end<br />
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}<br />
local sandboxCreateDisplay = message('sandbox-create-link-display')<br />
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)<br />
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})<br />
local mirrorPreload = message('mirror-link-preload')<br />
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}<br />
if subjectSpace == 828 then<br />
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}<br />
end<br />
local mirrorDisplay = message('mirror-link-display')<br />
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)<br />
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)<br />
end<br />
if testcasesTitle.exists then<br />
local testcasesPage = testcasesTitle.prefixedText<br />
local testcasesDisplay = message('testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)<br />
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}<br />
local testcasesEditDisplay = message('testcases-edit-link-display')<br />
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)<br />
-- for Modules, add testcases run link if exists<br />
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then<br />
local testcasesRunLinkDisplay = message('testcases-run-link-display')<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)<br />
else<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)<br />
end<br />
else<br />
local testcasesPreload<br />
if subjectSpace == 828 then<br />
testcasesPreload = message('module-testcases-preload')<br />
else<br />
testcasesPreload = message('template-testcases-preload')<br />
end<br />
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}<br />
local testcasesCreateDisplay = message('testcases-create-link-display')<br />
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)<br />
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)<br />
end<br />
local messageName<br />
if subjectSpace == 828 then<br />
messageName = 'experiment-blurb-module'<br />
else<br />
messageName = 'experiment-blurb-template'<br />
end<br />
return message(messageName, {sandboxLinks, testcasesLinks})<br />
end<br />
<br />
function p.makeCategoriesBlurb(args, env)<br />
--[[<br />
-- Generates the text "Please add categories to the /doc subpage."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'doc-link-display' --> '/doc'<br />
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'<br />
--]]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))<br />
return message('add-categories-blurb', {docPathLink})<br />
end<br />
<br />
function p.makeSubpagesBlurb(args, env)<br />
--[[<br />
-- Generates the "Subpages of this template" link.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'template-pagetype' --> 'template'<br />
-- 'module-pagetype' --> 'module'<br />
-- 'default-pagetype' --> 'page'<br />
-- 'subpages-link-display' --> 'Subpages of this $1'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
if not subjectSpace or not templateTitle then<br />
return nil<br />
end<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('template-pagetype')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('module-pagetype')<br />
else<br />
pagetype = message('default-pagetype')<br />
end<br />
local subpagesLink = makeWikilink(<br />
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',<br />
message('subpages-link-display', {pagetype})<br />
)<br />
return message('subpages-blurb', {subpagesLink})<br />
end<br />
<br />
function p.makePrintBlurb(args, env)<br />
--[=[<br />
-- Generates the blurb displayed when there is a print version of the template available.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
--<br />
-- Messages:<br />
-- 'print-link-display' --> '/Print'<br />
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'<br />
-- .. ' of this template exists at $1.'<br />
-- .. ' If you make a change to this template, please update the print version as well.'<br />
-- 'display-print-category' --> true<br />
-- 'print-category' --> 'Templates with print versions'<br />
--]=]<br />
local printTitle = env.printTitle<br />
if not printTitle then<br />
return nil<br />
end<br />
local ret<br />
if printTitle.exists then<br />
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))<br />
ret = message('print-blurb', {printLink})<br />
local displayPrintCategory = message('display-print-category', nil, 'boolean')<br />
if displayPrintCategory then<br />
ret = ret .. makeCategoryLink(message('print-category'))<br />
end<br />
end<br />
return ret<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Tracking categories<br />
----------------------------------------------------------------------------<br />
<br />
function p.addTrackingCategories(env)<br />
--[[<br />
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'display-strange-usage-category' --> true<br />
-- 'doc-subpage' --> 'doc'<br />
-- 'testcases-subpage' --> 'testcases'<br />
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'<br />
-- <br />
-- /testcases pages in the module namespace are not categorised, as they may have<br />
-- {{documentation}} transcluded automatically.<br />
--]]<br />
local title = env.title<br />
local subjectSpace = env.subjectSpace<br />
if not title or not subjectSpace then<br />
return nil<br />
end<br />
local subpage = title.subpageText<br />
local ret = ''<br />
if message('display-strange-usage-category', nil, 'boolean')<br />
and (<br />
subpage == message('doc-subpage')<br />
or subjectSpace ~= 828 and subpage == message('testcases-subpage')<br />
)<br />
then<br />
ret = ret .. makeCategoryLink(message('strange-usage-category'))<br />
end<br />
return ret<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation/config&diff=1944Module:Documentation/config2021-06-23T15:40:42Z<p>Jawitkien: </p>
<hr />
<div>----------------------------------------------------------------------------------------------------<br />
--<br />
-- Configuration for Module:Documentation<br />
--<br />
-- Here you can set the values of the parameters and messages used in Module:Documentation to<br />
-- localise it to your wiki and your language. Unless specified otherwise, values given here<br />
-- should be string values.<br />
-- DJW 20210623 stuff added from https://en.wikipedia.org/w/index.php?title=Module:Documentation/config&action=edit<br />
----------------------------------------------------------------------------------------------------<br />
<br />
local cfg = {} -- Do not edit this line.<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Protection template configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['protection-reason-edit']<br />
-- The protection reason for edit-protected templates to pass to<br />
-- [[Module:Protection banner]].<br />
cfg['protection-reason-edit'] = 'template'<br />
<br />
--[[<br />
----------------------------------------------------------------------------------------------------<br />
-- Sandbox notice configuration<br />
--<br />
-- On sandbox pages the module can display a template notifying users that the current page is a<br />
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a<br />
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the<br />
-- messages that the notices contains.<br />
----------------------------------------------------------------------------------------------------<br />
--]]<br />
<br />
-- cfg['sandbox-notice-image']<br />
-- The image displayed in the sandbox notice.<br />
cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
<br />
--[[<br />
-- cfg['sandbox-notice-pagetype-template']<br />
-- cfg['sandbox-notice-pagetype-module']<br />
-- cfg['sandbox-notice-pagetype-other']<br />
-- The page type of the sandbox page. The message that is displayed depends on the current subject<br />
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or<br />
-- cfg['sandbox-notice-diff-blurb'].<br />
--]]<br />
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'<br />
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'<br />
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'<br />
<br />
--[[<br />
-- cfg['sandbox-notice-blurb']<br />
-- cfg['sandbox-notice-diff-blurb']<br />
-- cfg['sandbox-notice-diff-display']<br />
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence<br />
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page<br />
-- type, which is either cfg['sandbox-notice-pagetype-template'],<br />
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what<br />
-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between<br />
-- the sandbox and the main template. The display value of the diff link is set by <br />
-- cfg['sandbox-notice-compare-link-display'].<br />
--]]<br />
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'<br />
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'<br />
cfg['sandbox-notice-compare-link-display'] = 'diff'<br />
<br />
--[[<br />
-- cfg['sandbox-notice-testcases-blurb']<br />
-- cfg['sandbox-notice-testcases-link-display']<br />
-- cfg['sandbox-notice-testcases-run-blurb']<br />
-- cfg['sandbox-notice-testcases-run-link-display']<br />
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page<br />
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.<br />
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.<br />
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page<br />
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test<br />
-- cases page, and $2 is a link to the page to run it.<br />
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test<br />
-- cases.<br />
--]]<br />
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'<br />
cfg['sandbox-notice-testcases-link-display'] = 'test cases'<br />
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'<br />
cfg['sandbox-notice-testcases-run-link-display'] = 'run'<br />
<br />
-- cfg['sandbox-category']<br />
-- A category to add to all template sandboxes.<br />
cfg['sandbox-category'] = 'Template sandboxes'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Start box configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['documentation-icon-wikitext']<br />
-- The wikitext for the icon shown at the top of the template.<br />
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
<br />
-- cfg['template-namespace-heading']<br />
-- The heading shown in the template namespace.<br />
cfg['template-namespace-heading'] = 'Template documentation'<br />
<br />
-- cfg['module-namespace-heading']<br />
-- The heading shown in the module namespace.<br />
cfg['module-namespace-heading'] = 'Module documentation'<br />
<br />
-- cfg['file-namespace-heading']<br />
-- The heading shown in the file namespace.<br />
cfg['file-namespace-heading'] = 'Summary'<br />
<br />
-- cfg['other-namespaces-heading']<br />
-- The heading shown in other namespaces.<br />
cfg['other-namespaces-heading'] = 'Documentation'<br />
<br />
-- cfg['view-link-display']<br />
-- The text to display for "view" links.<br />
cfg['view-link-display'] = 'view'<br />
<br />
-- cfg['edit-link-display']<br />
-- The text to display for "edit" links.<br />
cfg['edit-link-display'] = 'edit'<br />
<br />
-- cfg['history-link-display']<br />
-- The text to display for "history" links.<br />
cfg['history-link-display'] = 'history'<br />
<br />
-- cfg['purge-link-display']<br />
-- The text to display for "purge" links.<br />
cfg['purge-link-display'] = 'purge'<br />
<br />
-- cfg['create-link-display']<br />
-- The text to display for "create" links.<br />
cfg['create-link-display'] = 'create'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Link box (end box) configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['transcluded-from-blurb']<br />
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.<br />
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'<br />
<br />
--[[<br />
-- cfg['create-module-doc-blurb']<br />
-- Notice displayed in the module namespace when the documentation subpage does not exist.<br />
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the<br />
-- display cfg['create-link-display'].<br />
--]]<br />
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Experiment blurb configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
--[[<br />
-- cfg['experiment-blurb-template']<br />
-- cfg['experiment-blurb-module']<br />
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.<br />
-- It is only shown in the template and module namespaces. With the default English settings, it<br />
-- might look like this:<br />
--<br />
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.<br />
--<br />
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.<br />
--<br />
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending<br />
-- on what namespace we are in.<br />
-- <br />
-- Parameters:<br />
--<br />
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:<br />
--<br />
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])<br />
-- <br />
-- If the sandbox doesn't exist, it is in the format:<br />
--<br />
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])<br />
-- <br />
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']<br />
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']<br />
-- loads a default edit summary of cfg['mirror-edit-summary'].<br />
--<br />
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:<br />
--<br />
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-run-link-display'])<br />
--<br />
-- If the test cases page doesn't exist, it is in the format:<br />
-- <br />
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display'])<br />
--<br />
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the<br />
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current<br />
-- namespace.<br />
--]]<br />
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."<br />
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Sandbox link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['sandbox-subpage']<br />
-- The name of the template subpage typically used for sandboxes.<br />
cfg['sandbox-subpage'] = 'sandbox'<br />
<br />
-- cfg['template-sandbox-preload']<br />
-- Preload file for template sandbox pages.<br />
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'<br />
<br />
-- cfg['module-sandbox-preload']<br />
-- Preload file for Lua module sandbox pages.<br />
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'<br />
<br />
-- cfg['sandbox-link-display']<br />
-- The text to display for "sandbox" links.<br />
cfg['sandbox-link-display'] = 'sandbox'<br />
<br />
-- cfg['sandbox-edit-link-display']<br />
-- The text to display for sandbox "edit" links.<br />
cfg['sandbox-edit-link-display'] = 'edit'<br />
<br />
-- cfg['sandbox-create-link-display']<br />
-- The text to display for sandbox "create" links.<br />
cfg['sandbox-create-link-display'] = 'create'<br />
<br />
-- cfg['compare-link-display']<br />
-- The text to display for "compare" links.<br />
cfg['compare-link-display'] = 'diff'<br />
<br />
-- cfg['mirror-edit-summary']<br />
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the<br />
-- template page.<br />
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'<br />
<br />
-- cfg['mirror-link-display']<br />
-- The text to display for "mirror" links.<br />
cfg['mirror-link-display'] = 'mirror'<br />
<br />
-- cfg['mirror-link-preload']<br />
-- The page to preload when a user clicks the "mirror" link.<br />
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Test cases link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['testcases-subpage']<br />
-- The name of the template subpage typically used for test cases.<br />
cfg['testcases-subpage'] = 'testcases'<br />
<br />
-- cfg['template-testcases-preload']<br />
-- Preload file for template test cases pages.<br />
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'<br />
<br />
-- cfg['module-testcases-preload']<br />
-- Preload file for Lua module test cases pages.<br />
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'<br />
<br />
-- cfg['testcases-link-display']<br />
-- The text to display for "testcases" links.<br />
cfg['testcases-link-display'] = 'testcases'<br />
<br />
-- cfg['testcases-edit-link-display']<br />
-- The text to display for test cases "edit" links.<br />
cfg['testcases-edit-link-display'] = 'edit'<br />
<br />
-- cfg['testcases-run-link-display']<br />
-- The text to display for test cases "run" links.<br />
cfg['testcases-run-link-display'] = 'run'<br />
<br />
-- cfg['testcases-create-link-display']<br />
-- The text to display for test cases "create" links.<br />
cfg['testcases-create-link-display'] = 'create'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Add categories blurb configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
--[[<br />
-- cfg['add-categories-blurb']<br />
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or<br />
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a<br />
-- link to the /doc subpage with a display value of cfg['doc-link-display'].<br />
--]]<br />
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'<br />
<br />
-- cfg['doc-link-display']<br />
-- The text to display when linking to the /doc subpage.<br />
cfg['doc-link-display'] = '/doc'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Subpages link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
--[[<br />
-- cfg['subpages-blurb']<br />
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a<br />
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply<br />
-- the link followed by a period, and the link display provides the actual text.<br />
--]]<br />
cfg['subpages-blurb'] = '$1.'<br />
<br />
--[[<br />
-- cfg['subpages-link-display']<br />
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],<br />
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in<br />
-- the template namespace, the module namespace, or another namespace.<br />
--]]<br />
cfg['subpages-link-display'] = 'Subpages of this $1'<br />
<br />
-- cfg['template-pagetype']<br />
-- The pagetype to display for template pages.<br />
cfg['template-pagetype'] = 'template'<br />
<br />
-- cfg['module-pagetype']<br />
-- The pagetype to display for Lua module pages.<br />
cfg['module-pagetype'] = 'module'<br />
<br />
-- cfg['default-pagetype']<br />
-- The pagetype to display for pages other than templates or Lua modules.<br />
cfg['default-pagetype'] = 'page'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Doc link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['doc-subpage']<br />
-- The name of the subpage typically used for documentation pages.<br />
cfg['doc-subpage'] = 'doc'<br />
<br />
-- cfg['file-docpage-preload']<br />
-- Preload file for documentation page in the file namespace.<br />
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'<br />
<br />
-- cfg['docpage-preload']<br />
-- Preload file for template documentation pages in all namespaces.<br />
cfg['docpage-preload'] = 'Template:Documentation/preload'<br />
<br />
-- cfg['module-preload']<br />
-- Preload file for Lua module documentation pages.<br />
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Print version configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['print-subpage']<br />
-- The name of the template subpage used for print versions.<br />
cfg['print-subpage'] = 'Print'<br />
<br />
-- cfg['print-link-display']<br />
-- The text to display when linking to the /Print subpage.<br />
cfg['print-link-display'] = '/Print'<br />
<br />
-- cfg['print-blurb']<br />
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].<br />
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'<br />
.. ' If you make a change to this template, please update the print version as well.'<br />
<br />
-- cfg['display-print-category']<br />
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.<br />
-- This should be a boolean value (either true or false).<br />
cfg['display-print-category'] = true<br />
<br />
-- cfg['print-category']<br />
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.<br />
cfg['print-category'] = 'Templates with print versions'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- HTML and CSS configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['templatestyles']<br />
-- The name of the TemplateStyles page where CSS is kept.<br />
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.<br />
cfg['templatestyles'] = 'Module:Documentation/styles.css'<br />
<br />
-- cfg['container']<br />
-- Class which can be used to set flex or grid CSS on the<br />
-- two child divs documentation and documentation-metadata<br />
cfg['container'] = 'documentation-container'<br />
<br />
-- cfg['main-div-id']<br />
-- The "id" attribute of the main HTML "div" tag.<br />
cfg['main-div-id'] = 'template-documentation'<br />
<br />
-- cfg['main-div-classes']<br />
-- The CSS classes added to the main HTML "div" tag.<br />
cfg['main-div-classes'] = 'template-documentation iezoomfix'<br />
<br />
-- cfg['main-div-heading-class']<br />
-- Class for the main heading for templates and modules and assoc. talk spaces<br />
cfg['main-div-heading-class'] = 'documentation-heading'<br />
<br />
-- cfg['start-box-class']<br />
-- Class for the start box<br />
cfg['start-box-class'] = 'documentation-startbox'<br />
<br />
-- cfg['start-box-linkclasses']<br />
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.<br />
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'<br />
<br />
-- cfg['start-box-link-classes']<br />
-- Classes used for the [view][edit][history] or [create] links in the start box.<br />
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]]<br />
-- DJW 20210623 https://en.wikipedia.org/w/index.php?title=Module:Documentation/config&action=edit<br />
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'<br />
<br />
-- cfg['start-box-link-id']<br />
-- The HTML "id" attribute for the links in the start box.<br />
cfg['start-box-link-id'] = 'doc_editlinks'<br />
<br />
-- cfg['end-box-class']<br />
-- Class for the end box.<br />
cfg['end-box-class'] = 'documentation-metadata'<br />
<br />
-- cfg['end-box-plainlinks']<br />
-- Plainlinks<br />
cfg['end-box-plainlinks'] = 'plainlinks'<br />
<br />
-- cfg['toolbar-class']<br />
-- Class added for toolbar links.<br />
-- DJW 20210623 https://en.wikipedia.org/w/index.php?title=Module:Documentation/config&action=edit<br />
cfg['toolbar-class'] = 'documentation-toolbar'<br />
<br />
-- cfg['clear']<br />
-- Just used to clear things.<br />
-- DJW 20210623 https://en.wikipedia.org/w/index.php?title=Module:Documentation/config&action=edit<br />
cfg['clear'] = 'documentation-clear'<br />
<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- {{fmbox}} template configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['fmbox-id']<br />
-- The id sent to the "id" parameter of the {{fmbox}} template.<br />
cfg['fmbox-id'] = 'documentation-meta-data'<br />
<br />
-- cfg['fmbox-style']<br />
-- The value sent to the style parameter of {{fmbox}}.<br />
cfg['fmbox-style'] = 'background-color: #ecfcf4'<br />
<br />
-- cfg['fmbox-textstyle']<br />
-- The value sent to the "textstyle parameter of {{fmbox}}.<br />
cfg['fmbox-textstyle'] = 'font-style: italic'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Tracking category configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['display-strange-usage-category']<br />
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage<br />
-- or a /testcases subpage. This should be a boolean value (either true or false).<br />
cfg['display-strange-usage-category'] = true<br />
<br />
-- cfg['strange-usage-category']<br />
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a<br />
-- /doc subpage or a /testcases subpage.<br />
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'<br />
<br />
--[[<br />
----------------------------------------------------------------------------------------------------<br />
-- End configuration<br />
--<br />
-- Don't edit anything below this line.<br />
----------------------------------------------------------------------------------------------------<br />
--]]<br />
<br />
return cfg</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation&diff=1943Module:Documentation2021-06-23T15:30:55Z<p>Jawitkien: </p>
<hr />
<div>-- This module implements {{documentation}}.<br />
<br />
-- Get required modules.<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
-- Get the config table.<br />
local cfg = mw.loadData('Module:Documentation/config')<br />
<br />
local p = {}<br />
<br />
-- Often-used functions.<br />
local ugsub = mw.ustring.gsub<br />
<br />
----------------------------------------------------------------------------<br />
-- Helper functions<br />
--<br />
-- These are defined as local functions, but are made available in the p<br />
-- table for testing purposes.<br />
----------------------------------------------------------------------------<br />
<br />
local function message(cfgKey, valArray, expectType)<br />
--[[<br />
-- Gets a message from the cfg table and formats it if appropriate.<br />
-- The function raises an error if the value from the cfg table is not<br />
-- of the type expectType. The default type for expectType is 'string'.<br />
-- If the table valArray is present, strings such as $1, $2 etc. in the<br />
-- message are substituted with values from the table keys [1], [2] etc.<br />
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',<br />
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."<br />
--]]<br />
local msg = cfg[cfgKey]<br />
expectType = expectType or 'string' <br />
if type(msg) ~= expectType then<br />
error('message: (DJW)chk: Module;Documentation/config for cfg defn. type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)<br />
end<br />
if not valArray then<br />
return msg<br />
end<br />
<br />
local function getMessageVal(match)<br />
match = tonumber(match)<br />
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)<br />
end<br />
<br />
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)<br />
end<br />
<br />
p.message = message<br />
<br />
local function makeWikilink(page, display)<br />
if display then<br />
return mw.ustring.format('[[%s|%s]]', page, display)<br />
else<br />
return mw.ustring.format('[[%s]]', page)<br />
end<br />
end<br />
<br />
p.makeWikilink = makeWikilink<br />
<br />
local function makeCategoryLink(cat, sort)<br />
local catns = mw.site.namespaces[14].name<br />
return makeWikilink(catns .. ':' .. cat, sort)<br />
end<br />
<br />
p.makeCategoryLink = makeCategoryLink<br />
<br />
local function makeUrlLink(url, display)<br />
return mw.ustring.format('[%s %s]', url, display)<br />
end<br />
<br />
p.makeUrlLink = makeUrlLink<br />
<br />
local function makeToolbar(...)<br />
local ret = {}<br />
local lim = select('#', ...)<br />
if lim < 1 then<br />
return nil<br />
end<br />
for i = 1, lim do<br />
ret[#ret + 1] = select(i, ...)<br />
end<br />
-- 'documentation-toolbar'<br />
return '<span class="' .. message('toolbar-class') .. '">('<br />
.. table.concat(ret, ' &#124; ') .. ')</span>'<br />
end <br />
<br />
p.makeToolbar = makeToolbar<br />
<br />
----------------------------------------------------------------------------<br />
-- Argument processing<br />
----------------------------------------------------------------------------<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.<br />
if key == 'heading' or value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Entry points<br />
----------------------------------------------------------------------------<br />
<br />
function p.nonexistent(frame)<br />
if mw.title.getCurrentTitle().subpageText == 'testcases' then<br />
return frame:expandTemplate{title = 'module test cases notice'}<br />
else<br />
return p.main(frame)<br />
end<br />
end<br />
<br />
p.main = makeInvokeFunc('_main')<br />
<br />
function p._main(args)<br />
--[[<br />
-- This function defines logic flow for the module.<br />
-- @args - table of arguments passed by the user<br />
--]]<br />
local env = p.getEnvironment(args)<br />
local root = mw.html.create()<br />
root<br />
:wikitext(p._getModuleWikitext(args, env))<br />
:wikitext(p.protectionTemplate(env))<br />
:wikitext(p.sandboxNotice(args, env))<br />
:tag('div')<br />
-- 'documentation-container'<br />
:addClass(message('container'))<br />
:newline()<br />
:tag('div')<br />
-- 'documentation'<br />
:addClass(message('main-div-classes'))<br />
:newline()<br />
:wikitext(p._startBox(args, env))<br />
:wikitext(p._content(args, env))<br />
:tag('div')<br />
-- 'documentation-clear'<br />
:addClass(message('clear'))<br />
:done()<br />
:newline()<br />
:done()<br />
:wikitext(p._endBox(args, env))<br />
:done()<br />
:wikitext(p.addTrackingCategories(env))<br />
-- 'Module:Documentation/styles.css'<br />
return mw.getCurrentFrame():extensionTag (<br />
'templatestyles', '', {src=cfg['templatestyles']<br />
}) .. tostring(root)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Environment settings<br />
----------------------------------------------------------------------------<br />
<br />
function p.getEnvironment(args)<br />
--[[<br />
-- Returns a table with information about the environment, including title<br />
-- objects and other namespace- or path-related data.<br />
-- @args - table of arguments passed by the user<br />
--<br />
-- Title objects include:<br />
-- env.title - the page we are making documentation for (usually the current title)<br />
-- env.templateTitle - the template (or module, file, etc.)<br />
-- env.docTitle - the /doc subpage.<br />
-- env.sandboxTitle - the /sandbox subpage.<br />
-- env.testcasesTitle - the /testcases subpage.<br />
-- env.printTitle - the print version of the template, located at the /Print subpage.<br />
--<br />
-- Data includes:<br />
-- env.protectionLevels - the protection levels table of the title object.<br />
-- env.subjectSpace - the number of the title's subject namespace.<br />
-- env.docSpace - the number of the namespace the title puts its documentation in.<br />
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.<br />
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.<br />
-- <br />
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value<br />
-- returned will be nil.<br />
--]]<br />
<br />
local env, envFuncs = {}, {}<br />
<br />
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value<br />
-- returned by that function is memoized in the env table so that we don't call any of the functions<br />
-- more than once. (Nils won't be memoized.)<br />
setmetatable(env, {<br />
__index = function (t, key)<br />
local envFunc = envFuncs[key]<br />
if envFunc then<br />
local success, val = pcall(envFunc)<br />
if success then<br />
env[key] = val -- Memoise the value.<br />
return val<br />
end<br />
end<br />
return nil<br />
end<br />
}) <br />
<br />
function envFuncs.title()<br />
-- The title object for the current page, or a test page passed with args.page.<br />
local title<br />
local titleArg = args.page<br />
if titleArg then<br />
title = mw.title.new(titleArg)<br />
else<br />
title = mw.title.getCurrentTitle()<br />
end<br />
return title<br />
end<br />
<br />
function envFuncs.templateTitle()<br />
--[[<br />
-- The template (or module, etc.) title object.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local subpage = title.subpageText<br />
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then<br />
return mw.title.makeTitle(subjectSpace, title.baseText)<br />
else<br />
return mw.title.makeTitle(subjectSpace, title.text)<br />
end<br />
end<br />
<br />
function envFuncs.docTitle()<br />
--[[<br />
-- Title object of the /doc subpage.<br />
-- Messages:<br />
-- 'doc-subpage' --> 'doc'<br />
--]]<br />
local title = env.title<br />
local docname = args[1] -- User-specified doc page.<br />
local docpage<br />
if docname then<br />
docpage = docname<br />
else<br />
docpage = env.docpageBase .. '/' .. message('doc-subpage')<br />
end<br />
return mw.title.new(docpage)<br />
end<br />
<br />
function envFuncs.sandboxTitle()<br />
--[[<br />
-- Title object for the /sandbox subpage.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))<br />
end<br />
<br />
function envFuncs.testcasesTitle()<br />
--[[<br />
-- Title object for the /testcases subpage.<br />
-- Messages:<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))<br />
end<br />
<br />
function envFuncs.printTitle()<br />
--[[<br />
-- Title object for the /Print subpage.<br />
-- Messages:<br />
-- 'print-subpage' --> 'Print'<br />
--]]<br />
return env.templateTitle:subPageTitle(message('print-subpage'))<br />
end<br />
<br />
function envFuncs.protectionLevels()<br />
-- The protection levels table of the title object.<br />
return env.title.protectionLevels<br />
end<br />
<br />
function envFuncs.subjectSpace()<br />
-- The subject namespace number.<br />
return mw.site.namespaces[env.title.namespace].subject.id<br />
end<br />
<br />
function envFuncs.docSpace()<br />
-- The documentation namespace number. For most namespaces this is the<br />
-- same as the subject namespace. However, pages in the Article, File,<br />
-- MediaWiki or Category namespaces must have their /doc, /sandbox and<br />
-- /testcases pages in talk space.<br />
local subjectSpace = env.subjectSpace<br />
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then<br />
return subjectSpace + 1<br />
else<br />
return subjectSpace<br />
end<br />
end<br />
<br />
function envFuncs.docpageBase()<br />
-- The base page of the /doc, /sandbox, and /testcases subpages.<br />
-- For some namespaces this is the talk page, rather than the template page.<br />
local templateTitle = env.templateTitle<br />
local docSpace = env.docSpace<br />
local docSpaceText = mw.site.namespaces[docSpace].name<br />
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.<br />
return docSpaceText .. ':' .. templateTitle.text<br />
end<br />
<br />
function envFuncs.compareUrl()<br />
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
if templateTitle.exists and sandboxTitle.exists then<br />
local compareUrl = mw.uri.fullUrl(<br />
'Special:ComparePages',<br />
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}<br />
)<br />
return tostring(compareUrl)<br />
else<br />
return nil<br />
end<br />
end <br />
<br />
return env<br />
end <br />
<br />
----------------------------------------------------------------------------<br />
-- Auxiliary templates<br />
----------------------------------------------------------------------------<br />
<br />
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')<br />
<br />
function p._getModuleWikitext(args, env)<br />
local currentTitle = mw.title.getCurrentTitle()<br />
if currentTitle.contentModel ~= 'Scribunto' then return end<br />
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care<br />
local moduleWikitext = package.loaded["Module:Module wikitext"]<br />
if moduleWikitext then<br />
return moduleWikitext.main()<br />
end<br />
end<br />
<br />
function p.sandboxNotice(args, env)<br />
--[=[<br />
-- Generates a sandbox notice for display above sandbox pages.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'<br />
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'<br />
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'<br />
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'<br />
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'<br />
-- 'sandbox-notice-compare-link-display' --> 'diff'<br />
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'<br />
-- 'sandbox-notice-testcases-link-display' --> 'test cases'<br />
-- 'sandbox-category' --> 'Template sandboxes'<br />
--]=]<br />
local title = env.title<br />
local sandboxTitle = env.sandboxTitle<br />
local templateTitle = env.templateTitle<br />
local subjectSpace = env.subjectSpace<br />
if not (subjectSpace and title and sandboxTitle and templateTitle<br />
and mw.title.equals(title, sandboxTitle)) then<br />
return nil<br />
end<br />
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".<br />
local omargs = {}<br />
omargs.image = message('sandbox-notice-image')<br />
-- Get the text. We start with the opening blurb, which is something like<br />
-- "This is the template sandbox for [[Template:Foo]] (diff)."<br />
local text = ''<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('sandbox-notice-pagetype-template')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('sandbox-notice-pagetype-module')<br />
else<br />
pagetype = message('sandbox-notice-pagetype-other')<br />
end<br />
local templateLink = makeWikilink(templateTitle.prefixedText)<br />
local compareUrl = env.compareUrl<br />
if compareUrl then<br />
local compareDisplay = message('sandbox-notice-compare-link-display')<br />
local compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})<br />
else<br />
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})<br />
end<br />
-- Get the test cases page blurb if the page exists. This is something like<br />
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."<br />
local testcasesTitle = env.testcasesTitle<br />
if testcasesTitle and testcasesTitle.exists then<br />
if testcasesTitle.contentModel == "Scribunto" then<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})<br />
else<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})<br />
end<br />
end<br />
-- Add the sandbox to the sandbox category.<br />
omargs.text = text .. makeCategoryLink(message('sandbox-category'))<br />
<br />
-- 'documentation-clear'<br />
return '<div class="' .. message('clear') .. '"></div>'<br />
.. require('Module:Message box').main('ombox', omargs)<br />
end<br />
<br />
function p.protectionTemplate(env)<br />
-- Generates the padlock icon in the top right.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'protection-template' --> 'pp-template'<br />
-- 'protection-template-args' --> {docusage = 'yes'}<br />
local protectionLevels = env.protectionLevels<br />
if not protectionLevels then<br />
return nil<br />
end<br />
local editProt = protectionLevels.edit and protectionLevels.edit[1]<br />
local moveProt = protectionLevels.move and protectionLevels.move[1]<br />
if editProt then<br />
-- The page is edit-protected.<br />
return require('Module:Protection banner')._main{<br />
message('protection-reason-edit'), small = true<br />
}<br />
elseif moveProt and moveProt ~= 'autoconfirmed' then<br />
-- The page is move-protected but not edit-protected. Exclude move<br />
-- protection with the level "autoconfirmed", as this is equivalent to<br />
-- no move protection at all.<br />
return require('Module:Protection banner')._main{<br />
action = 'move', small = true<br />
}<br />
else<br />
return nil<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Start box<br />
----------------------------------------------------------------------------<br />
<br />
p.startBox = makeInvokeFunc('_startBox')<br />
<br />
function p._startBox(args, env)<br />
--[[<br />
-- This function generates the start box.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make<br />
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox<br />
-- which generate the box HTML.<br />
--]]<br />
env = env or p.getEnvironment(args)<br />
local links<br />
local content = args.content<br />
if not content or args[1] then<br />
-- No need to include the links if the documentation is on the template page itself.<br />
local linksData = p.makeStartBoxLinksData(args, env)<br />
if linksData then<br />
links = p.renderStartBoxLinks(linksData)<br />
end<br />
end<br />
-- Generate the start box html.<br />
local data = p.makeStartBoxData(args, env, links)<br />
if data then<br />
return p.renderStartBox(data)<br />
else<br />
-- User specified no heading.<br />
return nil<br />
end<br />
end<br />
<br />
function p.makeStartBoxLinksData(args, env)<br />
--[[<br />
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'view-link-display' --> 'view'<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'purge-link-display' --> 'purge'<br />
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'docpage-preload' --> 'Template:Documentation/preload'<br />
-- 'create-link-display' --> 'create'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local docTitle = env.docTitle<br />
if not title or not docTitle then<br />
return nil<br />
end<br />
if docTitle.isRedirect then <br />
docTitle = docTitle.redirectTarget<br />
end<br />
<br />
local data = {}<br />
data.title = title<br />
data.docTitle = docTitle<br />
-- View, display, edit, and purge links if /doc exists.<br />
data.viewLinkDisplay = message('view-link-display')<br />
data.editLinkDisplay = message('edit-link-display')<br />
data.historyLinkDisplay = message('history-link-display')<br />
data.purgeLinkDisplay = message('purge-link-display')<br />
-- Create link if /doc doesn't exist.<br />
local preload = args.preload<br />
if not preload then<br />
if subjectSpace == 6 then -- File namespace<br />
preload = message('file-docpage-preload')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
preload = message('module-preload')<br />
else<br />
preload = message('docpage-preload')<br />
end<br />
end<br />
data.preload = preload<br />
data.createLinkDisplay = message('create-link-display')<br />
return data<br />
end<br />
<br />
function p.renderStartBoxLinks(data)<br />
--[[<br />
-- Generates the [view][edit][history][purge] or [create] links from the data table.<br />
-- @data - a table of data generated by p.makeStartBoxLinksData<br />
--]]<br />
<br />
local function escapeBrackets(s)<br />
-- Escapes square brackets with HTML entities.<br />
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.<br />
s = s:gsub('%]', '&#93;')<br />
return s<br />
end<br />
<br />
local ret<br />
local docTitle = data.docTitle<br />
local title = data.title<br />
if docTitle.exists then<br />
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)<br />
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)<br />
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)<br />
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)<br />
ret = '[%s] [%s] [%s] [%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)<br />
else<br />
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)<br />
ret = '[%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, createLink)<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeStartBoxData(args, env, links)<br />
--[=[<br />
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.<br />
--<br />
-- Messages:<br />
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
-- 'template-namespace-heading' --> 'Template documentation'<br />
-- 'module-namespace-heading' --> 'Module documentation'<br />
-- 'file-namespace-heading' --> 'Summary'<br />
-- 'other-namespaces-heading' --> 'Documentation'<br />
-- 'testcases-create-link-display' --> 'create'<br />
--]=]<br />
local subjectSpace = env.subjectSpace<br />
if not subjectSpace then<br />
-- Default to an "other namespaces" namespace, so that we get at least some output<br />
-- if an error occurs.<br />
subjectSpace = 2<br />
end<br />
local data = {}<br />
<br />
-- Heading<br />
local heading = args.heading -- Blank values are not removed.<br />
if heading == '' then<br />
-- Don't display the start box if the heading arg is defined but blank.<br />
return nil<br />
end<br />
if heading then<br />
data.heading = heading<br />
elseif subjectSpace == 10 then -- Template namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')<br />
elseif subjectSpace == 6 then -- File namespace<br />
data.heading = message('file-namespace-heading')<br />
else<br />
data.heading = message('other-namespaces-heading')<br />
end<br />
<br />
-- Heading CSS<br />
local headingStyle = args['heading-style']<br />
if headingStyle then<br />
data.headingStyleText = headingStyle<br />
else<br />
-- 'documentation-heading'<br />
data.headingClass = message('main-div-heading-class')<br />
end<br />
<br />
-- Data for the [view][edit][history][purge] or [create] links.<br />
if links then<br />
-- 'mw-editsection-like plainlinks'<br />
data.linksClass = message('start-box-link-classes')<br />
data.links = links<br />
end<br />
<br />
return data<br />
end<br />
<br />
function p.renderStartBox(data)<br />
-- Renders the start box html.<br />
-- @data - a table of data generated by p.makeStartBoxData.<br />
local sbox = mw.html.create('div')<br />
sbox<br />
-- 'documentation-startbox'<br />
:addClass(message('start-box-class'))<br />
:newline()<br />
:tag('span')<br />
:addClass(data.headingClass)<br />
:cssText(data.headingStyleText)<br />
:wikitext(data.heading)<br />
local links = data.links<br />
if links then<br />
sbox:tag('span')<br />
:addClass(data.linksClass)<br />
:attr('id', data.linksId)<br />
:wikitext(links)<br />
end<br />
return tostring(sbox)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Documentation content<br />
----------------------------------------------------------------------------<br />
<br />
p.content = makeInvokeFunc('_content')<br />
<br />
function p._content(args, env)<br />
-- Displays the documentation contents<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
local content = args.content<br />
if not content and docTitle and docTitle.exists then<br />
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}<br />
end<br />
-- The line breaks below are necessary so that "=== Headings ===" at the start and end<br />
-- of docs are interpreted correctly.<br />
return '\n' .. (content or '') .. '\n' <br />
end<br />
<br />
p.contentTitle = makeInvokeFunc('_contentTitle')<br />
<br />
function p._contentTitle(args, env)<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
if not args.content and docTitle and docTitle.exists then<br />
return docTitle.prefixedText<br />
else<br />
return ''<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- End box<br />
----------------------------------------------------------------------------<br />
<br />
p.endBox = makeInvokeFunc('_endBox')<br />
<br />
function p._endBox(args, env)<br />
--[=[<br />
-- This function generates the end box (also known as the link box).<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
--]=]<br />
<br />
-- Get environment data.<br />
env = env or p.getEnvironment(args)<br />
local subjectSpace = env.subjectSpace<br />
local docTitle = env.docTitle<br />
if not subjectSpace or not docTitle then<br />
return nil<br />
end<br />
<br />
-- Check whether we should output the end box at all. Add the end<br />
-- box by default if the documentation exists or if we are in the<br />
-- user, module or template namespaces.<br />
local linkBox = args['link box']<br />
if linkBox == 'off'<br />
or not (<br />
docTitle.exists<br />
or subjectSpace == 2<br />
or subjectSpace == 828<br />
or subjectSpace == 10<br />
)<br />
then<br />
return nil<br />
end<br />
<br />
-- Assemble the link box.<br />
local text = ''<br />
if linkBox then<br />
text = text .. linkBox<br />
else<br />
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <br />
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then<br />
-- We are in the user, template or module namespaces.<br />
-- Add sandbox and testcases links.<br />
-- "Editors can experiment in this template's sandbox and testcases pages."<br />
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'<br />
if not args.content and not args[1] then<br />
-- "Please add categories to the /doc subpage."<br />
-- Don't show this message with inline docs or with an explicitly specified doc page,<br />
-- as then it is unclear where to add the categories.<br />
text = text .. (p.makeCategoriesBlurb(args, env) or '')<br />
end<br />
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"<br />
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.<br />
if printBlurb then<br />
text = text .. '<br />' .. printBlurb<br />
end<br />
end<br />
end<br />
<br />
local box = mw.html.create('div')<br />
-- 'documentation-metadata'<br />
box:attr('role', 'note')<br />
:addClass(message('end-box-class'))<br />
-- 'plainlinks'<br />
:addClass(message('end-box-plainlinks'))<br />
:wikitext(text)<br />
:done()<br />
<br />
return '\n' .. tostring(box)<br />
end<br />
<br />
function p.makeDocPageBlurb(args, env)<br />
--[=[<br />
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'transcluded-from-blurb' --> <br />
-- 'The above [[Wikipedia:Template documentation|documentation]] <br />
-- is [[Help:Transclusion|transcluded]] from $1.'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'create-link-display' --> 'create'<br />
-- 'create-module-doc-blurb' --><br />
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
--]=]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local ret<br />
if docTitle.exists then<br />
-- /doc exists; link to it.<br />
local docLink = makeWikilink(docTitle.prefixedText)<br />
local editUrl = docTitle:fullUrl{action = 'edit'}<br />
local editDisplay = message('edit-link-display')<br />
local editLink = makeUrlLink(editUrl, editDisplay)<br />
local historyUrl = docTitle:fullUrl{action = 'history'}<br />
local historyDisplay = message('history-link-display')<br />
local historyLink = makeUrlLink(historyUrl, historyDisplay)<br />
ret = message('transcluded-from-blurb', {docLink})<br />
.. ' '<br />
.. makeToolbar(editLink, historyLink)<br />
.. '<br />'<br />
elseif env.subjectSpace == 828 then<br />
-- /doc does not exist; ask to create it.<br />
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}<br />
local createDisplay = message('create-link-display')<br />
local createLink = makeUrlLink(createUrl, createDisplay)<br />
ret = message('create-module-doc-blurb', {createLink})<br />
.. '<br />'<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeExperimentBlurb(args, env)<br />
--[[<br />
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'sandbox-edit-link-display' --> 'edit'<br />
-- 'compare-link-display' --> 'diff'<br />
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'sandbox-create-link-display' --> 'create'<br />
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'<br />
-- 'mirror-link-display' --> 'mirror'<br />
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display'--> 'edit'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'testcases-create-link-display' --> 'create'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display' --> 'edit'<br />
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'<br />
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'<br />
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'<br />
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
local testcasesTitle = env.testcasesTitle<br />
local templatePage = templateTitle.prefixedText<br />
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then<br />
return nil<br />
end<br />
-- Make links.<br />
local sandboxLinks, testcasesLinks<br />
if sandboxTitle.exists then<br />
local sandboxPage = sandboxTitle.prefixedText<br />
local sandboxDisplay = message('sandbox-link-display')<br />
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)<br />
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}<br />
local sandboxEditDisplay = message('sandbox-edit-link-display')<br />
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)<br />
local compareUrl = env.compareUrl<br />
local compareLink<br />
if compareUrl then<br />
local compareDisplay = message('compare-link-display')<br />
compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
end<br />
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)<br />
else<br />
local sandboxPreload<br />
if subjectSpace == 828 then<br />
sandboxPreload = message('module-sandbox-preload')<br />
else<br />
sandboxPreload = message('template-sandbox-preload')<br />
end<br />
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}<br />
local sandboxCreateDisplay = message('sandbox-create-link-display')<br />
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)<br />
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})<br />
local mirrorPreload = message('mirror-link-preload')<br />
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}<br />
if subjectSpace == 828 then<br />
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}<br />
end<br />
local mirrorDisplay = message('mirror-link-display')<br />
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)<br />
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)<br />
end<br />
if testcasesTitle.exists then<br />
local testcasesPage = testcasesTitle.prefixedText<br />
local testcasesDisplay = message('testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)<br />
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}<br />
local testcasesEditDisplay = message('testcases-edit-link-display')<br />
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)<br />
-- for Modules, add testcases run link if exists<br />
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then<br />
local testcasesRunLinkDisplay = message('testcases-run-link-display')<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)<br />
else<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)<br />
end<br />
else<br />
local testcasesPreload<br />
if subjectSpace == 828 then<br />
testcasesPreload = message('module-testcases-preload')<br />
else<br />
testcasesPreload = message('template-testcases-preload')<br />
end<br />
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}<br />
local testcasesCreateDisplay = message('testcases-create-link-display')<br />
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)<br />
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)<br />
end<br />
local messageName<br />
if subjectSpace == 828 then<br />
messageName = 'experiment-blurb-module'<br />
else<br />
messageName = 'experiment-blurb-template'<br />
end<br />
return message(messageName, {sandboxLinks, testcasesLinks})<br />
end<br />
<br />
function p.makeCategoriesBlurb(args, env)<br />
--[[<br />
-- Generates the text "Please add categories to the /doc subpage."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'doc-link-display' --> '/doc'<br />
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'<br />
--]]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))<br />
return message('add-categories-blurb', {docPathLink})<br />
end<br />
<br />
function p.makeSubpagesBlurb(args, env)<br />
--[[<br />
-- Generates the "Subpages of this template" link.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'template-pagetype' --> 'template'<br />
-- 'module-pagetype' --> 'module'<br />
-- 'default-pagetype' --> 'page'<br />
-- 'subpages-link-display' --> 'Subpages of this $1'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
if not subjectSpace or not templateTitle then<br />
return nil<br />
end<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('template-pagetype')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('module-pagetype')<br />
else<br />
pagetype = message('default-pagetype')<br />
end<br />
local subpagesLink = makeWikilink(<br />
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',<br />
message('subpages-link-display', {pagetype})<br />
)<br />
return message('subpages-blurb', {subpagesLink})<br />
end<br />
<br />
function p.makePrintBlurb(args, env)<br />
--[=[<br />
-- Generates the blurb displayed when there is a print version of the template available.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
--<br />
-- Messages:<br />
-- 'print-link-display' --> '/Print'<br />
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'<br />
-- .. ' of this template exists at $1.'<br />
-- .. ' If you make a change to this template, please update the print version as well.'<br />
-- 'display-print-category' --> true<br />
-- 'print-category' --> 'Templates with print versions'<br />
--]=]<br />
local printTitle = env.printTitle<br />
if not printTitle then<br />
return nil<br />
end<br />
local ret<br />
if printTitle.exists then<br />
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))<br />
ret = message('print-blurb', {printLink})<br />
local displayPrintCategory = message('display-print-category', nil, 'boolean')<br />
if displayPrintCategory then<br />
ret = ret .. makeCategoryLink(message('print-category'))<br />
end<br />
end<br />
return ret<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Tracking categories<br />
----------------------------------------------------------------------------<br />
<br />
function p.addTrackingCategories(env)<br />
--[[<br />
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'display-strange-usage-category' --> true<br />
-- 'doc-subpage' --> 'doc'<br />
-- 'testcases-subpage' --> 'testcases'<br />
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'<br />
-- <br />
-- /testcases pages in the module namespace are not categorised, as they may have<br />
-- {{documentation}} transcluded automatically.<br />
--]]<br />
local title = env.title<br />
local subjectSpace = env.subjectSpace<br />
if not title or not subjectSpace then<br />
return nil<br />
end<br />
local subpage = title.subpageText<br />
local ret = ''<br />
if message('display-strange-usage-category', nil, 'boolean')<br />
and (<br />
subpage == message('doc-subpage')<br />
or subjectSpace ~= 828 and subpage == message('testcases-subpage')<br />
)<br />
then<br />
ret = ret .. makeCategoryLink(message('strange-usage-category'))<br />
end<br />
return ret<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation/config&diff=1942Module:Documentation/config2021-06-23T15:28:32Z<p>Jawitkien: </p>
<hr />
<div>----------------------------------------------------------------------------------------------------<br />
--<br />
-- Configuration for Module:Documentation<br />
--<br />
-- Here you can set the values of the parameters and messages used in Module:Documentation to<br />
-- localise it to your wiki and your language. Unless specified otherwise, values given here<br />
-- should be string values.<br />
----------------------------------------------------------------------------------------------------<br />
<br />
local cfg = {} -- Do not edit this line.<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Protection template configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['protection-reason-edit']<br />
-- The protection reason for edit-protected templates to pass to<br />
-- [[Module:Protection banner]].<br />
cfg['protection-reason-edit'] = 'template'<br />
<br />
--[[<br />
----------------------------------------------------------------------------------------------------<br />
-- Sandbox notice configuration<br />
--<br />
-- On sandbox pages the module can display a template notifying users that the current page is a<br />
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a<br />
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the<br />
-- messages that the notices contains.<br />
----------------------------------------------------------------------------------------------------<br />
--]]<br />
<br />
-- cfg['sandbox-notice-image']<br />
-- The image displayed in the sandbox notice.<br />
cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
<br />
--[[<br />
-- cfg['sandbox-notice-pagetype-template']<br />
-- cfg['sandbox-notice-pagetype-module']<br />
-- cfg['sandbox-notice-pagetype-other']<br />
-- The page type of the sandbox page. The message that is displayed depends on the current subject<br />
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or<br />
-- cfg['sandbox-notice-diff-blurb'].<br />
--]]<br />
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'<br />
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'<br />
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'<br />
<br />
--[[<br />
-- cfg['sandbox-notice-blurb']<br />
-- cfg['sandbox-notice-diff-blurb']<br />
-- cfg['sandbox-notice-diff-display']<br />
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence<br />
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page<br />
-- type, which is either cfg['sandbox-notice-pagetype-template'],<br />
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what<br />
-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between<br />
-- the sandbox and the main template. The display value of the diff link is set by <br />
-- cfg['sandbox-notice-compare-link-display'].<br />
--]]<br />
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'<br />
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'<br />
cfg['sandbox-notice-compare-link-display'] = 'diff'<br />
<br />
--[[<br />
-- cfg['sandbox-notice-testcases-blurb']<br />
-- cfg['sandbox-notice-testcases-link-display']<br />
-- cfg['sandbox-notice-testcases-run-blurb']<br />
-- cfg['sandbox-notice-testcases-run-link-display']<br />
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page<br />
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.<br />
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.<br />
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page<br />
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test<br />
-- cases page, and $2 is a link to the page to run it.<br />
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test<br />
-- cases.<br />
--]]<br />
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'<br />
cfg['sandbox-notice-testcases-link-display'] = 'test cases'<br />
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'<br />
cfg['sandbox-notice-testcases-run-link-display'] = 'run'<br />
<br />
-- cfg['sandbox-category']<br />
-- A category to add to all template sandboxes.<br />
cfg['sandbox-category'] = 'Template sandboxes'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Start box configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['documentation-icon-wikitext']<br />
-- The wikitext for the icon shown at the top of the template.<br />
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
<br />
-- cfg['template-namespace-heading']<br />
-- The heading shown in the template namespace.<br />
cfg['template-namespace-heading'] = 'Template documentation'<br />
<br />
-- cfg['module-namespace-heading']<br />
-- The heading shown in the module namespace.<br />
cfg['module-namespace-heading'] = 'Module documentation'<br />
<br />
-- cfg['file-namespace-heading']<br />
-- The heading shown in the file namespace.<br />
cfg['file-namespace-heading'] = 'Summary'<br />
<br />
-- cfg['other-namespaces-heading']<br />
-- The heading shown in other namespaces.<br />
cfg['other-namespaces-heading'] = 'Documentation'<br />
<br />
-- cfg['view-link-display']<br />
-- The text to display for "view" links.<br />
cfg['view-link-display'] = 'view'<br />
<br />
-- cfg['edit-link-display']<br />
-- The text to display for "edit" links.<br />
cfg['edit-link-display'] = 'edit'<br />
<br />
-- cfg['history-link-display']<br />
-- The text to display for "history" links.<br />
cfg['history-link-display'] = 'history'<br />
<br />
-- cfg['purge-link-display']<br />
-- The text to display for "purge" links.<br />
cfg['purge-link-display'] = 'purge'<br />
<br />
-- cfg['create-link-display']<br />
-- The text to display for "create" links.<br />
cfg['create-link-display'] = 'create'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Link box (end box) configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['transcluded-from-blurb']<br />
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.<br />
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'<br />
<br />
--[[<br />
-- cfg['create-module-doc-blurb']<br />
-- Notice displayed in the module namespace when the documentation subpage does not exist.<br />
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the<br />
-- display cfg['create-link-display'].<br />
--]]<br />
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Experiment blurb configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
--[[<br />
-- cfg['experiment-blurb-template']<br />
-- cfg['experiment-blurb-module']<br />
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.<br />
-- It is only shown in the template and module namespaces. With the default English settings, it<br />
-- might look like this:<br />
--<br />
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.<br />
--<br />
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.<br />
--<br />
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending<br />
-- on what namespace we are in.<br />
-- <br />
-- Parameters:<br />
--<br />
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:<br />
--<br />
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])<br />
-- <br />
-- If the sandbox doesn't exist, it is in the format:<br />
--<br />
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])<br />
-- <br />
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']<br />
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']<br />
-- loads a default edit summary of cfg['mirror-edit-summary'].<br />
--<br />
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:<br />
--<br />
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-run-link-display'])<br />
--<br />
-- If the test cases page doesn't exist, it is in the format:<br />
-- <br />
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display'])<br />
--<br />
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the<br />
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current<br />
-- namespace.<br />
--]]<br />
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."<br />
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Sandbox link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['sandbox-subpage']<br />
-- The name of the template subpage typically used for sandboxes.<br />
cfg['sandbox-subpage'] = 'sandbox'<br />
<br />
-- cfg['template-sandbox-preload']<br />
-- Preload file for template sandbox pages.<br />
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'<br />
<br />
-- cfg['module-sandbox-preload']<br />
-- Preload file for Lua module sandbox pages.<br />
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'<br />
<br />
-- cfg['sandbox-link-display']<br />
-- The text to display for "sandbox" links.<br />
cfg['sandbox-link-display'] = 'sandbox'<br />
<br />
-- cfg['sandbox-edit-link-display']<br />
-- The text to display for sandbox "edit" links.<br />
cfg['sandbox-edit-link-display'] = 'edit'<br />
<br />
-- cfg['sandbox-create-link-display']<br />
-- The text to display for sandbox "create" links.<br />
cfg['sandbox-create-link-display'] = 'create'<br />
<br />
-- cfg['compare-link-display']<br />
-- The text to display for "compare" links.<br />
cfg['compare-link-display'] = 'diff'<br />
<br />
-- cfg['mirror-edit-summary']<br />
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the<br />
-- template page.<br />
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'<br />
<br />
-- cfg['mirror-link-display']<br />
-- The text to display for "mirror" links.<br />
cfg['mirror-link-display'] = 'mirror'<br />
<br />
-- cfg['mirror-link-preload']<br />
-- The page to preload when a user clicks the "mirror" link.<br />
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Test cases link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['testcases-subpage']<br />
-- The name of the template subpage typically used for test cases.<br />
cfg['testcases-subpage'] = 'testcases'<br />
<br />
-- cfg['template-testcases-preload']<br />
-- Preload file for template test cases pages.<br />
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'<br />
<br />
-- cfg['module-testcases-preload']<br />
-- Preload file for Lua module test cases pages.<br />
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'<br />
<br />
-- cfg['testcases-link-display']<br />
-- The text to display for "testcases" links.<br />
cfg['testcases-link-display'] = 'testcases'<br />
<br />
-- cfg['testcases-edit-link-display']<br />
-- The text to display for test cases "edit" links.<br />
cfg['testcases-edit-link-display'] = 'edit'<br />
<br />
-- cfg['testcases-run-link-display']<br />
-- The text to display for test cases "run" links.<br />
cfg['testcases-run-link-display'] = 'run'<br />
<br />
-- cfg['testcases-create-link-display']<br />
-- The text to display for test cases "create" links.<br />
cfg['testcases-create-link-display'] = 'create'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Add categories blurb configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
--[[<br />
-- cfg['add-categories-blurb']<br />
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or<br />
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a<br />
-- link to the /doc subpage with a display value of cfg['doc-link-display'].<br />
--]]<br />
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'<br />
<br />
-- cfg['doc-link-display']<br />
-- The text to display when linking to the /doc subpage.<br />
cfg['doc-link-display'] = '/doc'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Subpages link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
--[[<br />
-- cfg['subpages-blurb']<br />
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a<br />
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply<br />
-- the link followed by a period, and the link display provides the actual text.<br />
--]]<br />
cfg['subpages-blurb'] = '$1.'<br />
<br />
--[[<br />
-- cfg['subpages-link-display']<br />
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],<br />
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in<br />
-- the template namespace, the module namespace, or another namespace.<br />
--]]<br />
cfg['subpages-link-display'] = 'Subpages of this $1'<br />
<br />
-- cfg['template-pagetype']<br />
-- The pagetype to display for template pages.<br />
cfg['template-pagetype'] = 'template'<br />
<br />
-- cfg['module-pagetype']<br />
-- The pagetype to display for Lua module pages.<br />
cfg['module-pagetype'] = 'module'<br />
<br />
-- cfg['default-pagetype']<br />
-- The pagetype to display for pages other than templates or Lua modules.<br />
cfg['default-pagetype'] = 'page'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Doc link configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['doc-subpage']<br />
-- The name of the subpage typically used for documentation pages.<br />
cfg['doc-subpage'] = 'doc'<br />
<br />
-- cfg['file-docpage-preload']<br />
-- Preload file for documentation page in the file namespace.<br />
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'<br />
<br />
-- cfg['docpage-preload']<br />
-- Preload file for template documentation pages in all namespaces.<br />
cfg['docpage-preload'] = 'Template:Documentation/preload'<br />
<br />
-- cfg['module-preload']<br />
-- Preload file for Lua module documentation pages.<br />
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Print version configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['print-subpage']<br />
-- The name of the template subpage used for print versions.<br />
cfg['print-subpage'] = 'Print'<br />
<br />
-- cfg['print-link-display']<br />
-- The text to display when linking to the /Print subpage.<br />
cfg['print-link-display'] = '/Print'<br />
<br />
-- cfg['print-blurb']<br />
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].<br />
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'<br />
.. ' If you make a change to this template, please update the print version as well.'<br />
<br />
-- cfg['display-print-category']<br />
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.<br />
-- This should be a boolean value (either true or false).<br />
cfg['display-print-category'] = true<br />
<br />
-- cfg['print-category']<br />
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.<br />
cfg['print-category'] = 'Templates with print versions'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- HTML and CSS configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['templatestyles']<br />
-- The name of the TemplateStyles page where CSS is kept.<br />
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.<br />
cfg['templatestyles'] = 'Module:Documentation/styles.css'<br />
<br />
-- cfg['container']<br />
-- Class which can be used to set flex or grid CSS on the<br />
-- two child divs documentation and documentation-metadata<br />
cfg['container'] = 'documentation-container'<br />
<br />
-- cfg['main-div-id']<br />
-- The "id" attribute of the main HTML "div" tag.<br />
cfg['main-div-id'] = 'template-documentation'<br />
<br />
-- cfg['main-div-classes']<br />
-- The CSS classes added to the main HTML "div" tag.<br />
cfg['main-div-classes'] = 'template-documentation iezoomfix'<br />
<br />
-- cfg['main-div-heading-class']<br />
-- Class for the main heading for templates and modules and assoc. talk spaces<br />
cfg['main-div-heading-class'] = 'documentation-heading'<br />
<br />
-- cfg['start-box-class']<br />
-- Class for the start box<br />
cfg['start-box-class'] = 'documentation-startbox'<br />
<br />
-- cfg['start-box-linkclasses']<br />
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.<br />
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'<br />
<br />
-- cfg['start-box-link-id']<br />
-- The HTML "id" attribute for the links in the start box.<br />
cfg['start-box-link-id'] = 'doc_editlinks'<br />
<br />
-- cfg['end-box-class']<br />
-- Class for the end box.<br />
cfg['end-box-class'] = 'documentation-metadata'<br />
<br />
-- cfg['end-box-plainlinks']<br />
-- Plainlinks<br />
cfg['end-box-plainlinks'] = 'plainlinks'<br />
<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- {{fmbox}} template configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['fmbox-id']<br />
-- The id sent to the "id" parameter of the {{fmbox}} template.<br />
cfg['fmbox-id'] = 'documentation-meta-data'<br />
<br />
-- cfg['fmbox-style']<br />
-- The value sent to the style parameter of {{fmbox}}.<br />
cfg['fmbox-style'] = 'background-color: #ecfcf4'<br />
<br />
-- cfg['fmbox-textstyle']<br />
-- The value sent to the "textstyle parameter of {{fmbox}}.<br />
cfg['fmbox-textstyle'] = 'font-style: italic'<br />
<br />
----------------------------------------------------------------------------------------------------<br />
-- Tracking category configuration<br />
----------------------------------------------------------------------------------------------------<br />
<br />
-- cfg['display-strange-usage-category']<br />
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage<br />
-- or a /testcases subpage. This should be a boolean value (either true or false).<br />
cfg['display-strange-usage-category'] = true<br />
<br />
-- cfg['strange-usage-category']<br />
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a<br />
-- /doc subpage or a /testcases subpage.<br />
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'<br />
<br />
--[[<br />
----------------------------------------------------------------------------------------------------<br />
-- End configuration<br />
--<br />
-- Don't edit anything below this line.<br />
----------------------------------------------------------------------------------------------------<br />
--]]<br />
<br />
return cfg</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation&diff=1941Module:Documentation2021-06-23T15:19:21Z<p>Jawitkien: </p>
<hr />
<div>-- This module implements {{documentation}}.<br />
<br />
-- Get required modules.<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
-- Get the config table.<br />
local cfg = mw.loadData('Module:Documentation/config')<br />
<br />
local p = {}<br />
<br />
-- Often-used functions.<br />
local ugsub = mw.ustring.gsub<br />
<br />
----------------------------------------------------------------------------<br />
-- Helper functions<br />
--<br />
-- These are defined as local functions, but are made available in the p<br />
-- table for testing purposes.<br />
----------------------------------------------------------------------------<br />
<br />
local function message(cfgKey, valArray, expectType)<br />
--[[<br />
-- Gets a message from the cfg table and formats it if appropriate.<br />
-- The function raises an error if the value from the cfg table is not<br />
-- of the type expectType. The default type for expectType is 'string'.<br />
-- If the table valArray is present, strings such as $1, $2 etc. in the<br />
-- message are substituted with values from the table keys [1], [2] etc.<br />
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',<br />
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."<br />
--]]<br />
local msg = cfg[cfgKey]<br />
expectType = expectType or 'string' <br />
if type(msg) ~= expectType then<br />
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)<br />
end<br />
if not valArray then<br />
return msg<br />
end<br />
<br />
local function getMessageVal(match)<br />
match = tonumber(match)<br />
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)<br />
end<br />
<br />
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)<br />
end<br />
<br />
p.message = message<br />
<br />
local function makeWikilink(page, display)<br />
if display then<br />
return mw.ustring.format('[[%s|%s]]', page, display)<br />
else<br />
return mw.ustring.format('[[%s]]', page)<br />
end<br />
end<br />
<br />
p.makeWikilink = makeWikilink<br />
<br />
local function makeCategoryLink(cat, sort)<br />
local catns = mw.site.namespaces[14].name<br />
return makeWikilink(catns .. ':' .. cat, sort)<br />
end<br />
<br />
p.makeCategoryLink = makeCategoryLink<br />
<br />
local function makeUrlLink(url, display)<br />
return mw.ustring.format('[%s %s]', url, display)<br />
end<br />
<br />
p.makeUrlLink = makeUrlLink<br />
<br />
local function makeToolbar(...)<br />
local ret = {}<br />
local lim = select('#', ...)<br />
if lim < 1 then<br />
return nil<br />
end<br />
for i = 1, lim do<br />
ret[#ret + 1] = select(i, ...)<br />
end<br />
-- 'documentation-toolbar'<br />
return '<span class="' .. message('toolbar-class') .. '">('<br />
.. table.concat(ret, ' &#124; ') .. ')</span>'<br />
end <br />
<br />
p.makeToolbar = makeToolbar<br />
<br />
----------------------------------------------------------------------------<br />
-- Argument processing<br />
----------------------------------------------------------------------------<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.<br />
if key == 'heading' or value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Entry points<br />
----------------------------------------------------------------------------<br />
<br />
function p.nonexistent(frame)<br />
if mw.title.getCurrentTitle().subpageText == 'testcases' then<br />
return frame:expandTemplate{title = 'module test cases notice'}<br />
else<br />
return p.main(frame)<br />
end<br />
end<br />
<br />
p.main = makeInvokeFunc('_main')<br />
<br />
function p._main(args)<br />
--[[<br />
-- This function defines logic flow for the module.<br />
-- @args - table of arguments passed by the user<br />
--]]<br />
local env = p.getEnvironment(args)<br />
local root = mw.html.create()<br />
root<br />
:wikitext(p._getModuleWikitext(args, env))<br />
:wikitext(p.protectionTemplate(env))<br />
:wikitext(p.sandboxNotice(args, env))<br />
:tag('div')<br />
-- 'documentation-container'<br />
:addClass(message('container'))<br />
:newline()<br />
:tag('div')<br />
-- 'documentation'<br />
:addClass(message('main-div-classes'))<br />
:newline()<br />
:wikitext(p._startBox(args, env))<br />
:wikitext(p._content(args, env))<br />
:tag('div')<br />
-- 'documentation-clear'<br />
:addClass(message('clear'))<br />
:done()<br />
:newline()<br />
:done()<br />
:wikitext(p._endBox(args, env))<br />
:done()<br />
:wikitext(p.addTrackingCategories(env))<br />
-- 'Module:Documentation/styles.css'<br />
return mw.getCurrentFrame():extensionTag (<br />
'templatestyles', '', {src=cfg['templatestyles']<br />
}) .. tostring(root)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Environment settings<br />
----------------------------------------------------------------------------<br />
<br />
function p.getEnvironment(args)<br />
--[[<br />
-- Returns a table with information about the environment, including title<br />
-- objects and other namespace- or path-related data.<br />
-- @args - table of arguments passed by the user<br />
--<br />
-- Title objects include:<br />
-- env.title - the page we are making documentation for (usually the current title)<br />
-- env.templateTitle - the template (or module, file, etc.)<br />
-- env.docTitle - the /doc subpage.<br />
-- env.sandboxTitle - the /sandbox subpage.<br />
-- env.testcasesTitle - the /testcases subpage.<br />
-- env.printTitle - the print version of the template, located at the /Print subpage.<br />
--<br />
-- Data includes:<br />
-- env.protectionLevels - the protection levels table of the title object.<br />
-- env.subjectSpace - the number of the title's subject namespace.<br />
-- env.docSpace - the number of the namespace the title puts its documentation in.<br />
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.<br />
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.<br />
-- <br />
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value<br />
-- returned will be nil.<br />
--]]<br />
<br />
local env, envFuncs = {}, {}<br />
<br />
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value<br />
-- returned by that function is memoized in the env table so that we don't call any of the functions<br />
-- more than once. (Nils won't be memoized.)<br />
setmetatable(env, {<br />
__index = function (t, key)<br />
local envFunc = envFuncs[key]<br />
if envFunc then<br />
local success, val = pcall(envFunc)<br />
if success then<br />
env[key] = val -- Memoise the value.<br />
return val<br />
end<br />
end<br />
return nil<br />
end<br />
}) <br />
<br />
function envFuncs.title()<br />
-- The title object for the current page, or a test page passed with args.page.<br />
local title<br />
local titleArg = args.page<br />
if titleArg then<br />
title = mw.title.new(titleArg)<br />
else<br />
title = mw.title.getCurrentTitle()<br />
end<br />
return title<br />
end<br />
<br />
function envFuncs.templateTitle()<br />
--[[<br />
-- The template (or module, etc.) title object.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local subpage = title.subpageText<br />
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then<br />
return mw.title.makeTitle(subjectSpace, title.baseText)<br />
else<br />
return mw.title.makeTitle(subjectSpace, title.text)<br />
end<br />
end<br />
<br />
function envFuncs.docTitle()<br />
--[[<br />
-- Title object of the /doc subpage.<br />
-- Messages:<br />
-- 'doc-subpage' --> 'doc'<br />
--]]<br />
local title = env.title<br />
local docname = args[1] -- User-specified doc page.<br />
local docpage<br />
if docname then<br />
docpage = docname<br />
else<br />
docpage = env.docpageBase .. '/' .. message('doc-subpage')<br />
end<br />
return mw.title.new(docpage)<br />
end<br />
<br />
function envFuncs.sandboxTitle()<br />
--[[<br />
-- Title object for the /sandbox subpage.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))<br />
end<br />
<br />
function envFuncs.testcasesTitle()<br />
--[[<br />
-- Title object for the /testcases subpage.<br />
-- Messages:<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))<br />
end<br />
<br />
function envFuncs.printTitle()<br />
--[[<br />
-- Title object for the /Print subpage.<br />
-- Messages:<br />
-- 'print-subpage' --> 'Print'<br />
--]]<br />
return env.templateTitle:subPageTitle(message('print-subpage'))<br />
end<br />
<br />
function envFuncs.protectionLevels()<br />
-- The protection levels table of the title object.<br />
return env.title.protectionLevels<br />
end<br />
<br />
function envFuncs.subjectSpace()<br />
-- The subject namespace number.<br />
return mw.site.namespaces[env.title.namespace].subject.id<br />
end<br />
<br />
function envFuncs.docSpace()<br />
-- The documentation namespace number. For most namespaces this is the<br />
-- same as the subject namespace. However, pages in the Article, File,<br />
-- MediaWiki or Category namespaces must have their /doc, /sandbox and<br />
-- /testcases pages in talk space.<br />
local subjectSpace = env.subjectSpace<br />
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then<br />
return subjectSpace + 1<br />
else<br />
return subjectSpace<br />
end<br />
end<br />
<br />
function envFuncs.docpageBase()<br />
-- The base page of the /doc, /sandbox, and /testcases subpages.<br />
-- For some namespaces this is the talk page, rather than the template page.<br />
local templateTitle = env.templateTitle<br />
local docSpace = env.docSpace<br />
local docSpaceText = mw.site.namespaces[docSpace].name<br />
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.<br />
return docSpaceText .. ':' .. templateTitle.text<br />
end<br />
<br />
function envFuncs.compareUrl()<br />
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
if templateTitle.exists and sandboxTitle.exists then<br />
local compareUrl = mw.uri.fullUrl(<br />
'Special:ComparePages',<br />
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}<br />
)<br />
return tostring(compareUrl)<br />
else<br />
return nil<br />
end<br />
end <br />
<br />
return env<br />
end <br />
<br />
----------------------------------------------------------------------------<br />
-- Auxiliary templates<br />
----------------------------------------------------------------------------<br />
<br />
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')<br />
<br />
function p._getModuleWikitext(args, env)<br />
local currentTitle = mw.title.getCurrentTitle()<br />
if currentTitle.contentModel ~= 'Scribunto' then return end<br />
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care<br />
local moduleWikitext = package.loaded["Module:Module wikitext"]<br />
if moduleWikitext then<br />
return moduleWikitext.main()<br />
end<br />
end<br />
<br />
function p.sandboxNotice(args, env)<br />
--[=[<br />
-- Generates a sandbox notice for display above sandbox pages.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'<br />
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'<br />
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'<br />
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'<br />
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'<br />
-- 'sandbox-notice-compare-link-display' --> 'diff'<br />
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'<br />
-- 'sandbox-notice-testcases-link-display' --> 'test cases'<br />
-- 'sandbox-category' --> 'Template sandboxes'<br />
--]=]<br />
local title = env.title<br />
local sandboxTitle = env.sandboxTitle<br />
local templateTitle = env.templateTitle<br />
local subjectSpace = env.subjectSpace<br />
if not (subjectSpace and title and sandboxTitle and templateTitle<br />
and mw.title.equals(title, sandboxTitle)) then<br />
return nil<br />
end<br />
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".<br />
local omargs = {}<br />
omargs.image = message('sandbox-notice-image')<br />
-- Get the text. We start with the opening blurb, which is something like<br />
-- "This is the template sandbox for [[Template:Foo]] (diff)."<br />
local text = ''<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('sandbox-notice-pagetype-template')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('sandbox-notice-pagetype-module')<br />
else<br />
pagetype = message('sandbox-notice-pagetype-other')<br />
end<br />
local templateLink = makeWikilink(templateTitle.prefixedText)<br />
local compareUrl = env.compareUrl<br />
if compareUrl then<br />
local compareDisplay = message('sandbox-notice-compare-link-display')<br />
local compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})<br />
else<br />
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})<br />
end<br />
-- Get the test cases page blurb if the page exists. This is something like<br />
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."<br />
local testcasesTitle = env.testcasesTitle<br />
if testcasesTitle and testcasesTitle.exists then<br />
if testcasesTitle.contentModel == "Scribunto" then<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})<br />
else<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})<br />
end<br />
end<br />
-- Add the sandbox to the sandbox category.<br />
omargs.text = text .. makeCategoryLink(message('sandbox-category'))<br />
<br />
-- 'documentation-clear'<br />
return '<div class="' .. message('clear') .. '"></div>'<br />
.. require('Module:Message box').main('ombox', omargs)<br />
end<br />
<br />
function p.protectionTemplate(env)<br />
-- Generates the padlock icon in the top right.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'protection-template' --> 'pp-template'<br />
-- 'protection-template-args' --> {docusage = 'yes'}<br />
local protectionLevels = env.protectionLevels<br />
if not protectionLevels then<br />
return nil<br />
end<br />
local editProt = protectionLevels.edit and protectionLevels.edit[1]<br />
local moveProt = protectionLevels.move and protectionLevels.move[1]<br />
if editProt then<br />
-- The page is edit-protected.<br />
return require('Module:Protection banner')._main{<br />
message('protection-reason-edit'), small = true<br />
}<br />
elseif moveProt and moveProt ~= 'autoconfirmed' then<br />
-- The page is move-protected but not edit-protected. Exclude move<br />
-- protection with the level "autoconfirmed", as this is equivalent to<br />
-- no move protection at all.<br />
return require('Module:Protection banner')._main{<br />
action = 'move', small = true<br />
}<br />
else<br />
return nil<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Start box<br />
----------------------------------------------------------------------------<br />
<br />
p.startBox = makeInvokeFunc('_startBox')<br />
<br />
function p._startBox(args, env)<br />
--[[<br />
-- This function generates the start box.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make<br />
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox<br />
-- which generate the box HTML.<br />
--]]<br />
env = env or p.getEnvironment(args)<br />
local links<br />
local content = args.content<br />
if not content or args[1] then<br />
-- No need to include the links if the documentation is on the template page itself.<br />
local linksData = p.makeStartBoxLinksData(args, env)<br />
if linksData then<br />
links = p.renderStartBoxLinks(linksData)<br />
end<br />
end<br />
-- Generate the start box html.<br />
local data = p.makeStartBoxData(args, env, links)<br />
if data then<br />
return p.renderStartBox(data)<br />
else<br />
-- User specified no heading.<br />
return nil<br />
end<br />
end<br />
<br />
function p.makeStartBoxLinksData(args, env)<br />
--[[<br />
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'view-link-display' --> 'view'<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'purge-link-display' --> 'purge'<br />
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'docpage-preload' --> 'Template:Documentation/preload'<br />
-- 'create-link-display' --> 'create'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local docTitle = env.docTitle<br />
if not title or not docTitle then<br />
return nil<br />
end<br />
if docTitle.isRedirect then <br />
docTitle = docTitle.redirectTarget<br />
end<br />
<br />
local data = {}<br />
data.title = title<br />
data.docTitle = docTitle<br />
-- View, display, edit, and purge links if /doc exists.<br />
data.viewLinkDisplay = message('view-link-display')<br />
data.editLinkDisplay = message('edit-link-display')<br />
data.historyLinkDisplay = message('history-link-display')<br />
data.purgeLinkDisplay = message('purge-link-display')<br />
-- Create link if /doc doesn't exist.<br />
local preload = args.preload<br />
if not preload then<br />
if subjectSpace == 6 then -- File namespace<br />
preload = message('file-docpage-preload')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
preload = message('module-preload')<br />
else<br />
preload = message('docpage-preload')<br />
end<br />
end<br />
data.preload = preload<br />
data.createLinkDisplay = message('create-link-display')<br />
return data<br />
end<br />
<br />
function p.renderStartBoxLinks(data)<br />
--[[<br />
-- Generates the [view][edit][history][purge] or [create] links from the data table.<br />
-- @data - a table of data generated by p.makeStartBoxLinksData<br />
--]]<br />
<br />
local function escapeBrackets(s)<br />
-- Escapes square brackets with HTML entities.<br />
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.<br />
s = s:gsub('%]', '&#93;')<br />
return s<br />
end<br />
<br />
local ret<br />
local docTitle = data.docTitle<br />
local title = data.title<br />
if docTitle.exists then<br />
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)<br />
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)<br />
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)<br />
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)<br />
ret = '[%s] [%s] [%s] [%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)<br />
else<br />
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)<br />
ret = '[%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, createLink)<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeStartBoxData(args, env, links)<br />
--[=[<br />
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.<br />
--<br />
-- Messages:<br />
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
-- 'template-namespace-heading' --> 'Template documentation'<br />
-- 'module-namespace-heading' --> 'Module documentation'<br />
-- 'file-namespace-heading' --> 'Summary'<br />
-- 'other-namespaces-heading' --> 'Documentation'<br />
-- 'testcases-create-link-display' --> 'create'<br />
--]=]<br />
local subjectSpace = env.subjectSpace<br />
if not subjectSpace then<br />
-- Default to an "other namespaces" namespace, so that we get at least some output<br />
-- if an error occurs.<br />
subjectSpace = 2<br />
end<br />
local data = {}<br />
<br />
-- Heading<br />
local heading = args.heading -- Blank values are not removed.<br />
if heading == '' then<br />
-- Don't display the start box if the heading arg is defined but blank.<br />
return nil<br />
end<br />
if heading then<br />
data.heading = heading<br />
elseif subjectSpace == 10 then -- Template namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')<br />
elseif subjectSpace == 6 then -- File namespace<br />
data.heading = message('file-namespace-heading')<br />
else<br />
data.heading = message('other-namespaces-heading')<br />
end<br />
<br />
-- Heading CSS<br />
local headingStyle = args['heading-style']<br />
if headingStyle then<br />
data.headingStyleText = headingStyle<br />
else<br />
-- 'documentation-heading'<br />
data.headingClass = message('main-div-heading-class')<br />
end<br />
<br />
-- Data for the [view][edit][history][purge] or [create] links.<br />
if links then<br />
-- 'mw-editsection-like plainlinks'<br />
data.linksClass = message('start-box-link-classes')<br />
data.links = links<br />
end<br />
<br />
return data<br />
end<br />
<br />
function p.renderStartBox(data)<br />
-- Renders the start box html.<br />
-- @data - a table of data generated by p.makeStartBoxData.<br />
local sbox = mw.html.create('div')<br />
sbox<br />
-- 'documentation-startbox'<br />
:addClass(message('start-box-class'))<br />
:newline()<br />
:tag('span')<br />
:addClass(data.headingClass)<br />
:cssText(data.headingStyleText)<br />
:wikitext(data.heading)<br />
local links = data.links<br />
if links then<br />
sbox:tag('span')<br />
:addClass(data.linksClass)<br />
:attr('id', data.linksId)<br />
:wikitext(links)<br />
end<br />
return tostring(sbox)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Documentation content<br />
----------------------------------------------------------------------------<br />
<br />
p.content = makeInvokeFunc('_content')<br />
<br />
function p._content(args, env)<br />
-- Displays the documentation contents<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
local content = args.content<br />
if not content and docTitle and docTitle.exists then<br />
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}<br />
end<br />
-- The line breaks below are necessary so that "=== Headings ===" at the start and end<br />
-- of docs are interpreted correctly.<br />
return '\n' .. (content or '') .. '\n' <br />
end<br />
<br />
p.contentTitle = makeInvokeFunc('_contentTitle')<br />
<br />
function p._contentTitle(args, env)<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
if not args.content and docTitle and docTitle.exists then<br />
return docTitle.prefixedText<br />
else<br />
return ''<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- End box<br />
----------------------------------------------------------------------------<br />
<br />
p.endBox = makeInvokeFunc('_endBox')<br />
<br />
function p._endBox(args, env)<br />
--[=[<br />
-- This function generates the end box (also known as the link box).<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
--]=]<br />
<br />
-- Get environment data.<br />
env = env or p.getEnvironment(args)<br />
local subjectSpace = env.subjectSpace<br />
local docTitle = env.docTitle<br />
if not subjectSpace or not docTitle then<br />
return nil<br />
end<br />
<br />
-- Check whether we should output the end box at all. Add the end<br />
-- box by default if the documentation exists or if we are in the<br />
-- user, module or template namespaces.<br />
local linkBox = args['link box']<br />
if linkBox == 'off'<br />
or not (<br />
docTitle.exists<br />
or subjectSpace == 2<br />
or subjectSpace == 828<br />
or subjectSpace == 10<br />
)<br />
then<br />
return nil<br />
end<br />
<br />
-- Assemble the link box.<br />
local text = ''<br />
if linkBox then<br />
text = text .. linkBox<br />
else<br />
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <br />
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then<br />
-- We are in the user, template or module namespaces.<br />
-- Add sandbox and testcases links.<br />
-- "Editors can experiment in this template's sandbox and testcases pages."<br />
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'<br />
if not args.content and not args[1] then<br />
-- "Please add categories to the /doc subpage."<br />
-- Don't show this message with inline docs or with an explicitly specified doc page,<br />
-- as then it is unclear where to add the categories.<br />
text = text .. (p.makeCategoriesBlurb(args, env) or '')<br />
end<br />
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"<br />
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.<br />
if printBlurb then<br />
text = text .. '<br />' .. printBlurb<br />
end<br />
end<br />
end<br />
<br />
local box = mw.html.create('div')<br />
-- 'documentation-metadata'<br />
box:attr('role', 'note')<br />
:addClass(message('end-box-class'))<br />
-- 'plainlinks'<br />
:addClass(message('end-box-plainlinks'))<br />
:wikitext(text)<br />
:done()<br />
<br />
return '\n' .. tostring(box)<br />
end<br />
<br />
function p.makeDocPageBlurb(args, env)<br />
--[=[<br />
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'transcluded-from-blurb' --> <br />
-- 'The above [[Wikipedia:Template documentation|documentation]] <br />
-- is [[Help:Transclusion|transcluded]] from $1.'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'create-link-display' --> 'create'<br />
-- 'create-module-doc-blurb' --><br />
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
--]=]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local ret<br />
if docTitle.exists then<br />
-- /doc exists; link to it.<br />
local docLink = makeWikilink(docTitle.prefixedText)<br />
local editUrl = docTitle:fullUrl{action = 'edit'}<br />
local editDisplay = message('edit-link-display')<br />
local editLink = makeUrlLink(editUrl, editDisplay)<br />
local historyUrl = docTitle:fullUrl{action = 'history'}<br />
local historyDisplay = message('history-link-display')<br />
local historyLink = makeUrlLink(historyUrl, historyDisplay)<br />
ret = message('transcluded-from-blurb', {docLink})<br />
.. ' '<br />
.. makeToolbar(editLink, historyLink)<br />
.. '<br />'<br />
elseif env.subjectSpace == 828 then<br />
-- /doc does not exist; ask to create it.<br />
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}<br />
local createDisplay = message('create-link-display')<br />
local createLink = makeUrlLink(createUrl, createDisplay)<br />
ret = message('create-module-doc-blurb', {createLink})<br />
.. '<br />'<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeExperimentBlurb(args, env)<br />
--[[<br />
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'sandbox-edit-link-display' --> 'edit'<br />
-- 'compare-link-display' --> 'diff'<br />
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'sandbox-create-link-display' --> 'create'<br />
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'<br />
-- 'mirror-link-display' --> 'mirror'<br />
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display'--> 'edit'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'testcases-create-link-display' --> 'create'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display' --> 'edit'<br />
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'<br />
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'<br />
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'<br />
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
local testcasesTitle = env.testcasesTitle<br />
local templatePage = templateTitle.prefixedText<br />
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then<br />
return nil<br />
end<br />
-- Make links.<br />
local sandboxLinks, testcasesLinks<br />
if sandboxTitle.exists then<br />
local sandboxPage = sandboxTitle.prefixedText<br />
local sandboxDisplay = message('sandbox-link-display')<br />
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)<br />
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}<br />
local sandboxEditDisplay = message('sandbox-edit-link-display')<br />
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)<br />
local compareUrl = env.compareUrl<br />
local compareLink<br />
if compareUrl then<br />
local compareDisplay = message('compare-link-display')<br />
compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
end<br />
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)<br />
else<br />
local sandboxPreload<br />
if subjectSpace == 828 then<br />
sandboxPreload = message('module-sandbox-preload')<br />
else<br />
sandboxPreload = message('template-sandbox-preload')<br />
end<br />
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}<br />
local sandboxCreateDisplay = message('sandbox-create-link-display')<br />
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)<br />
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})<br />
local mirrorPreload = message('mirror-link-preload')<br />
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}<br />
if subjectSpace == 828 then<br />
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}<br />
end<br />
local mirrorDisplay = message('mirror-link-display')<br />
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)<br />
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)<br />
end<br />
if testcasesTitle.exists then<br />
local testcasesPage = testcasesTitle.prefixedText<br />
local testcasesDisplay = message('testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)<br />
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}<br />
local testcasesEditDisplay = message('testcases-edit-link-display')<br />
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)<br />
-- for Modules, add testcases run link if exists<br />
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then<br />
local testcasesRunLinkDisplay = message('testcases-run-link-display')<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)<br />
else<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)<br />
end<br />
else<br />
local testcasesPreload<br />
if subjectSpace == 828 then<br />
testcasesPreload = message('module-testcases-preload')<br />
else<br />
testcasesPreload = message('template-testcases-preload')<br />
end<br />
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}<br />
local testcasesCreateDisplay = message('testcases-create-link-display')<br />
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)<br />
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)<br />
end<br />
local messageName<br />
if subjectSpace == 828 then<br />
messageName = 'experiment-blurb-module'<br />
else<br />
messageName = 'experiment-blurb-template'<br />
end<br />
return message(messageName, {sandboxLinks, testcasesLinks})<br />
end<br />
<br />
function p.makeCategoriesBlurb(args, env)<br />
--[[<br />
-- Generates the text "Please add categories to the /doc subpage."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'doc-link-display' --> '/doc'<br />
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'<br />
--]]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))<br />
return message('add-categories-blurb', {docPathLink})<br />
end<br />
<br />
function p.makeSubpagesBlurb(args, env)<br />
--[[<br />
-- Generates the "Subpages of this template" link.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'template-pagetype' --> 'template'<br />
-- 'module-pagetype' --> 'module'<br />
-- 'default-pagetype' --> 'page'<br />
-- 'subpages-link-display' --> 'Subpages of this $1'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
if not subjectSpace or not templateTitle then<br />
return nil<br />
end<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('template-pagetype')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('module-pagetype')<br />
else<br />
pagetype = message('default-pagetype')<br />
end<br />
local subpagesLink = makeWikilink(<br />
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',<br />
message('subpages-link-display', {pagetype})<br />
)<br />
return message('subpages-blurb', {subpagesLink})<br />
end<br />
<br />
function p.makePrintBlurb(args, env)<br />
--[=[<br />
-- Generates the blurb displayed when there is a print version of the template available.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
--<br />
-- Messages:<br />
-- 'print-link-display' --> '/Print'<br />
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'<br />
-- .. ' of this template exists at $1.'<br />
-- .. ' If you make a change to this template, please update the print version as well.'<br />
-- 'display-print-category' --> true<br />
-- 'print-category' --> 'Templates with print versions'<br />
--]=]<br />
local printTitle = env.printTitle<br />
if not printTitle then<br />
return nil<br />
end<br />
local ret<br />
if printTitle.exists then<br />
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))<br />
ret = message('print-blurb', {printLink})<br />
local displayPrintCategory = message('display-print-category', nil, 'boolean')<br />
if displayPrintCategory then<br />
ret = ret .. makeCategoryLink(message('print-category'))<br />
end<br />
end<br />
return ret<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Tracking categories<br />
----------------------------------------------------------------------------<br />
<br />
function p.addTrackingCategories(env)<br />
--[[<br />
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'display-strange-usage-category' --> true<br />
-- 'doc-subpage' --> 'doc'<br />
-- 'testcases-subpage' --> 'testcases'<br />
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'<br />
-- <br />
-- /testcases pages in the module namespace are not categorised, as they may have<br />
-- {{documentation}} transcluded automatically.<br />
--]]<br />
local title = env.title<br />
local subjectSpace = env.subjectSpace<br />
if not title or not subjectSpace then<br />
return nil<br />
end<br />
local subpage = title.subpageText<br />
local ret = ''<br />
if message('display-strange-usage-category', nil, 'boolean')<br />
and (<br />
subpage == message('doc-subpage')<br />
or subjectSpace ~= 828 and subpage == message('testcases-subpage')<br />
)<br />
then<br />
ret = ret .. makeCategoryLink(message('strange-usage-category'))<br />
end<br />
return ret<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation&diff=1940Module:Documentation2021-06-23T15:15:21Z<p>Jawitkien: </p>
<hr />
<div>-- This module implements {{documentation}}.<br />
<br />
-- Get required modules.<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
-- Get the config table.<br />
local cfg = mw.loadData('Module:Documentation/config')<br />
<br />
local p = {}<br />
<br />
-- Often-used functions.<br />
local ugsub = mw.ustring.gsub<br />
<br />
----------------------------------------------------------------------------<br />
-- Helper functions<br />
--<br />
-- These are defined as local functions, but are made available in the p<br />
-- table for testing purposes.<br />
----------------------------------------------------------------------------<br />
<br />
local function message(cfgKey, valArray, expectType)<br />
--[[<br />
-- Gets a message from the cfg table and formats it if appropriate.<br />
-- The function raises an error if the value from the cfg table is not<br />
-- of the type expectType. The default type for expectType is 'string'.<br />
-- If the table valArray is present, strings such as $1, $2 etc. in the<br />
-- message are substituted with values from the table keys [1], [2] etc.<br />
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',<br />
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."<br />
--]]<br />
local msg = cfg[cfgKey]<br />
expectType = expectType or 'string' <br />
if type(msg) ~= expectType then<br />
error('message: Module-Documentation type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)<br />
end<br />
if not valArray then<br />
return msg<br />
end<br />
<br />
local function getMessageVal(match)<br />
match = tonumber(match)<br />
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)<br />
end<br />
<br />
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)<br />
end<br />
<br />
p.message = message<br />
<br />
local function makeWikilink(page, display)<br />
if display then<br />
return mw.ustring.format('[[%s|%s]]', page, display)<br />
else<br />
return mw.ustring.format('[[%s]]', page)<br />
end<br />
end<br />
<br />
p.makeWikilink = makeWikilink<br />
<br />
local function makeCategoryLink(cat, sort)<br />
local catns = mw.site.namespaces[14].name<br />
return makeWikilink(catns .. ':' .. cat, sort)<br />
end<br />
<br />
p.makeCategoryLink = makeCategoryLink<br />
<br />
local function makeUrlLink(url, display)<br />
return mw.ustring.format('[%s %s]', url, display)<br />
end<br />
<br />
p.makeUrlLink = makeUrlLink<br />
<br />
local function makeToolbar(...)<br />
local ret = {}<br />
local lim = select('#', ...)<br />
if lim < 1 then<br />
return nil<br />
end<br />
for i = 1, lim do<br />
ret[#ret + 1] = select(i, ...)<br />
end<br />
-- 'documentation-toolbar'<br />
return '<span class="' .. message('toolbar-class') .. '">('<br />
.. table.concat(ret, ' &#124; ') .. ')</span>'<br />
end <br />
<br />
p.makeToolbar = makeToolbar<br />
<br />
----------------------------------------------------------------------------<br />
-- Argument processing<br />
----------------------------------------------------------------------------<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.<br />
if key == 'heading' or value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Entry points<br />
----------------------------------------------------------------------------<br />
<br />
function p.nonexistent(frame)<br />
if mw.title.getCurrentTitle().subpageText == 'testcases' then<br />
return frame:expandTemplate{title = 'module test cases notice'}<br />
else<br />
return p.main(frame)<br />
end<br />
end<br />
<br />
p.main = makeInvokeFunc('_main')<br />
<br />
function p._main(args)<br />
--[[<br />
-- This function defines logic flow for the module.<br />
-- @args - table of arguments passed by the user<br />
--]]<br />
local env = p.getEnvironment(args)<br />
local root = mw.html.create()<br />
root<br />
:wikitext(p._getModuleWikitext(args, env))<br />
:wikitext(p.protectionTemplate(env))<br />
:wikitext(p.sandboxNotice(args, env))<br />
:tag('div')<br />
-- 'documentation-container'<br />
:addClass(message('containerZ'))<br />
:newline()<br />
:tag('div')<br />
-- 'documentation'<br />
:addClass(message('main-div-classes'))<br />
:newline()<br />
:wikitext(p._startBox(args, env))<br />
:wikitext(p._content(args, env))<br />
:tag('div')<br />
-- 'documentation-clear'<br />
:addClass(message('clear'))<br />
:done()<br />
:newline()<br />
:done()<br />
:wikitext(p._endBox(args, env))<br />
:done()<br />
:wikitext(p.addTrackingCategories(env))<br />
-- 'Module:Documentation/styles.css'<br />
return mw.getCurrentFrame():extensionTag (<br />
'templatestyles', '', {src=cfg['templatestyles']<br />
}) .. tostring(root)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Environment settings<br />
----------------------------------------------------------------------------<br />
<br />
function p.getEnvironment(args)<br />
--[[<br />
-- Returns a table with information about the environment, including title<br />
-- objects and other namespace- or path-related data.<br />
-- @args - table of arguments passed by the user<br />
--<br />
-- Title objects include:<br />
-- env.title - the page we are making documentation for (usually the current title)<br />
-- env.templateTitle - the template (or module, file, etc.)<br />
-- env.docTitle - the /doc subpage.<br />
-- env.sandboxTitle - the /sandbox subpage.<br />
-- env.testcasesTitle - the /testcases subpage.<br />
-- env.printTitle - the print version of the template, located at the /Print subpage.<br />
--<br />
-- Data includes:<br />
-- env.protectionLevels - the protection levels table of the title object.<br />
-- env.subjectSpace - the number of the title's subject namespace.<br />
-- env.docSpace - the number of the namespace the title puts its documentation in.<br />
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.<br />
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.<br />
-- <br />
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value<br />
-- returned will be nil.<br />
--]]<br />
<br />
local env, envFuncs = {}, {}<br />
<br />
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value<br />
-- returned by that function is memoized in the env table so that we don't call any of the functions<br />
-- more than once. (Nils won't be memoized.)<br />
setmetatable(env, {<br />
__index = function (t, key)<br />
local envFunc = envFuncs[key]<br />
if envFunc then<br />
local success, val = pcall(envFunc)<br />
if success then<br />
env[key] = val -- Memoise the value.<br />
return val<br />
end<br />
end<br />
return nil<br />
end<br />
}) <br />
<br />
function envFuncs.title()<br />
-- The title object for the current page, or a test page passed with args.page.<br />
local title<br />
local titleArg = args.page<br />
if titleArg then<br />
title = mw.title.new(titleArg)<br />
else<br />
title = mw.title.getCurrentTitle()<br />
end<br />
return title<br />
end<br />
<br />
function envFuncs.templateTitle()<br />
--[[<br />
-- The template (or module, etc.) title object.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local subpage = title.subpageText<br />
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then<br />
return mw.title.makeTitle(subjectSpace, title.baseText)<br />
else<br />
return mw.title.makeTitle(subjectSpace, title.text)<br />
end<br />
end<br />
<br />
function envFuncs.docTitle()<br />
--[[<br />
-- Title object of the /doc subpage.<br />
-- Messages:<br />
-- 'doc-subpage' --> 'doc'<br />
--]]<br />
local title = env.title<br />
local docname = args[1] -- User-specified doc page.<br />
local docpage<br />
if docname then<br />
docpage = docname<br />
else<br />
docpage = env.docpageBase .. '/' .. message('doc-subpage')<br />
end<br />
return mw.title.new(docpage)<br />
end<br />
<br />
function envFuncs.sandboxTitle()<br />
--[[<br />
-- Title object for the /sandbox subpage.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))<br />
end<br />
<br />
function envFuncs.testcasesTitle()<br />
--[[<br />
-- Title object for the /testcases subpage.<br />
-- Messages:<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))<br />
end<br />
<br />
function envFuncs.printTitle()<br />
--[[<br />
-- Title object for the /Print subpage.<br />
-- Messages:<br />
-- 'print-subpage' --> 'Print'<br />
--]]<br />
return env.templateTitle:subPageTitle(message('print-subpage'))<br />
end<br />
<br />
function envFuncs.protectionLevels()<br />
-- The protection levels table of the title object.<br />
return env.title.protectionLevels<br />
end<br />
<br />
function envFuncs.subjectSpace()<br />
-- The subject namespace number.<br />
return mw.site.namespaces[env.title.namespace].subject.id<br />
end<br />
<br />
function envFuncs.docSpace()<br />
-- The documentation namespace number. For most namespaces this is the<br />
-- same as the subject namespace. However, pages in the Article, File,<br />
-- MediaWiki or Category namespaces must have their /doc, /sandbox and<br />
-- /testcases pages in talk space.<br />
local subjectSpace = env.subjectSpace<br />
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then<br />
return subjectSpace + 1<br />
else<br />
return subjectSpace<br />
end<br />
end<br />
<br />
function envFuncs.docpageBase()<br />
-- The base page of the /doc, /sandbox, and /testcases subpages.<br />
-- For some namespaces this is the talk page, rather than the template page.<br />
local templateTitle = env.templateTitle<br />
local docSpace = env.docSpace<br />
local docSpaceText = mw.site.namespaces[docSpace].name<br />
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.<br />
return docSpaceText .. ':' .. templateTitle.text<br />
end<br />
<br />
function envFuncs.compareUrl()<br />
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
if templateTitle.exists and sandboxTitle.exists then<br />
local compareUrl = mw.uri.fullUrl(<br />
'Special:ComparePages',<br />
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}<br />
)<br />
return tostring(compareUrl)<br />
else<br />
return nil<br />
end<br />
end <br />
<br />
return env<br />
end <br />
<br />
----------------------------------------------------------------------------<br />
-- Auxiliary templates<br />
----------------------------------------------------------------------------<br />
<br />
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')<br />
<br />
function p._getModuleWikitext(args, env)<br />
local currentTitle = mw.title.getCurrentTitle()<br />
if currentTitle.contentModel ~= 'Scribunto' then return end<br />
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care<br />
local moduleWikitext = package.loaded["Module:Module wikitext"]<br />
if moduleWikitext then<br />
return moduleWikitext.main()<br />
end<br />
end<br />
<br />
function p.sandboxNotice(args, env)<br />
--[=[<br />
-- Generates a sandbox notice for display above sandbox pages.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'<br />
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'<br />
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'<br />
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'<br />
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'<br />
-- 'sandbox-notice-compare-link-display' --> 'diff'<br />
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'<br />
-- 'sandbox-notice-testcases-link-display' --> 'test cases'<br />
-- 'sandbox-category' --> 'Template sandboxes'<br />
--]=]<br />
local title = env.title<br />
local sandboxTitle = env.sandboxTitle<br />
local templateTitle = env.templateTitle<br />
local subjectSpace = env.subjectSpace<br />
if not (subjectSpace and title and sandboxTitle and templateTitle<br />
and mw.title.equals(title, sandboxTitle)) then<br />
return nil<br />
end<br />
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".<br />
local omargs = {}<br />
omargs.image = message('sandbox-notice-image')<br />
-- Get the text. We start with the opening blurb, which is something like<br />
-- "This is the template sandbox for [[Template:Foo]] (diff)."<br />
local text = ''<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('sandbox-notice-pagetype-template')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('sandbox-notice-pagetype-module')<br />
else<br />
pagetype = message('sandbox-notice-pagetype-other')<br />
end<br />
local templateLink = makeWikilink(templateTitle.prefixedText)<br />
local compareUrl = env.compareUrl<br />
if compareUrl then<br />
local compareDisplay = message('sandbox-notice-compare-link-display')<br />
local compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})<br />
else<br />
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})<br />
end<br />
-- Get the test cases page blurb if the page exists. This is something like<br />
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."<br />
local testcasesTitle = env.testcasesTitle<br />
if testcasesTitle and testcasesTitle.exists then<br />
if testcasesTitle.contentModel == "Scribunto" then<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})<br />
else<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})<br />
end<br />
end<br />
-- Add the sandbox to the sandbox category.<br />
omargs.text = text .. makeCategoryLink(message('sandbox-category'))<br />
<br />
-- 'documentation-clear'<br />
return '<div class="' .. message('clear') .. '"></div>'<br />
.. require('Module:Message box').main('ombox', omargs)<br />
end<br />
<br />
function p.protectionTemplate(env)<br />
-- Generates the padlock icon in the top right.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'protection-template' --> 'pp-template'<br />
-- 'protection-template-args' --> {docusage = 'yes'}<br />
local protectionLevels = env.protectionLevels<br />
if not protectionLevels then<br />
return nil<br />
end<br />
local editProt = protectionLevels.edit and protectionLevels.edit[1]<br />
local moveProt = protectionLevels.move and protectionLevels.move[1]<br />
if editProt then<br />
-- The page is edit-protected.<br />
return require('Module:Protection banner')._main{<br />
message('protection-reason-edit'), small = true<br />
}<br />
elseif moveProt and moveProt ~= 'autoconfirmed' then<br />
-- The page is move-protected but not edit-protected. Exclude move<br />
-- protection with the level "autoconfirmed", as this is equivalent to<br />
-- no move protection at all.<br />
return require('Module:Protection banner')._main{<br />
action = 'move', small = true<br />
}<br />
else<br />
return nil<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Start box<br />
----------------------------------------------------------------------------<br />
<br />
p.startBox = makeInvokeFunc('_startBox')<br />
<br />
function p._startBox(args, env)<br />
--[[<br />
-- This function generates the start box.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make<br />
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox<br />
-- which generate the box HTML.<br />
--]]<br />
env = env or p.getEnvironment(args)<br />
local links<br />
local content = args.content<br />
if not content or args[1] then<br />
-- No need to include the links if the documentation is on the template page itself.<br />
local linksData = p.makeStartBoxLinksData(args, env)<br />
if linksData then<br />
links = p.renderStartBoxLinks(linksData)<br />
end<br />
end<br />
-- Generate the start box html.<br />
local data = p.makeStartBoxData(args, env, links)<br />
if data then<br />
return p.renderStartBox(data)<br />
else<br />
-- User specified no heading.<br />
return nil<br />
end<br />
end<br />
<br />
function p.makeStartBoxLinksData(args, env)<br />
--[[<br />
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'view-link-display' --> 'view'<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'purge-link-display' --> 'purge'<br />
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'docpage-preload' --> 'Template:Documentation/preload'<br />
-- 'create-link-display' --> 'create'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local docTitle = env.docTitle<br />
if not title or not docTitle then<br />
return nil<br />
end<br />
if docTitle.isRedirect then <br />
docTitle = docTitle.redirectTarget<br />
end<br />
<br />
local data = {}<br />
data.title = title<br />
data.docTitle = docTitle<br />
-- View, display, edit, and purge links if /doc exists.<br />
data.viewLinkDisplay = message('view-link-display')<br />
data.editLinkDisplay = message('edit-link-display')<br />
data.historyLinkDisplay = message('history-link-display')<br />
data.purgeLinkDisplay = message('purge-link-display')<br />
-- Create link if /doc doesn't exist.<br />
local preload = args.preload<br />
if not preload then<br />
if subjectSpace == 6 then -- File namespace<br />
preload = message('file-docpage-preload')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
preload = message('module-preload')<br />
else<br />
preload = message('docpage-preload')<br />
end<br />
end<br />
data.preload = preload<br />
data.createLinkDisplay = message('create-link-display')<br />
return data<br />
end<br />
<br />
function p.renderStartBoxLinks(data)<br />
--[[<br />
-- Generates the [view][edit][history][purge] or [create] links from the data table.<br />
-- @data - a table of data generated by p.makeStartBoxLinksData<br />
--]]<br />
<br />
local function escapeBrackets(s)<br />
-- Escapes square brackets with HTML entities.<br />
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.<br />
s = s:gsub('%]', '&#93;')<br />
return s<br />
end<br />
<br />
local ret<br />
local docTitle = data.docTitle<br />
local title = data.title<br />
if docTitle.exists then<br />
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)<br />
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)<br />
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)<br />
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)<br />
ret = '[%s] [%s] [%s] [%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)<br />
else<br />
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)<br />
ret = '[%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, createLink)<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeStartBoxData(args, env, links)<br />
--[=[<br />
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.<br />
--<br />
-- Messages:<br />
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
-- 'template-namespace-heading' --> 'Template documentation'<br />
-- 'module-namespace-heading' --> 'Module documentation'<br />
-- 'file-namespace-heading' --> 'Summary'<br />
-- 'other-namespaces-heading' --> 'Documentation'<br />
-- 'testcases-create-link-display' --> 'create'<br />
--]=]<br />
local subjectSpace = env.subjectSpace<br />
if not subjectSpace then<br />
-- Default to an "other namespaces" namespace, so that we get at least some output<br />
-- if an error occurs.<br />
subjectSpace = 2<br />
end<br />
local data = {}<br />
<br />
-- Heading<br />
local heading = args.heading -- Blank values are not removed.<br />
if heading == '' then<br />
-- Don't display the start box if the heading arg is defined but blank.<br />
return nil<br />
end<br />
if heading then<br />
data.heading = heading<br />
elseif subjectSpace == 10 then -- Template namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')<br />
elseif subjectSpace == 6 then -- File namespace<br />
data.heading = message('file-namespace-heading')<br />
else<br />
data.heading = message('other-namespaces-heading')<br />
end<br />
<br />
-- Heading CSS<br />
local headingStyle = args['heading-style']<br />
if headingStyle then<br />
data.headingStyleText = headingStyle<br />
else<br />
-- 'documentation-heading'<br />
data.headingClass = message('main-div-heading-class')<br />
end<br />
<br />
-- Data for the [view][edit][history][purge] or [create] links.<br />
if links then<br />
-- 'mw-editsection-like plainlinks'<br />
data.linksClass = message('start-box-link-classes')<br />
data.links = links<br />
end<br />
<br />
return data<br />
end<br />
<br />
function p.renderStartBox(data)<br />
-- Renders the start box html.<br />
-- @data - a table of data generated by p.makeStartBoxData.<br />
local sbox = mw.html.create('div')<br />
sbox<br />
-- 'documentation-startbox'<br />
:addClass(message('start-box-class'))<br />
:newline()<br />
:tag('span')<br />
:addClass(data.headingClass)<br />
:cssText(data.headingStyleText)<br />
:wikitext(data.heading)<br />
local links = data.links<br />
if links then<br />
sbox:tag('span')<br />
:addClass(data.linksClass)<br />
:attr('id', data.linksId)<br />
:wikitext(links)<br />
end<br />
return tostring(sbox)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Documentation content<br />
----------------------------------------------------------------------------<br />
<br />
p.content = makeInvokeFunc('_content')<br />
<br />
function p._content(args, env)<br />
-- Displays the documentation contents<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
local content = args.content<br />
if not content and docTitle and docTitle.exists then<br />
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}<br />
end<br />
-- The line breaks below are necessary so that "=== Headings ===" at the start and end<br />
-- of docs are interpreted correctly.<br />
return '\n' .. (content or '') .. '\n' <br />
end<br />
<br />
p.contentTitle = makeInvokeFunc('_contentTitle')<br />
<br />
function p._contentTitle(args, env)<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
if not args.content and docTitle and docTitle.exists then<br />
return docTitle.prefixedText<br />
else<br />
return ''<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- End box<br />
----------------------------------------------------------------------------<br />
<br />
p.endBox = makeInvokeFunc('_endBox')<br />
<br />
function p._endBox(args, env)<br />
--[=[<br />
-- This function generates the end box (also known as the link box).<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
--]=]<br />
<br />
-- Get environment data.<br />
env = env or p.getEnvironment(args)<br />
local subjectSpace = env.subjectSpace<br />
local docTitle = env.docTitle<br />
if not subjectSpace or not docTitle then<br />
return nil<br />
end<br />
<br />
-- Check whether we should output the end box at all. Add the end<br />
-- box by default if the documentation exists or if we are in the<br />
-- user, module or template namespaces.<br />
local linkBox = args['link box']<br />
if linkBox == 'off'<br />
or not (<br />
docTitle.exists<br />
or subjectSpace == 2<br />
or subjectSpace == 828<br />
or subjectSpace == 10<br />
)<br />
then<br />
return nil<br />
end<br />
<br />
-- Assemble the link box.<br />
local text = ''<br />
if linkBox then<br />
text = text .. linkBox<br />
else<br />
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <br />
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then<br />
-- We are in the user, template or module namespaces.<br />
-- Add sandbox and testcases links.<br />
-- "Editors can experiment in this template's sandbox and testcases pages."<br />
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'<br />
if not args.content and not args[1] then<br />
-- "Please add categories to the /doc subpage."<br />
-- Don't show this message with inline docs or with an explicitly specified doc page,<br />
-- as then it is unclear where to add the categories.<br />
text = text .. (p.makeCategoriesBlurb(args, env) or '')<br />
end<br />
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"<br />
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.<br />
if printBlurb then<br />
text = text .. '<br />' .. printBlurb<br />
end<br />
end<br />
end<br />
<br />
local box = mw.html.create('div')<br />
-- 'documentation-metadata'<br />
box:attr('role', 'note')<br />
:addClass(message('end-box-class'))<br />
-- 'plainlinks'<br />
:addClass(message('end-box-plainlinks'))<br />
:wikitext(text)<br />
:done()<br />
<br />
return '\n' .. tostring(box)<br />
end<br />
<br />
function p.makeDocPageBlurb(args, env)<br />
--[=[<br />
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'transcluded-from-blurb' --> <br />
-- 'The above [[Wikipedia:Template documentation|documentation]] <br />
-- is [[Help:Transclusion|transcluded]] from $1.'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'create-link-display' --> 'create'<br />
-- 'create-module-doc-blurb' --><br />
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
--]=]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local ret<br />
if docTitle.exists then<br />
-- /doc exists; link to it.<br />
local docLink = makeWikilink(docTitle.prefixedText)<br />
local editUrl = docTitle:fullUrl{action = 'edit'}<br />
local editDisplay = message('edit-link-display')<br />
local editLink = makeUrlLink(editUrl, editDisplay)<br />
local historyUrl = docTitle:fullUrl{action = 'history'}<br />
local historyDisplay = message('history-link-display')<br />
local historyLink = makeUrlLink(historyUrl, historyDisplay)<br />
ret = message('transcluded-from-blurb', {docLink})<br />
.. ' '<br />
.. makeToolbar(editLink, historyLink)<br />
.. '<br />'<br />
elseif env.subjectSpace == 828 then<br />
-- /doc does not exist; ask to create it.<br />
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}<br />
local createDisplay = message('create-link-display')<br />
local createLink = makeUrlLink(createUrl, createDisplay)<br />
ret = message('create-module-doc-blurb', {createLink})<br />
.. '<br />'<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeExperimentBlurb(args, env)<br />
--[[<br />
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'sandbox-edit-link-display' --> 'edit'<br />
-- 'compare-link-display' --> 'diff'<br />
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'sandbox-create-link-display' --> 'create'<br />
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'<br />
-- 'mirror-link-display' --> 'mirror'<br />
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display'--> 'edit'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'testcases-create-link-display' --> 'create'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display' --> 'edit'<br />
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'<br />
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'<br />
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'<br />
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
local testcasesTitle = env.testcasesTitle<br />
local templatePage = templateTitle.prefixedText<br />
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then<br />
return nil<br />
end<br />
-- Make links.<br />
local sandboxLinks, testcasesLinks<br />
if sandboxTitle.exists then<br />
local sandboxPage = sandboxTitle.prefixedText<br />
local sandboxDisplay = message('sandbox-link-display')<br />
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)<br />
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}<br />
local sandboxEditDisplay = message('sandbox-edit-link-display')<br />
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)<br />
local compareUrl = env.compareUrl<br />
local compareLink<br />
if compareUrl then<br />
local compareDisplay = message('compare-link-display')<br />
compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
end<br />
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)<br />
else<br />
local sandboxPreload<br />
if subjectSpace == 828 then<br />
sandboxPreload = message('module-sandbox-preload')<br />
else<br />
sandboxPreload = message('template-sandbox-preload')<br />
end<br />
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}<br />
local sandboxCreateDisplay = message('sandbox-create-link-display')<br />
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)<br />
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})<br />
local mirrorPreload = message('mirror-link-preload')<br />
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}<br />
if subjectSpace == 828 then<br />
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}<br />
end<br />
local mirrorDisplay = message('mirror-link-display')<br />
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)<br />
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)<br />
end<br />
if testcasesTitle.exists then<br />
local testcasesPage = testcasesTitle.prefixedText<br />
local testcasesDisplay = message('testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)<br />
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}<br />
local testcasesEditDisplay = message('testcases-edit-link-display')<br />
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)<br />
-- for Modules, add testcases run link if exists<br />
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then<br />
local testcasesRunLinkDisplay = message('testcases-run-link-display')<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)<br />
else<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)<br />
end<br />
else<br />
local testcasesPreload<br />
if subjectSpace == 828 then<br />
testcasesPreload = message('module-testcases-preload')<br />
else<br />
testcasesPreload = message('template-testcases-preload')<br />
end<br />
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}<br />
local testcasesCreateDisplay = message('testcases-create-link-display')<br />
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)<br />
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)<br />
end<br />
local messageName<br />
if subjectSpace == 828 then<br />
messageName = 'experiment-blurb-module'<br />
else<br />
messageName = 'experiment-blurb-template'<br />
end<br />
return message(messageName, {sandboxLinks, testcasesLinks})<br />
end<br />
<br />
function p.makeCategoriesBlurb(args, env)<br />
--[[<br />
-- Generates the text "Please add categories to the /doc subpage."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'doc-link-display' --> '/doc'<br />
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'<br />
--]]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))<br />
return message('add-categories-blurb', {docPathLink})<br />
end<br />
<br />
function p.makeSubpagesBlurb(args, env)<br />
--[[<br />
-- Generates the "Subpages of this template" link.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'template-pagetype' --> 'template'<br />
-- 'module-pagetype' --> 'module'<br />
-- 'default-pagetype' --> 'page'<br />
-- 'subpages-link-display' --> 'Subpages of this $1'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
if not subjectSpace or not templateTitle then<br />
return nil<br />
end<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('template-pagetype')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('module-pagetype')<br />
else<br />
pagetype = message('default-pagetype')<br />
end<br />
local subpagesLink = makeWikilink(<br />
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',<br />
message('subpages-link-display', {pagetype})<br />
)<br />
return message('subpages-blurb', {subpagesLink})<br />
end<br />
<br />
function p.makePrintBlurb(args, env)<br />
--[=[<br />
-- Generates the blurb displayed when there is a print version of the template available.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
--<br />
-- Messages:<br />
-- 'print-link-display' --> '/Print'<br />
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'<br />
-- .. ' of this template exists at $1.'<br />
-- .. ' If you make a change to this template, please update the print version as well.'<br />
-- 'display-print-category' --> true<br />
-- 'print-category' --> 'Templates with print versions'<br />
--]=]<br />
local printTitle = env.printTitle<br />
if not printTitle then<br />
return nil<br />
end<br />
local ret<br />
if printTitle.exists then<br />
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))<br />
ret = message('print-blurb', {printLink})<br />
local displayPrintCategory = message('display-print-category', nil, 'boolean')<br />
if displayPrintCategory then<br />
ret = ret .. makeCategoryLink(message('print-category'))<br />
end<br />
end<br />
return ret<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Tracking categories<br />
----------------------------------------------------------------------------<br />
<br />
function p.addTrackingCategories(env)<br />
--[[<br />
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'display-strange-usage-category' --> true<br />
-- 'doc-subpage' --> 'doc'<br />
-- 'testcases-subpage' --> 'testcases'<br />
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'<br />
-- <br />
-- /testcases pages in the module namespace are not categorised, as they may have<br />
-- {{documentation}} transcluded automatically.<br />
--]]<br />
local title = env.title<br />
local subjectSpace = env.subjectSpace<br />
if not title or not subjectSpace then<br />
return nil<br />
end<br />
local subpage = title.subpageText<br />
local ret = ''<br />
if message('display-strange-usage-category', nil, 'boolean')<br />
and (<br />
subpage == message('doc-subpage')<br />
or subjectSpace ~= 828 and subpage == message('testcases-subpage')<br />
)<br />
then<br />
ret = ret .. makeCategoryLink(message('strange-usage-category'))<br />
end<br />
return ret<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation&diff=1939Module:Documentation2021-06-23T15:13:48Z<p>Jawitkien: </p>
<hr />
<div>-- This module implements {{documentation}}.<br />
<br />
-- Get required modules.<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
-- Get the config table.<br />
local cfg = mw.loadData('Module:Documentation/config')<br />
<br />
local p = {}<br />
<br />
-- Often-used functions.<br />
local ugsub = mw.ustring.gsub<br />
<br />
----------------------------------------------------------------------------<br />
-- Helper functions<br />
--<br />
-- These are defined as local functions, but are made available in the p<br />
-- table for testing purposes.<br />
----------------------------------------------------------------------------<br />
<br />
local function message(cfgKey, valArray, expectType)<br />
--[[<br />
-- Gets a message from the cfg table and formats it if appropriate.<br />
-- The function raises an error if the value from the cfg table is not<br />
-- of the type expectType. The default type for expectType is 'string'.<br />
-- If the table valArray is present, strings such as $1, $2 etc. in the<br />
-- message are substituted with values from the table keys [1], [2] etc.<br />
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',<br />
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."<br />
--]]<br />
local msg = cfg[cfgKey]<br />
expectType = expectType or 'string' <br />
if type(msg) ~= expectType then<br />
error('message: Module-Documentation type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)<br />
end<br />
if not valArray then<br />
return msg<br />
end<br />
<br />
local function getMessageVal(match)<br />
match = tonumber(match)<br />
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)<br />
end<br />
<br />
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)<br />
end<br />
<br />
p.message = message<br />
<br />
local function makeWikilink(page, display)<br />
if display then<br />
return mw.ustring.format('[[%s|%s]]', page, display)<br />
else<br />
return mw.ustring.format('[[%s]]', page)<br />
end<br />
end<br />
<br />
p.makeWikilink = makeWikilink<br />
<br />
local function makeCategoryLink(cat, sort)<br />
local catns = mw.site.namespaces[14].name<br />
return makeWikilink(catns .. ':' .. cat, sort)<br />
end<br />
<br />
p.makeCategoryLink = makeCategoryLink<br />
<br />
local function makeUrlLink(url, display)<br />
return mw.ustring.format('[%s %s]', url, display)<br />
end<br />
<br />
p.makeUrlLink = makeUrlLink<br />
<br />
local function makeToolbar(...)<br />
local ret = {}<br />
local lim = select('#', ...)<br />
if lim < 1 then<br />
return nil<br />
end<br />
for i = 1, lim do<br />
ret[#ret + 1] = select(i, ...)<br />
end<br />
-- 'documentation-toolbar'<br />
return '<span class="' .. message('toolbar-class') .. '">('<br />
.. table.concat(ret, ' &#124; ') .. ')</span>'<br />
end <br />
<br />
p.makeToolbar = makeToolbar<br />
<br />
----------------------------------------------------------------------------<br />
-- Argument processing<br />
----------------------------------------------------------------------------<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.<br />
if key == 'heading' or value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Entry points<br />
----------------------------------------------------------------------------<br />
<br />
function p.nonexistent(frame)<br />
if mw.title.getCurrentTitle().subpageText == 'testcases' then<br />
return frame:expandTemplate{title = 'module test cases notice'}<br />
else<br />
return p.main(frame)<br />
end<br />
end<br />
<br />
p.main = makeInvokeFunc('_main')<br />
<br />
function p._main(args)<br />
--[[<br />
-- This function defines logic flow for the module.<br />
-- @args - table of arguments passed by the user<br />
--]]<br />
local env = p.getEnvironment(args)<br />
local root = mw.html.create()<br />
root<br />
:wikitext(p._getModuleWikitext(args, env))<br />
:wikitext(p.protectionTemplate(env))<br />
:wikitext(p.sandboxNotice(args, env))<br />
:tag('div')<br />
-- 'documentation-container'<br />
:addClass(message('container'))<br />
:newline()<br />
:tag('div')<br />
-- 'documentation'<br />
:addClass(message('main-div-classes'))<br />
:newline()<br />
:wikitext(p._startBox(args, env))<br />
:wikitext(p._content(args, env))<br />
:tag('div')<br />
-- 'documentation-clear'<br />
:addClass(message('clear'))<br />
:done()<br />
:newline()<br />
:done()<br />
:wikitext(p._endBox(args, env))<br />
:done()<br />
:wikitext(p.addTrackingCategories(env))<br />
-- 'Module:Documentation/styles.css'<br />
return mw.getCurrentFrame():extensionTag (<br />
'templatestyles', '', {src=cfg['templatestyles']<br />
}) .. tostring(root)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Environment settings<br />
----------------------------------------------------------------------------<br />
<br />
function p.getEnvironment(args)<br />
--[[<br />
-- Returns a table with information about the environment, including title<br />
-- objects and other namespace- or path-related data.<br />
-- @args - table of arguments passed by the user<br />
--<br />
-- Title objects include:<br />
-- env.title - the page we are making documentation for (usually the current title)<br />
-- env.templateTitle - the template (or module, file, etc.)<br />
-- env.docTitle - the /doc subpage.<br />
-- env.sandboxTitle - the /sandbox subpage.<br />
-- env.testcasesTitle - the /testcases subpage.<br />
-- env.printTitle - the print version of the template, located at the /Print subpage.<br />
--<br />
-- Data includes:<br />
-- env.protectionLevels - the protection levels table of the title object.<br />
-- env.subjectSpace - the number of the title's subject namespace.<br />
-- env.docSpace - the number of the namespace the title puts its documentation in.<br />
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.<br />
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.<br />
-- <br />
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value<br />
-- returned will be nil.<br />
--]]<br />
<br />
local env, envFuncs = {}, {}<br />
<br />
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value<br />
-- returned by that function is memoized in the env table so that we don't call any of the functions<br />
-- more than once. (Nils won't be memoized.)<br />
setmetatable(env, {<br />
__index = function (t, key)<br />
local envFunc = envFuncs[key]<br />
if envFunc then<br />
local success, val = pcall(envFunc)<br />
if success then<br />
env[key] = val -- Memoise the value.<br />
return val<br />
end<br />
end<br />
return nil<br />
end<br />
}) <br />
<br />
function envFuncs.title()<br />
-- The title object for the current page, or a test page passed with args.page.<br />
local title<br />
local titleArg = args.page<br />
if titleArg then<br />
title = mw.title.new(titleArg)<br />
else<br />
title = mw.title.getCurrentTitle()<br />
end<br />
return title<br />
end<br />
<br />
function envFuncs.templateTitle()<br />
--[[<br />
-- The template (or module, etc.) title object.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local subpage = title.subpageText<br />
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then<br />
return mw.title.makeTitle(subjectSpace, title.baseText)<br />
else<br />
return mw.title.makeTitle(subjectSpace, title.text)<br />
end<br />
end<br />
<br />
function envFuncs.docTitle()<br />
--[[<br />
-- Title object of the /doc subpage.<br />
-- Messages:<br />
-- 'doc-subpage' --> 'doc'<br />
--]]<br />
local title = env.title<br />
local docname = args[1] -- User-specified doc page.<br />
local docpage<br />
if docname then<br />
docpage = docname<br />
else<br />
docpage = env.docpageBase .. '/' .. message('doc-subpage')<br />
end<br />
return mw.title.new(docpage)<br />
end<br />
<br />
function envFuncs.sandboxTitle()<br />
--[[<br />
-- Title object for the /sandbox subpage.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))<br />
end<br />
<br />
function envFuncs.testcasesTitle()<br />
--[[<br />
-- Title object for the /testcases subpage.<br />
-- Messages:<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))<br />
end<br />
<br />
function envFuncs.printTitle()<br />
--[[<br />
-- Title object for the /Print subpage.<br />
-- Messages:<br />
-- 'print-subpage' --> 'Print'<br />
--]]<br />
return env.templateTitle:subPageTitle(message('print-subpage'))<br />
end<br />
<br />
function envFuncs.protectionLevels()<br />
-- The protection levels table of the title object.<br />
return env.title.protectionLevels<br />
end<br />
<br />
function envFuncs.subjectSpace()<br />
-- The subject namespace number.<br />
return mw.site.namespaces[env.title.namespace].subject.id<br />
end<br />
<br />
function envFuncs.docSpace()<br />
-- The documentation namespace number. For most namespaces this is the<br />
-- same as the subject namespace. However, pages in the Article, File,<br />
-- MediaWiki or Category namespaces must have their /doc, /sandbox and<br />
-- /testcases pages in talk space.<br />
local subjectSpace = env.subjectSpace<br />
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then<br />
return subjectSpace + 1<br />
else<br />
return subjectSpace<br />
end<br />
end<br />
<br />
function envFuncs.docpageBase()<br />
-- The base page of the /doc, /sandbox, and /testcases subpages.<br />
-- For some namespaces this is the talk page, rather than the template page.<br />
local templateTitle = env.templateTitle<br />
local docSpace = env.docSpace<br />
local docSpaceText = mw.site.namespaces[docSpace].name<br />
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.<br />
return docSpaceText .. ':' .. templateTitle.text<br />
end<br />
<br />
function envFuncs.compareUrl()<br />
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
if templateTitle.exists and sandboxTitle.exists then<br />
local compareUrl = mw.uri.fullUrl(<br />
'Special:ComparePages',<br />
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}<br />
)<br />
return tostring(compareUrl)<br />
else<br />
return nil<br />
end<br />
end <br />
<br />
return env<br />
end <br />
<br />
----------------------------------------------------------------------------<br />
-- Auxiliary templates<br />
----------------------------------------------------------------------------<br />
<br />
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')<br />
<br />
function p._getModuleWikitext(args, env)<br />
local currentTitle = mw.title.getCurrentTitle()<br />
if currentTitle.contentModel ~= 'Scribunto' then return end<br />
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care<br />
local moduleWikitext = package.loaded["Module:Module wikitext"]<br />
if moduleWikitext then<br />
return moduleWikitext.main()<br />
end<br />
end<br />
<br />
function p.sandboxNotice(args, env)<br />
--[=[<br />
-- Generates a sandbox notice for display above sandbox pages.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'<br />
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'<br />
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'<br />
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'<br />
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'<br />
-- 'sandbox-notice-compare-link-display' --> 'diff'<br />
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'<br />
-- 'sandbox-notice-testcases-link-display' --> 'test cases'<br />
-- 'sandbox-category' --> 'Template sandboxes'<br />
--]=]<br />
local title = env.title<br />
local sandboxTitle = env.sandboxTitle<br />
local templateTitle = env.templateTitle<br />
local subjectSpace = env.subjectSpace<br />
if not (subjectSpace and title and sandboxTitle and templateTitle<br />
and mw.title.equals(title, sandboxTitle)) then<br />
return nil<br />
end<br />
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".<br />
local omargs = {}<br />
omargs.image = message('sandbox-notice-image')<br />
-- Get the text. We start with the opening blurb, which is something like<br />
-- "This is the template sandbox for [[Template:Foo]] (diff)."<br />
local text = ''<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('sandbox-notice-pagetype-template')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('sandbox-notice-pagetype-module')<br />
else<br />
pagetype = message('sandbox-notice-pagetype-other')<br />
end<br />
local templateLink = makeWikilink(templateTitle.prefixedText)<br />
local compareUrl = env.compareUrl<br />
if compareUrl then<br />
local compareDisplay = message('sandbox-notice-compare-link-display')<br />
local compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})<br />
else<br />
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})<br />
end<br />
-- Get the test cases page blurb if the page exists. This is something like<br />
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."<br />
local testcasesTitle = env.testcasesTitle<br />
if testcasesTitle and testcasesTitle.exists then<br />
if testcasesTitle.contentModel == "Scribunto" then<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})<br />
else<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})<br />
end<br />
end<br />
-- Add the sandbox to the sandbox category.<br />
omargs.text = text .. makeCategoryLink(message('sandbox-category'))<br />
<br />
-- 'documentation-clear'<br />
return '<div class="' .. message('clear') .. '"></div>'<br />
.. require('Module:Message box').main('ombox', omargs)<br />
end<br />
<br />
function p.protectionTemplate(env)<br />
-- Generates the padlock icon in the top right.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'protection-template' --> 'pp-template'<br />
-- 'protection-template-args' --> {docusage = 'yes'}<br />
local protectionLevels = env.protectionLevels<br />
if not protectionLevels then<br />
return nil<br />
end<br />
local editProt = protectionLevels.edit and protectionLevels.edit[1]<br />
local moveProt = protectionLevels.move and protectionLevels.move[1]<br />
if editProt then<br />
-- The page is edit-protected.<br />
return require('Module:Protection banner')._main{<br />
message('protection-reason-edit'), small = true<br />
}<br />
elseif moveProt and moveProt ~= 'autoconfirmed' then<br />
-- The page is move-protected but not edit-protected. Exclude move<br />
-- protection with the level "autoconfirmed", as this is equivalent to<br />
-- no move protection at all.<br />
return require('Module:Protection banner')._main{<br />
action = 'move', small = true<br />
}<br />
else<br />
return nil<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Start box<br />
----------------------------------------------------------------------------<br />
<br />
p.startBox = makeInvokeFunc('_startBox')<br />
<br />
function p._startBox(args, env)<br />
--[[<br />
-- This function generates the start box.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make<br />
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox<br />
-- which generate the box HTML.<br />
--]]<br />
env = env or p.getEnvironment(args)<br />
local links<br />
local content = args.content<br />
if not content or args[1] then<br />
-- No need to include the links if the documentation is on the template page itself.<br />
local linksData = p.makeStartBoxLinksData(args, env)<br />
if linksData then<br />
links = p.renderStartBoxLinks(linksData)<br />
end<br />
end<br />
-- Generate the start box html.<br />
local data = p.makeStartBoxData(args, env, links)<br />
if data then<br />
return p.renderStartBox(data)<br />
else<br />
-- User specified no heading.<br />
return nil<br />
end<br />
end<br />
<br />
function p.makeStartBoxLinksData(args, env)<br />
--[[<br />
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'view-link-display' --> 'view'<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'purge-link-display' --> 'purge'<br />
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'docpage-preload' --> 'Template:Documentation/preload'<br />
-- 'create-link-display' --> 'create'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local docTitle = env.docTitle<br />
if not title or not docTitle then<br />
return nil<br />
end<br />
if docTitle.isRedirect then <br />
docTitle = docTitle.redirectTarget<br />
end<br />
<br />
local data = {}<br />
data.title = title<br />
data.docTitle = docTitle<br />
-- View, display, edit, and purge links if /doc exists.<br />
data.viewLinkDisplay = message('view-link-display')<br />
data.editLinkDisplay = message('edit-link-display')<br />
data.historyLinkDisplay = message('history-link-display')<br />
data.purgeLinkDisplay = message('purge-link-display')<br />
-- Create link if /doc doesn't exist.<br />
local preload = args.preload<br />
if not preload then<br />
if subjectSpace == 6 then -- File namespace<br />
preload = message('file-docpage-preload')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
preload = message('module-preload')<br />
else<br />
preload = message('docpage-preload')<br />
end<br />
end<br />
data.preload = preload<br />
data.createLinkDisplay = message('create-link-display')<br />
return data<br />
end<br />
<br />
function p.renderStartBoxLinks(data)<br />
--[[<br />
-- Generates the [view][edit][history][purge] or [create] links from the data table.<br />
-- @data - a table of data generated by p.makeStartBoxLinksData<br />
--]]<br />
<br />
local function escapeBrackets(s)<br />
-- Escapes square brackets with HTML entities.<br />
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.<br />
s = s:gsub('%]', '&#93;')<br />
return s<br />
end<br />
<br />
local ret<br />
local docTitle = data.docTitle<br />
local title = data.title<br />
if docTitle.exists then<br />
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)<br />
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)<br />
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)<br />
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)<br />
ret = '[%s] [%s] [%s] [%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)<br />
else<br />
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)<br />
ret = '[%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, createLink)<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeStartBoxData(args, env, links)<br />
--[=[<br />
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.<br />
--<br />
-- Messages:<br />
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
-- 'template-namespace-heading' --> 'Template documentation'<br />
-- 'module-namespace-heading' --> 'Module documentation'<br />
-- 'file-namespace-heading' --> 'Summary'<br />
-- 'other-namespaces-heading' --> 'Documentation'<br />
-- 'testcases-create-link-display' --> 'create'<br />
--]=]<br />
local subjectSpace = env.subjectSpace<br />
if not subjectSpace then<br />
-- Default to an "other namespaces" namespace, so that we get at least some output<br />
-- if an error occurs.<br />
subjectSpace = 2<br />
end<br />
local data = {}<br />
<br />
-- Heading<br />
local heading = args.heading -- Blank values are not removed.<br />
if heading == '' then<br />
-- Don't display the start box if the heading arg is defined but blank.<br />
return nil<br />
end<br />
if heading then<br />
data.heading = heading<br />
elseif subjectSpace == 10 then -- Template namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')<br />
elseif subjectSpace == 6 then -- File namespace<br />
data.heading = message('file-namespace-heading')<br />
else<br />
data.heading = message('other-namespaces-heading')<br />
end<br />
<br />
-- Heading CSS<br />
local headingStyle = args['heading-style']<br />
if headingStyle then<br />
data.headingStyleText = headingStyle<br />
else<br />
-- 'documentation-heading'<br />
data.headingClass = message('main-div-heading-class')<br />
end<br />
<br />
-- Data for the [view][edit][history][purge] or [create] links.<br />
if links then<br />
-- 'mw-editsection-like plainlinks'<br />
data.linksClass = message('start-box-link-classes')<br />
data.links = links<br />
end<br />
<br />
return data<br />
end<br />
<br />
function p.renderStartBox(data)<br />
-- Renders the start box html.<br />
-- @data - a table of data generated by p.makeStartBoxData.<br />
local sbox = mw.html.create('div')<br />
sbox<br />
-- 'documentation-startbox'<br />
:addClass(message('start-box-class'))<br />
:newline()<br />
:tag('span')<br />
:addClass(data.headingClass)<br />
:cssText(data.headingStyleText)<br />
:wikitext(data.heading)<br />
local links = data.links<br />
if links then<br />
sbox:tag('span')<br />
:addClass(data.linksClass)<br />
:attr('id', data.linksId)<br />
:wikitext(links)<br />
end<br />
return tostring(sbox)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Documentation content<br />
----------------------------------------------------------------------------<br />
<br />
p.content = makeInvokeFunc('_content')<br />
<br />
function p._content(args, env)<br />
-- Displays the documentation contents<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
local content = args.content<br />
if not content and docTitle and docTitle.exists then<br />
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}<br />
end<br />
-- The line breaks below are necessary so that "=== Headings ===" at the start and end<br />
-- of docs are interpreted correctly.<br />
return '\n' .. (content or '') .. '\n' <br />
end<br />
<br />
p.contentTitle = makeInvokeFunc('_contentTitle')<br />
<br />
function p._contentTitle(args, env)<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
if not args.content and docTitle and docTitle.exists then<br />
return docTitle.prefixedText<br />
else<br />
return ''<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- End box<br />
----------------------------------------------------------------------------<br />
<br />
p.endBox = makeInvokeFunc('_endBox')<br />
<br />
function p._endBox(args, env)<br />
--[=[<br />
-- This function generates the end box (also known as the link box).<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
--]=]<br />
<br />
-- Get environment data.<br />
env = env or p.getEnvironment(args)<br />
local subjectSpace = env.subjectSpace<br />
local docTitle = env.docTitle<br />
if not subjectSpace or not docTitle then<br />
return nil<br />
end<br />
<br />
-- Check whether we should output the end box at all. Add the end<br />
-- box by default if the documentation exists or if we are in the<br />
-- user, module or template namespaces.<br />
local linkBox = args['link box']<br />
if linkBox == 'off'<br />
or not (<br />
docTitle.exists<br />
or subjectSpace == 2<br />
or subjectSpace == 828<br />
or subjectSpace == 10<br />
)<br />
then<br />
return nil<br />
end<br />
<br />
-- Assemble the link box.<br />
local text = ''<br />
if linkBox then<br />
text = text .. linkBox<br />
else<br />
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <br />
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then<br />
-- We are in the user, template or module namespaces.<br />
-- Add sandbox and testcases links.<br />
-- "Editors can experiment in this template's sandbox and testcases pages."<br />
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'<br />
if not args.content and not args[1] then<br />
-- "Please add categories to the /doc subpage."<br />
-- Don't show this message with inline docs or with an explicitly specified doc page,<br />
-- as then it is unclear where to add the categories.<br />
text = text .. (p.makeCategoriesBlurb(args, env) or '')<br />
end<br />
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"<br />
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.<br />
if printBlurb then<br />
text = text .. '<br />' .. printBlurb<br />
end<br />
end<br />
end<br />
<br />
local box = mw.html.create('div')<br />
-- 'documentation-metadata'<br />
box:attr('role', 'note')<br />
:addClass(message('end-box-class'))<br />
-- 'plainlinks'<br />
:addClass(message('end-box-plainlinks'))<br />
:wikitext(text)<br />
:done()<br />
<br />
return '\n' .. tostring(box)<br />
end<br />
<br />
function p.makeDocPageBlurb(args, env)<br />
--[=[<br />
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'transcluded-from-blurb' --> <br />
-- 'The above [[Wikipedia:Template documentation|documentation]] <br />
-- is [[Help:Transclusion|transcluded]] from $1.'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'create-link-display' --> 'create'<br />
-- 'create-module-doc-blurb' --><br />
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
--]=]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local ret<br />
if docTitle.exists then<br />
-- /doc exists; link to it.<br />
local docLink = makeWikilink(docTitle.prefixedText)<br />
local editUrl = docTitle:fullUrl{action = 'edit'}<br />
local editDisplay = message('edit-link-display')<br />
local editLink = makeUrlLink(editUrl, editDisplay)<br />
local historyUrl = docTitle:fullUrl{action = 'history'}<br />
local historyDisplay = message('history-link-display')<br />
local historyLink = makeUrlLink(historyUrl, historyDisplay)<br />
ret = message('transcluded-from-blurb', {docLink})<br />
.. ' '<br />
.. makeToolbar(editLink, historyLink)<br />
.. '<br />'<br />
elseif env.subjectSpace == 828 then<br />
-- /doc does not exist; ask to create it.<br />
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}<br />
local createDisplay = message('create-link-display')<br />
local createLink = makeUrlLink(createUrl, createDisplay)<br />
ret = message('create-module-doc-blurb', {createLink})<br />
.. '<br />'<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeExperimentBlurb(args, env)<br />
--[[<br />
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'sandbox-edit-link-display' --> 'edit'<br />
-- 'compare-link-display' --> 'diff'<br />
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'sandbox-create-link-display' --> 'create'<br />
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'<br />
-- 'mirror-link-display' --> 'mirror'<br />
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display'--> 'edit'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'testcases-create-link-display' --> 'create'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display' --> 'edit'<br />
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'<br />
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'<br />
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'<br />
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
local testcasesTitle = env.testcasesTitle<br />
local templatePage = templateTitle.prefixedText<br />
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then<br />
return nil<br />
end<br />
-- Make links.<br />
local sandboxLinks, testcasesLinks<br />
if sandboxTitle.exists then<br />
local sandboxPage = sandboxTitle.prefixedText<br />
local sandboxDisplay = message('sandbox-link-display')<br />
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)<br />
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}<br />
local sandboxEditDisplay = message('sandbox-edit-link-display')<br />
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)<br />
local compareUrl = env.compareUrl<br />
local compareLink<br />
if compareUrl then<br />
local compareDisplay = message('compare-link-display')<br />
compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
end<br />
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)<br />
else<br />
local sandboxPreload<br />
if subjectSpace == 828 then<br />
sandboxPreload = message('module-sandbox-preload')<br />
else<br />
sandboxPreload = message('template-sandbox-preload')<br />
end<br />
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}<br />
local sandboxCreateDisplay = message('sandbox-create-link-display')<br />
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)<br />
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})<br />
local mirrorPreload = message('mirror-link-preload')<br />
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}<br />
if subjectSpace == 828 then<br />
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}<br />
end<br />
local mirrorDisplay = message('mirror-link-display')<br />
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)<br />
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)<br />
end<br />
if testcasesTitle.exists then<br />
local testcasesPage = testcasesTitle.prefixedText<br />
local testcasesDisplay = message('testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)<br />
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}<br />
local testcasesEditDisplay = message('testcases-edit-link-display')<br />
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)<br />
-- for Modules, add testcases run link if exists<br />
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then<br />
local testcasesRunLinkDisplay = message('testcases-run-link-display')<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)<br />
else<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)<br />
end<br />
else<br />
local testcasesPreload<br />
if subjectSpace == 828 then<br />
testcasesPreload = message('module-testcases-preload')<br />
else<br />
testcasesPreload = message('template-testcases-preload')<br />
end<br />
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}<br />
local testcasesCreateDisplay = message('testcases-create-link-display')<br />
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)<br />
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)<br />
end<br />
local messageName<br />
if subjectSpace == 828 then<br />
messageName = 'experiment-blurb-module'<br />
else<br />
messageName = 'experiment-blurb-template'<br />
end<br />
return message(messageName, {sandboxLinks, testcasesLinks})<br />
end<br />
<br />
function p.makeCategoriesBlurb(args, env)<br />
--[[<br />
-- Generates the text "Please add categories to the /doc subpage."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'doc-link-display' --> '/doc'<br />
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'<br />
--]]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))<br />
return message('add-categories-blurb', {docPathLink})<br />
end<br />
<br />
function p.makeSubpagesBlurb(args, env)<br />
--[[<br />
-- Generates the "Subpages of this template" link.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'template-pagetype' --> 'template'<br />
-- 'module-pagetype' --> 'module'<br />
-- 'default-pagetype' --> 'page'<br />
-- 'subpages-link-display' --> 'Subpages of this $1'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
if not subjectSpace or not templateTitle then<br />
return nil<br />
end<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('template-pagetype')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('module-pagetype')<br />
else<br />
pagetype = message('default-pagetype')<br />
end<br />
local subpagesLink = makeWikilink(<br />
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',<br />
message('subpages-link-display', {pagetype})<br />
)<br />
return message('subpages-blurb', {subpagesLink})<br />
end<br />
<br />
function p.makePrintBlurb(args, env)<br />
--[=[<br />
-- Generates the blurb displayed when there is a print version of the template available.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
--<br />
-- Messages:<br />
-- 'print-link-display' --> '/Print'<br />
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'<br />
-- .. ' of this template exists at $1.'<br />
-- .. ' If you make a change to this template, please update the print version as well.'<br />
-- 'display-print-category' --> true<br />
-- 'print-category' --> 'Templates with print versions'<br />
--]=]<br />
local printTitle = env.printTitle<br />
if not printTitle then<br />
return nil<br />
end<br />
local ret<br />
if printTitle.exists then<br />
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))<br />
ret = message('print-blurb', {printLink})<br />
local displayPrintCategory = message('display-print-category', nil, 'boolean')<br />
if displayPrintCategory then<br />
ret = ret .. makeCategoryLink(message('print-category'))<br />
end<br />
end<br />
return ret<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Tracking categories<br />
----------------------------------------------------------------------------<br />
<br />
function p.addTrackingCategories(env)<br />
--[[<br />
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'display-strange-usage-category' --> true<br />
-- 'doc-subpage' --> 'doc'<br />
-- 'testcases-subpage' --> 'testcases'<br />
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'<br />
-- <br />
-- /testcases pages in the module namespace are not categorised, as they may have<br />
-- {{documentation}} transcluded automatically.<br />
--]]<br />
local title = env.title<br />
local subjectSpace = env.subjectSpace<br />
if not title or not subjectSpace then<br />
return nil<br />
end<br />
local subpage = title.subpageText<br />
local ret = ''<br />
if message('display-strange-usage-category', nil, 'boolean')<br />
and (<br />
subpage == message('doc-subpage')<br />
or subjectSpace ~= 828 and subpage == message('testcases-subpage')<br />
)<br />
then<br />
ret = ret .. makeCategoryLink(message('strange-usage-category'))<br />
end<br />
return ret<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Documentation&diff=1938Module:Documentation2021-06-23T15:11:59Z<p>Jawitkien: </p>
<hr />
<div>-- This module implements {{documentation}}.<br />
<br />
-- Get required modules.<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
-- Get the config table.<br />
local cfg = mw.loadData('Module:Documentation/config')<br />
<br />
local p = {}<br />
<br />
-- Often-used functions.<br />
local ugsub = mw.ustring.gsub<br />
<br />
----------------------------------------------------------------------------<br />
-- Helper functions<br />
--<br />
-- These are defined as local functions, but are made available in the p<br />
-- table for testing purposes.<br />
----------------------------------------------------------------------------<br />
<br />
local function message(cfgKey, valArray, expectType)<br />
--[[<br />
-- Gets a message from the cfg table and formats it if appropriate.<br />
-- The function raises an error if the value from the cfg table is not<br />
-- of the type expectType. The default type for expectType is 'string'.<br />
-- If the table valArray is present, strings such as $1, $2 etc. in the<br />
-- message are substituted with values from the table keys [1], [2] etc.<br />
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',<br />
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."<br />
--]]<br />
local msg = cfg[cfgKey]<br />
expectType = expectType or 'string' or nil<br />
if type(msg) ~= expectType then<br />
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)<br />
end<br />
if not valArray then<br />
return msg<br />
end<br />
<br />
local function getMessageVal(match)<br />
match = tonumber(match)<br />
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)<br />
end<br />
<br />
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)<br />
end<br />
<br />
p.message = message<br />
<br />
local function makeWikilink(page, display)<br />
if display then<br />
return mw.ustring.format('[[%s|%s]]', page, display)<br />
else<br />
return mw.ustring.format('[[%s]]', page)<br />
end<br />
end<br />
<br />
p.makeWikilink = makeWikilink<br />
<br />
local function makeCategoryLink(cat, sort)<br />
local catns = mw.site.namespaces[14].name<br />
return makeWikilink(catns .. ':' .. cat, sort)<br />
end<br />
<br />
p.makeCategoryLink = makeCategoryLink<br />
<br />
local function makeUrlLink(url, display)<br />
return mw.ustring.format('[%s %s]', url, display)<br />
end<br />
<br />
p.makeUrlLink = makeUrlLink<br />
<br />
local function makeToolbar(...)<br />
local ret = {}<br />
local lim = select('#', ...)<br />
if lim < 1 then<br />
return nil<br />
end<br />
for i = 1, lim do<br />
ret[#ret + 1] = select(i, ...)<br />
end<br />
-- 'documentation-toolbar'<br />
return '<span class="' .. message('toolbar-class') .. '">('<br />
.. table.concat(ret, ' &#124; ') .. ')</span>'<br />
end <br />
<br />
p.makeToolbar = makeToolbar<br />
<br />
----------------------------------------------------------------------------<br />
-- Argument processing<br />
----------------------------------------------------------------------------<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.<br />
if key == 'heading' or value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Entry points<br />
----------------------------------------------------------------------------<br />
<br />
function p.nonexistent(frame)<br />
if mw.title.getCurrentTitle().subpageText == 'testcases' then<br />
return frame:expandTemplate{title = 'module test cases notice'}<br />
else<br />
return p.main(frame)<br />
end<br />
end<br />
<br />
p.main = makeInvokeFunc('_main')<br />
<br />
function p._main(args)<br />
--[[<br />
-- This function defines logic flow for the module.<br />
-- @args - table of arguments passed by the user<br />
--]]<br />
local env = p.getEnvironment(args)<br />
local root = mw.html.create()<br />
root<br />
:wikitext(p._getModuleWikitext(args, env))<br />
:wikitext(p.protectionTemplate(env))<br />
:wikitext(p.sandboxNotice(args, env))<br />
:tag('div')<br />
-- 'documentation-container'<br />
:addClass(message('container'))<br />
:newline()<br />
:tag('div')<br />
-- 'documentation'<br />
:addClass(message('main-div-classes'))<br />
:newline()<br />
:wikitext(p._startBox(args, env))<br />
:wikitext(p._content(args, env))<br />
:tag('div')<br />
-- 'documentation-clear'<br />
:addClass(message('clear'))<br />
:done()<br />
:newline()<br />
:done()<br />
:wikitext(p._endBox(args, env))<br />
:done()<br />
:wikitext(p.addTrackingCategories(env))<br />
-- 'Module:Documentation/styles.css'<br />
return mw.getCurrentFrame():extensionTag (<br />
'templatestyles', '', {src=cfg['templatestyles']<br />
}) .. tostring(root)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Environment settings<br />
----------------------------------------------------------------------------<br />
<br />
function p.getEnvironment(args)<br />
--[[<br />
-- Returns a table with information about the environment, including title<br />
-- objects and other namespace- or path-related data.<br />
-- @args - table of arguments passed by the user<br />
--<br />
-- Title objects include:<br />
-- env.title - the page we are making documentation for (usually the current title)<br />
-- env.templateTitle - the template (or module, file, etc.)<br />
-- env.docTitle - the /doc subpage.<br />
-- env.sandboxTitle - the /sandbox subpage.<br />
-- env.testcasesTitle - the /testcases subpage.<br />
-- env.printTitle - the print version of the template, located at the /Print subpage.<br />
--<br />
-- Data includes:<br />
-- env.protectionLevels - the protection levels table of the title object.<br />
-- env.subjectSpace - the number of the title's subject namespace.<br />
-- env.docSpace - the number of the namespace the title puts its documentation in.<br />
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.<br />
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.<br />
-- <br />
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value<br />
-- returned will be nil.<br />
--]]<br />
<br />
local env, envFuncs = {}, {}<br />
<br />
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value<br />
-- returned by that function is memoized in the env table so that we don't call any of the functions<br />
-- more than once. (Nils won't be memoized.)<br />
setmetatable(env, {<br />
__index = function (t, key)<br />
local envFunc = envFuncs[key]<br />
if envFunc then<br />
local success, val = pcall(envFunc)<br />
if success then<br />
env[key] = val -- Memoise the value.<br />
return val<br />
end<br />
end<br />
return nil<br />
end<br />
}) <br />
<br />
function envFuncs.title()<br />
-- The title object for the current page, or a test page passed with args.page.<br />
local title<br />
local titleArg = args.page<br />
if titleArg then<br />
title = mw.title.new(titleArg)<br />
else<br />
title = mw.title.getCurrentTitle()<br />
end<br />
return title<br />
end<br />
<br />
function envFuncs.templateTitle()<br />
--[[<br />
-- The template (or module, etc.) title object.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local subpage = title.subpageText<br />
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then<br />
return mw.title.makeTitle(subjectSpace, title.baseText)<br />
else<br />
return mw.title.makeTitle(subjectSpace, title.text)<br />
end<br />
end<br />
<br />
function envFuncs.docTitle()<br />
--[[<br />
-- Title object of the /doc subpage.<br />
-- Messages:<br />
-- 'doc-subpage' --> 'doc'<br />
--]]<br />
local title = env.title<br />
local docname = args[1] -- User-specified doc page.<br />
local docpage<br />
if docname then<br />
docpage = docname<br />
else<br />
docpage = env.docpageBase .. '/' .. message('doc-subpage')<br />
end<br />
return mw.title.new(docpage)<br />
end<br />
<br />
function envFuncs.sandboxTitle()<br />
--[[<br />
-- Title object for the /sandbox subpage.<br />
-- Messages:<br />
-- 'sandbox-subpage' --> 'sandbox'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))<br />
end<br />
<br />
function envFuncs.testcasesTitle()<br />
--[[<br />
-- Title object for the /testcases subpage.<br />
-- Messages:<br />
-- 'testcases-subpage' --> 'testcases'<br />
--]]<br />
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))<br />
end<br />
<br />
function envFuncs.printTitle()<br />
--[[<br />
-- Title object for the /Print subpage.<br />
-- Messages:<br />
-- 'print-subpage' --> 'Print'<br />
--]]<br />
return env.templateTitle:subPageTitle(message('print-subpage'))<br />
end<br />
<br />
function envFuncs.protectionLevels()<br />
-- The protection levels table of the title object.<br />
return env.title.protectionLevels<br />
end<br />
<br />
function envFuncs.subjectSpace()<br />
-- The subject namespace number.<br />
return mw.site.namespaces[env.title.namespace].subject.id<br />
end<br />
<br />
function envFuncs.docSpace()<br />
-- The documentation namespace number. For most namespaces this is the<br />
-- same as the subject namespace. However, pages in the Article, File,<br />
-- MediaWiki or Category namespaces must have their /doc, /sandbox and<br />
-- /testcases pages in talk space.<br />
local subjectSpace = env.subjectSpace<br />
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then<br />
return subjectSpace + 1<br />
else<br />
return subjectSpace<br />
end<br />
end<br />
<br />
function envFuncs.docpageBase()<br />
-- The base page of the /doc, /sandbox, and /testcases subpages.<br />
-- For some namespaces this is the talk page, rather than the template page.<br />
local templateTitle = env.templateTitle<br />
local docSpace = env.docSpace<br />
local docSpaceText = mw.site.namespaces[docSpace].name<br />
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.<br />
return docSpaceText .. ':' .. templateTitle.text<br />
end<br />
<br />
function envFuncs.compareUrl()<br />
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
if templateTitle.exists and sandboxTitle.exists then<br />
local compareUrl = mw.uri.fullUrl(<br />
'Special:ComparePages',<br />
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}<br />
)<br />
return tostring(compareUrl)<br />
else<br />
return nil<br />
end<br />
end <br />
<br />
return env<br />
end <br />
<br />
----------------------------------------------------------------------------<br />
-- Auxiliary templates<br />
----------------------------------------------------------------------------<br />
<br />
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')<br />
<br />
function p._getModuleWikitext(args, env)<br />
local currentTitle = mw.title.getCurrentTitle()<br />
if currentTitle.contentModel ~= 'Scribunto' then return end<br />
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care<br />
local moduleWikitext = package.loaded["Module:Module wikitext"]<br />
if moduleWikitext then<br />
return moduleWikitext.main()<br />
end<br />
end<br />
<br />
function p.sandboxNotice(args, env)<br />
--[=[<br />
-- Generates a sandbox notice for display above sandbox pages.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'<br />
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'<br />
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'<br />
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'<br />
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'<br />
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'<br />
-- 'sandbox-notice-compare-link-display' --> 'diff'<br />
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'<br />
-- 'sandbox-notice-testcases-link-display' --> 'test cases'<br />
-- 'sandbox-category' --> 'Template sandboxes'<br />
--]=]<br />
local title = env.title<br />
local sandboxTitle = env.sandboxTitle<br />
local templateTitle = env.templateTitle<br />
local subjectSpace = env.subjectSpace<br />
if not (subjectSpace and title and sandboxTitle and templateTitle<br />
and mw.title.equals(title, sandboxTitle)) then<br />
return nil<br />
end<br />
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".<br />
local omargs = {}<br />
omargs.image = message('sandbox-notice-image')<br />
-- Get the text. We start with the opening blurb, which is something like<br />
-- "This is the template sandbox for [[Template:Foo]] (diff)."<br />
local text = ''<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('sandbox-notice-pagetype-template')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('sandbox-notice-pagetype-module')<br />
else<br />
pagetype = message('sandbox-notice-pagetype-other')<br />
end<br />
local templateLink = makeWikilink(templateTitle.prefixedText)<br />
local compareUrl = env.compareUrl<br />
if compareUrl then<br />
local compareDisplay = message('sandbox-notice-compare-link-display')<br />
local compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})<br />
else<br />
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})<br />
end<br />
-- Get the test cases page blurb if the page exists. This is something like<br />
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."<br />
local testcasesTitle = env.testcasesTitle<br />
if testcasesTitle and testcasesTitle.exists then<br />
if testcasesTitle.contentModel == "Scribunto" then<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})<br />
else<br />
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)<br />
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})<br />
end<br />
end<br />
-- Add the sandbox to the sandbox category.<br />
omargs.text = text .. makeCategoryLink(message('sandbox-category'))<br />
<br />
-- 'documentation-clear'<br />
return '<div class="' .. message('clear') .. '"></div>'<br />
.. require('Module:Message box').main('ombox', omargs)<br />
end<br />
<br />
function p.protectionTemplate(env)<br />
-- Generates the padlock icon in the top right.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'protection-template' --> 'pp-template'<br />
-- 'protection-template-args' --> {docusage = 'yes'}<br />
local protectionLevels = env.protectionLevels<br />
if not protectionLevels then<br />
return nil<br />
end<br />
local editProt = protectionLevels.edit and protectionLevels.edit[1]<br />
local moveProt = protectionLevels.move and protectionLevels.move[1]<br />
if editProt then<br />
-- The page is edit-protected.<br />
return require('Module:Protection banner')._main{<br />
message('protection-reason-edit'), small = true<br />
}<br />
elseif moveProt and moveProt ~= 'autoconfirmed' then<br />
-- The page is move-protected but not edit-protected. Exclude move<br />
-- protection with the level "autoconfirmed", as this is equivalent to<br />
-- no move protection at all.<br />
return require('Module:Protection banner')._main{<br />
action = 'move', small = true<br />
}<br />
else<br />
return nil<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Start box<br />
----------------------------------------------------------------------------<br />
<br />
p.startBox = makeInvokeFunc('_startBox')<br />
<br />
function p._startBox(args, env)<br />
--[[<br />
-- This function generates the start box.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make<br />
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox<br />
-- which generate the box HTML.<br />
--]]<br />
env = env or p.getEnvironment(args)<br />
local links<br />
local content = args.content<br />
if not content or args[1] then<br />
-- No need to include the links if the documentation is on the template page itself.<br />
local linksData = p.makeStartBoxLinksData(args, env)<br />
if linksData then<br />
links = p.renderStartBoxLinks(linksData)<br />
end<br />
end<br />
-- Generate the start box html.<br />
local data = p.makeStartBoxData(args, env, links)<br />
if data then<br />
return p.renderStartBox(data)<br />
else<br />
-- User specified no heading.<br />
return nil<br />
end<br />
end<br />
<br />
function p.makeStartBoxLinksData(args, env)<br />
--[[<br />
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'view-link-display' --> 'view'<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'purge-link-display' --> 'purge'<br />
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'docpage-preload' --> 'Template:Documentation/preload'<br />
-- 'create-link-display' --> 'create'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local title = env.title<br />
local docTitle = env.docTitle<br />
if not title or not docTitle then<br />
return nil<br />
end<br />
if docTitle.isRedirect then <br />
docTitle = docTitle.redirectTarget<br />
end<br />
<br />
local data = {}<br />
data.title = title<br />
data.docTitle = docTitle<br />
-- View, display, edit, and purge links if /doc exists.<br />
data.viewLinkDisplay = message('view-link-display')<br />
data.editLinkDisplay = message('edit-link-display')<br />
data.historyLinkDisplay = message('history-link-display')<br />
data.purgeLinkDisplay = message('purge-link-display')<br />
-- Create link if /doc doesn't exist.<br />
local preload = args.preload<br />
if not preload then<br />
if subjectSpace == 6 then -- File namespace<br />
preload = message('file-docpage-preload')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
preload = message('module-preload')<br />
else<br />
preload = message('docpage-preload')<br />
end<br />
end<br />
data.preload = preload<br />
data.createLinkDisplay = message('create-link-display')<br />
return data<br />
end<br />
<br />
function p.renderStartBoxLinks(data)<br />
--[[<br />
-- Generates the [view][edit][history][purge] or [create] links from the data table.<br />
-- @data - a table of data generated by p.makeStartBoxLinksData<br />
--]]<br />
<br />
local function escapeBrackets(s)<br />
-- Escapes square brackets with HTML entities.<br />
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.<br />
s = s:gsub('%]', '&#93;')<br />
return s<br />
end<br />
<br />
local ret<br />
local docTitle = data.docTitle<br />
local title = data.title<br />
if docTitle.exists then<br />
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)<br />
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)<br />
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)<br />
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)<br />
ret = '[%s] [%s] [%s] [%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)<br />
else<br />
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)<br />
ret = '[%s]'<br />
ret = escapeBrackets(ret)<br />
ret = mw.ustring.format(ret, createLink)<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeStartBoxData(args, env, links)<br />
--[=[<br />
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.<br />
--<br />
-- Messages:<br />
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'<br />
-- 'template-namespace-heading' --> 'Template documentation'<br />
-- 'module-namespace-heading' --> 'Module documentation'<br />
-- 'file-namespace-heading' --> 'Summary'<br />
-- 'other-namespaces-heading' --> 'Documentation'<br />
-- 'testcases-create-link-display' --> 'create'<br />
--]=]<br />
local subjectSpace = env.subjectSpace<br />
if not subjectSpace then<br />
-- Default to an "other namespaces" namespace, so that we get at least some output<br />
-- if an error occurs.<br />
subjectSpace = 2<br />
end<br />
local data = {}<br />
<br />
-- Heading<br />
local heading = args.heading -- Blank values are not removed.<br />
if heading == '' then<br />
-- Don't display the start box if the heading arg is defined but blank.<br />
return nil<br />
end<br />
if heading then<br />
data.heading = heading<br />
elseif subjectSpace == 10 then -- Template namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')<br />
elseif subjectSpace == 828 then -- Module namespace<br />
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')<br />
elseif subjectSpace == 6 then -- File namespace<br />
data.heading = message('file-namespace-heading')<br />
else<br />
data.heading = message('other-namespaces-heading')<br />
end<br />
<br />
-- Heading CSS<br />
local headingStyle = args['heading-style']<br />
if headingStyle then<br />
data.headingStyleText = headingStyle<br />
else<br />
-- 'documentation-heading'<br />
data.headingClass = message('main-div-heading-class')<br />
end<br />
<br />
-- Data for the [view][edit][history][purge] or [create] links.<br />
if links then<br />
-- 'mw-editsection-like plainlinks'<br />
data.linksClass = message('start-box-link-classes')<br />
data.links = links<br />
end<br />
<br />
return data<br />
end<br />
<br />
function p.renderStartBox(data)<br />
-- Renders the start box html.<br />
-- @data - a table of data generated by p.makeStartBoxData.<br />
local sbox = mw.html.create('div')<br />
sbox<br />
-- 'documentation-startbox'<br />
:addClass(message('start-box-class'))<br />
:newline()<br />
:tag('span')<br />
:addClass(data.headingClass)<br />
:cssText(data.headingStyleText)<br />
:wikitext(data.heading)<br />
local links = data.links<br />
if links then<br />
sbox:tag('span')<br />
:addClass(data.linksClass)<br />
:attr('id', data.linksId)<br />
:wikitext(links)<br />
end<br />
return tostring(sbox)<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Documentation content<br />
----------------------------------------------------------------------------<br />
<br />
p.content = makeInvokeFunc('_content')<br />
<br />
function p._content(args, env)<br />
-- Displays the documentation contents<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
local content = args.content<br />
if not content and docTitle and docTitle.exists then<br />
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}<br />
end<br />
-- The line breaks below are necessary so that "=== Headings ===" at the start and end<br />
-- of docs are interpreted correctly.<br />
return '\n' .. (content or '') .. '\n' <br />
end<br />
<br />
p.contentTitle = makeInvokeFunc('_contentTitle')<br />
<br />
function p._contentTitle(args, env)<br />
env = env or p.getEnvironment(args)<br />
local docTitle = env.docTitle<br />
if not args.content and docTitle and docTitle.exists then<br />
return docTitle.prefixedText<br />
else<br />
return ''<br />
end<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- End box<br />
----------------------------------------------------------------------------<br />
<br />
p.endBox = makeInvokeFunc('_endBox')<br />
<br />
function p._endBox(args, env)<br />
--[=[<br />
-- This function generates the end box (also known as the link box).<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
--]=]<br />
<br />
-- Get environment data.<br />
env = env or p.getEnvironment(args)<br />
local subjectSpace = env.subjectSpace<br />
local docTitle = env.docTitle<br />
if not subjectSpace or not docTitle then<br />
return nil<br />
end<br />
<br />
-- Check whether we should output the end box at all. Add the end<br />
-- box by default if the documentation exists or if we are in the<br />
-- user, module or template namespaces.<br />
local linkBox = args['link box']<br />
if linkBox == 'off'<br />
or not (<br />
docTitle.exists<br />
or subjectSpace == 2<br />
or subjectSpace == 828<br />
or subjectSpace == 10<br />
)<br />
then<br />
return nil<br />
end<br />
<br />
-- Assemble the link box.<br />
local text = ''<br />
if linkBox then<br />
text = text .. linkBox<br />
else<br />
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <br />
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then<br />
-- We are in the user, template or module namespaces.<br />
-- Add sandbox and testcases links.<br />
-- "Editors can experiment in this template's sandbox and testcases pages."<br />
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'<br />
if not args.content and not args[1] then<br />
-- "Please add categories to the /doc subpage."<br />
-- Don't show this message with inline docs or with an explicitly specified doc page,<br />
-- as then it is unclear where to add the categories.<br />
text = text .. (p.makeCategoriesBlurb(args, env) or '')<br />
end<br />
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"<br />
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.<br />
if printBlurb then<br />
text = text .. '<br />' .. printBlurb<br />
end<br />
end<br />
end<br />
<br />
local box = mw.html.create('div')<br />
-- 'documentation-metadata'<br />
box:attr('role', 'note')<br />
:addClass(message('end-box-class'))<br />
-- 'plainlinks'<br />
:addClass(message('end-box-plainlinks'))<br />
:wikitext(text)<br />
:done()<br />
<br />
return '\n' .. tostring(box)<br />
end<br />
<br />
function p.makeDocPageBlurb(args, env)<br />
--[=[<br />
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'edit-link-display' --> 'edit'<br />
-- 'history-link-display' --> 'history'<br />
-- 'transcluded-from-blurb' --> <br />
-- 'The above [[Wikipedia:Template documentation|documentation]] <br />
-- is [[Help:Transclusion|transcluded]] from $1.'<br />
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'<br />
-- 'create-link-display' --> 'create'<br />
-- 'create-module-doc-blurb' --><br />
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'<br />
--]=]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local ret<br />
if docTitle.exists then<br />
-- /doc exists; link to it.<br />
local docLink = makeWikilink(docTitle.prefixedText)<br />
local editUrl = docTitle:fullUrl{action = 'edit'}<br />
local editDisplay = message('edit-link-display')<br />
local editLink = makeUrlLink(editUrl, editDisplay)<br />
local historyUrl = docTitle:fullUrl{action = 'history'}<br />
local historyDisplay = message('history-link-display')<br />
local historyLink = makeUrlLink(historyUrl, historyDisplay)<br />
ret = message('transcluded-from-blurb', {docLink})<br />
.. ' '<br />
.. makeToolbar(editLink, historyLink)<br />
.. '<br />'<br />
elseif env.subjectSpace == 828 then<br />
-- /doc does not exist; ask to create it.<br />
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}<br />
local createDisplay = message('create-link-display')<br />
local createLink = makeUrlLink(createUrl, createDisplay)<br />
ret = message('create-module-doc-blurb', {createLink})<br />
.. '<br />'<br />
end<br />
return ret<br />
end<br />
<br />
function p.makeExperimentBlurb(args, env)<br />
--[[<br />
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- <br />
-- Messages:<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'sandbox-edit-link-display' --> 'edit'<br />
-- 'compare-link-display' --> 'diff'<br />
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'sandbox-create-link-display' --> 'create'<br />
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'<br />
-- 'mirror-link-display' --> 'mirror'<br />
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'<br />
-- 'sandbox-link-display' --> 'sandbox'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display'--> 'edit'<br />
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'<br />
-- 'testcases-create-link-display' --> 'create'<br />
-- 'testcases-link-display' --> 'testcases'<br />
-- 'testcases-edit-link-display' --> 'edit'<br />
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'<br />
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'<br />
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'<br />
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
local sandboxTitle = env.sandboxTitle<br />
local testcasesTitle = env.testcasesTitle<br />
local templatePage = templateTitle.prefixedText<br />
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then<br />
return nil<br />
end<br />
-- Make links.<br />
local sandboxLinks, testcasesLinks<br />
if sandboxTitle.exists then<br />
local sandboxPage = sandboxTitle.prefixedText<br />
local sandboxDisplay = message('sandbox-link-display')<br />
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)<br />
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}<br />
local sandboxEditDisplay = message('sandbox-edit-link-display')<br />
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)<br />
local compareUrl = env.compareUrl<br />
local compareLink<br />
if compareUrl then<br />
local compareDisplay = message('compare-link-display')<br />
compareLink = makeUrlLink(compareUrl, compareDisplay)<br />
end<br />
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)<br />
else<br />
local sandboxPreload<br />
if subjectSpace == 828 then<br />
sandboxPreload = message('module-sandbox-preload')<br />
else<br />
sandboxPreload = message('template-sandbox-preload')<br />
end<br />
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}<br />
local sandboxCreateDisplay = message('sandbox-create-link-display')<br />
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)<br />
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})<br />
local mirrorPreload = message('mirror-link-preload')<br />
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}<br />
if subjectSpace == 828 then<br />
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}<br />
end<br />
local mirrorDisplay = message('mirror-link-display')<br />
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)<br />
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)<br />
end<br />
if testcasesTitle.exists then<br />
local testcasesPage = testcasesTitle.prefixedText<br />
local testcasesDisplay = message('testcases-link-display')<br />
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)<br />
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}<br />
local testcasesEditDisplay = message('testcases-edit-link-display')<br />
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)<br />
-- for Modules, add testcases run link if exists<br />
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then<br />
local testcasesRunLinkDisplay = message('testcases-run-link-display')<br />
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)<br />
else<br />
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)<br />
end<br />
else<br />
local testcasesPreload<br />
if subjectSpace == 828 then<br />
testcasesPreload = message('module-testcases-preload')<br />
else<br />
testcasesPreload = message('template-testcases-preload')<br />
end<br />
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}<br />
local testcasesCreateDisplay = message('testcases-create-link-display')<br />
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)<br />
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)<br />
end<br />
local messageName<br />
if subjectSpace == 828 then<br />
messageName = 'experiment-blurb-module'<br />
else<br />
messageName = 'experiment-blurb-template'<br />
end<br />
return message(messageName, {sandboxLinks, testcasesLinks})<br />
end<br />
<br />
function p.makeCategoriesBlurb(args, env)<br />
--[[<br />
-- Generates the text "Please add categories to the /doc subpage."<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
-- Messages:<br />
-- 'doc-link-display' --> '/doc'<br />
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'<br />
--]]<br />
local docTitle = env.docTitle<br />
if not docTitle then<br />
return nil<br />
end<br />
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))<br />
return message('add-categories-blurb', {docPathLink})<br />
end<br />
<br />
function p.makeSubpagesBlurb(args, env)<br />
--[[<br />
-- Generates the "Subpages of this template" link.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'template-pagetype' --> 'template'<br />
-- 'module-pagetype' --> 'module'<br />
-- 'default-pagetype' --> 'page'<br />
-- 'subpages-link-display' --> 'Subpages of this $1'<br />
--]]<br />
local subjectSpace = env.subjectSpace<br />
local templateTitle = env.templateTitle<br />
if not subjectSpace or not templateTitle then<br />
return nil<br />
end<br />
local pagetype<br />
if subjectSpace == 10 then<br />
pagetype = message('template-pagetype')<br />
elseif subjectSpace == 828 then<br />
pagetype = message('module-pagetype')<br />
else<br />
pagetype = message('default-pagetype')<br />
end<br />
local subpagesLink = makeWikilink(<br />
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',<br />
message('subpages-link-display', {pagetype})<br />
)<br />
return message('subpages-blurb', {subpagesLink})<br />
end<br />
<br />
function p.makePrintBlurb(args, env)<br />
--[=[<br />
-- Generates the blurb displayed when there is a print version of the template available.<br />
-- @args - a table of arguments passed by the user<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
--<br />
-- Messages:<br />
-- 'print-link-display' --> '/Print'<br />
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'<br />
-- .. ' of this template exists at $1.'<br />
-- .. ' If you make a change to this template, please update the print version as well.'<br />
-- 'display-print-category' --> true<br />
-- 'print-category' --> 'Templates with print versions'<br />
--]=]<br />
local printTitle = env.printTitle<br />
if not printTitle then<br />
return nil<br />
end<br />
local ret<br />
if printTitle.exists then<br />
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))<br />
ret = message('print-blurb', {printLink})<br />
local displayPrintCategory = message('display-print-category', nil, 'boolean')<br />
if displayPrintCategory then<br />
ret = ret .. makeCategoryLink(message('print-category'))<br />
end<br />
end<br />
return ret<br />
end<br />
<br />
----------------------------------------------------------------------------<br />
-- Tracking categories<br />
----------------------------------------------------------------------------<br />
<br />
function p.addTrackingCategories(env)<br />
--[[<br />
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.<br />
-- @env - environment table containing title objects, etc., generated with p.getEnvironment<br />
<br />
-- Messages:<br />
-- 'display-strange-usage-category' --> true<br />
-- 'doc-subpage' --> 'doc'<br />
-- 'testcases-subpage' --> 'testcases'<br />
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'<br />
-- <br />
-- /testcases pages in the module namespace are not categorised, as they may have<br />
-- {{documentation}} transcluded automatically.<br />
--]]<br />
local title = env.title<br />
local subjectSpace = env.subjectSpace<br />
if not title or not subjectSpace then<br />
return nil<br />
end<br />
local subpage = title.subpageText<br />
local ret = ''<br />
if message('display-strange-usage-category', nil, 'boolean')<br />
and (<br />
subpage == message('doc-subpage')<br />
or subjectSpace ~= 828 and subpage == message('testcases-subpage')<br />
)<br />
then<br />
ret = ret .. makeCategoryLink(message('strange-usage-category'))<br />
end<br />
return ret<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Template:In5&diff=1937Template:In52021-06-23T15:04:58Z<p>Jawitkien: </p>
<hr />
<div><includeonly>{{{{{|safesubst:}}}#invoke:in5|in5|1={{{1|}}}}}</includeonly><noinclude><br />
<br />
{{Documentation}} <br />
<br />
<!--[[Category:Smart formatting templates|In5]]--><br />
</noinclude></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Template:In5&diff=1936Template:In52021-06-23T15:04:41Z<p>Jawitkien: </p>
<hr />
<div><includeonly>{{{{{|safesubst:}}}#invoke:in5|in5|1={{{1|}}}}}</includeonly><noinclude><br />
<br />
<!-- {{Documentation}} !--><br />
<br />
<!--[[Category:Smart formatting templates|In5]]--><br />
</noinclude></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Template:In5&diff=1935Template:In52021-06-23T15:01:36Z<p>Jawitkien: Created page with "<includeonly>{{{{{|safesubst:}}}#invoke:in5|in5|1={{{1|}}}}}</includeonly><noinclude> {{Documentation}} <!--In5--> </noinclude>"</p>
<hr />
<div><includeonly>{{{{{|safesubst:}}}#invoke:in5|in5|1={{{1|}}}}}</includeonly><noinclude><br />
<br />
{{Documentation}}<br />
<br />
<!--[[Category:Smart formatting templates|In5]]--><br />
</noinclude></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=File:Semi-protection-shackle.svg&diff=1934File:Semi-protection-shackle.svg2021-06-23T14:59:47Z<p>Jawitkien: Jawitkien uploaded a new version of File:Semi-protection-shackle.svg</p>
<hr />
<div></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=File:Semi-protection-shackle.svg&diff=1933File:Semi-protection-shackle.svg2021-06-23T14:59:44Z<p>Jawitkien: Jawitkien uploaded a new version of File:Semi-protection-shackle.svg</p>
<hr />
<div></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=File:Semi-protection-shackle.svg&diff=1932File:Semi-protection-shackle.svg2021-06-23T14:59:40Z<p>Jawitkien: </p>
<hr />
<div></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:In5/doc&diff=1931Module:In5/doc2021-06-23T14:53:20Z<p>Jawitkien: Created page with "{{module rating|alpha}} This is a Lua implementation of the {{tl|in5}} template. Please see the template page for documentation."</p>
<hr />
<div>{{module rating|alpha}}<br />
<br />
This is a Lua implementation of the {{tl|in5}} template. Please see the template page for documentation.</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:In5&diff=1930Module:In52021-06-23T14:52:34Z<p>Jawitkien: Created page with "-- This module implements {{in5}}. local p = {} function p.in5(frame) local indent = frame.args[1] -- Trim whitespace and convert to number. Default to 5 if not pres..."</p>
<hr />
<div>-- This module implements {{in5}}.<br />
<br />
local p = {}<br />
<br />
function p.in5(frame)<br />
local indent = frame.args[1]<br />
-- Trim whitespace and convert to number. Default to 5 if not present,<br />
-- as per the template title.<br />
indent = tonumber( mw.text.trim(indent) ) or 5<br />
-- Round down to nearest integer. Decimal values produce funky results<br />
-- from the original template, but there's no need for us to replicate that.<br />
indent = math.floor( indent )<br />
-- Don't output anything for zero or less. Again, there was some funky output<br />
-- here for negatives, but now we're in Lua we should use sane defaults.<br />
if indent <= 0 then<br />
return<br />
end<br />
<br />
local base = '&nbsp; '<br />
local modulo = '&nbsp;'<br />
<br />
--[[<br />
Indent values and the corresponding values for base and modulo:<br />
<br />
indent base modulo<br />
1 0 1<br />
2 0 2<br />
3 1 1<br />
4 1 2<br />
5 2 1<br />
6 2 2<br />
7 3 1<br />
8 3 2<br />
9 4 1<br />
10 4 2<br />
]]<br />
<br />
local baseNum = math.floor( (indent - 1) / 2 )<br />
local modNum = math.fmod( indent - 1 , 2 ) + 1<br />
<br />
return mw.ustring.rep( base, baseNum) .. mw.ustring.rep( modulo, modNum )<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Arguments/doc&diff=1929Module:Arguments/doc2021-06-23T14:50:49Z<p>Jawitkien: </p>
<hr />
<div>{{Used in system}}<br />
{{Module rating|p}}<br />
<br />
This module provides easy processing of arguments passed from #invoke. It is a meta-module, meant for use by other modules, and should not be called from #invoke directly. Its features include:<br />
* Easy trimming of arguments and removal of blank arguments.<br />
* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)<br />
* Arguments can be passed in directly from another Lua module or from the debug console.<br />
* Most features can be customized.<br />
<br />
== Basic use ==<br />
<br />
First, you need to load the module. It contains one function, named <code>getArgs</code>.<br />
<br />
<syntaxhighlight lang="lua"><br />
local getArgs = require('Module:Arguments').getArgs<br />
</syntaxhighlight><br />
<br />
In the most basic scenario, you can use getArgs inside your main function. The variable <code>args</code> is a table containing the arguments from #invoke. (See below for details.)<br />
<br />
<syntaxhighlight lang="lua"><br />
local getArgs = require('Module:Arguments').getArgs<br />
local p = {}<br />
<br />
function p.main(frame)<br />
local args = getArgs(frame)<br />
-- Main module code goes here.<br />
end<br />
<br />
return p<br />
</syntaxhighlight><br />
<br />
However, the recommended practice is to use a function just for processing arguments from #invoke. This means that if someone calls your module from another Lua module you don't have to have a frame object available, which improves performance.<br />
<br />
<syntaxhighlight lang="lua"><br />
local getArgs = require('Module:Arguments').getArgs<br />
local p = {}<br />
<br />
function p.main(frame)<br />
local args = getArgs(frame)<br />
return p._main(args)<br />
end<br />
<br />
function p._main(args)<br />
-- Main module code goes here.<br />
end<br />
<br />
return p<br />
</syntaxhighlight><br />
<br />
If you want multiple functions to use the arguments, and you also want them to be accessible from #invoke, you can use a wrapper function.<br />
<br />
<syntaxhighlight lang="lua"><br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
local p = {}<br />
<br />
local function makeInvokeFunc(funcName)<br />
return function (frame)<br />
local args = getArgs(frame)<br />
return p[funcName](args)<br />
end<br />
end<br />
<br />
p.func1 = makeInvokeFunc('_func1')<br />
<br />
function p._func1(args)<br />
-- Code for the first function goes here.<br />
end<br />
<br />
p.func2 = makeInvokeFunc('_func2')<br />
<br />
function p._func2(args)<br />
-- Code for the second function goes here.<br />
end<br />
<br />
return p<br />
</syntaxhighlight><br />
<br />
=== Options ===<br />
<br />
The following options are available. They are explained in the sections below.<br />
<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
trim = false,<br />
removeBlanks = false,<br />
valueFunc = function (key, value)<br />
-- Code for processing one argument<br />
end,<br />
frameOnly = true,<br />
parentOnly = true,<br />
parentFirst = true,<br />
wrappers = {<br />
'Template:A wrapper template',<br />
'Template:Another wrapper template'<br />
},<br />
readOnly = true,<br />
noOverwrite = true<br />
})<br />
</syntaxhighlight><br />
<br />
=== Trimming and removing blanks ===<br />
<br />
Blank arguments often trip up coders new to converting MediaWiki templates to Lua. In template syntax, blank strings and strings consisting only of whitespace are considered false. However, in Lua, blank strings and strings consisting of whitespace are considered true. This means that if you don't pay attention to such arguments when you write your Lua modules, you might treat something as true that should actually be treated as false. To avoid this, by default this module removes all blank arguments.<br />
<br />
Similarly, whitespace can cause problems when dealing with positional arguments. Although whitespace is trimmed for named arguments coming from #invoke, it is preserved for positional arguments. Most of the time this additional whitespace is not desired, so this module trims it off by default.<br />
<br />
However, sometimes you want to use blank arguments as input, and sometimes you want to keep additional whitespace. This can be necessary to convert some templates exactly as they were written. If you want to do this, you can set the <code>trim</code> and <code>removeBlanks</code> arguments to <code>false</code>.<br />
<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
trim = false,<br />
removeBlanks = false<br />
})<br />
</syntaxhighlight><br />
<br />
=== Custom formatting of arguments ===<br />
<br />
Sometimes you want to remove some blank arguments but not others, or perhaps you might want to put all of the positional arguments in lower case. To do things like this you can use the <code>valueFunc</code> option. The input to this option must be a function that takes two parameters, <code>key</code> and <code>value</code>, and returns a single value. This value is what you will get when you access the field <code>key</code> in the <code>args</code> table.<br />
<br />
Example 1: this function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments.<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if key == 1 then<br />
return value<br />
elseif value then<br />
value = mw.text.trim(value)<br />
if value ~= '' then<br />
return value<br />
end<br />
end<br />
return nil<br />
end<br />
})<br />
</syntaxhighlight><br />
<br />
Example 2: this function removes blank arguments and converts all arguments to lower case, but doesn't trim whitespace from positional parameters.<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if not value then<br />
return nil<br />
end<br />
value = mw.ustring.lower(value)<br />
if mw.ustring.find(value, '%S') then<br />
return value<br />
end<br />
return nil<br />
end<br />
})<br />
</syntaxhighlight><br />
<br />
Note: the above functions will fail if passed input that is not of type <code>string</code> or <code>nil</code>. This might be the case if you use the <code>getArgs</code> function in the main function of your module, and that function is called by another Lua module. In this case, you will need to check the type of your input. This is not a problem if you are using a function specially for arguments from #invoke (i.e. you have <code>p.main</code> and <code>p._main</code> functions, or something similar).<br />
<br />
{{cot|Examples 1 and 2 with type checking}}<br />
Example 1:<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if key == 1 then<br />
return value<br />
elseif type(value) == 'string' then<br />
value = mw.text.trim(value)<br />
if value ~= '' then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
</syntaxhighlight><br />
<br />
Example 2:<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
valueFunc = function (key, value)<br />
if type(value) == 'string' then<br />
value = mw.ustring.lower(value)<br />
if mw.ustring.find(value, '%S') then<br />
return value<br />
else<br />
return nil<br />
end<br />
else<br />
return value<br />
end<br />
end<br />
})<br />
</syntaxhighlight><br />
{{cob}}<br />
<br />
Also, please note that the <code>valueFunc</code> function is called more or less every time an argument is requested from the <code>args</code> table, so if you care about performance you should make sure you aren't doing anything inefficient with your code.<br />
<br />
=== Frames and parent frames ===<br />
<br />
Arguments in the <code>args</code> table can be passed from the current frame or from its parent frame at the same time. To understand what this means, it is easiest to give an example. Let's say that we have a module called <code>Module:ExampleArgs</code>. This module prints the first two positional arguments that it is passed.<br />
<br />
{{cot|Module:ExampleArgs code}}<br />
<syntaxhighlight lang="lua"><br />
local getArgs = require('Module:Arguments').getArgs<br />
local p = {}<br />
<br />
function p.main(frame)<br />
local args = getArgs(frame)<br />
return p._main(args)<br />
end<br />
<br />
function p._main(args)<br />
local first = args[1] or ''<br />
local second = args[2] or ''<br />
return first .. ' ' .. second<br />
end<br />
<br />
return p<br />
</syntaxhighlight><br />
{{cob}}<br />
<br />
<code>Module:ExampleArgs</code> is then called by <code>Template:ExampleArgs</code>, which contains the code <code><nowiki>{{#invoke:ExampleArgs|main|firstInvokeArg}}</nowiki></code>. This produces the result "firstInvokeArg".<br />
<br />
Now if we were to call <code>Template:ExampleArgs</code>, the following would happen:<br />
<br />
{| class="wikitable" style="width: 50em; max-width: 100%;"<br />
|-<br />
! style="width: 60%;" | Code<br />
! style="width: 40%;" | Result<br />
|-<br />
| <code><nowiki>{{ExampleArgs}}</nowiki></code><br />
| firstInvokeArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code><br />
| firstInvokeArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code><br />
| firstInvokeArg secondTemplateArg<br />
|}<br />
<br />
There are three options you can set to change this behaviour: <code>frameOnly</code>, <code>parentOnly</code> and <code>parentFirst</code>. If you set <code>frameOnly</code> then only arguments passed from the current frame will be accepted; if you set <code>parentOnly</code> then only arguments passed from the parent frame will be accepted; and if you set <code>parentFirst</code> then arguments will be passed from both the current and parent frames, but the parent frame will have priority over the current frame. Here are the results in terms of <code>Template:ExampleArgs</code>:<br />
<br />
; frameOnly<br />
{| class="wikitable" style="width: 50em; max-width: 100%;"<br />
|-<br />
! style="width: 60%;" | Code<br />
! style="width: 40%;" | Result<br />
|-<br />
| <code><nowiki>{{ExampleArgs}}</nowiki></code><br />
| firstInvokeArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code><br />
| firstInvokeArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code><br />
| firstInvokeArg<br />
|}<br />
<br />
; parentOnly<br />
{| class="wikitable" style="width: 50em; max-width: 100%;"<br />
|-<br />
! style="width: 60%;" | Code<br />
! style="width: 40%;" | Result<br />
|-<br />
| <code><nowiki>{{ExampleArgs}}</nowiki></code><br />
| <br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code><br />
| firstTemplateArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code><br />
| firstTemplateArg secondTemplateArg<br />
|}<br />
<br />
; parentFirst<br />
{| class="wikitable" style="width: 50em; max-width: 100%;"<br />
|-<br />
! style="width: 60%;" | Code<br />
! style="width: 40%;" | Result<br />
|-<br />
| <code><nowiki>{{ExampleArgs}}</nowiki></code><br />
| firstInvokeArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code><br />
| firstTemplateArg<br />
|-<br />
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code><br />
| firstTemplateArg secondTemplateArg<br />
|}<br />
<br />
Notes:<br />
# If you set both the <code>frameOnly</code> and <code>parentOnly</code> options, the module won't fetch any arguments at all from #invoke. This is probably not what you want.<br />
# In some situations a parent frame may not be available, e.g. if getArgs is passed the parent frame rather than the current frame. In this case, only the frame arguments will be used (unless parentOnly is set, in which case no arguments will be used) and the <code>parentFirst</code> and <code>frameOnly</code> options will have no effect.<br />
<br />
=== Wrappers ===<br />
<br />
The ''wrappers'' option is used to specify a limited number of templates as ''wrapper templates'', that is, templates whose only purpose is to call a module. If the module detects that it is being called from a wrapper template, it will only check for arguments in the parent frame; otherwise it will only check for arguments in the frame passed to getArgs. This allows modules to be called by either #invoke or through a wrapper template without the loss of performance associated with having to check both the frame and the parent frame for each argument lookup.<br />
<br />
For example, the only content of [[Template:Side box]] (excluding content in {{tag|noinclude}} tags) is <code><nowiki>{{#invoke:Side box|main}}</nowiki></code>. There is no point in checking the arguments passed directly to the #invoke statement for this template, as no arguments will ever be specified there. We can avoid checking arguments passed to #invoke by using the ''parentOnly'' option, but if we do this then #invoke will not work from other pages either. If this were the case, the {{para|text|Some text}} in the code <code><nowiki>{{#invoke:Side box|main|text=Some text}}</nowiki></code> would be ignored completely, no matter what page it was used from. By using the <code>wrappers</code> option to specify 'Template:Side box' as a wrapper, we can make <code><nowiki>{{#invoke:Side box|main|text=Some text}}</nowiki></code> work from most pages, while still not requiring that the module check for arguments on the [[Template:Side box]] page itself.<br />
<br />
Wrappers can be specified either as a string, or as an array of strings.<br />
<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
wrappers = 'Template:Wrapper template'<br />
})<br />
</syntaxhighlight><br />
<br />
<br />
<syntaxhighlight lang="lua"><br />
local args = getArgs(frame, {<br />
wrappers = {<br />
'Template:Wrapper 1',<br />
'Template:Wrapper 2',<br />
-- Any number of wrapper templates can be added here.<br />
}<br />
})<br />
</syntaxhighlight><br />
<br />
Notes:<br />
# The module will automatically detect if it is being called from a wrapper template's /sandbox subpage, so there is no need to specify sandbox pages explicitly.<br />
# The ''wrappers'' option effectively changes the default of the ''frameOnly'' and ''parentOnly'' options. If, for example, ''parentOnly'' were explicitly set to false with ''wrappers'' set, calls via wrapper templates would result in both frame and parent arguments being loaded, though calls not via wrapper templates would result in only frame arguments being loaded.<br />
# If the ''wrappers'' option is set and no parent frame is available, the module will always get the arguments from the frame passed to <code>getArgs</code>.<br />
<br />
=== Writing to the args table ===<br />
<br />
Sometimes it can be useful to write new values to the args table. This is possible with the default settings of this module. (However, bear in mind that it is usually better coding style to create a new table with your new values and copy arguments from the args table as needed.)<br />
<br />
<syntaxhighlight lang="lua"><br />
args.foo = 'some value'<br />
</syntaxhighlight><br />
<br />
It is possible to alter this behaviour with the <code>readOnly</code> and <code>noOverwrite</code> options. If <code>readOnly</code> is set then it is not possible to write any values to the args table at all. If <code>noOverwrite</code> is set, then it is possible to add new values to the table, but it is not possible to add a value if it would overwrite any arguments that are passed from #invoke.<br />
<br />
=== Ref tags ===<br />
<br />
This module uses [[mw:Extension:Scribunto/Lua reference manual#Metatables|metatables]] to fetch arguments from #invoke. This allows access to both the frame arguments and the parent frame arguments without using the <code>pairs()</code> function. This can help if your module might be passed {{tag|ref}} tags as input.<br />
<br />
As soon as {{tag|ref}} tags are accessed from Lua, they are processed by the MediaWiki software and the reference will appear in the reference list at the bottom of the article. If your module proceeds to omit the reference tag from the output, you will end up with a phantom reference – a reference that appears in the reference list but without any number linking to it. This has been a problem with modules that use <code>pairs()</code> to detect whether to use the arguments from the frame or the parent frame, as those modules automatically process every available argument.<br />
<br />
This module solves this problem by allowing access to both frame and parent frame arguments, while still only fetching those arguments when it is necessary. The problem will still occur if you use <code>pairs(args)</code> elsewhere in your module, however.<br />
<br />
=== Known limitations ===<br />
<br />
The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own argument processing function instead of this module.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||<br />
[[Category:Lua metamodules]]<br />
}}</includeonly></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Lang-zh/doc&diff=1928Module:Lang-zh/doc2021-06-23T14:46:41Z<p>Jawitkien: Created page with "{{module rating|protected}} {{Lua|Module:Arguments|Module:No globals}} == Usage == This is the module for the template {{tl|Lang-zh}}. Its main features are described on tha..."</p>
<hr />
<div>{{module rating|protected}}<br />
{{Lua|Module:Arguments|Module:No globals}}<br />
<br />
== Usage ==<br />
<br />
This is the module for the template {{tl|Lang-zh}}. Its main features are described on that template's [[Template:Lang-zh/doc|documentation page]], refer to that for how to use it in articles. This documentation describes some particular features of the module.<br />
<br />
The first table in the module lists the articles in which the template will put traditional Chinese first. Add articles to this list in the same fashion (the order doesn't matter) to include them. If you cannot edit the module because its protected use the {{tl|edit template-protected}} template on its talk page to request a change.<br />
<br />
===Use from other modules===<br />
<br />
The module can be called directly from another module as well as a template. To do this first load the module<br />
<br />
<syntaxhighlight lang="lua"><br />
local Zh = require("Module:Lang-zh")._Zh<br />
</syntaxhighlight><br />
<br />
Then call it as follows, with the arguments in a table<br />
<br />
<syntaxhighlight lang="lua"><br />
local output = Zh{["c"] = "中国", ["p"] = "zhōngguó"}<br />
</syntaxhighlight><br />
<br />
==Tracking categories==<br />
* {{Category link with count|Articles containing Chinese-language text}}<br />
* {{Category link with count|Articles containing simplified Chinese-language text}}<br />
* {{Category link with count|Articles containing traditional Chinese-language text}}<br />
* {{Category link with count|Pages using template Zh with sup tags}}<br />
<br />
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||<br />
<!-- Categories go here and interwikis go in Wikidata. --><br />
[[Category:Modules that add a tracking category]]<br />
}}</includeonly></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Module:Lang-zh&diff=1927Module:Lang-zh2021-06-23T14:45:37Z<p>Jawitkien: Created page with "require('Module:No globals') local p = {} -- articles in which traditional Chinese preceeds simplified Chinese local t1st = { ["228 Incident"] = true, ["Chinese calendar"]..."</p>
<hr />
<div>require('Module:No globals')<br />
<br />
local p = {}<br />
<br />
-- articles in which traditional Chinese preceeds simplified Chinese<br />
local t1st = {<br />
["228 Incident"] = true,<br />
["Chinese calendar"] = true,<br />
["Lippo Centre, Hong Kong"] = true,<br />
["Republic of China"] = true,<br />
["Republic of China at the 1924 Summer Olympics"] = true,<br />
["Taiwan"] = true,<br />
["Taiwan (island)"] = true,<br />
["Taiwan Province"] = true,<br />
["Wei Boyang"] = true,<br />
}<br />
<br />
-- the labels for each part <br />
local labels = {<br />
["c"] = "Chinese",<br />
["s"] = "simplified Chinese",<br />
["t"] = "traditional Chinese",<br />
["p"] = "pinyin",<br />
["tp"] = "Tongyong Pinyin",<br />
["w"] = "Wade–Giles",<br />
["j"] = "Jyutping",<br />
["cy"] = "Cantonese Yale",<br />
["sl"] = "Sidney Lau",<br />
["poj"] = "Pe̍h-ōe-jī",<br />
["zhu"] = "Zhuyin Fuhao",<br />
["l"] = "lit.",<br />
}<br />
<br />
-- article titles for wikilinks for each part<br />
local wlinks = {<br />
["c"] = "Chinese language",<br />
["s"] = "simplified Chinese characters",<br />
["t"] = "traditional Chinese characters",<br />
["p"] = "pinyin",<br />
["tp"] = "Tongyong Pinyin",<br />
["w"] = "Wade–Giles",<br />
["j"] = "Jyutping",<br />
["cy"] = "Yale romanization of Cantonese",<br />
["sl"] = "Sidney Lau romanisation",<br />
["poj"] = "Pe̍h-ōe-jī",<br />
["zhu"] = "Bopomofo",<br />
["l"] = "Literal translation",<br />
}<br />
<br />
-- for those parts which are to be treated as languages their ISO code<br />
local ISOlang = {<br />
["c"] = "zh",<br />
["t"] = "zh-Hant",<br />
["s"] = "zh-Hans",<br />
["p"] = "zh-Latn-pinyin",<br />
["tp"] = "zh-Latn",<br />
["w"] = "zh-Latn-wadegile",<br />
["j"] = "yue-Latn-jyutping",<br />
["cy"] = "yue-Latn",<br />
["sl"] = "yue-Latn",<br />
["poj"] = "nan-Latn",<br />
["zhu"] = "zh-Bopo",<br />
}<br />
<br />
local italic = {<br />
["p"] = true,<br />
["tp"] = true,<br />
["w"] = true,<br />
["j"] = true,<br />
["cy"] = true,<br />
["sl"] = true,<br />
["poj"] = true,<br />
}<br />
<br />
local superscript = {<br />
["w"] = true,<br />
["sl"] = true,<br />
}<br />
-- Categories for different kinds of Chinese text<br />
local cats = {<br />
["c"] = "[[Category:Articles containing Chinese-language text]]",<br />
["s"] = "[[Category:Articles containing simplified Chinese-language text]]",<br />
["t"] = "[[Category:Articles containing traditional Chinese-language text]]",<br />
}<br />
<br />
function p.Zh(frame)<br />
-- load arguments module to simplify handling of args<br />
local getArgs = require('Module:Arguments').getArgs<br />
<br />
local args = getArgs(frame)<br />
return p._Zh(args)<br />
end<br />
<br />
function p._Zh(args)<br />
local uselinks = not (args["links"] == "no") -- whether to add links<br />
local uselabels = not (args["labels"] == "no") -- whether to have labels<br />
local capfirst = args["scase"] ~= nil<br />
<br />
local t1 = false -- whether traditional Chinese characters go first<br />
local j1 = false -- whether Cantonese Romanisations go first<br />
local testChar<br />
if (args["first"]) then<br />
for testChar in mw.ustring.gmatch(args["first"], "%a+") do<br />
if (testChar == "t") then<br />
t1 = true<br />
end<br />
if (testChar == "j") then<br />
j1 = true<br />
end<br />
end<br />
end<br />
if (t1 == false) then<br />
local title = mw.title.getCurrentTitle()<br />
t1 = t1st[title.text] == true<br />
end<br />
<br />
-- based on setting/preference specify order<br />
local orderlist = {"c", "s", "t", "p", "tp", "w", "j", "cy", "sl", "poj", "zhu", "l"}<br />
if (t1) then<br />
orderlist[2] = "t"<br />
orderlist[3] = "s"<br />
end<br />
if (j1) then<br />
orderlist[4] = "j"<br />
orderlist[5] = "cy"<br />
orderlist[6] = "sl"<br />
orderlist[7] = "p"<br />
orderlist[8] = "tp"<br />
orderlist[9] = "w"<br />
end<br />
<br />
-- rename rules. Rules to change parameters and labels based on other parameters<br />
if args["hp"] then<br />
-- hp an alias for p ([hanyu] pinyin)<br />
args["p"] = args["hp"]<br />
end<br />
if args["tp"] then<br />
-- if also Tongyu pinyin use full name for Hanyu pinyin<br />
labels["p"] = "Hanyu Pinyin"<br />
end<br />
<br />
if (args["s"] and args["s"] == args["t"]) then<br />
-- Treat simplified + traditional as Chinese if they're the same<br />
args["c"] = args["s"]<br />
args["s"] = nil<br />
args["t"] = nil<br />
elseif (not (args["s"] and args["t"])) then<br />
-- use short label if only one of simplified and traditional<br />
labels["s"] = labels["c"]<br />
labels["t"] = labels["c"]<br />
end<br />
<br />
local body = "" -- the output string<br />
local params -- for creating HTML spans<br />
local label -- the label, i.e. the bit preceeding the supplied text<br />
local val -- the supplied text<br />
<br />
-- go through all possible fields in loop, adding them to the output<br />
for i, part in ipairs(orderlist) do<br />
if (args[part]) then<br />
-- build label<br />
label = ""<br />
if (uselabels) then<br />
label = labels[part]<br />
if (capfirst) then<br />
label = mw.language.getContentLanguage():ucfirst(label)<br />
capfirst = false<br />
end<br />
if (uselinks) then<br />
label = "[[" .. wlinks[part] .. "|" .. label .. "]]"<br />
end<br />
if (labels[part] ~= "lit.") then<br />
label = label .. "&#58;"<br />
else<br />
label = "<small>" .. label .. "</small>"<br />
end<br />
label = label .. " "<br />
end<br />
-- build value<br />
val = args[part]<br />
if (cats[part]) and mw.title.getCurrentTitle().namespace == 0 then<br />
-- if has associated category AND current page in article namespace, add category<br />
val = cats[part] .. val<br />
end<br />
if (ISOlang[part]) then<br />
-- add span for language if needed<br />
params = {["lang"] = ISOlang[part]}<br />
val = mw.text.tag({name="span",attrs=params, content=val})<br />
elseif (part == "l") then<br />
-- put literals in quotes<br />
val = "'" .. val .. "'"<br />
end<br />
if (italic[part]) then<br />
-- italicise<br />
val = "<i>" .. val .. "</i>"<br />
end<br />
if string.match(val, "</?sup>") then val = val.."[[Category:Pages using template Zh with sup tags]]" end<br />
if (superscript[part]) then<br />
-- superscript<br />
val = val:gsub("(%d)", "<sup>%1</sup>"):gsub("(%d)</sup>%*<sup>(%d)", "%1*%2"):gsub("<sup><sup>([%d%*]+)</sup></sup>", "<sup>%1</sup>")<br />
end<br />
-- add both to body<br />
body = body .. label .. val .. "; "<br />
end<br />
end<br />
<br />
if (body > "") then -- check for empty string<br />
return string.sub(body, 1, -3) -- chop off final semicolon and space<br />
else --no named parameters; see if there's a first parameter, ignoring its name<br />
if (args[1]) then<br />
-- if there is treat it as Chinese<br />
label = ""<br />
if (uselabels) then<br />
label = labels["c"]<br />
if (uselinks) then<br />
label = "[[" .. wlinks["c"] .. "|" .. label .. "]]"<br />
end<br />
label = label .. "&#58; "<br />
end<br />
-- default to show links and labels as no options given<br />
if mw.title.getCurrentTitle().namespace == 0 then<br />
-- if current page in article namespace<br />
val = cats["c"] .. args[1]<br />
else<br />
val = args[1]<br />
end<br />
params = {["lang"] = ISOlang["c"]}<br />
val = mw.text.tag({name="span",attrs=params, content=val})<br />
return label .. val<br />
end<br />
return ""<br />
end<br />
end<br />
<br />
return p</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=Template:Zh&diff=1926Template:Zh2021-06-23T14:44:20Z<p>Jawitkien: Created page with "<includeonly>{{#invoke:Lang-zh|Zh}}</includeonly><noinclude>{{documentation}}</noinclude>"</p>
<hr />
<div><includeonly>{{#invoke:Lang-zh|Zh}}</includeonly><noinclude>{{documentation}}</noinclude></div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Bagua&diff=1925I Ching/Bagua2021-06-23T14:42:57Z<p>Jawitkien: </p>
<hr />
<div>Another possible source of ''bagua'' is the following, attributed to [[King Wen of Zhou]] Dynasty: "When the world began, there was heaven and earth. Heaven mated with the earth and gave birth to everything in the world. Heaven is ''Qian''-gua, and the Earth is ''Kun''-gua. The remaining six guas are their sons and daughters".<br />
<br />
The trigrams are related to the five elements of Wu Xing, used by [[Feng Shui]] practitioners and in [[Traditional Chinese Medicine]]. <br />
<br />
Those five elements are Water, Wood, Fire, Earth and Metal.<br />
*: The Water (Kan) and Fire (Li) trigrams correspond directly with the Water and Fire elements.<br />
*: The element of Wood corresponds with the trigrams of Wind (Xun) (as a gentle but inexorable force that can erode and penetrate stone) and Thunder (Zhen). <br />
*: The element of Earth corresponds with both the trigrams of Earth (Kun) and Mountain (Gen). <br />
*: The element of Metal corresponds with the trigrams of Heaven (Qian) and Lake (Dui).<br />
<br />
There are eight possible combinations to render the various trigrams ({{zh|labels=no|c=八卦}} ''bāguà''):<br />
{| class="wikitable" style="text-align:center;"<br />
|-<br />
!<br />
! Trigram figure<br />
! Possible binary value<br />
! Name<br />
! Translation: ''Wilhelm''<ref>Wilhelm, R. & Baynes, C., (1967): "The I Ching or Book of Changes", With foreword by Carl Jung, Introduction, Bollingen Series XIX, Princeton University Press, (1st ed. 1950)</ref><br />
! Image in nature <small>(pp.l-li)</small><br />
! Direction <small>(p.&nbsp;269)</small><br />
! Family relationship <small>(p.&nbsp;274)</small><br />
! Body part <small>(p.&nbsp;274)</small><br />
! Attribute <small>(p.&nbsp;273)</small><br />
! Stage/ state <small>(pp.l-li)</small><br />
! Animal <small>(p.&nbsp;273)</small><br />
|-<br />
| 1 || ☰ || 111 || {{zh|labels=no|c=乾}}<br />''qián'' || ''the Creative'', (natural) force || heaven, sky<br />{{lang|zh|天}}<br />
| northwest || father || head || strong, persisting || creative || {{lang|zh|馬}}<br />horse<br />
|-<br />
| 2 || ☱ || 110 || {{lang|zh|兌}}<br />''duì'' || ''the Joyous'', open (reflection) || lake, marsh<br />{{lang|zh|澤}}<br />
| west || third daughter || mouth || pleasure || tranquil (complete devotion) || {{lang|zh|羊}}<br />sheep, goat<br />
|-<br />
| 3 || ☲ || 101 || {{lang|zh|離}}<br />''lí'' || ''the Clinging'', radiance || fire, glow<br />{{lang|zh|火}}<br />
| south || second daughter || eye || light-giving, humane "dependence" || clinging, clarity, adaptable || {{lang|zh|雉}}<br />pheasant<br />
|-<br />
| 4 || ☳ || 100 || {{lang|zh|震}}<br />''zhèn'' || ''the Arousing'', shake || thunder<br />{{lang|zh|雷}}<br />
| east || first son || foot || inciting movement || initiative || {{lang|zh|龍}}<br />dragon<br />
|-<br />
| 5 || ☴ || 011 || {{lang|zh|巽}}<br />''xùn'' || ''the Gentle'', ground || wind, air<br />{{lang|zh|風}}<br />
| southeast || first daughter || thigh || penetrating || gentle entrance || {{lang|zh|雞}}<br />fowl<br />
|-<br />
| 6 || ☵ || 010 || {{lang|zh|坎}}<br />''kǎn'' || ''the Abysmal'', [[gorge]] || water<br />{{lang|zh|水}}<br />
| north || second son || ear || dangerous || in-motion || {{lang|zh|豕}}<br />pig<br />
|-<br />
| 7 || ☶ || 001 || {{lang|zh|艮}}<br />''gèn'' || ''Keeping Still'', bound || mountain<br />{{lang|zh|山}} || northeast || third son || hand || resting, stand-still || completion || {{lang|zh|狗}}<br />wolf, dog<br />
|-<br />
| 8 || ☷ || 000 || {{lang|zh|坤}}<br />''kūn'' || ''the Receptive'', field || ground, earth<br />{{lang|zh|地}}<br />
| southwest || mother (consort) || belly || devoted, yielding || receptive || {{lang|zh|牛}}<br />cow<br />
|}<br />
<br />
===Hexagram lookup table===<br />
{| class="wikitable" style="text-align:center;"<br />
|-----<br />
| width="10%" ! style="background:LightYellow;" | Upper →<br />Lower ↓<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=乾}} Qián<br />[[File:Trigramme2630 ☰.svg]]<br />Heaven'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=坤}} Kūn<br />[[File:Trigramme2637 ☷.svg]]<br />Ground''', '''Earth'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=震}} Zhèn<br />[[File:Trigramme2633 ☳.svg]]<br />Thunder'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=坎}} Kǎn<br />[[File:Trigramme2635 ☵.svg]]<br />Water'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=艮}} Gèn<br />[[File:Trigramme2636 ☶.svg]]<br />Mountain'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=巽}} Xùn<br />[[File:Trigramme2634 ☴.svg]]<br />Wind''', '''Air'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|t=離}} Lí<br />[[File:Trigramme2632 ☲.svg]]<br />Flame''', '''Fire'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|t=兌}} Duì<br />[[File:Trigramme2631 ☱.svg]]<br />Lake'''<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=乾}} Qián<br />[[File:Trigramme2630 ☰.svg]]<br />Heaven'''<br />
| [[I Ching/Hexagram# 1|01]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 1|Force]] <br />
| [[I Ching/Hexagram# 11|11]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 11|Pervading]]<br />
| [[I Ching/Hexagram# 34|34]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 34|Great Invigorating]]<br />
| [[I Ching/Hexagram# 5|05]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 5|Attending]] <br />
| <br />[[I Ching/Hexagram# 26|26]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 26|Great <br />Accumulating]]<br />
| <br />[[I Ching/Hexagram# 9|09]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 9|Small <br />Harvest]]<br />
| <br />[[I Ching/Hexagram# 14|14]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 14|Great <br />Possessing]]<br />
| [[I Ching/Hexagram# 43|43]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 43|Displacement]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=坤}} Kūn<br />[[File:Trigramme2637 ☷.svg]]<br />Earth'''<br />
| [[I Ching/Hexagram# 12|12]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 12|Obstruction]]<br />
| [[I Ching/Hexagram# 2|02]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 2|Field]] <br /><br />
| [[I Ching/Hexagram# 16|16]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 16|Providing-For]]<br />
| [[I Ching/Hexagram# 8|08]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 8|Grouping]]<br />
| [[I Ching/Hexagram# 23|23]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 23|Stripping]]<br />
| [[I Ching/Hexagram# 20|20]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 20|Viewing]]<br />
| [[I Ching/Hexagram# 35|35]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 35|Prospering]]<br />
| [[I Ching/Hexagram# 45|45]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 45|Clustering]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=震}} Zhèn<br />[[File:Trigramme2633 ☳.svg]]<br />Thunder'''<br />
| [[I Ching/Hexagram# 25|25]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2633 ☳.svg]] <br /> [[I Ching/Hexagram# 25|Innocence]]<br />
| [[I Ching/Hexagram# 24|24]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 24|Returning]]<br />
| [[I Ching/Hexagram# 51|51]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 51|Shake]]<br />
| [[I Ching/Hexagram# 3|03]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 3|Sprouting]]<br />
| [[I Ching/Hexagram# 27|27]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 27|Swallowing]]<br />
| [[I Ching/Hexagram# 42|42]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 42|Augmenting]]<br />
| [[I Ching/Hexagram# 21|21]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 21|Gnawing Bite]]<br />
| [[I Ching/Hexagram# 17|17]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 17|Following]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=坎}} Kǎn<br />[[File:Trigramme2635 ☵.svg]]<br />Water'''<br />
| [[I Ching/Hexagram# 6|06]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 6|Arguing]]<br />
| [[I Ching/Hexagram# 7|07]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 7|Leading]]<br />
| [[I Ching/Hexagram# 40|40]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 40|Deliverance]]<br />
| [[I Ching/Hexagram# 29|29]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 29|Gorge]]<br />
| [[I Ching/Hexagram# 4|04]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 4|Enveloping]]<br />
| [[I Ching/Hexagram# 59|59]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 59|Dispersing]]<br />
| [[I Ching/Hexagram# 64|64]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 64|Before Completion]]<br />
| [[I Ching/Hexagram# 47|47]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 47|Confining]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=艮}} Gèn<br />[[File:Trigramme2636 ☶.svg]]<br />Mountain'''<br />
| [[I Ching/Hexagram# 33|33]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 33|Retiring]]<br />
| [[I Ching/Hexagram# 15|15]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 15|Humbling]]<br />
| [[I Ching/Hexagram# 62|62]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 62|Small Exceeding]]<br />
| [[I Ching/Hexagram# 39|39]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 39|Limping]]<br />
| [[I Ching/Hexagram# 52|52]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 52|Bound]]<br />
| [[I Ching/Hexagram# 53|53]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 53|Infiltrating]]<br />
| [[I Ching/Hexagram# 56|56]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 56|Sojourning]]<br />
| [[I Ching/Hexagram# 31|31]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 31|Conjoining]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=巽}} Xùn<br />[[File:Trigramme2634 ☴.svg]]<br />Wind'''<br />
| [[I Ching/Hexagram# 44|44]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 44|Coupling]]<br />
| [[I Ching/Hexagram# 46|46]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 46|Ascending]]<br />
| [[I Ching/Hexagram# 32|32]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 32|Persevering]]<br />
| [[I Ching/Hexagram# 48|48]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 48|Welling]]<br />
| [[I Ching/Hexagram# 18|18]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 18|Correcting]]<br />
| [[I Ching/Hexagram# 57|57]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 57|Ground]]<br />
| [[I Ching/Hexagram# 50|50]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 50|Holding]]<br />
| [[I Ching/Hexagram# 28|28]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 28|Great Exceeding]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=離}} Lí<br />[[File:Trigramme2632 ☲.svg]]<br />Flame'''<br />
| [[I Ching/Hexagram# 13|13]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 13|Concording<br />People]]<br />
| [[I Ching/Hexagram# 36|36]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 36|Intelligence<br />Hidden]]<br />
| [[I Ching/Hexagram# 55|55]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 55|Abounding]]<br />
| [[I Ching/Hexagram# 63|63]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 63|Already<br />Fording]]<br />
| [[I Ching/Hexagram# 22|22]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 22|Adorning]]<br />
| [[I Ching/Hexagram# 37|37]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 37|Dwelling<br />People]]<br />
| [[I Ching/Hexagram# 30|30]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 30|Radiance]]<br />
| [[I Ching/Hexagram# 49|49]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 49|Skinning]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=兌}} Duì<br />[[File:Trigramme2631 ☱.svg]]<br />Lake'''<br />
| [[I Ching/Hexagram# 10|10]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 10|Treading]]<br />
| [[I Ching/Hexagram# 19|19]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 19|Nearing]]<br />
| [[I Ching/Hexagram# 54|54]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 54|Converting the Maiden]]<br />
| [[I Ching/Hexagram# 60|60]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 60|Articulating]]<br />
| [[I Ching/Hexagram# 41|41]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 41|Diminishing]]<br />
| [[I Ching/Hexagram# 61|61]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 61|Inner Truth]]<br />
| [[I Ching/Hexagram# 38|38]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 38|Polarising]]<br />
| [[I Ching/Hexagram# 58|58]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 58|Open]]<br />
|}</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Bagua&diff=1924I Ching/Bagua2021-06-23T14:39:20Z<p>Jawitkien: Page name"List of hexagrams of the I Ching#Hexagram" from WIkipedia changed to "I Ching/Hexagram#Hexagram" on PDKB wiki</p>
<hr />
<div>Another possible source of ''bagua'' is the following, attributed to [[King Wen of Zhou]] Dynasty: "When the world began, there was heaven and earth. Heaven mated with the earth and gave birth to everything in the world. Heaven is ''Qian''-gua, and the Earth is ''Kun''-gua. The remaining six guas are their sons and daughters".<br />
<br />
The trigrams are related to the five elements of Wu Xing, used by [[Feng Shui]] practitioners and in [[Traditional Chinese Medicine]]. Those five elements are Water, Wood, Fire, Earth and Metal. The Water (Kan) and Fire (Li) trigrams correspond directly with the Water and Fire elements. The element of Earth corresponds with both the trigrams of Earth (Kun) and Mountain (Gen). The element of Wood corresponds with the trigrams of Wind (Xun) (as a gentle but inexorable force that can erode and penetrate stone) and Thunder (Zhen). The element of Metal corresponds with the trigrams of Heaven (Qian) and Lake (Dui).<br />
<br />
There are eight possible combinations to render the various trigrams ({{zh|labels=no|c=八卦}} ''bāguà''):<br />
{| class="wikitable" style="text-align:center;"<br />
|-<br />
!<br />
! Trigram figure<br />
! Possible binary value<br />
! Name<br />
! Translation: ''Wilhelm''<ref>Wilhelm, R. & Baynes, C., (1967): "The I Ching or Book of Changes", With foreword by Carl Jung, Introduction, Bollingen Series XIX, Princeton University Press, (1st ed. 1950)</ref><br />
! Image in nature <small>(pp.l-li)</small><br />
! Direction <small>(p.&nbsp;269)</small><br />
! Family relationship <small>(p.&nbsp;274)</small><br />
! Body part <small>(p.&nbsp;274)</small><br />
! Attribute <small>(p.&nbsp;273)</small><br />
! Stage/ state <small>(pp.l-li)</small><br />
! Animal <small>(p.&nbsp;273)</small><br />
|-<br />
| 1 || ☰ || 111 || {{zh|labels=no|c=乾}}<br />''qián'' || ''the Creative'', (natural) force || heaven, sky<br />{{lang|zh|天}}<br />
| northwest || father || head || strong, persisting || creative || {{lang|zh|馬}}<br />horse<br />
|-<br />
| 2 || ☱ || 110 || {{lang|zh|兌}}<br />''duì'' || ''the Joyous'', open (reflection) || lake, marsh<br />{{lang|zh|澤}}<br />
| west || third daughter || mouth || pleasure || tranquil (complete devotion) || {{lang|zh|羊}}<br />sheep, goat<br />
|-<br />
| 3 || ☲ || 101 || {{lang|zh|離}}<br />''lí'' || ''the Clinging'', radiance || fire, glow<br />{{lang|zh|火}}<br />
| south || second daughter || eye || light-giving, humane "dependence" || clinging, clarity, adaptable || {{lang|zh|雉}}<br />pheasant<br />
|-<br />
| 4 || ☳ || 100 || {{lang|zh|震}}<br />''zhèn'' || ''the Arousing'', shake || thunder<br />{{lang|zh|雷}}<br />
| east || first son || foot || inciting movement || initiative || {{lang|zh|龍}}<br />dragon<br />
|-<br />
| 5 || ☴ || 011 || {{lang|zh|巽}}<br />''xùn'' || ''the Gentle'', ground || wind, air<br />{{lang|zh|風}}<br />
| southeast || first daughter || thigh || penetrating || gentle entrance || {{lang|zh|雞}}<br />fowl<br />
|-<br />
| 6 || ☵ || 010 || {{lang|zh|坎}}<br />''kǎn'' || ''the Abysmal'', [[gorge]] || water<br />{{lang|zh|水}}<br />
| north || second son || ear || dangerous || in-motion || {{lang|zh|豕}}<br />pig<br />
|-<br />
| 7 || ☶ || 001 || {{lang|zh|艮}}<br />''gèn'' || ''Keeping Still'', bound || mountain<br />{{lang|zh|山}} || northeast || third son || hand || resting, stand-still || completion || {{lang|zh|狗}}<br />wolf, dog<br />
|-<br />
| 8 || ☷ || 000 || {{lang|zh|坤}}<br />''kūn'' || ''the Receptive'', field || ground, earth<br />{{lang|zh|地}}<br />
| southwest || mother (consort) || belly || devoted, yielding || receptive || {{lang|zh|牛}}<br />cow<br />
|}<br />
<br />
===Hexagram lookup table===<br />
{| class="wikitable" style="text-align:center;"<br />
|-----<br />
| width="10%" ! style="background:LightYellow;" | Upper →<br />Lower ↓<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=乾}} Qián<br />[[File:Trigramme2630 ☰.svg]]<br />Heaven'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=坤}} Kūn<br />[[File:Trigramme2637 ☷.svg]]<br />Ground''', '''Earth'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=震}} Zhèn<br />[[File:Trigramme2633 ☳.svg]]<br />Thunder'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=坎}} Kǎn<br />[[File:Trigramme2635 ☵.svg]]<br />Water'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=艮}} Gèn<br />[[File:Trigramme2636 ☶.svg]]<br />Mountain'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|c=巽}} Xùn<br />[[File:Trigramme2634 ☴.svg]]<br />Wind''', '''Air'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|t=離}} Lí<br />[[File:Trigramme2632 ☲.svg]]<br />Flame''', '''Fire'''<br />
| valign="top" width="10%" ! style="background:Gold;" |'''{{zh|labels=no|t=兌}} Duì<br />[[File:Trigramme2631 ☱.svg]]<br />Lake'''<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=乾}} Qián<br />[[File:Trigramme2630 ☰.svg]]<br />Heaven'''<br />
| [[I Ching/Hexagram# 1|01]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 1|Force]] <br />
| [[I Ching/Hexagram# 11|11]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 11|Pervading]]<br />
| [[I Ching/Hexagram# 34|34]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 34|Great Invigorating]]<br />
| [[I Ching/Hexagram# 5|05]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 5|Attending]] <br />
| <br />[[I Ching/Hexagram# 26|26]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 26|Great <br />Accumulating]]<br />
| <br />[[I Ching/Hexagram# 9|09]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 9|Small <br />Harvest]]<br />
| <br />[[I Ching/Hexagram# 14|14]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 14|Great <br />Possessing]]<br />
| [[I Ching/Hexagram# 43|43]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[I Ching/Hexagram# 43|Displacement]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=坤}} Kūn<br />[[File:Trigramme2637 ☷.svg]]<br />Earth'''<br />
| [[I Ching/Hexagram# 12|12]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 12|Obstruction]]<br />
| [[I Ching/Hexagram# 2|02]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 2|Field]] <br /><br />
| [[I Ching/Hexagram# 16|16]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 16|Providing-For]]<br />
| [[I Ching/Hexagram# 8|08]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 8|Grouping]]<br />
| [[I Ching/Hexagram# 23|23]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 23|Stripping]]<br />
| [[I Ching/Hexagram# 20|20]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 20|Viewing]]<br />
| [[I Ching/Hexagram# 35|35]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 35|Prospering]]<br />
| [[I Ching/Hexagram# 45|45]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[I Ching/Hexagram# 45|Clustering]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=震}} Zhèn<br />[[File:Trigramme2633 ☳.svg]]<br />Thunder'''<br />
| [[I Ching/Hexagram# 25|25]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2633 ☳.svg]] <br /> [[I Ching/Hexagram# 25|Innocence]]<br />
| [[I Ching/Hexagram# 24|24]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 24|Returning]]<br />
| [[I Ching/Hexagram# 51|51]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 51|Shake]]<br />
| [[I Ching/Hexagram# 3|03]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 3|Sprouting]]<br />
| [[I Ching/Hexagram# 27|27]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 27|Swallowing]]<br />
| [[I Ching/Hexagram# 42|42]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 42|Augmenting]]<br />
| [[I Ching/Hexagram# 21|21]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 21|Gnawing Bite]]<br />
| [[I Ching/Hexagram# 17|17]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[I Ching/Hexagram# 17|Following]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=坎}} Kǎn<br />[[File:Trigramme2635 ☵.svg]]<br />Water'''<br />
| [[I Ching/Hexagram# 6|06]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 6|Arguing]]<br />
| [[I Ching/Hexagram# 7|07]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 7|Leading]]<br />
| [[I Ching/Hexagram# 40|40]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 40|Deliverance]]<br />
| [[I Ching/Hexagram# 29|29]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 29|Gorge]]<br />
| [[I Ching/Hexagram# 4|04]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 4|Enveloping]]<br />
| [[I Ching/Hexagram# 59|59]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 59|Dispersing]]<br />
| [[I Ching/Hexagram# 64|64]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 64|Before Completion]]<br />
| [[I Ching/Hexagram# 47|47]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[I Ching/Hexagram# 47|Confining]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=艮}} Gèn<br />[[File:Trigramme2636 ☶.svg]]<br />Mountain'''<br />
| [[I Ching/Hexagram# 33|33]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 33|Retiring]]<br />
| [[I Ching/Hexagram# 15|15]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 15|Humbling]]<br />
| [[I Ching/Hexagram# 62|62]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 62|Small Exceeding]]<br />
| [[I Ching/Hexagram# 39|39]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 39|Limping]]<br />
| [[I Ching/Hexagram# 52|52]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 52|Bound]]<br />
| [[I Ching/Hexagram# 53|53]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 53|Infiltrating]]<br />
| [[I Ching/Hexagram# 56|56]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 56|Sojourning]]<br />
| [[I Ching/Hexagram# 31|31]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[I Ching/Hexagram# 31|Conjoining]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=巽}} Xùn<br />[[File:Trigramme2634 ☴.svg]]<br />Wind'''<br />
| [[I Ching/Hexagram# 44|44]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 44|Coupling]]<br />
| [[I Ching/Hexagram# 46|46]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 46|Ascending]]<br />
| [[I Ching/Hexagram# 32|32]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 32|Persevering]]<br />
| [[I Ching/Hexagram# 48|48]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 48|Welling]]<br />
| [[I Ching/Hexagram# 18|18]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 18|Correcting]]<br />
| [[I Ching/Hexagram# 57|57]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 57|Ground]]<br />
| [[I Ching/Hexagram# 50|50]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 50|Holding]]<br />
| [[I Ching/Hexagram# 28|28]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[I Ching/Hexagram# 28|Great Exceeding]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=離}} Lí<br />[[File:Trigramme2632 ☲.svg]]<br />Flame'''<br />
| [[I Ching/Hexagram# 13|13]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 13|Concording<br />People]]<br />
| [[I Ching/Hexagram# 36|36]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 36|Intelligence<br />Hidden]]<br />
| [[I Ching/Hexagram# 55|55]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 55|Abounding]]<br />
| [[I Ching/Hexagram# 63|63]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 63|Already<br />Fording]]<br />
| [[I Ching/Hexagram# 22|22]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 22|Adorning]]<br />
| [[I Ching/Hexagram# 37|37]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 37|Dwelling<br />People]]<br />
| [[I Ching/Hexagram# 30|30]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 30|Radiance]]<br />
| [[I Ching/Hexagram# 49|49]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[I Ching/Hexagram# 49|Skinning]]<br />
|-<br />
! style="background:Pink;" |'''{{zh|labels=no|c=兌}} Duì<br />[[File:Trigramme2631 ☱.svg]]<br />Lake'''<br />
| [[I Ching/Hexagram# 10|10]]<br />[[File:Trigramme2630 ☰.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 10|Treading]]<br />
| [[I Ching/Hexagram# 19|19]]<br />[[File:Trigramme2637 ☷.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 19|Nearing]]<br />
| [[I Ching/Hexagram# 54|54]]<br />[[File:Trigramme2633 ☳.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 54|Converting the Maiden]]<br />
| [[I Ching/Hexagram# 60|60]]<br />[[File:Trigramme2635 ☵.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 60|Articulating]]<br />
| [[I Ching/Hexagram# 41|41]]<br />[[File:Trigramme2636 ☶.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 41|Diminishing]]<br />
| [[I Ching/Hexagram# 61|61]]<br />[[File:Trigramme2634 ☴.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 61|Inner Truth]]<br />
| [[I Ching/Hexagram# 38|38]]<br />[[File:Trigramme2632 ☲.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 38|Polarising]]<br />
| [[I Ching/Hexagram# 58|58]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[File:Trigramme2631 ☱.svg]]<br />[[I Ching/Hexagram# 58|Open]]<br />
|}</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Hexagram&diff=1923I Ching/Hexagram2021-06-23T14:25:28Z<p>Jawitkien: </p>
<hr />
<div>A '''hexagram''' in this context is a figure composed of six stacked horizontal lines ([[wikt:爻|爻]] yáo), where each line is either [[Yin and yang|Yang]] (an unbroken, or solid line), or [[Yin and yang|Yin]] (broken, an open line with a gap in the center). The hexagram lines are traditionally counted from the bottom up, so the lowest line is considered line one while the top line is line six. Hexagrams are formed by combining the original [[I Ching/Bagua|eight trigrams]] in different combinations. Each hexagram is accompanied with a description, often cryptic, akin to parables. Each line in every hexagram is also given a similar description.</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Hexagram&diff=1922I Ching/Hexagram2021-06-23T14:24:49Z<p>Jawitkien: Created page with "A '''hexagram''' in this context is a figure composed of six stacked horizontal lines (爻 yáo), where each line is either Yang (an unbroken, or..."</p>
<hr />
<div>A '''hexagram''' in this context is a figure composed of six stacked horizontal lines ([[wikt:爻|爻]] yáo), where each line is either [[Yin and yang|Yang]] (an unbroken, or solid line), or [[Yin and yang|Yin]] (broken, an open line with a gap in the center). The hexagram lines are traditionally counted from the bottom up, so the lowest line is considered line one while the top line is line six. Hexagrams are formed by combining the original [[Bagua|eight trigrams]] in different combinations. Each hexagram is accompanied with a description, often cryptic, akin to parables. Each line in every hexagram is also given a similar description.</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Table&diff=1921I Ching/Table2021-06-23T14:23:44Z<p>Jawitkien: </p>
<hr />
<div>{| style="margin: 0 0 1em 1em; border: 1px solid #aaaaaa; background: #f9f9f9;" align="center" cellpadding=0 cellspacing=0<br />
! style="padding: 0 5px 0 5px; background:#ccccff; text-align:center;" | [[I Ching]] [[I Ching/Hexagram|King Wen order for hexagrams]]<br />
|-<br />
| style="font-size: 100%; padding: 0 5px 0 5px; border-top: #aaa 1px solid;" |<br />
<br />
{| style="background:#f9f9f9;text-align:center;" width="480" border="0" colspan="16" |<br />
|- <br />
| [[I Ching/Hexagram#Hexagram 1|01 ䷀]]<br />
| [[I Ching/Hexagram#Hexagram 2|02 ䷁]]<br />
| [[I Ching/Hexagram#Hexagram 3|03 ䷂]]<br />
| [[I Ching/Hexagram#Hexagram 4|04 ䷃]]<br />
| [[I Ching/Hexagram#Hexagram 5|05 ䷄]]<br />
| [[I Ching/Hexagram#Hexagram 6|06 ䷅]]<br />
| [[I Ching/Hexagram#Hexagram 7|07 ䷆]]<br />
| [[I Ching/Hexagram#Hexagram 8|08 ䷇]]<br />
| [[I Ching/Hexagram#Hexagram 9|09 ䷈]]<br />
| [[I Ching/Hexagram#Hexagram 10|10 ䷉]]<br />
| [[I Ching/Hexagram#Hexagram 11|11 ䷊]]<br />
| [[I Ching/Hexagram#Hexagram 12|12 ䷋]]<br />
| [[I Ching/Hexagram#Hexagram 13|13 ䷌]]<br />
| [[I Ching/Hexagram#Hexagram 14|14 ䷍]]<br />
| [[I Ching/Hexagram#Hexagram 15|15 ䷎]]<br />
| [[I Ching/Hexagram#Hexagram 16|16 ䷏]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 17|17 ䷐]]<br />
| [[I Ching/Hexagram#Hexagram 18|18 ䷑]]<br />
| [[I Ching/Hexagram#Hexagram 19|19 ䷒]]<br />
| [[I Ching/Hexagram#Hexagram 20|20 ䷓]]<br />
| [[I Ching/Hexagram#Hexagram 21|21 ䷔]]<br />
| [[I Ching/Hexagram#Hexagram 22|22 ䷕]]<br />
| [[I Ching/Hexagram#Hexagram 23|23 ䷖]]<br />
| [[I Ching/Hexagram#Hexagram 24|24 ䷗]]<br />
| [[I Ching/Hexagram#Hexagram 25|25 ䷘]]<br />
| [[I Ching/Hexagram#Hexagram 26|26 ䷙]]<br />
| [[I Ching/Hexagram#Hexagram 27|27 ䷚]]<br />
| [[I Ching/Hexagram#Hexagram 28|28 ䷛]]<br />
| [[I Ching/Hexagram#Hexagram 29|29 ䷜]]<br />
| [[I Ching/Hexagram#Hexagram 30|30 ䷝]]<br />
| [[I Ching/Hexagram#Hexagram 31|31 ䷞]]<br />
| [[I Ching/Hexagram#Hexagram 32|32 ䷟]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 33|33 ䷠]]<br />
| [[I Ching/Hexagram#Hexagram 34|34 ䷡]]<br />
| [[I Ching/Hexagram#Hexagram 35|35 ䷢]]<br />
| [[I Ching/Hexagram#Hexagram 36|36 ䷣]]<br />
| [[I Ching/Hexagram#Hexagram 37|37 ䷤]]<br />
| [[I Ching/Hexagram#Hexagram 38|38 ䷥]]<br />
| [[I Ching/Hexagram#Hexagram 39|39 ䷦]]<br />
| [[I Ching/Hexagram#Hexagram 40|40 ䷧]]<br />
| [[I Ching/Hexagram#Hexagram 41|41 ䷨]]<br />
| [[I Ching/Hexagram#Hexagram 42|42 ䷩]]<br />
| [[I Ching/Hexagram#Hexagram 43|43 ䷪]]<br />
| [[I Ching/Hexagram#Hexagram 44|44 ䷫]]<br />
| [[I Ching/Hexagram#Hexagram 45|45 ䷬]]<br />
| [[I Ching/Hexagram#Hexagram 46|46 ䷭]]<br />
| [[I Ching/Hexagram#Hexagram 47|47 ䷮]]<br />
| [[I Ching/Hexagram#Hexagram 48|48 ䷯]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 49|49 ䷰]]<br />
| [[I Ching/Hexagram#Hexagram 50|50 ䷱]]<br />
| [[I Ching/Hexagram#Hexagram 51|51 ䷲]]<br />
| [[I Ching/Hexagram#Hexagram 52|52 ䷳]]<br />
| [[I Ching/Hexagram#Hexagram 53|53 ䷴]]<br />
| [[I Ching/Hexagram#Hexagram 54|54 ䷵]]<br />
| [[I Ching/Hexagram#Hexagram 55|55 ䷶]]<br />
| [[I Ching/Hexagram#Hexagram 56|56 ䷷]]<br />
| [[I Ching/Hexagram#Hexagram 57|57 ䷸]]<br />
| [[I Ching/Hexagram#Hexagram 58|58 ䷹]]<br />
| [[I Ching/Hexagram#Hexagram 59|59 ䷺]]<br />
| [[I Ching/Hexagram#Hexagram 60|60 ䷻]]<br />
| [[I Ching/Hexagram#Hexagram 61|61 ䷼]]<br />
| [[I Ching/Hexagram#Hexagram 62|62 ䷽]]<br />
| [[I Ching/Hexagram#Hexagram 63|63 ䷾]]<br />
| [[I Ching/Hexagram#Hexagram 64|64 ䷿]]<br />
|}<br />
|}</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Table&diff=1920I Ching/Table2021-06-23T14:22:05Z<p>Jawitkien: </p>
<hr />
<div>{| style="margin: 0 0 1em 1em; border: 1px solid #aaaaaa; background: #f9f9f9;" align="center" cellpadding=0 cellspacing=0<br />
! style="padding: 0 5px 0 5px; background:#ccccff; text-align:center;" | [[I Ching]] [[I Ching/Hexagram|hexagrams]]<br />
|-<br />
| style="font-size: 100%; padding: 0 5px 0 5px; border-top: #aaa 1px solid;" |<br />
<br />
{| style="background:#f9f9f9;text-align:center;" width="480" border="0" colspan="16" |<br />
|- <br />
| [[I Ching/Hexagram#Hexagram 1|01 ䷀]]<br />
| [[I Ching/Hexagram#Hexagram 2|02 ䷁]]<br />
| [[I Ching/Hexagram#Hexagram 3|03 ䷂]]<br />
| [[I Ching/Hexagram#Hexagram 4|04 ䷃]]<br />
| [[I Ching/Hexagram#Hexagram 5|05 ䷄]]<br />
| [[I Ching/Hexagram#Hexagram 6|06 ䷅]]<br />
| [[I Ching/Hexagram#Hexagram 7|07 ䷆]]<br />
| [[I Ching/Hexagram#Hexagram 8|08 ䷇]]<br />
| [[I Ching/Hexagram#Hexagram 9|09 ䷈]]<br />
| [[I Ching/Hexagram#Hexagram 10|10 ䷉]]<br />
| [[I Ching/Hexagram#Hexagram 11|11 ䷊]]<br />
| [[I Ching/Hexagram#Hexagram 12|12 ䷋]]<br />
| [[I Ching/Hexagram#Hexagram 13|13 ䷌]]<br />
| [[I Ching/Hexagram#Hexagram 14|14 ䷍]]<br />
| [[I Ching/Hexagram#Hexagram 15|15 ䷎]]<br />
| [[I Ching/Hexagram#Hexagram 16|16 ䷏]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 17|17 ䷐]]<br />
| [[I Ching/Hexagram#Hexagram 18|18 ䷑]]<br />
| [[I Ching/Hexagram#Hexagram 19|19 ䷒]]<br />
| [[I Ching/Hexagram#Hexagram 20|20 ䷓]]<br />
| [[I Ching/Hexagram#Hexagram 21|21 ䷔]]<br />
| [[I Ching/Hexagram#Hexagram 22|22 ䷕]]<br />
| [[I Ching/Hexagram#Hexagram 23|23 ䷖]]<br />
| [[I Ching/Hexagram#Hexagram 24|24 ䷗]]<br />
| [[I Ching/Hexagram#Hexagram 25|25 ䷘]]<br />
| [[I Ching/Hexagram#Hexagram 26|26 ䷙]]<br />
| [[I Ching/Hexagram#Hexagram 27|27 ䷚]]<br />
| [[I Ching/Hexagram#Hexagram 28|28 ䷛]]<br />
| [[I Ching/Hexagram#Hexagram 29|29 ䷜]]<br />
| [[I Ching/Hexagram#Hexagram 30|30 ䷝]]<br />
| [[I Ching/Hexagram#Hexagram 31|31 ䷞]]<br />
| [[I Ching/Hexagram#Hexagram 32|32 ䷟]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 33|33 ䷠]]<br />
| [[I Ching/Hexagram#Hexagram 34|34 ䷡]]<br />
| [[I Ching/Hexagram#Hexagram 35|35 ䷢]]<br />
| [[I Ching/Hexagram#Hexagram 36|36 ䷣]]<br />
| [[I Ching/Hexagram#Hexagram 37|37 ䷤]]<br />
| [[I Ching/Hexagram#Hexagram 38|38 ䷥]]<br />
| [[I Ching/Hexagram#Hexagram 39|39 ䷦]]<br />
| [[I Ching/Hexagram#Hexagram 40|40 ䷧]]<br />
| [[I Ching/Hexagram#Hexagram 41|41 ䷨]]<br />
| [[I Ching/Hexagram#Hexagram 42|42 ䷩]]<br />
| [[I Ching/Hexagram#Hexagram 43|43 ䷪]]<br />
| [[I Ching/Hexagram#Hexagram 44|44 ䷫]]<br />
| [[I Ching/Hexagram#Hexagram 45|45 ䷬]]<br />
| [[I Ching/Hexagram#Hexagram 46|46 ䷭]]<br />
| [[I Ching/Hexagram#Hexagram 47|47 ䷮]]<br />
| [[I Ching/Hexagram#Hexagram 48|48 ䷯]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 49|49 ䷰]]<br />
| [[I Ching/Hexagram#Hexagram 50|50 ䷱]]<br />
| [[I Ching/Hexagram#Hexagram 51|51 ䷲]]<br />
| [[I Ching/Hexagram#Hexagram 52|52 ䷳]]<br />
| [[I Ching/Hexagram#Hexagram 53|53 ䷴]]<br />
| [[I Ching/Hexagram#Hexagram 54|54 ䷵]]<br />
| [[I Ching/Hexagram#Hexagram 55|55 ䷶]]<br />
| [[I Ching/Hexagram#Hexagram 56|56 ䷷]]<br />
| [[I Ching/Hexagram#Hexagram 57|57 ䷸]]<br />
| [[I Ching/Hexagram#Hexagram 58|58 ䷹]]<br />
| [[I Ching/Hexagram#Hexagram 59|59 ䷺]]<br />
| [[I Ching/Hexagram#Hexagram 60|60 ䷻]]<br />
| [[I Ching/Hexagram#Hexagram 61|61 ䷼]]<br />
| [[I Ching/Hexagram#Hexagram 62|62 ䷽]]<br />
| [[I Ching/Hexagram#Hexagram 63|63 ䷾]]<br />
| [[I Ching/Hexagram#Hexagram 64|64 ䷿]]<br />
|}<br />
|}</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I_Ching/Table&diff=1919I Ching/Table2021-06-23T14:21:09Z<p>Jawitkien: Created page with "{| style="margin: 0 0 1em 1em; border: 1px solid #aaaaaa; background: #f9f9f9;" align="center" cellpadding=0 cellspacing=0 ! style="padding: 0 5px 0 5px; background:#ccccff; t..."</p>
<hr />
<div>{| style="margin: 0 0 1em 1em; border: 1px solid #aaaaaa; background: #f9f9f9;" align="center" cellpadding=0 cellspacing=0<br />
! style="padding: 0 5px 0 5px; background:#ccccff; text-align:center;" | [[I Ching]] [[Hexagram (I Ching)|hexagrams]]<br />
|-<br />
| style="font-size: 100%; padding: 0 5px 0 5px; border-top: #aaa 1px solid;" |<br />
<br />
{| style="background:#f9f9f9;text-align:center;" width="480" border="0" colspan="16" |<br />
|- <br />
| [[I Ching/Hexagram#Hexagram 1|01 ䷀]]<br />
| [[I Ching/Hexagram#Hexagram 2|02 ䷁]]<br />
| [[I Ching/Hexagram#Hexagram 3|03 ䷂]]<br />
| [[I Ching/Hexagram#Hexagram 4|04 ䷃]]<br />
| [[I Ching/Hexagram#Hexagram 5|05 ䷄]]<br />
| [[I Ching/Hexagram#Hexagram 6|06 ䷅]]<br />
| [[I Ching/Hexagram#Hexagram 7|07 ䷆]]<br />
| [[I Ching/Hexagram#Hexagram 8|08 ䷇]]<br />
| [[I Ching/Hexagram#Hexagram 9|09 ䷈]]<br />
| [[I Ching/Hexagram#Hexagram 10|10 ䷉]]<br />
| [[I Ching/Hexagram#Hexagram 11|11 ䷊]]<br />
| [[I Ching/Hexagram#Hexagram 12|12 ䷋]]<br />
| [[I Ching/Hexagram#Hexagram 13|13 ䷌]]<br />
| [[I Ching/Hexagram#Hexagram 14|14 ䷍]]<br />
| [[I Ching/Hexagram#Hexagram 15|15 ䷎]]<br />
| [[I Ching/Hexagram#Hexagram 16|16 ䷏]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 17|17 ䷐]]<br />
| [[I Ching/Hexagram#Hexagram 18|18 ䷑]]<br />
| [[I Ching/Hexagram#Hexagram 19|19 ䷒]]<br />
| [[I Ching/Hexagram#Hexagram 20|20 ䷓]]<br />
| [[I Ching/Hexagram#Hexagram 21|21 ䷔]]<br />
| [[I Ching/Hexagram#Hexagram 22|22 ䷕]]<br />
| [[I Ching/Hexagram#Hexagram 23|23 ䷖]]<br />
| [[I Ching/Hexagram#Hexagram 24|24 ䷗]]<br />
| [[I Ching/Hexagram#Hexagram 25|25 ䷘]]<br />
| [[I Ching/Hexagram#Hexagram 26|26 ䷙]]<br />
| [[I Ching/Hexagram#Hexagram 27|27 ䷚]]<br />
| [[I Ching/Hexagram#Hexagram 28|28 ䷛]]<br />
| [[I Ching/Hexagram#Hexagram 29|29 ䷜]]<br />
| [[I Ching/Hexagram#Hexagram 30|30 ䷝]]<br />
| [[I Ching/Hexagram#Hexagram 31|31 ䷞]]<br />
| [[I Ching/Hexagram#Hexagram 32|32 ䷟]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 33|33 ䷠]]<br />
| [[I Ching/Hexagram#Hexagram 34|34 ䷡]]<br />
| [[I Ching/Hexagram#Hexagram 35|35 ䷢]]<br />
| [[I Ching/Hexagram#Hexagram 36|36 ䷣]]<br />
| [[I Ching/Hexagram#Hexagram 37|37 ䷤]]<br />
| [[I Ching/Hexagram#Hexagram 38|38 ䷥]]<br />
| [[I Ching/Hexagram#Hexagram 39|39 ䷦]]<br />
| [[I Ching/Hexagram#Hexagram 40|40 ䷧]]<br />
| [[I Ching/Hexagram#Hexagram 41|41 ䷨]]<br />
| [[I Ching/Hexagram#Hexagram 42|42 ䷩]]<br />
| [[I Ching/Hexagram#Hexagram 43|43 ䷪]]<br />
| [[I Ching/Hexagram#Hexagram 44|44 ䷫]]<br />
| [[I Ching/Hexagram#Hexagram 45|45 ䷬]]<br />
| [[I Ching/Hexagram#Hexagram 46|46 ䷭]]<br />
| [[I Ching/Hexagram#Hexagram 47|47 ䷮]]<br />
| [[I Ching/Hexagram#Hexagram 48|48 ䷯]]<br />
|-<br />
| [[I Ching/Hexagram#Hexagram 49|49 ䷰]]<br />
| [[I Ching/Hexagram#Hexagram 50|50 ䷱]]<br />
| [[I Ching/Hexagram#Hexagram 51|51 ䷲]]<br />
| [[I Ching/Hexagram#Hexagram 52|52 ䷳]]<br />
| [[I Ching/Hexagram#Hexagram 53|53 ䷴]]<br />
| [[I Ching/Hexagram#Hexagram 54|54 ䷵]]<br />
| [[I Ching/Hexagram#Hexagram 55|55 ䷶]]<br />
| [[I Ching/Hexagram#Hexagram 56|56 ䷷]]<br />
| [[I Ching/Hexagram#Hexagram 57|57 ䷸]]<br />
| [[I Ching/Hexagram#Hexagram 58|58 ䷹]]<br />
| [[I Ching/Hexagram#Hexagram 59|59 ䷺]]<br />
| [[I Ching/Hexagram#Hexagram 60|60 ䷻]]<br />
| [[I Ching/Hexagram#Hexagram 61|61 ䷼]]<br />
| [[I Ching/Hexagram#Hexagram 62|62 ䷽]]<br />
| [[I Ching/Hexagram#Hexagram 63|63 ䷾]]<br />
| [[I Ching/Hexagram#Hexagram 64|64 ䷿]]<br />
|}<br />
|}</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I-Ching&diff=1918I-Ching2021-06-23T14:19:30Z<p>Jawitkien: </p>
<hr />
<div>{{short description|Wikimedia list article}}<br />
__NOTOC__<br />
{{DISPLAYTITLE:List of hexagrams of the ''I Ching''}}<br />
This is a list of the 64 '''[[Hexagram (I Ching)|hexagrams]]''' of the '''''[[I Ching]]''''', or ''Book of Changes'', and their [[Template:Unicode chart Yijing Hexagram Symbols|Unicode character codes]].<br />
<br />
This list is in [[King Wen sequence|King Wen order]]. (Cf. [[King Wen sequence#Other hexagram sequences|other hexagram sequences]].)<br />
<br />
{{:I Ching/Table}}<br />
<br />
== Hexagram 1 ==<br />
<br />
[[image:iching-hexagram-01.svg|right]]<br />
<br />
''Hexagram 1'' is named {{lang|zh|乾}} (qián), "Force". Other variations include "the creative", "strong action", "the key", and "god". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is the same.<br />
<br />
{{charmap|name1=Hexagram for the Creative Heaven|1=4DC0|IncludeGB=no}}<!-- Note: setting IncludeGB to yes throughout breaks the page with “Node-count limit exceeded” errors --><br />
<br />
== Hexagram 2 ==<br />
<br />
[[image:iching-hexagram-02.svg|right]]<br />
<br />
''Hexagram 2'' is named {{lang|zh|坤}} (kūn), "Field". Other variations include "the receptive", "acquiescence", and "the flow". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is identical.<br />
<br />
{{charmap|name1=Hexagram for the Receptive Earth|1=4DC1|IncludeGB=no}}<br />
<br />
== Hexagram 3 ==<br />
<br />
[[image:iching-hexagram-03.svg|right]]<br />
<br />
''Hexagram 3'' is named {{lang|zh|屯}} (zhūn), "Sprouting". Other variations include "difficulty at the beginning", "gathering support", and "hoarding". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Difficulty at the Beginning|1=4DC2|IncludeGB=no}}<br />
<br />
== Hexagram 4 ==<br />
<br />
[[image:iching-hexagram-04.svg|right]]<br />
<br />
''Hexagram 4'' is named {{lang|zh|蒙}} (méng), "Enveloping". Other variations include "youthful folly", "the young shoot", and "discovering". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water. Its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Youthful Folly|1=4DC3|IncludeGB=no}}<br />
<br />
== Hexagram 5 ==<br />
<br />
[[image:iching-hexagram-05.svg|right]]<br />
<br />
''Hexagram 5'' is named {{lang|zh|需}} (xū), "Attending". Other variations include "waiting", "moistened", and "arriving". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Waiting|1=4DC4|IncludeGB=no}}<br />
<br />
== Hexagram 6 ==<br />
<br />
[[image:iching-hexagram-06.svg|right]]<br />
<br />
''Hexagram 6'' is named {{lang|zh|訟}} (sòng), "Arguing". Other variations include "conflict" and "lawsuit". Its inner (lower) [[Ba gua|trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Conflict|1=4DC5|IncludeGB=no}}<br />
<br />
== Hexagram 7 ==<br />
<br />
[[image:iching-hexagram-07.svg|right]]<br />
<br />
''Hexagram 7'' is named {{lang|zh|師}} (shī), "Leading". Other variations include "the army" and "the troops". Its inner (lower) [[Ba gua|trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[水]]}}) water, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for the Army|1=4DC6|IncludeGB=no}}<br />
<br />
== Hexagram 8 ==<br />
<br />
[[image:iching-hexagram-08.svg|right]]<br />
<br />
''Hexagram 8'' is named {{lang|zh|比}} (bǐ), "Grouping". Other variations include "holding together" and "alliance". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Holding Together|1=4DC7|IncludeGB=no}}<br />
<br />
== Hexagram 9 ==<br />
<br />
[[image:iching-hexagram-09.svg|right]]<br />
<br />
''Hexagram 9'' is named {{lang|zh|小畜}} (xiǎo xù), "Small Accumulating". Other variations include "the taming power of the small" and "small harvest". Its inner (lower) trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Small Taming|1=4DC8|IncludeGB=no}}<br />
<br />
== Hexagram 10 ==<br />
<br />
[[image:iching-hexagram-10.svg|right]]<br />
<br />
''Hexagram 10'' is named {{lang|zh|履}} (lǚ), "Treading". Other variations include "treading (conduct)" and "continuing". Its inner (lower) [[Ba gua|trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|[[澤]]}}) swamp, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Treading|1=4DC9|IncludeGB=no}}<br />
<br />
== Hexagram 11 ==<br />
<br />
[[image:iching-hexagram-11.svg|right]]<br />
<br />
''Hexagram 11'' is named {{lang|zh|泰}} (tài), "Pervading". Other variations include "peace" and "greatness". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Peace|1=4DCA|IncludeGB=no}}<br />
== Hexagram 12 ==<br />
<br />
[[image:iching-hexagram-12.svg|right]]<br />
<br />
''Hexagram 12'' is named {{lang|zh|否}} (pǐ), "Obstruction". Other variations include "standstill (stagnation)" and "selfish persons". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Standstill|1=4DCB|IncludeGB=no}}<br />
<br />
== Hexagram 13 ==<br />
<br />
[[image:iching-hexagram-13.svg|right]]<br />
<br />
''Hexagram 13'' is named {{lang|zh|同人}} (tóng rén), "Concording People". Other variations include "fellowship with men" and "gathering men". Its inner (lower) [[Ba gua|trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Fellowship|1=4DCC|IncludeGB=no}}<br />
<br />
== Hexagram 14 ==<br />
<br />
[[image:iching-hexagram-14.svg|right]]<br />
<br />
''Hexagram 14'' is named {{lang|zh|大有}} (dà yǒu), "Great Possessing". Other variations include "possession in great measure" and "the great possession". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Great Possession|1=4DCD|IncludeGB=no}}<br />
<br />
== Hexagram 15 ==<br />
<br />
[[image:iching-hexagram-15.svg|right]]<br />
<br />
''Hexagram 15'' is named {{lang|zh|謙}} (qiān), "Humbling". Other variations include "modesty". Its inner (lower) [[Ba gua|trigram]] is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Modesty|1=4DCE|IncludeGB=no}}<br />
<br />
== Hexagram 16 ==<br />
<br />
[[image:iching-hexagram-16.svg|right]]<br />
<br />
''Hexagram 16'' is named {{lang|zh|豫}} (yù), "Providing-For". Other variations include "enthusiasm" and "excess". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Enthusiasm|1=4DCF|IncludeGB=no}}<br />
<br />
== Hexagram 17 ==<br />
<br />
[[image:iching-hexagram-17.svg|right]]<br />
<br />
''Hexagram 17'' is named {{lang|zh|隨}} (suí), "Following". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer (upper) [[trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{linktext|lang=zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Following|1=4DD0|IncludeGB=no}}<br />
<br />
== Hexagram 18 ==<br />
<br />
[[image:iching-hexagram-18.svg|right]]<br />
<br />
''Hexagram 18'' is named {{lang|zh|蠱}} (gǔ), "Correcting". Other variations include "work on what has been spoiled (decay)", ''decaying'' and "branch".<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2001<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot's+guide+to+I+Ching+%22Yu%22<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref> Its inner (lower) [[Ba gua|trigram]] is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind, and its outer (upper) trigram is ☶ ({{lang|zh|艮 gèn}}) bound = ({{lang|zh|[[山]]}}) mountain. ''[[Gu (poison)|Gu]]'' is the name of a venom-based poison traditionally used in Chinese witchcraft.<br />
<br />
{{charmap|name1=Hexagram for Work on the Decayed|1=4DD1|IncludeGB=no}}<br />
<br />
== Hexagram 19 ==<br />
<br />
[[image:iching-hexagram-19.svg|right]]<br />
<br />
''Hexagram 19'' is named {{lang|zh|臨}} (lín), "Nearing". Other variations include "approach" and "the forest". Its inner (lower) [[Ba gua|trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Approach|1=4DD2|IncludeGB=no}}<br />
<br />
== Hexagram 20 ==<br />
<br />
[[image:iching-hexagram-20.svg|right]]<br />
<br />
''Hexagram 20'' is named {{lang|zh|觀}} (guān), "Viewing". Other variations include "contemplation (view)" and "looking up". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Contemplation|1=4DD3|IncludeGB=no}}<br />
== Hexagram 21 ==<br />
<br />
[[image:iching-hexagram-21.svg|right]]<br />
<br />
''Hexagram 21'' is named {{lang|zh|噬嗑}} (shì kè), "Gnawing Bite". Other variations include "biting through" and "biting and chewing". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2002<br />
| publisher = Alpha (Pearson)<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot%27s+guide+to+I+Ching+%22Shi+He%22+%22Gnawing%22&pg=PA128<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref><br />
{{charmap|name1=Hexagram for Biting Through|1=4DD4|IncludeGB=no}}<br />
== Hexagram 22 ==<br />
<br />
[[image:iching-hexagram-22.svg|right]]<br />
<br />
''Hexagram 22'' is named {{lang|zh|賁}} (bì), "Adorning". Other variations include "grace" and "luxuriance". Its inner (lower) [[bagua|trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer (upper) [[trigram]] is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2002<br />
| publisher = Alpha (Pearson)<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot%27s+guide+to+I+Ching+%22Bi%22+%22Adorning%22&pg=PA130<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref><br />
<br />
{{charmap|name1=Hexagram for Grace|1=4DD5|IncludeGB=no}}<br />
<br />
== Hexagram 23 ==<br />
<br />
[[image:iching-hexagram-23.svg|right]]<br />
<br />
''Hexagram 23'' is named {{lang|zh|剝}} (bō), "Stripping". Other variations include "splitting apart" and "flaying". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Splitting Apart|1=4DD6|IncludeGB=no}}<br />
<br />
== Hexagram 24 ==<br />
<br />
[[image:iching-hexagram-24.svg|right]]<br />
<br />
''Hexagram 24'' is named {{lang|zh|復}} (fù), "Returning". Other variations include "return (the turning point)". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Return|1=4DD7|IncludeGB=no}}<br />
<br />
== Hexagram 25 ==<br />
<br />
[[image:iching-hexagram-25.svg|right]]<br />
<br />
''Hexagram 25'' is named {{lang|zh|無妄}} (wú wàng), "Without Embroiling". Other variations include "innocence (the unexpected)" and "pestilence". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Innocence|1=4DD8|IncludeGB=no}}<br />
== Hexagram 26 ==<br />
<br />
[[image:iching-hexagram-26.svg|right]]<br />
<br />
''Hexagram 26'' is named {{lang|zh|大畜}} (dà xù), "Great Accumulating". Other variations include "the taming power of the great", "great storage", and "potential energy". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Great Taming|1=4DD9|IncludeGB=no}}<br />
<br />
== Hexagram 27 ==<br />
<br />
[[image:iching-hexagram-27.svg|right]]<br />
<br />
''Hexagram 27'' is named {{lang|zh|頤}} (yí), "Swallowing". Other variations include "the corners of the mouth (providing nourishment)", "jaws" and "comfort/security". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Mouth Corners|1=4DDA|IncludeGB=no}}<br />
<br />
== Hexagram 28 ==<br />
<br />
[[image:iching-hexagram-28.svg|right]]<br />
<br />
''Hexagram 28'' is named {{lang|zh|大過}} (dà guò), "Great Exceeding". Other variations include "preponderance of the great", "great surpassing" and "critical mass". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Great Preponderance|1=4DDB|IncludeGB=no}}<br />
<br />
== Hexagram 29 ==<br />
<br />
[[image:iching-hexagram-29.svg|right]]<br />
<br />
''Hexagram 29'' is named {{lang|zh|坎}} (kǎn), "Gorge". Other variations include "the [[Abyssal zone|abyss]]" (in the oceanographic sense) and "repeated entrapment". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is identical.<br />
<br />
{{charmap|name1=Hexagram for the Abysmal Water|1=4DDC|IncludeGB=no}}<br />
== Hexagram 30 ==<br />
<br />
[[image:iching-hexagram-30.svg|right]]<br />
<br />
''Hexagram 30'' is named {{lang|zh|離}} (lí), "Radiance". Other variations include "the clinging, fire" and "the net". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is identical. The origin of the character has its roots in symbols of long-tailed birds such as the [[peacock]] or the legendary [[phoenix (mythology)|phoenix]].<br />
<br />
{{charmap|name1=Hexagram for the Clinging Fire|1=4DDD|IncludeGB=no}}<br />
<br />
== Hexagram 31 ==<br />
<br />
[[image:iching-hexagram-31.svg|right]]<br />
<br />
''Hexagram 31'' is named {{lang|zh|咸}} (xián), "Conjoining". Other variations include "influence (wooing)" and "feelings". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Influence|1=4DDE|IncludeGB=no}}<br />
<br />
== Hexagram 32 ==<br />
<br />
[[image:iching-hexagram-32.svg|right]]<br />
<br />
''Hexagram 32'' is named {{lang|zh|恆}} (héng), "Persevering". Other variations include "duration" and "constancy". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Duration|1=4DDF|IncludeGB=no}}<br />
<br />
== Hexagram 33 ==<br />
<br />
[[image:iching-hexagram-33.svg|right]]<br />
<br />
''Hexagram 33'' is named {{lang|zh|遯}} (dùn), "Retiring". Other variations include "retreat" and "yielding". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Retreat|1=4DE0|IncludeGB=no}}<br />
== Hexagram 34 ==<br />
<br />
[[image:iching-hexagram-34.svg|right]]<br />
<br />
''Hexagram 34'' is named {{lang|zh|大壯}} (dà zhuàng), "Great Invigorating". Other variations include "the power of the great" and "great maturity". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{lang|zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Great Power|1=4DE1|IncludeGB=no}}<br />
<br />
== Hexagram 35 ==<br />
<br />
[[image:iching-hexagram-35.svg|right]]<br />
<br />
''Hexagram 35'' is named {{lang|zh|晉}} (jìn), "Prospering". Other variations include "progress" and "aquas". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Progress|1=4DE2|IncludeGB=no}}<br />
<br />
== Hexagram 36 ==<br />
<br />
[[image:iching-hexagram-36.svg|right]]<br />
<br />
''Hexagram 36'' is named {{lang|zh|明夷}} (míng yí), "Darkening of the Light". Other variations include "brilliance injured" and "intelligence hidden". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Darkening of the Light|1=4DE3|IncludeGB=no}}<br />
<br />
== Hexagram 37 ==<br />
<br />
[[image:iching-hexagram-37.svg|right]]<br />
<br />
''Hexagram 37'' is named {{lang|zh|家人}} (jiā rén), "Dwelling People". Other variations include "the family (the clan)" and "family members". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for the Family|1=4DE4|IncludeGB=no}}<br />
<br />
== Hexagram 38 ==<br />
<br />
[[image:iching-hexagram-38.svg|right]]<br />
<br />
''Hexagram 38'' is named {{lang|zh|睽}} (kuí), "Polarising". Other variations include "opposition" and "perversion". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Opposition|1=4DE5|IncludeGB=no}}<br />
<br />
== Hexagram 39 ==<br />
<br />
[[image:iching-hexagram-39.svg|right]]<br />
<br />
''Hexagram 39'' is named {{lang|zh|蹇}} (jiǎn), "Limping". Other variations include "obstruction" and "afoot". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for Obstruction|1=4DE6|IncludeGB=no}}<br />
<br />
== Hexagram 40 ==<br />
<br />
[[image:iching-hexagram-40.svg|right]]<br />
<br />
''Hexagram 40'' is named {{lang|zh|解}} (xiè), "Taking-Apart". Other variations include "deliverance" and "untangled". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Deliverance|1=4DE7|IncludeGB=no}}<br />
<br />
== Hexagram 41 ==<br />
[[File:Iching-hexagram-41.png|alt=|right|I ching 41- diminishing, {{lang|zh|山泽损}}]]<br />
''Hexagram 41'' is named {{lang|zh|損}} (sǔn), "Diminishing". Other variations include "decrease". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Decrease|1=4DE8|IncludeGB=no}}<br />
== Hexagram 42 ==<br />
<br />
[[image:iching-hexagram-42.svg|right]]<br />
<br />
''Hexagram 42'' is named {{lang|zh|益}} (yì), "Augmenting". Other variations include "increase". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Increase|1=4DE9|IncludeGB=no}}<br />
<br />
== Hexagram 43 ==<br />
<br />
[[image:iching-hexagram-43.svg|right]]<br />
<br />
''Hexagram 43'' is named {{lang|zh|夬}} (guài), "Displacement". Other variations include "resoluteness", "parting", and "break-through". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Breakthrough|1=4DEA|IncludeGB=no}}<br />
<br />
== Hexagram 44 ==<br />
<br />
[[image:iching-hexagram-44.svg|right]]<br />
<br />
''Hexagram 44'' is named {{lang|zh|姤}} (gòu), "Coupling". Other variations include "coming to meet" and "meeting". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Coming to Meet|1=4DEB|IncludeGB=no}}<br />
<br />
== Hexagram 45 ==<br />
<br />
[[image:iching-hexagram-45.svg|right]]<br />
<br />
''Hexagram 45'' is named {{lang|zh|萃}} (cuì), "Clustering". Other variations include "gathering together (massing)" and "finished". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Gathering Together|1=4DEC|IncludeGB=no}}<br />
<br />
== Hexagram 46 ==<br />
<br />
[[image:iching-hexagram-46.svg|right]]<br />
<br />
''Hexagram 46'' is named {{lang|zh|升}} (shēng), "Ascending". Other variations include "pushing upward". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Pushing Upward|1=4DED|IncludeGB=no}}<br />
<br />
== Hexagram 47 ==<br />
<br />
[[image:iching-hexagram-47.svg|right]]<br />
<br />
''Hexagram 47'' is named {{lang|zh|困}} (kùn), "Confining". Other variations include "oppression (exhaustion)" and "entangled". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Oppression|1=4DEE|IncludeGB=no}}<br />
<br />
== Hexagram 48 ==<br />
<br />
[[image:iching-hexagram-48.svg|right]]<br />
<br />
''Hexagram 48'' is named {{lang|zh|井}} (jǐng), "Welling". Other variations include "the well". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for the Well|1=4DEF|IncludeGB=no}}<br />
<br />
== Hexagram 49 ==<br />
<br />
[[image:iching-hexagram-49.svg|right]]<br />
<br />
''Hexagram 49'' is named {{lang|zh|革}} (gé), "Skinning". Other variations include "revolution (molting)" and "the bridle". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Revolution|1=4DF0|IncludeGB=no}}<br />
<br />
== Hexagram 50 ==<br />
<br />
[[image:iching-hexagram-50.svg|right]]<br />
<br />
''Hexagram 50'' is named {{lang|zh|鼎}} (dǐng), "Holding". Other variations include "the cauldron". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for the Cauldron|1=4DF1|IncludeGB=no}}<br />
<br />
== Hexagram 51 ==<br />
<br />
[[image:iching-hexagram-51.svg|right]]<br />
<br />
''Hexagram 51'' is named {{lang|zh|震}} (zhèn), "Shake". Other variations include "the arousing (shock, thunder)" and "thunder". Both its inner and outer trigrams are ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for the Arousing Thunder|1=4DF2|IncludeGB=no}}<br />
<br />
== Hexagram 52 ==<br />
<br />
[[image:iching-hexagram-52.svg|right]]<br />
<br />
''Hexagram 52'' is named {{lang|zh|艮}} (gèn), "Bound". Other variations include "keeping still, mountain" and "stilling". Both its inner and outer trigrams are ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for the Keeping Still Mountain|1=4DF3|IncludeGB=no}}<br />
<br />
== Hexagram 53 ==<br />
<br />
[[image:iching-hexagram-53.svg|right]]<br />
<br />
''Hexagram 53'' is named {{lang|zh|漸}} (jiàn), "Infiltrating". Other variations include "development (gradual progress)" and "advancement". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Development|1=4DF4|IncludeGB=no}}<br />
<br />
== Hexagram 54 ==<br />
<br />
[[image:iching-hexagram-54.svg|right]]<br />
<br />
''Hexagram 54'' is named {{lang|zh|歸妹}} (guī mèi), "Converting the Maiden". Other variations include "the marrying maiden" and "returning maiden". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for the Marrying Maiden|1=4DF5|IncludeGB=no}}<br />
<br />
== Hexagram 55 ==<br />
<br />
[[image:iching-hexagram-55.svg|right]]<br />
<br />
''Hexagram 55'' is named {{lang|zh|豐}} (fēng), "Abounding". Other variations include "abundance" and "fullness". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Water (Wu Xing)|火]]}}) fire, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Abundance|1=4DF6|IncludeGB=no}}<br />
<br />
== Hexagram 56 ==<br />
<br />
[[image:iching-hexagram-56.svg|right]]<br />
<br />
''Hexagram 56'' is named {{lang|zh|旅}} (lǚ), "Sojourning". Other variations include "the wanderer" and "traveling". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for the Wanderer|1=4DF7|IncludeGB=no}}<br />
<br />
== Hexagram 57 ==<br />
<br />
[[image:iching-hexagram-57.svg|right]]<br />
<br />
''Hexagram 57'' is named {{linktext|lang=zh|巽}} (xùn), "Ground". Other variations include "the gentle (the penetrating, wind)" and "calculations". Both its inner and outer trigrams are ☴ ({{linktext|lang=zh|巽}} xùn) ground = ({{linktext|lang=zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for the Gentle Wind|1=4DF8|IncludeGB=no}}<br />
<br />
== Hexagram 58 ==<br />
<br />
[[image:iching-hexagram-58.svg|right]]<br />
<br />
''Hexagram 58'' is named {{lang|zh|兌}} (duì), "Open". Other variations include "the joyous, lake" and "usurpation". Both its inner and outer trigrams are ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for the Joyous Lake|1=4DF9|IncludeGB=no}}<br />
== Hexagram 59 ==<br />
<br />
[[image:iching-hexagram-59.svg|right]]<br />
<br />
''Hexagram 59'' is named {{lang|zh|渙}} (huàn), "Dispersing". Other variations include "dispersion (dissolution)" and "dispersal". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Dispersion|1=4DFA|IncludeGB=no}}<br />
<br />
== Hexagram 60 ==<br />
<br />
[[image:iching-hexagram-60.svg|right]]<br />
<br />
''Hexagram 60'' is named {{lang|zh|節}} (jié), "Articulating". Other variations include "limitation" and "moderation". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for Limitation|1=4DFB|IncludeGB=no}}<br />
<br />
== Hexagram 61 ==<br />
<br />
[[image:iching-hexagram-61.svg|right]]<br />
<br />
''Hexagram 61'' is named {{lang|zh|中孚}} (zhōng fú), "Center Returning". Other variations include "inner truth" and "central return". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{linktext|lang=zh|澤}}) swamp, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Inner Truth|1=4DFC|IncludeGB=no}}<br />
== Hexagram 62 ==<br />
<br />
[[image:iching-hexagram-62.svg|right]]<br />
<br />
''Hexagram 62'' is named {{lang|zh|小過}} (xiǎo guò), "Small Exceeding". Other variations include "preponderance of the small" and "small surpassing". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Small Preponderance|1=4DFD|IncludeGB=no}}<br />
<br />
== Hexagram 63 ==<br />
<br />
[[image:iching-hexagram-63.svg|right]]<br />
<br />
''Hexagram 63'' is named {{lang|zh|既濟}} (jì jì), "Already Fording". Other variations include "after completion" and "already completed" or "already done" . Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for After Completion|1=4DFE|IncludeGB=no}}<br />
<br />
== Hexagram 64 ==<br />
<br />
[[image:iching-hexagram-64.svg|right]]<br />
<br />
''Hexagram 64'' is named {{lang|zh|未濟}} (wèi jì), "Not Yet Fording". Other variations include "before completion" and "not yet completed". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Before Completion|1=4DFF|IncludeGB=no}}<br />
<br />
{| align="center"<br />
| {{I Ching}}<br />
|}<br />
<br /><br />
{| align="right"<br />
| {{Taoism condensed}}<br />
|}<br />
<br />
== References ==<br />
<br />
{{reflist}}<br />
<br />
==External links==<br />
* {{in lang|en|fr}} [http://wengu.tartarie.com/wg/wengu.php?l=Yijing Wilhelm, Baynes “The I Ching or Book of Changes”] <small>(Association Française des Professeurs de Chinois)</small><br />
<br />
{{Asia topic|Literature of}}<br />
<br />
[[Category:I Ching]]</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I-Ching&diff=1917I-Ching2021-06-23T14:17:52Z<p>Jawitkien: </p>
<hr />
<div>{{short description|Wikimedia list article}}<br />
__NOTOC__<br />
{{DISPLAYTITLE:List of hexagrams of the ''I Ching''}}<br />
This is a list of the 64 '''[[Hexagram (I Ching)|hexagrams]]''' of the '''''[[I Ching]]''''', or ''Book of Changes'', and their [[Template:Unicode chart Yijing Hexagram Symbols|Unicode character codes]].<br />
<br />
This list is in [[King Wen sequence|King Wen order]]. (Cf. [[King Wen sequence#Other hexagram sequences|other hexagram sequences]].)<br />
<br />
{{I Ching/Table}}<br />
<br />
== Hexagram 1 ==<br />
<br />
[[image:iching-hexagram-01.svg|right]]<br />
<br />
''Hexagram 1'' is named {{lang|zh|乾}} (qián), "Force". Other variations include "the creative", "strong action", "the key", and "god". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is the same.<br />
<br />
{{charmap|name1=Hexagram for the Creative Heaven|1=4DC0|IncludeGB=no}}<!-- Note: setting IncludeGB to yes throughout breaks the page with “Node-count limit exceeded” errors --><br />
<br />
== Hexagram 2 ==<br />
<br />
[[image:iching-hexagram-02.svg|right]]<br />
<br />
''Hexagram 2'' is named {{lang|zh|坤}} (kūn), "Field". Other variations include "the receptive", "acquiescence", and "the flow". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is identical.<br />
<br />
{{charmap|name1=Hexagram for the Receptive Earth|1=4DC1|IncludeGB=no}}<br />
<br />
== Hexagram 3 ==<br />
<br />
[[image:iching-hexagram-03.svg|right]]<br />
<br />
''Hexagram 3'' is named {{lang|zh|屯}} (zhūn), "Sprouting". Other variations include "difficulty at the beginning", "gathering support", and "hoarding". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Difficulty at the Beginning|1=4DC2|IncludeGB=no}}<br />
<br />
== Hexagram 4 ==<br />
<br />
[[image:iching-hexagram-04.svg|right]]<br />
<br />
''Hexagram 4'' is named {{lang|zh|蒙}} (méng), "Enveloping". Other variations include "youthful folly", "the young shoot", and "discovering". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water. Its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Youthful Folly|1=4DC3|IncludeGB=no}}<br />
<br />
== Hexagram 5 ==<br />
<br />
[[image:iching-hexagram-05.svg|right]]<br />
<br />
''Hexagram 5'' is named {{lang|zh|需}} (xū), "Attending". Other variations include "waiting", "moistened", and "arriving". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Waiting|1=4DC4|IncludeGB=no}}<br />
<br />
== Hexagram 6 ==<br />
<br />
[[image:iching-hexagram-06.svg|right]]<br />
<br />
''Hexagram 6'' is named {{lang|zh|訟}} (sòng), "Arguing". Other variations include "conflict" and "lawsuit". Its inner (lower) [[Ba gua|trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Conflict|1=4DC5|IncludeGB=no}}<br />
<br />
== Hexagram 7 ==<br />
<br />
[[image:iching-hexagram-07.svg|right]]<br />
<br />
''Hexagram 7'' is named {{lang|zh|師}} (shī), "Leading". Other variations include "the army" and "the troops". Its inner (lower) [[Ba gua|trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[水]]}}) water, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for the Army|1=4DC6|IncludeGB=no}}<br />
<br />
== Hexagram 8 ==<br />
<br />
[[image:iching-hexagram-08.svg|right]]<br />
<br />
''Hexagram 8'' is named {{lang|zh|比}} (bǐ), "Grouping". Other variations include "holding together" and "alliance". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Holding Together|1=4DC7|IncludeGB=no}}<br />
<br />
== Hexagram 9 ==<br />
<br />
[[image:iching-hexagram-09.svg|right]]<br />
<br />
''Hexagram 9'' is named {{lang|zh|小畜}} (xiǎo xù), "Small Accumulating". Other variations include "the taming power of the small" and "small harvest". Its inner (lower) trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Small Taming|1=4DC8|IncludeGB=no}}<br />
<br />
== Hexagram 10 ==<br />
<br />
[[image:iching-hexagram-10.svg|right]]<br />
<br />
''Hexagram 10'' is named {{lang|zh|履}} (lǚ), "Treading". Other variations include "treading (conduct)" and "continuing". Its inner (lower) [[Ba gua|trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|[[澤]]}}) swamp, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Treading|1=4DC9|IncludeGB=no}}<br />
<br />
== Hexagram 11 ==<br />
<br />
[[image:iching-hexagram-11.svg|right]]<br />
<br />
''Hexagram 11'' is named {{lang|zh|泰}} (tài), "Pervading". Other variations include "peace" and "greatness". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Peace|1=4DCA|IncludeGB=no}}<br />
== Hexagram 12 ==<br />
<br />
[[image:iching-hexagram-12.svg|right]]<br />
<br />
''Hexagram 12'' is named {{lang|zh|否}} (pǐ), "Obstruction". Other variations include "standstill (stagnation)" and "selfish persons". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Standstill|1=4DCB|IncludeGB=no}}<br />
<br />
== Hexagram 13 ==<br />
<br />
[[image:iching-hexagram-13.svg|right]]<br />
<br />
''Hexagram 13'' is named {{lang|zh|同人}} (tóng rén), "Concording People". Other variations include "fellowship with men" and "gathering men". Its inner (lower) [[Ba gua|trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Fellowship|1=4DCC|IncludeGB=no}}<br />
<br />
== Hexagram 14 ==<br />
<br />
[[image:iching-hexagram-14.svg|right]]<br />
<br />
''Hexagram 14'' is named {{lang|zh|大有}} (dà yǒu), "Great Possessing". Other variations include "possession in great measure" and "the great possession". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Great Possession|1=4DCD|IncludeGB=no}}<br />
<br />
== Hexagram 15 ==<br />
<br />
[[image:iching-hexagram-15.svg|right]]<br />
<br />
''Hexagram 15'' is named {{lang|zh|謙}} (qiān), "Humbling". Other variations include "modesty". Its inner (lower) [[Ba gua|trigram]] is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Modesty|1=4DCE|IncludeGB=no}}<br />
<br />
== Hexagram 16 ==<br />
<br />
[[image:iching-hexagram-16.svg|right]]<br />
<br />
''Hexagram 16'' is named {{lang|zh|豫}} (yù), "Providing-For". Other variations include "enthusiasm" and "excess". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Enthusiasm|1=4DCF|IncludeGB=no}}<br />
<br />
== Hexagram 17 ==<br />
<br />
[[image:iching-hexagram-17.svg|right]]<br />
<br />
''Hexagram 17'' is named {{lang|zh|隨}} (suí), "Following". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer (upper) [[trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{linktext|lang=zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Following|1=4DD0|IncludeGB=no}}<br />
<br />
== Hexagram 18 ==<br />
<br />
[[image:iching-hexagram-18.svg|right]]<br />
<br />
''Hexagram 18'' is named {{lang|zh|蠱}} (gǔ), "Correcting". Other variations include "work on what has been spoiled (decay)", ''decaying'' and "branch".<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2001<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot's+guide+to+I+Ching+%22Yu%22<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref> Its inner (lower) [[Ba gua|trigram]] is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind, and its outer (upper) trigram is ☶ ({{lang|zh|艮 gèn}}) bound = ({{lang|zh|[[山]]}}) mountain. ''[[Gu (poison)|Gu]]'' is the name of a venom-based poison traditionally used in Chinese witchcraft.<br />
<br />
{{charmap|name1=Hexagram for Work on the Decayed|1=4DD1|IncludeGB=no}}<br />
<br />
== Hexagram 19 ==<br />
<br />
[[image:iching-hexagram-19.svg|right]]<br />
<br />
''Hexagram 19'' is named {{lang|zh|臨}} (lín), "Nearing". Other variations include "approach" and "the forest". Its inner (lower) [[Ba gua|trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Approach|1=4DD2|IncludeGB=no}}<br />
<br />
== Hexagram 20 ==<br />
<br />
[[image:iching-hexagram-20.svg|right]]<br />
<br />
''Hexagram 20'' is named {{lang|zh|觀}} (guān), "Viewing". Other variations include "contemplation (view)" and "looking up". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Contemplation|1=4DD3|IncludeGB=no}}<br />
== Hexagram 21 ==<br />
<br />
[[image:iching-hexagram-21.svg|right]]<br />
<br />
''Hexagram 21'' is named {{lang|zh|噬嗑}} (shì kè), "Gnawing Bite". Other variations include "biting through" and "biting and chewing". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2002<br />
| publisher = Alpha (Pearson)<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot%27s+guide+to+I+Ching+%22Shi+He%22+%22Gnawing%22&pg=PA128<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref><br />
{{charmap|name1=Hexagram for Biting Through|1=4DD4|IncludeGB=no}}<br />
== Hexagram 22 ==<br />
<br />
[[image:iching-hexagram-22.svg|right]]<br />
<br />
''Hexagram 22'' is named {{lang|zh|賁}} (bì), "Adorning". Other variations include "grace" and "luxuriance". Its inner (lower) [[bagua|trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer (upper) [[trigram]] is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2002<br />
| publisher = Alpha (Pearson)<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot%27s+guide+to+I+Ching+%22Bi%22+%22Adorning%22&pg=PA130<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref><br />
<br />
{{charmap|name1=Hexagram for Grace|1=4DD5|IncludeGB=no}}<br />
<br />
== Hexagram 23 ==<br />
<br />
[[image:iching-hexagram-23.svg|right]]<br />
<br />
''Hexagram 23'' is named {{lang|zh|剝}} (bō), "Stripping". Other variations include "splitting apart" and "flaying". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Splitting Apart|1=4DD6|IncludeGB=no}}<br />
<br />
== Hexagram 24 ==<br />
<br />
[[image:iching-hexagram-24.svg|right]]<br />
<br />
''Hexagram 24'' is named {{lang|zh|復}} (fù), "Returning". Other variations include "return (the turning point)". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Return|1=4DD7|IncludeGB=no}}<br />
<br />
== Hexagram 25 ==<br />
<br />
[[image:iching-hexagram-25.svg|right]]<br />
<br />
''Hexagram 25'' is named {{lang|zh|無妄}} (wú wàng), "Without Embroiling". Other variations include "innocence (the unexpected)" and "pestilence". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Innocence|1=4DD8|IncludeGB=no}}<br />
== Hexagram 26 ==<br />
<br />
[[image:iching-hexagram-26.svg|right]]<br />
<br />
''Hexagram 26'' is named {{lang|zh|大畜}} (dà xù), "Great Accumulating". Other variations include "the taming power of the great", "great storage", and "potential energy". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Great Taming|1=4DD9|IncludeGB=no}}<br />
<br />
== Hexagram 27 ==<br />
<br />
[[image:iching-hexagram-27.svg|right]]<br />
<br />
''Hexagram 27'' is named {{lang|zh|頤}} (yí), "Swallowing". Other variations include "the corners of the mouth (providing nourishment)", "jaws" and "comfort/security". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Mouth Corners|1=4DDA|IncludeGB=no}}<br />
<br />
== Hexagram 28 ==<br />
<br />
[[image:iching-hexagram-28.svg|right]]<br />
<br />
''Hexagram 28'' is named {{lang|zh|大過}} (dà guò), "Great Exceeding". Other variations include "preponderance of the great", "great surpassing" and "critical mass". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Great Preponderance|1=4DDB|IncludeGB=no}}<br />
<br />
== Hexagram 29 ==<br />
<br />
[[image:iching-hexagram-29.svg|right]]<br />
<br />
''Hexagram 29'' is named {{lang|zh|坎}} (kǎn), "Gorge". Other variations include "the [[Abyssal zone|abyss]]" (in the oceanographic sense) and "repeated entrapment". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is identical.<br />
<br />
{{charmap|name1=Hexagram for the Abysmal Water|1=4DDC|IncludeGB=no}}<br />
== Hexagram 30 ==<br />
<br />
[[image:iching-hexagram-30.svg|right]]<br />
<br />
''Hexagram 30'' is named {{lang|zh|離}} (lí), "Radiance". Other variations include "the clinging, fire" and "the net". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is identical. The origin of the character has its roots in symbols of long-tailed birds such as the [[peacock]] or the legendary [[phoenix (mythology)|phoenix]].<br />
<br />
{{charmap|name1=Hexagram for the Clinging Fire|1=4DDD|IncludeGB=no}}<br />
<br />
== Hexagram 31 ==<br />
<br />
[[image:iching-hexagram-31.svg|right]]<br />
<br />
''Hexagram 31'' is named {{lang|zh|咸}} (xián), "Conjoining". Other variations include "influence (wooing)" and "feelings". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Influence|1=4DDE|IncludeGB=no}}<br />
<br />
== Hexagram 32 ==<br />
<br />
[[image:iching-hexagram-32.svg|right]]<br />
<br />
''Hexagram 32'' is named {{lang|zh|恆}} (héng), "Persevering". Other variations include "duration" and "constancy". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Duration|1=4DDF|IncludeGB=no}}<br />
<br />
== Hexagram 33 ==<br />
<br />
[[image:iching-hexagram-33.svg|right]]<br />
<br />
''Hexagram 33'' is named {{lang|zh|遯}} (dùn), "Retiring". Other variations include "retreat" and "yielding". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Retreat|1=4DE0|IncludeGB=no}}<br />
== Hexagram 34 ==<br />
<br />
[[image:iching-hexagram-34.svg|right]]<br />
<br />
''Hexagram 34'' is named {{lang|zh|大壯}} (dà zhuàng), "Great Invigorating". Other variations include "the power of the great" and "great maturity". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{lang|zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Great Power|1=4DE1|IncludeGB=no}}<br />
<br />
== Hexagram 35 ==<br />
<br />
[[image:iching-hexagram-35.svg|right]]<br />
<br />
''Hexagram 35'' is named {{lang|zh|晉}} (jìn), "Prospering". Other variations include "progress" and "aquas". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Progress|1=4DE2|IncludeGB=no}}<br />
<br />
== Hexagram 36 ==<br />
<br />
[[image:iching-hexagram-36.svg|right]]<br />
<br />
''Hexagram 36'' is named {{lang|zh|明夷}} (míng yí), "Darkening of the Light". Other variations include "brilliance injured" and "intelligence hidden". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Darkening of the Light|1=4DE3|IncludeGB=no}}<br />
<br />
== Hexagram 37 ==<br />
<br />
[[image:iching-hexagram-37.svg|right]]<br />
<br />
''Hexagram 37'' is named {{lang|zh|家人}} (jiā rén), "Dwelling People". Other variations include "the family (the clan)" and "family members". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for the Family|1=4DE4|IncludeGB=no}}<br />
<br />
== Hexagram 38 ==<br />
<br />
[[image:iching-hexagram-38.svg|right]]<br />
<br />
''Hexagram 38'' is named {{lang|zh|睽}} (kuí), "Polarising". Other variations include "opposition" and "perversion". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Opposition|1=4DE5|IncludeGB=no}}<br />
<br />
== Hexagram 39 ==<br />
<br />
[[image:iching-hexagram-39.svg|right]]<br />
<br />
''Hexagram 39'' is named {{lang|zh|蹇}} (jiǎn), "Limping". Other variations include "obstruction" and "afoot". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for Obstruction|1=4DE6|IncludeGB=no}}<br />
<br />
== Hexagram 40 ==<br />
<br />
[[image:iching-hexagram-40.svg|right]]<br />
<br />
''Hexagram 40'' is named {{lang|zh|解}} (xiè), "Taking-Apart". Other variations include "deliverance" and "untangled". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Deliverance|1=4DE7|IncludeGB=no}}<br />
<br />
== Hexagram 41 ==<br />
[[File:Iching-hexagram-41.png|alt=|right|I ching 41- diminishing, {{lang|zh|山泽损}}]]<br />
''Hexagram 41'' is named {{lang|zh|損}} (sǔn), "Diminishing". Other variations include "decrease". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Decrease|1=4DE8|IncludeGB=no}}<br />
== Hexagram 42 ==<br />
<br />
[[image:iching-hexagram-42.svg|right]]<br />
<br />
''Hexagram 42'' is named {{lang|zh|益}} (yì), "Augmenting". Other variations include "increase". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Increase|1=4DE9|IncludeGB=no}}<br />
<br />
== Hexagram 43 ==<br />
<br />
[[image:iching-hexagram-43.svg|right]]<br />
<br />
''Hexagram 43'' is named {{lang|zh|夬}} (guài), "Displacement". Other variations include "resoluteness", "parting", and "break-through". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Breakthrough|1=4DEA|IncludeGB=no}}<br />
<br />
== Hexagram 44 ==<br />
<br />
[[image:iching-hexagram-44.svg|right]]<br />
<br />
''Hexagram 44'' is named {{lang|zh|姤}} (gòu), "Coupling". Other variations include "coming to meet" and "meeting". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Coming to Meet|1=4DEB|IncludeGB=no}}<br />
<br />
== Hexagram 45 ==<br />
<br />
[[image:iching-hexagram-45.svg|right]]<br />
<br />
''Hexagram 45'' is named {{lang|zh|萃}} (cuì), "Clustering". Other variations include "gathering together (massing)" and "finished". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Gathering Together|1=4DEC|IncludeGB=no}}<br />
<br />
== Hexagram 46 ==<br />
<br />
[[image:iching-hexagram-46.svg|right]]<br />
<br />
''Hexagram 46'' is named {{lang|zh|升}} (shēng), "Ascending". Other variations include "pushing upward". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Pushing Upward|1=4DED|IncludeGB=no}}<br />
<br />
== Hexagram 47 ==<br />
<br />
[[image:iching-hexagram-47.svg|right]]<br />
<br />
''Hexagram 47'' is named {{lang|zh|困}} (kùn), "Confining". Other variations include "oppression (exhaustion)" and "entangled". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Oppression|1=4DEE|IncludeGB=no}}<br />
<br />
== Hexagram 48 ==<br />
<br />
[[image:iching-hexagram-48.svg|right]]<br />
<br />
''Hexagram 48'' is named {{lang|zh|井}} (jǐng), "Welling". Other variations include "the well". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for the Well|1=4DEF|IncludeGB=no}}<br />
<br />
== Hexagram 49 ==<br />
<br />
[[image:iching-hexagram-49.svg|right]]<br />
<br />
''Hexagram 49'' is named {{lang|zh|革}} (gé), "Skinning". Other variations include "revolution (molting)" and "the bridle". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Revolution|1=4DF0|IncludeGB=no}}<br />
<br />
== Hexagram 50 ==<br />
<br />
[[image:iching-hexagram-50.svg|right]]<br />
<br />
''Hexagram 50'' is named {{lang|zh|鼎}} (dǐng), "Holding". Other variations include "the cauldron". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for the Cauldron|1=4DF1|IncludeGB=no}}<br />
<br />
== Hexagram 51 ==<br />
<br />
[[image:iching-hexagram-51.svg|right]]<br />
<br />
''Hexagram 51'' is named {{lang|zh|震}} (zhèn), "Shake". Other variations include "the arousing (shock, thunder)" and "thunder". Both its inner and outer trigrams are ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for the Arousing Thunder|1=4DF2|IncludeGB=no}}<br />
<br />
== Hexagram 52 ==<br />
<br />
[[image:iching-hexagram-52.svg|right]]<br />
<br />
''Hexagram 52'' is named {{lang|zh|艮}} (gèn), "Bound". Other variations include "keeping still, mountain" and "stilling". Both its inner and outer trigrams are ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for the Keeping Still Mountain|1=4DF3|IncludeGB=no}}<br />
<br />
== Hexagram 53 ==<br />
<br />
[[image:iching-hexagram-53.svg|right]]<br />
<br />
''Hexagram 53'' is named {{lang|zh|漸}} (jiàn), "Infiltrating". Other variations include "development (gradual progress)" and "advancement". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Development|1=4DF4|IncludeGB=no}}<br />
<br />
== Hexagram 54 ==<br />
<br />
[[image:iching-hexagram-54.svg|right]]<br />
<br />
''Hexagram 54'' is named {{lang|zh|歸妹}} (guī mèi), "Converting the Maiden". Other variations include "the marrying maiden" and "returning maiden". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for the Marrying Maiden|1=4DF5|IncludeGB=no}}<br />
<br />
== Hexagram 55 ==<br />
<br />
[[image:iching-hexagram-55.svg|right]]<br />
<br />
''Hexagram 55'' is named {{lang|zh|豐}} (fēng), "Abounding". Other variations include "abundance" and "fullness". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Water (Wu Xing)|火]]}}) fire, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Abundance|1=4DF6|IncludeGB=no}}<br />
<br />
== Hexagram 56 ==<br />
<br />
[[image:iching-hexagram-56.svg|right]]<br />
<br />
''Hexagram 56'' is named {{lang|zh|旅}} (lǚ), "Sojourning". Other variations include "the wanderer" and "traveling". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for the Wanderer|1=4DF7|IncludeGB=no}}<br />
<br />
== Hexagram 57 ==<br />
<br />
[[image:iching-hexagram-57.svg|right]]<br />
<br />
''Hexagram 57'' is named {{linktext|lang=zh|巽}} (xùn), "Ground". Other variations include "the gentle (the penetrating, wind)" and "calculations". Both its inner and outer trigrams are ☴ ({{linktext|lang=zh|巽}} xùn) ground = ({{linktext|lang=zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for the Gentle Wind|1=4DF8|IncludeGB=no}}<br />
<br />
== Hexagram 58 ==<br />
<br />
[[image:iching-hexagram-58.svg|right]]<br />
<br />
''Hexagram 58'' is named {{lang|zh|兌}} (duì), "Open". Other variations include "the joyous, lake" and "usurpation". Both its inner and outer trigrams are ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for the Joyous Lake|1=4DF9|IncludeGB=no}}<br />
== Hexagram 59 ==<br />
<br />
[[image:iching-hexagram-59.svg|right]]<br />
<br />
''Hexagram 59'' is named {{lang|zh|渙}} (huàn), "Dispersing". Other variations include "dispersion (dissolution)" and "dispersal". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Dispersion|1=4DFA|IncludeGB=no}}<br />
<br />
== Hexagram 60 ==<br />
<br />
[[image:iching-hexagram-60.svg|right]]<br />
<br />
''Hexagram 60'' is named {{lang|zh|節}} (jié), "Articulating". Other variations include "limitation" and "moderation". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for Limitation|1=4DFB|IncludeGB=no}}<br />
<br />
== Hexagram 61 ==<br />
<br />
[[image:iching-hexagram-61.svg|right]]<br />
<br />
''Hexagram 61'' is named {{lang|zh|中孚}} (zhōng fú), "Center Returning". Other variations include "inner truth" and "central return". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{linktext|lang=zh|澤}}) swamp, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Inner Truth|1=4DFC|IncludeGB=no}}<br />
== Hexagram 62 ==<br />
<br />
[[image:iching-hexagram-62.svg|right]]<br />
<br />
''Hexagram 62'' is named {{lang|zh|小過}} (xiǎo guò), "Small Exceeding". Other variations include "preponderance of the small" and "small surpassing". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Small Preponderance|1=4DFD|IncludeGB=no}}<br />
<br />
== Hexagram 63 ==<br />
<br />
[[image:iching-hexagram-63.svg|right]]<br />
<br />
''Hexagram 63'' is named {{lang|zh|既濟}} (jì jì), "Already Fording". Other variations include "after completion" and "already completed" or "already done" . Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for After Completion|1=4DFE|IncludeGB=no}}<br />
<br />
== Hexagram 64 ==<br />
<br />
[[image:iching-hexagram-64.svg|right]]<br />
<br />
''Hexagram 64'' is named {{lang|zh|未濟}} (wèi jì), "Not Yet Fording". Other variations include "before completion" and "not yet completed". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Before Completion|1=4DFF|IncludeGB=no}}<br />
<br />
{| align="center"<br />
| {{I Ching}}<br />
|}<br />
<br /><br />
{| align="right"<br />
| {{Taoism condensed}}<br />
|}<br />
<br />
== References ==<br />
<br />
{{reflist}}<br />
<br />
==External links==<br />
* {{in lang|en|fr}} [http://wengu.tartarie.com/wg/wengu.php?l=Yijing Wilhelm, Baynes “The I Ching or Book of Changes”] <small>(Association Française des Professeurs de Chinois)</small><br />
<br />
{{Asia topic|Literature of}}<br />
<br />
[[Category:I Ching]]</div>Jawitkienhttps://pdkb.chivanet.org/wiki/index.php?title=I-Ching&diff=1916I-Ching2021-06-23T14:16:43Z<p>Jawitkien: Initial page is a copy of</p>
<hr />
<div>{{short description|Wikimedia list article}}<br />
__NOTOC__<br />
{{DISPLAYTITLE:List of hexagrams of the ''I Ching''}}<br />
This is a list of the 64 '''[[Hexagram (I Ching)|hexagrams]]''' of the '''''[[I Ching]]''''', or ''Book of Changes'', and their [[Template:Unicode chart Yijing Hexagram Symbols|Unicode character codes]].<br />
<br />
This list is in [[King Wen sequence|King Wen order]]. (Cf. [[King Wen sequence#Other hexagram sequences|other hexagram sequences]].)<br />
<br />
{{I Ching}}<br />
<br />
== Hexagram 1 ==<br />
<br />
[[image:iching-hexagram-01.svg|right]]<br />
<br />
''Hexagram 1'' is named {{lang|zh|乾}} (qián), "Force". Other variations include "the creative", "strong action", "the key", and "god". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is the same.<br />
<br />
{{charmap|name1=Hexagram for the Creative Heaven|1=4DC0|IncludeGB=no}}<!-- Note: setting IncludeGB to yes throughout breaks the page with “Node-count limit exceeded” errors --><br />
<br />
== Hexagram 2 ==<br />
<br />
[[image:iching-hexagram-02.svg|right]]<br />
<br />
''Hexagram 2'' is named {{lang|zh|坤}} (kūn), "Field". Other variations include "the receptive", "acquiescence", and "the flow". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is identical.<br />
<br />
{{charmap|name1=Hexagram for the Receptive Earth|1=4DC1|IncludeGB=no}}<br />
<br />
== Hexagram 3 ==<br />
<br />
[[image:iching-hexagram-03.svg|right]]<br />
<br />
''Hexagram 3'' is named {{lang|zh|屯}} (zhūn), "Sprouting". Other variations include "difficulty at the beginning", "gathering support", and "hoarding". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Difficulty at the Beginning|1=4DC2|IncludeGB=no}}<br />
<br />
== Hexagram 4 ==<br />
<br />
[[image:iching-hexagram-04.svg|right]]<br />
<br />
''Hexagram 4'' is named {{lang|zh|蒙}} (méng), "Enveloping". Other variations include "youthful folly", "the young shoot", and "discovering". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water. Its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Youthful Folly|1=4DC3|IncludeGB=no}}<br />
<br />
== Hexagram 5 ==<br />
<br />
[[image:iching-hexagram-05.svg|right]]<br />
<br />
''Hexagram 5'' is named {{lang|zh|需}} (xū), "Attending". Other variations include "waiting", "moistened", and "arriving". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Waiting|1=4DC4|IncludeGB=no}}<br />
<br />
== Hexagram 6 ==<br />
<br />
[[image:iching-hexagram-06.svg|right]]<br />
<br />
''Hexagram 6'' is named {{lang|zh|訟}} (sòng), "Arguing". Other variations include "conflict" and "lawsuit". Its inner (lower) [[Ba gua|trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Conflict|1=4DC5|IncludeGB=no}}<br />
<br />
== Hexagram 7 ==<br />
<br />
[[image:iching-hexagram-07.svg|right]]<br />
<br />
''Hexagram 7'' is named {{lang|zh|師}} (shī), "Leading". Other variations include "the army" and "the troops". Its inner (lower) [[Ba gua|trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[水]]}}) water, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for the Army|1=4DC6|IncludeGB=no}}<br />
<br />
== Hexagram 8 ==<br />
<br />
[[image:iching-hexagram-08.svg|right]]<br />
<br />
''Hexagram 8'' is named {{lang|zh|比}} (bǐ), "Grouping". Other variations include "holding together" and "alliance". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for Holding Together|1=4DC7|IncludeGB=no}}<br />
<br />
== Hexagram 9 ==<br />
<br />
[[image:iching-hexagram-09.svg|right]]<br />
<br />
''Hexagram 9'' is named {{lang|zh|小畜}} (xiǎo xù), "Small Accumulating". Other variations include "the taming power of the small" and "small harvest". Its inner (lower) trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Small Taming|1=4DC8|IncludeGB=no}}<br />
<br />
== Hexagram 10 ==<br />
<br />
[[image:iching-hexagram-10.svg|right]]<br />
<br />
''Hexagram 10'' is named {{lang|zh|履}} (lǚ), "Treading". Other variations include "treading (conduct)" and "continuing". Its inner (lower) [[Ba gua|trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|[[澤]]}}) swamp, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Treading|1=4DC9|IncludeGB=no}}<br />
<br />
== Hexagram 11 ==<br />
<br />
[[image:iching-hexagram-11.svg|right]]<br />
<br />
''Hexagram 11'' is named {{lang|zh|泰}} (tài), "Pervading". Other variations include "peace" and "greatness". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Peace|1=4DCA|IncludeGB=no}}<br />
== Hexagram 12 ==<br />
<br />
[[image:iching-hexagram-12.svg|right]]<br />
<br />
''Hexagram 12'' is named {{lang|zh|否}} (pǐ), "Obstruction". Other variations include "standstill (stagnation)" and "selfish persons". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Standstill|1=4DCB|IncludeGB=no}}<br />
<br />
== Hexagram 13 ==<br />
<br />
[[image:iching-hexagram-13.svg|right]]<br />
<br />
''Hexagram 13'' is named {{lang|zh|同人}} (tóng rén), "Concording People". Other variations include "fellowship with men" and "gathering men". Its inner (lower) [[Ba gua|trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire, and its outer (upper) [[trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Fellowship|1=4DCC|IncludeGB=no}}<br />
<br />
== Hexagram 14 ==<br />
<br />
[[image:iching-hexagram-14.svg|right]]<br />
<br />
''Hexagram 14'' is named {{lang|zh|大有}} (dà yǒu), "Great Possessing". Other variations include "possession in great measure" and "the great possession". Its inner (lower) [[Ba gua|trigram]] is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven, and its outer (upper) [[trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Great Possession|1=4DCD|IncludeGB=no}}<br />
<br />
== Hexagram 15 ==<br />
<br />
[[image:iching-hexagram-15.svg|right]]<br />
<br />
''Hexagram 15'' is named {{lang|zh|謙}} (qiān), "Humbling". Other variations include "modesty". Its inner (lower) [[Ba gua|trigram]] is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Modesty|1=4DCE|IncludeGB=no}}<br />
<br />
== Hexagram 16 ==<br />
<br />
[[image:iching-hexagram-16.svg|right]]<br />
<br />
''Hexagram 16'' is named {{lang|zh|豫}} (yù), "Providing-For". Other variations include "enthusiasm" and "excess". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Enthusiasm|1=4DCF|IncludeGB=no}}<br />
<br />
== Hexagram 17 ==<br />
<br />
[[image:iching-hexagram-17.svg|right]]<br />
<br />
''Hexagram 17'' is named {{lang|zh|隨}} (suí), "Following". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer (upper) [[trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{linktext|lang=zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Following|1=4DD0|IncludeGB=no}}<br />
<br />
== Hexagram 18 ==<br />
<br />
[[image:iching-hexagram-18.svg|right]]<br />
<br />
''Hexagram 18'' is named {{lang|zh|蠱}} (gǔ), "Correcting". Other variations include "work on what has been spoiled (decay)", ''decaying'' and "branch".<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2001<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot's+guide+to+I+Ching+%22Yu%22<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref> Its inner (lower) [[Ba gua|trigram]] is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind, and its outer (upper) trigram is ☶ ({{lang|zh|艮 gèn}}) bound = ({{lang|zh|[[山]]}}) mountain. ''[[Gu (poison)|Gu]]'' is the name of a venom-based poison traditionally used in Chinese witchcraft.<br />
<br />
{{charmap|name1=Hexagram for Work on the Decayed|1=4DD1|IncludeGB=no}}<br />
<br />
== Hexagram 19 ==<br />
<br />
[[image:iching-hexagram-19.svg|right]]<br />
<br />
''Hexagram 19'' is named {{lang|zh|臨}} (lín), "Nearing". Other variations include "approach" and "the forest". Its inner (lower) [[Ba gua|trigram]] is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer (upper) [[trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Approach|1=4DD2|IncludeGB=no}}<br />
<br />
== Hexagram 20 ==<br />
<br />
[[image:iching-hexagram-20.svg|right]]<br />
<br />
''Hexagram 20'' is named {{lang|zh|觀}} (guān), "Viewing". Other variations include "contemplation (view)" and "looking up". Its inner (lower) [[Ba gua|trigram]] is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth, and its outer (upper) [[trigram]] is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Contemplation|1=4DD3|IncludeGB=no}}<br />
== Hexagram 21 ==<br />
<br />
[[image:iching-hexagram-21.svg|right]]<br />
<br />
''Hexagram 21'' is named {{lang|zh|噬嗑}} (shì kè), "Gnawing Bite". Other variations include "biting through" and "biting and chewing". Its inner (lower) [[Ba gua|trigram]] is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2002<br />
| publisher = Alpha (Pearson)<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot%27s+guide+to+I+Ching+%22Shi+He%22+%22Gnawing%22&pg=PA128<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref><br />
{{charmap|name1=Hexagram for Biting Through|1=4DD4|IncludeGB=no}}<br />
== Hexagram 22 ==<br />
<br />
[[image:iching-hexagram-22.svg|right]]<br />
<br />
''Hexagram 22'' is named {{lang|zh|賁}} (bì), "Adorning". Other variations include "grace" and "luxuriance". Its inner (lower) [[bagua|trigram]] is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer (upper) [[trigram]] is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<ref>{{cite book<br />
| last = Moran<br />
| first = Elizabeth<br />
|author2=Joseph Yu<br />
| title = The Complete Idiot's Guide to the I Ching<br />
| year = 2002<br />
| publisher = Alpha (Pearson)<br />
| url = https://books.google.com/books?id=1CK2efLIY7sC&q=The+completely+Idiot%27s+guide+to+I+Ching+%22Bi%22+%22Adorning%22&pg=PA130<br />
| isbn = 9780028639796<br />
| access-date = 16 October 2008<br />
}}</ref><br />
<br />
{{charmap|name1=Hexagram for Grace|1=4DD5|IncludeGB=no}}<br />
<br />
== Hexagram 23 ==<br />
<br />
[[image:iching-hexagram-23.svg|right]]<br />
<br />
''Hexagram 23'' is named {{lang|zh|剝}} (bō), "Stripping". Other variations include "splitting apart" and "flaying". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Splitting Apart|1=4DD6|IncludeGB=no}}<br />
<br />
== Hexagram 24 ==<br />
<br />
[[image:iching-hexagram-24.svg|right]]<br />
<br />
''Hexagram 24'' is named {{lang|zh|復}} (fù), "Returning". Other variations include "return (the turning point)". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|[[地]]}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Return|1=4DD7|IncludeGB=no}}<br />
<br />
== Hexagram 25 ==<br />
<br />
[[image:iching-hexagram-25.svg|right]]<br />
<br />
''Hexagram 25'' is named {{lang|zh|無妄}} (wú wàng), "Without Embroiling". Other variations include "innocence (the unexpected)" and "pestilence". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|[[天]]}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Innocence|1=4DD8|IncludeGB=no}}<br />
== Hexagram 26 ==<br />
<br />
[[image:iching-hexagram-26.svg|right]]<br />
<br />
''Hexagram 26'' is named {{lang|zh|大畜}} (dà xù), "Great Accumulating". Other variations include "the taming power of the great", "great storage", and "potential energy". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Great Taming|1=4DD9|IncludeGB=no}}<br />
<br />
== Hexagram 27 ==<br />
<br />
[[image:iching-hexagram-27.svg|right]]<br />
<br />
''Hexagram 27'' is named {{lang|zh|頤}} (yí), "Swallowing". Other variations include "the corners of the mouth (providing nourishment)", "jaws" and "comfort/security". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Mouth Corners|1=4DDA|IncludeGB=no}}<br />
<br />
== Hexagram 28 ==<br />
<br />
[[image:iching-hexagram-28.svg|right]]<br />
<br />
''Hexagram 28'' is named {{lang|zh|大過}} (dà guò), "Great Exceeding". Other variations include "preponderance of the great", "great surpassing" and "critical mass". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Great Preponderance|1=4DDB|IncludeGB=no}}<br />
<br />
== Hexagram 29 ==<br />
<br />
[[image:iching-hexagram-29.svg|right]]<br />
<br />
''Hexagram 29'' is named {{lang|zh|坎}} (kǎn), "Gorge". Other variations include "the [[Abyssal zone|abyss]]" (in the oceanographic sense) and "repeated entrapment". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is identical.<br />
<br />
{{charmap|name1=Hexagram for the Abysmal Water|1=4DDC|IncludeGB=no}}<br />
== Hexagram 30 ==<br />
<br />
[[image:iching-hexagram-30.svg|right]]<br />
<br />
''Hexagram 30'' is named {{lang|zh|離}} (lí), "Radiance". Other variations include "the clinging, fire" and "the net". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is identical. The origin of the character has its roots in symbols of long-tailed birds such as the [[peacock]] or the legendary [[phoenix (mythology)|phoenix]].<br />
<br />
{{charmap|name1=Hexagram for the Clinging Fire|1=4DDD|IncludeGB=no}}<br />
<br />
== Hexagram 31 ==<br />
<br />
[[image:iching-hexagram-31.svg|right]]<br />
<br />
''Hexagram 31'' is named {{lang|zh|咸}} (xián), "Conjoining". Other variations include "influence (wooing)" and "feelings". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Influence|1=4DDE|IncludeGB=no}}<br />
<br />
== Hexagram 32 ==<br />
<br />
[[image:iching-hexagram-32.svg|right]]<br />
<br />
''Hexagram 32'' is named {{lang|zh|恆}} (héng), "Persevering". Other variations include "duration" and "constancy". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Duration|1=4DDF|IncludeGB=no}}<br />
<br />
== Hexagram 33 ==<br />
<br />
[[image:iching-hexagram-33.svg|right]]<br />
<br />
''Hexagram 33'' is named {{lang|zh|遯}} (dùn), "Retiring". Other variations include "retreat" and "yielding". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Retreat|1=4DE0|IncludeGB=no}}<br />
== Hexagram 34 ==<br />
<br />
[[image:iching-hexagram-34.svg|right]]<br />
<br />
''Hexagram 34'' is named {{lang|zh|大壯}} (dà zhuàng), "Great Invigorating". Other variations include "the power of the great" and "great maturity". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{lang|zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Great Power|1=4DE1|IncludeGB=no}}<br />
<br />
== Hexagram 35 ==<br />
<br />
[[image:iching-hexagram-35.svg|right]]<br />
<br />
''Hexagram 35'' is named {{lang|zh|晉}} (jìn), "Prospering". Other variations include "progress" and "aquas". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Progress|1=4DE2|IncludeGB=no}}<br />
<br />
== Hexagram 36 ==<br />
<br />
[[image:iching-hexagram-36.svg|right]]<br />
<br />
''Hexagram 36'' is named {{lang|zh|明夷}} (míng yí), "Darkening of the Light". Other variations include "brilliance injured" and "intelligence hidden". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Darkening of the Light|1=4DE3|IncludeGB=no}}<br />
<br />
== Hexagram 37 ==<br />
<br />
[[image:iching-hexagram-37.svg|right]]<br />
<br />
''Hexagram 37'' is named {{lang|zh|家人}} (jiā rén), "Dwelling People". Other variations include "the family (the clan)" and "family members". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for the Family|1=4DE4|IncludeGB=no}}<br />
<br />
== Hexagram 38 ==<br />
<br />
[[image:iching-hexagram-38.svg|right]]<br />
<br />
''Hexagram 38'' is named {{lang|zh|睽}} (kuí), "Polarising". Other variations include "opposition" and "perversion". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Opposition|1=4DE5|IncludeGB=no}}<br />
<br />
== Hexagram 39 ==<br />
<br />
[[image:iching-hexagram-39.svg|right]]<br />
<br />
''Hexagram 39'' is named {{lang|zh|蹇}} (jiǎn), "Limping". Other variations include "obstruction" and "afoot". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for Obstruction|1=4DE6|IncludeGB=no}}<br />
<br />
== Hexagram 40 ==<br />
<br />
[[image:iching-hexagram-40.svg|right]]<br />
<br />
''Hexagram 40'' is named {{lang|zh|解}} (xiè), "Taking-Apart". Other variations include "deliverance" and "untangled". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Deliverance|1=4DE7|IncludeGB=no}}<br />
<br />
== Hexagram 41 ==<br />
[[File:Iching-hexagram-41.png|alt=|right|I ching 41- diminishing, {{lang|zh|山泽损}}]]<br />
''Hexagram 41'' is named {{lang|zh|損}} (sǔn), "Diminishing". Other variations include "decrease". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for Decrease|1=4DE8|IncludeGB=no}}<br />
== Hexagram 42 ==<br />
<br />
[[image:iching-hexagram-42.svg|right]]<br />
<br />
''Hexagram 42'' is named {{lang|zh|益}} (yì), "Augmenting". Other variations include "increase". Its inner trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Increase|1=4DE9|IncludeGB=no}}<br />
<br />
== Hexagram 43 ==<br />
<br />
[[image:iching-hexagram-43.svg|right]]<br />
<br />
''Hexagram 43'' is named {{lang|zh|夬}} (guài), "Displacement". Other variations include "resoluteness", "parting", and "break-through". Its inner trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Breakthrough|1=4DEA|IncludeGB=no}}<br />
<br />
== Hexagram 44 ==<br />
<br />
[[image:iching-hexagram-44.svg|right]]<br />
<br />
''Hexagram 44'' is named {{lang|zh|姤}} (gòu), "Coupling". Other variations include "coming to meet" and "meeting". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☰ ({{lang|zh|乾}} qián) force = ({{lang|zh|天}}) heaven.<br />
<br />
{{charmap|name1=Hexagram for Coming to Meet|1=4DEB|IncludeGB=no}}<br />
<br />
== Hexagram 45 ==<br />
<br />
[[image:iching-hexagram-45.svg|right]]<br />
<br />
''Hexagram 45'' is named {{lang|zh|萃}} (cuì), "Clustering". Other variations include "gathering together (massing)" and "finished". Its inner trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Gathering Together|1=4DEC|IncludeGB=no}}<br />
<br />
== Hexagram 46 ==<br />
<br />
[[image:iching-hexagram-46.svg|right]]<br />
<br />
''Hexagram 46'' is named {{lang|zh|升}} (shēng), "Ascending". Other variations include "pushing upward". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☷ ({{lang|zh|坤}} kūn) field = ({{lang|zh|地}}) earth.<br />
<br />
{{charmap|name1=Hexagram for Pushing Upward|1=4DED|IncludeGB=no}}<br />
<br />
== Hexagram 47 ==<br />
<br />
[[image:iching-hexagram-47.svg|right]]<br />
<br />
''Hexagram 47'' is named {{lang|zh|困}} (kùn), "Confining". Other variations include "oppression (exhaustion)" and "entangled". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Oppression|1=4DEE|IncludeGB=no}}<br />
<br />
== Hexagram 48 ==<br />
<br />
[[image:iching-hexagram-48.svg|right]]<br />
<br />
''Hexagram 48'' is named {{lang|zh|井}} (jǐng), "Welling". Other variations include "the well". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for the Well|1=4DEF|IncludeGB=no}}<br />
<br />
== Hexagram 49 ==<br />
<br />
[[image:iching-hexagram-49.svg|right]]<br />
<br />
''Hexagram 49'' is named {{lang|zh|革}} (gé), "Skinning". Other variations include "revolution (molting)" and "the bridle". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire, and its outer trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for Revolution|1=4DF0|IncludeGB=no}}<br />
<br />
== Hexagram 50 ==<br />
<br />
[[image:iching-hexagram-50.svg|right]]<br />
<br />
''Hexagram 50'' is named {{lang|zh|鼎}} (dǐng), "Holding". Other variations include "the cauldron". Its inner trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for the Cauldron|1=4DF1|IncludeGB=no}}<br />
<br />
== Hexagram 51 ==<br />
<br />
[[image:iching-hexagram-51.svg|right]]<br />
<br />
''Hexagram 51'' is named {{lang|zh|震}} (zhèn), "Shake". Other variations include "the arousing (shock, thunder)" and "thunder". Both its inner and outer trigrams are ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for the Arousing Thunder|1=4DF2|IncludeGB=no}}<br />
<br />
== Hexagram 52 ==<br />
<br />
[[image:iching-hexagram-52.svg|right]]<br />
<br />
''Hexagram 52'' is named {{lang|zh|艮}} (gèn), "Bound". Other variations include "keeping still, mountain" and "stilling". Both its inner and outer trigrams are ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain.<br />
<br />
{{charmap|name1=Hexagram for the Keeping Still Mountain|1=4DF3|IncludeGB=no}}<br />
<br />
== Hexagram 53 ==<br />
<br />
[[image:iching-hexagram-53.svg|right]]<br />
<br />
''Hexagram 53'' is named {{lang|zh|漸}} (jiàn), "Infiltrating". Other variations include "development (gradual progress)" and "advancement". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Development|1=4DF4|IncludeGB=no}}<br />
<br />
== Hexagram 54 ==<br />
<br />
[[image:iching-hexagram-54.svg|right]]<br />
<br />
''Hexagram 54'' is named {{lang|zh|歸妹}} (guī mèi), "Converting the Maiden". Other variations include "the marrying maiden" and "returning maiden". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for the Marrying Maiden|1=4DF5|IncludeGB=no}}<br />
<br />
== Hexagram 55 ==<br />
<br />
[[image:iching-hexagram-55.svg|right]]<br />
<br />
''Hexagram 55'' is named {{lang|zh|豐}} (fēng), "Abounding". Other variations include "abundance" and "fullness". Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Water (Wu Xing)|火]]}}) fire, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Abundance|1=4DF6|IncludeGB=no}}<br />
<br />
== Hexagram 56 ==<br />
<br />
[[image:iching-hexagram-56.svg|right]]<br />
<br />
''Hexagram 56'' is named {{lang|zh|旅}} (lǚ), "Sojourning". Other variations include "the wanderer" and "traveling". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|山}}) mountain, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|火}}) fire.<br />
<br />
{{charmap|name1=Hexagram for the Wanderer|1=4DF7|IncludeGB=no}}<br />
<br />
== Hexagram 57 ==<br />
<br />
[[image:iching-hexagram-57.svg|right]]<br />
<br />
''Hexagram 57'' is named {{linktext|lang=zh|巽}} (xùn), "Ground". Other variations include "the gentle (the penetrating, wind)" and "calculations". Both its inner and outer trigrams are ☴ ({{linktext|lang=zh|巽}} xùn) ground = ({{linktext|lang=zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for the Gentle Wind|1=4DF8|IncludeGB=no}}<br />
<br />
== Hexagram 58 ==<br />
<br />
[[image:iching-hexagram-58.svg|right]]<br />
<br />
''Hexagram 58'' is named {{lang|zh|兌}} (duì), "Open". Other variations include "the joyous, lake" and "usurpation". Both its inner and outer trigrams are ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp.<br />
<br />
{{charmap|name1=Hexagram for the Joyous Lake|1=4DF9|IncludeGB=no}}<br />
== Hexagram 59 ==<br />
<br />
[[image:iching-hexagram-59.svg|right]]<br />
<br />
''Hexagram 59'' is named {{lang|zh|渙}} (huàn), "Dispersing". Other variations include "dispersion (dissolution)" and "dispersal". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|風}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Dispersion|1=4DFA|IncludeGB=no}}<br />
<br />
== Hexagram 60 ==<br />
<br />
[[image:iching-hexagram-60.svg|right]]<br />
<br />
''Hexagram 60'' is named {{lang|zh|節}} (jié), "Articulating". Other variations include "limitation" and "moderation". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{lang|zh|澤}}) swamp, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|水}}) water.<br />
<br />
{{charmap|name1=Hexagram for Limitation|1=4DFB|IncludeGB=no}}<br />
<br />
== Hexagram 61 ==<br />
<br />
[[image:iching-hexagram-61.svg|right]]<br />
<br />
''Hexagram 61'' is named {{lang|zh|中孚}} (zhōng fú), "Center Returning". Other variations include "inner truth" and "central return". Its inner trigram is ☱ ({{lang|zh|兌}} duì) open = ({{linktext|lang=zh|澤}}) swamp, and its outer trigram is ☴ ({{lang|zh|巽}} xùn) ground = ({{lang|zh|[[風]]}}) wind.<br />
<br />
{{charmap|name1=Hexagram for Inner Truth|1=4DFC|IncludeGB=no}}<br />
== Hexagram 62 ==<br />
<br />
[[image:iching-hexagram-62.svg|right]]<br />
<br />
''Hexagram 62'' is named {{lang|zh|小過}} (xiǎo guò), "Small Exceeding". Other variations include "preponderance of the small" and "small surpassing". Its inner trigram is ☶ ({{lang|zh|艮}} gèn) bound = ({{lang|zh|[[山]]}}) mountain, and its outer trigram is ☳ ({{lang|zh|震}} zhèn) shake = ({{linktext|lang=zh|雷}}) thunder.<br />
<br />
{{charmap|name1=Hexagram for Small Preponderance|1=4DFD|IncludeGB=no}}<br />
<br />
== Hexagram 63 ==<br />
<br />
[[image:iching-hexagram-63.svg|right]]<br />
<br />
''Hexagram 63'' is named {{lang|zh|既濟}} (jì jì), "Already Fording". Other variations include "after completion" and "already completed" or "already done" . Its inner trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire, and its outer trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water.<br />
<br />
{{charmap|name1=Hexagram for After Completion|1=4DFE|IncludeGB=no}}<br />
<br />
== Hexagram 64 ==<br />
<br />
[[image:iching-hexagram-64.svg|right]]<br />
<br />
''Hexagram 64'' is named {{lang|zh|未濟}} (wèi jì), "Not Yet Fording". Other variations include "before completion" and "not yet completed". Its inner trigram is ☵ ({{lang|zh|坎}} kǎn) gorge = ({{lang|zh|[[Water (Wu Xing)|水]]}}) water, and its outer trigram is ☲ ({{lang|zh|離}} lí) radiance = ({{lang|zh|[[Fire (Wu Xing)|火]]}}) fire.<br />
<br />
{{charmap|name1=Hexagram for Before Completion|1=4DFF|IncludeGB=no}}<br />
<br />
{| align="center"<br />
| {{I Ching}}<br />
|}<br />
<br /><br />
{| align="right"<br />
| {{Taoism condensed}}<br />
|}<br />
<br />
== References ==<br />
<br />
{{reflist}}<br />
<br />
==External links==<br />
* {{in lang|en|fr}} [http://wengu.tartarie.com/wg/wengu.php?l=Yijing Wilhelm, Baynes “The I Ching or Book of Changes”] <small>(Association Française des Professeurs de Chinois)</small><br />
<br />
{{Asia topic|Literature of}}<br />
<br />
[[Category:I Ching]]</div>Jawitkien