モジュール:File clip/doc
 | これはモジュール:File clipの解説サブページです。 使用方法、カテゴリ、およびその他モジュールページ自体に含まれない情報を収容しています。 |
 | このモジュールはアルファ版です。現在、挙動や仕様などをテストしています。機能の追加や変更の提案も歓迎します。 |
 | このモジュールはテンプレートスタイルを使用しています: |
画像やPDFファイルのトリミング表示を行います。このモジュールは{{File clip}}の実装を置き換える目的で作成されました。
現時点では{{File clip/sandbox}}が当モジュールのラッパーテンプレートになっており、Template:File clip/testcasesにて動作テストを行っています。
使い方
[編集]{{#invoke:File clip|呼び出す関数名|ファイル名|width=表示サイズ（横幅）|その他のオプション ... }}
呼び出す関数名にthumbを指定するとサムネイル形式で表示し、nothumbを指定するとフレームなしの形式で表示します。
ファイル名と表示サイズの指定は省略できません。
ファイル名を指定する際に名前空間プレフィックス（ファイル:やFile:など）を付ける必要はありません。
|width=には表示する際の横幅をピクセル単位で指定します。指定する値は数値のみとし、単位は付けないでください。
その他のオプションには以下の指定が可能です。
|t=,|r=,|b=,|l=- それぞれ切り抜く上部分、右部分、下部分、左部分の大きさを百分率で指定します。指定する値は0以上100未満の数値のみとし、%は付けないでください。省略した場合は0を指定した場合と同じになります。|w=,|h=- それぞれ元のファイルの横幅・縦幅をピクセル単位で指定します。指定する値は数値のみとし、単位は付けないでください。省略した場合はScribuntoのファイルメタデータを利用して横幅・縦幅を自動的に取得しますが、これを行うと高負荷構文解析関数使用回数のカウンタが増加します。|w=と|h=の両方を指定することにより、これを回避することができます。|align=- ファイルの表示位置を指定します。指定可能な値と省略時の挙動については[[ファイル:ファイル名|...]]による画像の表示と同様です。詳細についてはthumb形式の場合はHelp:画像の表示#thumbを、nothumb形式の場合はHelp:画像の表示#配置指定をご覧ください。|caption=（あるいは|c=） - キャプションを指定します。省略時はファイル名が使われます。|alt=- キャプションとは別にimg要素のalt属性の値を設定する場合は指定します。空文字列を指定することもできます。|page=- ファイル形式がDjVuやPDFの場合に、表示するページの番号を指定します。省略すると1ページ目を表示します。|link=- 画像をクリックした際のリンクを変更することができます（空文字列も指定可能）。CC BYなど、ファイルのライセンスが帰属表示を求めている場合は、このオプションを使わないでください。詳しくはHelp:画像の表示#画像リンクをご覧ください。
使用例
[編集]コード
{{#invoke:File clip|thumb|Wikipedia Logo 1.0.png|width=200|align=left|t=0|r=25|b=70|l=35|caption=2003年から2010年まで使われていたウィキペディアのロゴの一部分}}
表示
