利用者:Omotecho/sandbox/Template:Currency/doc

{{Documentation subpage}} {{High-use}} {{lua|Module:モジュール:Currency|Module:モジュール:Currency/Presentation}} {{Lua sidebar}} このテンプレートは、通貨に関する記事にリンク付きの適切な記号を使い、通貨の値に書式を設定します。通貨を指定しない場合、テンプレートは金額をアメリカドル（en:United States dollars）で表示します。

使い方

パラメータを指定しない場合。

パラメータを指定した場合。

この記法の詳細です。

value　数値。カンマ区切りの有無を問いません。続けて任意の量の指定子（quantifier）を書く場合は：'thousand'、'million'、'M'、'billion'、'B'、または 'trillion'。

code is an ISO 4217 通貨コードもしくはその他の非標準コードのうち、以下の一覧にあるもの。

|first=　設定すると、任意の値に書き下した通貨名を生成。

|linked=　no に設定すると、通貨記号または書き下した通貨名にレンダリングして内部リンクを付ける。

|fmt=　value の桁の区切り方を指定。

commas（既定）　value のカンマを含む桁を区切る。これは既定で有効であり、|fmt= が空または省略された場合と同じ。

gaps　value の桁区切りに半角アキを採用。

none　value の桁を区切らずにレンダリング。

|passthrough=　数値を解析するテンペートが |fmt= に従うべきか、または通貨記号の直後に |amount= が指定する文字列を置くかどうかを指定。|passthrough=yes または |passthrough=no のいずれかの値が必要。

パラメータ名を使用する場合は、|amount= と |code= が推奨されます。ただしテンプレートは |Amount=、|type= および |Type= も受け入れます。

注記：名前付きと名前なしの両方のパラメータを使うと、予想外の結果が生じるかもしれません。次の例だと、テンプレートは最初の名なしパラメーターを数値と想定しています。

{{Currency|amount=1000|GBP}}

£1,000 という出力を期待するなら、{{Currency|1000|GBP}} あるいはまた {{Currency|amount=1000|code=GBP}} を選びましょう。

非標準でも対応する為替コードの一覧

ISO 4217 通過コードに置き換え可能なコード

これらの非標準コードは、次の標準コードの ISO 4217 エイリアスです。

• EGE
• EU
• EURO
• FRW
• KSH
• NEP
• POUND
• POUND STERLING
• RMB
• STERLING
• STG
• TSH
• UK
• UNITED STATES
• US
• U.S.
• USA
• USH

対応外の非標準コード

以下のコードはその通貨固有の側面をサポートしており、一致する ISO 4217 通貨コードがないか、既存の ISO 4217 コードの代替版 ⇒ などです。

• BITCOIN – 一致する ISO 4217 通貨コードがない
• BTC – 一致する ISO 4217 通貨コードがない
• DKK2 – 右のコードの代替版 ⇒ DKK
• FRF – 廃止
• GRD – 廃止
• LSL2 – 複数形＝LSL
• LTL – 廃止
• NOK2 – 右のコードの代替版 ⇒ NOK
• SEK2 – 右のコードの代替版 ⇒ SEK
• SZL2 – 複数形＝ SZL
• US$ - 例外：標準コード "USD"（および "$"）と同様でありながら、文字数が多い "US$"ではなく "$" のみ表示。（記事中に "US$" と表示しては不適切に長く見える場合でも、曖昧さを避けるためテンプレートは "アメリカドル" にリンクする必要があります。）
• XBT – 一致する ISO 4217 通貨コードがない

例

アメリカドル以外の通貨は、適切な ISO 4217 通貨コードを使ってレンダリングできます。

• バミューダのドル、{{Currency|1000|BMD}} と書くと表示は：BD$1,000
• バングラデシュのタカ、{{Currency|1000|BDT}} と書くと表示は：৳1,000
• アルメニアのドラム、{{Currency|1000|AMD}} と書くと表示は：֏ 1,000

よく知られた通貨なら、一部ですが一般的な略語や正式名称を使えるようにした機能もあります。

• {{Currency|1000|US}} と書くと表示は：US$1,000
• {{Currency|1000|United States}} と書くと表示は：US$1,000
• {{Currency|1,000|JPY}} と書くと表示は：¥1,000

好みによりますが、パラメータの名称を使うこともできます：

• {{Currency|amount=1000|code=US}} と書くと表示は：US$1,000
• {{Currency|1000|code=euro}} と書くと表示は：€1,000

マイナスの数値の場合：

• {{Currency|amount=-1000|code=US}} と書くと表示は：US$−1,000

数量を文字で書く場合：

• {{Currency|1000 million|code=euro}} と書くと表示は：€1,000,000,000
• {{Currency|1000M|code=euro}} と書くと表示は：€1,000,000,000

文中で初めて通貨を記すときには、通貨の完全な名前と数値の両方を示すため、パラメータの "first" を定義してあるなら、それを適用します。

• {{Currency|1000|cve|first=yes}} と書くと表示は：1,000 カーボベルデ・エスクードs
• {{Currency|1000|cve}} と書くと表示は：1.000$00

通貨記号 DKK、NOK、SEK は曖昧さを避けるため、単数と複数の2種類の記法を使い分けることがあります。

• DKK なら：

  {{Currency|1000|dkk}} と書くと表示は：kr. 1,000

  {{Currency|1000|dkk2}} と書くと表示は：DKK 1,000

• NOK なら：

  {{Currency|1000|NOK}} と書くと表示は：kr 1,000

  {{Currency|1000|NOK2}} と書くと表示は：NOK 1,000

• SEK なら：

  {{Currency|1000|SEK}} と書くと表示は：kr 1,000

  {{Currency|1000|SEK2}} と書くと表示は：SEK 1,000

これらと同様に、次のように金額の単数と複数形で記号が異なる通貨が一部あります。

• {{Currency|1|LSL}} と書くと表示は：L1

  {{Currency|1000|LSL2}} と書くと表示は：M1,000

  現在のところ、この区別をテンプレートが自動で処理しないため、この種のコードを使う編集者の責任で正しく表示させてください。

数字の桁区切り：

• |fmt=commas

  {{Currency|1000 million|code=euro|fmt=commas}} と書くと表示はカンマ区切り：€1,000,000,000

• |fmt=gaps

  {{Currency|1000 million|code=euro|fmt=gaps}} と書くと表示はスペースで区切ります：€1000000000

• |fmt=none

  {{Currency|1000 million|code=euro|fmt=none}} と書くと表示は桁区切りなし：€1000000000

パススルー：

• |passthrough=yes

  {{Currency|6 million|PHP|passthrough=yes}} と書くと表示は：₱6,000,000

  {{Currency|6 trillion|PHP|passthrough=yes}} と書くと表示は：₱6,000,000,000,000

  {{Currency|6 tn|PHP|passthrough=yes}} と書くと表示は：

• |passthrough=no

  {{Currency|6 million|PHP|passthrough=no}} と書くと表示は：₱6,000,000

  {{Currency|6 trillion|PHP|passthrough=no}} と書くと表示は：₱6,000,000,000,000

  {{Currency|6 tn|PHP|passthrough=no}} と書くと表示は：（予想されるエラーとして、 6 tn を与えられても、テンプレートは 6,000,000,000,000 に解析する方法がない。）

• 使用は控えめに！ 通常は |fmt= で代用します。（|passthrough= を使うなら、必ず、日付と単位の表記ガイドに適合させてください。）

エラーメッセージ

{{currency}} から生成されるエラーメッセージは、既定で以下のものがあります。

• – 2番目の名なしパラメータもしくは割り当てた |code= が、テンプレートのコード一覧に該当しません。割り当てたコードが正しい ISO 4217 通貨コードか、上記の対応するる非標準コードの中にあるか確認してください。
• – 1番目の名なしパラメータもしくは |amount= の指定に既定のマイナス記号、カンマ、小数点ではない文字が1件以上あるか、または許可された数量詞ではない文字が混入しています。区切り文字がカンマなら、数字が3 桁ずつで区切ってあること、さらに数値に含まれる小数点が 1つだけであると確認してください。amount パラメータと code パラメータは、両方とも名前付き（|amount= と |code=）、あるいは両方とも名前なしでなければいけません。
• – この内部エラーの発生は、編集者がモジュール:Currency/Presentation をいじっているとき限定です。通貨の記号をその値に関連して配置する位置をモジュール:Currency が認識していないことを示します。
• – この内部エラーの発生は、編集者がモジュール:Currency/Presentation をいじっているとき限定です。通貨の記号または名称にリンクさせるページがモジュール:Currency に存在しないことを示します。

TemplateData

これはビジュアルエディターやテンプレートウィザードにより使用されるテンプレートのためのTemplateData文書です。

Omotecho/sandbox/Template:Currency

このテンプレートを使うと、リンク付きの通貨記号と現金の金額を表示します。

テンプレートパラメーター

このテンプレートは、パラメーターを1行で記述することが推奨されています。

パラメーター		説明	型	状態
数値	1 amount Amount	指定した通貨の値	行	必須
通貨	2 code type Type	表示する通貨。有効な ISO 4217 コードまたはテンプレートページに載った非標準コードの一覧にあるものに限定 既定 USD 例 USD	行	推奨
書き下し	first	任意の値に設定すると、通貨名を書き下し（長い形式）で生成。使うときは、記事内で最初に通貨に言及する場合に限定	行	省略可能
リンク付き通貨	linked	その通貨の記事にリンクするかどうか。「no」を指定するとリンクなし、他の値を指定するとリンク元を表示 既定 yes 例 no	行	省略可能
書式設定	fmt	数値の桁（けた）区切りを指定：カンマ、スペース（gaps）またはなし 既定 commas 例 gaps	行	省略可能
パススルー	passthrough	"yes" を指定すると、Amount の文字列を数値に変換せず、記号の直後に配置。 既定 no 例 yes	行	省略可能

関連項目

使い方のパターンについて重要なまとめ。

• 日付
• 単位
• {{tl|Format price}} Template:Format price、四捨五入と「大きな数値」の書式設定を処理するテンプレート
• {{tl|Inflation}} Template:Inflation、過去のコストを現在（または他の年）の同等の値に調整する
• {{tlx|Infobox currency}}