モジュール:Portal bar
| Luaモジュールを使用しています: |
| このモジュールはテンプレートスタイルを使用しています: |
このモジュールは、ポータルへのリンクを横長のボックスで表示する{{Portal bar}}を実装しています。詳しくはテンプレートの説明文を参照してください。
2025年7月時点では、Portal barのほかに{{Related portals}}で使用しています。
説明
[編集]以下のように使います。
注: 基本的にはテンプレート内で呼び出すため、記事中で直接呼び出すことはほとんどありません。引数の解説のために示しています。
{{#invoke:Portal bar|main|ポータル名1|ポータル名2|...|border=no}}
- main以降の無名の引数には、ポータル名を指定します。複数指定できます。
- 引数
|border=の値にno、n、falseまたは0を指定すると、枠線なしのボックスを生成します。 - 引数
|redlinks=の値にyes、y、trueまたはincludeを指定すると、(名前を間違っている、まだ作成されていない、過去にあったが削除されたなどの理由で)リンク先が存在しない赤リンクのポータルも表示します。 - Template:Portal barでは文字サイズfont-sizeが88%と少し小さめです。一方、引数
|related=の値にyesを指定すると、Template:Related portals向け(ポータル内での使用向け)に通常の文字サイズで表示され、アイコン画像も少し大きくなります。
実際の表示などの詳細はテンプレートの説明文Template:Portal bar/doc、Template:Related portals/docを参照してください。
なおこのモジュールは、モジュール:Portalを使用してポータルのアイコン画像を取得しています。画像の追加・変更・除去についてはモジュール:Portal/doc#画像を参照してください。
-- This module implements {{portal bar}}.
require('strict')
-- determine whether we're being called from a sandbox
local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true)
local sandbox = isSandbox and '/sandbox' or ''
local portalModule = require('Module:Portal'..sandbox)
local getImageName = portalModule._image
local checkPortals = portalModule._checkPortals
local processPortalArgs = portalModule._processPortalArgs
local yesno = require( 'Module:Yesno' )
local getArgs = require('Module:Arguments').getArgs
local p = {}
local function sandboxVersion(s)
return isSandbox and s.."-sand" or s
end
-- Builds the portal bar used by {{portal bar}}.
function p._main( portals, args )
-- check for sensible args
args = type(args) == "table" and args or {}
-- Normalize arguments
for key, default in pairs({border=true,redlinks=false,tracking=true}) do
if args[key] == nil then args[key] = default end
args[key] = yesno(args[key], default)
end
local nav = mw.html.create( 'div' )
:addClass(sandboxVersion('portal-bar'))
:addClass( 'noprint metadata noviewer' )
:attr( 'role', 'navigation' )
:attr( 'aria-label' , 'Portals' )
:addClass(sandboxVersion(args.border and 'portal-bar-bordered' or 'portal-bar-unbordered'))
local trackingCat = ''
-- Allow any number of portals
args.minPortals = 0
args.maxPortals = -1
-- Check to see whether there are redlinks, filter out unless args.redlink is true
portals, trackingCat = checkPortals(portals, args)
nav:wikitext(trackingCat)
if #portals == 0 then
return trackingCat
end
local related = yesno(args.related)
if related then
nav:addClass(sandboxVersion('portal-bar-related'))
else
local header = nav:tag('span')
header:addClass(sandboxVersion('portal-bar-header'))
header:wikitext('[[Portal:コンテンツ/ポータル|ポータル]]')
if #portals > 1 then
header:wikitext('')
end
header:wikitext(':')
end
local container = nav:tag('ul')
container:addClass(sandboxVersion('portal-bar-content'))
if related then
container:addClass(sandboxVersion('portal-bar-content-related'))
end
local size = related and '28x24px' or '21x19px'
for _, portal in ipairs( portals ) do
container
:tag( 'li' )
:addClass(sandboxVersion('portal-bar-item'))
:wikitext( string.format('<span class="nowrap">[[File:%s|%s]] </span>[[Portal:%s|%s]]',
getImageName(portal,true), size, portal, portal))
end
local styleFile = 'Module:Portal bar'..sandbox..'/styles.css'
return mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = styleFile }
} .. tostring( nav )
end
-- Processes external arguments and sends them to the other functions.
function p.main( frame )
local origArgs = getArgs(frame)
local portals, args = processPortalArgs(origArgs)
return p._main( portals, args )
end
return p