「モジュール:Citation/Show date/doc」を編集中

{{使用箇所の多いテンプレート|610,000以上}}
{{Lua|モジュール:Citation/CS1/Date validation|モジュール:Citation/Show date/Configuration}}
このモジュールは出典テンプレートで使われる各種の日付を表示します。{{tl|Citation/showdate}}・{{tl|Citation/showdateEN}}の内部で使用されているほか、各種出典テンプレートから直接使用することもできます。

従来のテンプレートで有効な日付形式は基本的にサポートしている一方で、CS1モジュールの機能を利用することで、{{para|df}}による日付の変換や、範囲を含む日付のような複雑な形式もサポートしているのが特長です。

== 使い方 ==
=== 書式 ===
<syntaxhighlight lang="wikitext">{{#invoke:Citation/Show date |show_date |1= |param-name= |post-text= |df=}}</syntaxhighlight>

{{para|1}}に日付を指定してください。

{{para|param-name}}には{{pval|date}}・{{pval|publication-date}}・{{pval|doi-broken-date}}・{{pval|archive-date}}・{{pval|access-date}}のような日付の種類を指定します。省略するか空文字列を指定した場合は、{{pval|date}}が指定された場合と同じ動作になります。

{{para|post-text}}には閲覧日の後ろに表示する文字列を指定します。この引数は{{para|param-name|access-date}}を同時に指定した場合のみ有効です。{{para|post-text}}を指定しなかった場合は閲覧日の後ろに「閲覧。」を表示します。空文字列を指定した場合は閲覧日の後ろに文字列を追加しません。

{{para|df}}には日付の表示形式を指定します。指定可能な値には{{pval|ja}}・{{pval|ymd}}・{{pval|mdy}}・{{pval|dmy}}などがあり、それぞれの意味合いはCS1テンプレートの同名の引数に指定する値と同じです。ただし{{para|df}}を省略した場合は日付の変換を行いません。{{para|param-name}}に{{pval|archive-date}}もしくは{{pval|access-date}}を指定した場合は、{{para|df}}に関係なく常に日付を日本語形式で表示します。

== 動作の解説 ==
このモジュールの大まかな動作は以下のようになっています。以下の説明文にある<code>dates()</code>と<code>reformat_dates()</code>は、いずれも[[モジュール:Citation/CS1/Date validation]]で定義されている関数です。

まず、引数で指定された日付を<code>dates()</code>で検査します。

検査に合格した場合は必要に応じてreformat_dates()で日付を変換した上で、日付をモジュールの呼び出し元に返します。

{{para|param-name|access-date}}が指定されていて、<code>dates()</code>による検査が不合格であった場合は、{{tl|Accessdate}}をモジュールの内部で呼び出し、その結果を返します。

{{para|param-name}}の値が{{pval|access-date}}以外で、<code>dates()</code>による検査が不合格であった場合は、{{tl|ISO dateJA}}をモジュールの内部で呼び出して、日付を[[ISO 8601]]形式へ変換することを試みます。ISO 8601形式への変換に成功した場合は日付が再来年以降のものでないことを確認した上で、ISO 8601形式の日付をreformat_dates()で更に変換して返すか、もしくはモジュールの引数に指定された日付をそのまま返します。ISO 8601形式への変換に失敗した場合や、日付が再来年以降のものであった場合は、元の日付にエラーメッセージを追記して返します。

<includeonly>{{sandbox other||
<!-- カテゴリは以下に追加してください -->
[[Category:ウィキペディアのモジュール]]<!-- 適切なサブカテゴリに張り替えてください -->
}}</includeonly>