モジュール:Failsafe/doc

このページは、モジュール:Failsafeの説明文を記述するページです。

このモジュールは、バージョン確認のために他モジュールを点検します。この関数は、一般的にはモジュールのインポートに使用されますが、ウィキボヤージュのモジュールにも提供されます。

ウィキデータでのバージョン： 2022-04-25

関数[編集]

function fs._failsafe( version, moduleInterface )

パラメータ：

version（bool or string or table）
nil or falseの時、バージョン確認はされず、モジュールに書かれているバージョンを参照します。

stringが渡されている時、もしも'wikidata'が渡されているならばウィキデータに保存されたバージョンを参照します。バージョン番号そのものが含まれている場合にはそのバージョンを使用します。取得したあるいは渡されたバージョン番号とモジュール内に書かれたバージョン番号を比較し、異なる場合は現在のバージョン番号が返り、そうでないならばfalseが返ります。

tableを渡された場合、frameテーブルとして処理します。
moduleInterface（table）
モジュールの情報が入ったテーブル

戻り値：

現在のバージョンか、falseが戻り値になります。

function fs.getModuleVersion( frame )

ウィキデータやモジュールに保存されたバージョンを提供し、可能ならばそれらが一致するか評価します。

moduleInterfaceの構造[編集]

local Modulname = {
	suite    = 'Modulname',
	sub      = 'Untermodul',  
	serial   = '2019-07-09',
	item     = 12345678,   -- ウィキデータID

	-- 以下も使われますが、何を想定したものかは不明です。

	frame    = false,
	ns       = -9999,      -- number; 現在の名前空間番号
	nsDocs   = -99999,     -- number; 中央ドキュメントの名前空間番号
	title    = false,      -- 現在のページのタイトルオブジェクト
	transl   = false,
	subpages = ?,
	suffix   = ?,
	swift    = ?,
	start    = ?,          -- string; 定義されたpageDocRoot引数
	script   = ?,          -- string; モジュール名（メイン）
	say      = ?,          -- string; メッセージキー
	specific = ?,          -- string, optional; 追加の情報
	collect  = ?,
	lazy     = ?,
	lead     = ?,
}

おそらくドイツ語版ウィキペディアのModul:Vorlage:LuaModuleDocにあるでしょう。

例[編集]

function fs._failsafe( nil, moduleInterface )

```
{{#invoke: {{BASEPAGENAME}} | failsafe }}
```
モジュールからバージョンを提供します。

function fs._failsafe( 'wikidata', moduleInterface )

{{#invoke: {{BASEPAGENAME}} | failsafe | wikidata }}

ウィキデータからバージョンを提供します。

function fs._failsafe( '2019-07-09', moduleInterface )

```
{{#invoke: {{BASEPAGENAME}} | failsafe | 2019-07-09 }}
```
渡されたバージョンとモジュールのバージョンを比較します。

{{#ifeq: {{#invoke:{{BASEPAGENAME}} | failsafe }} | {{#invoke:{{BASEPAGENAME}} | failsafe | wikidata }}
| {{ombox | type = notice | image = [[Image:Blue check.svg|30px]] | text = モジュールは最新です }}
}}

ウィキデータに保存されているバージョンとモジュールに書かれているバージョンが一致するか評価します。

使用状況[編集]

このモジュールを使用しているテンプレートは以下の通りです：

テンプレート:モジュールのバージョン