From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../index.html | 12 ++ .../macros/commonly-used_macros/index.html | 210 +++++++++++++++++++++ files/ja/mdn/structures/macros/index.html | 46 +++++ 3 files changed, 268 insertions(+) create mode 100644 files/ja/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html create mode 100644 files/ja/mdn/structures/macros/commonly-used_macros/index.html create mode 100644 files/ja/mdn/structures/macros/index.html (limited to 'files/ja/mdn/structures/macros') diff --git a/files/ja/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html b/files/ja/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html new file mode 100644 index 0000000000..a22ce9c70e --- /dev/null +++ b/files/ja/mdn/structures/macros/commonly-used_macros/creating_templates_for_multi-languages/index.html @@ -0,0 +1,12 @@ +--- +title: creating templates for multi-languages +slug: >- + MDN/Structures/Macros/Commonly-used_macros/creating_templates_for_multi-languages +--- +
{{MDNSidebar}}
+
註：　このページは執筆中です。
+

執筆用memo

+ +

テンプレートの 2 つのタイプ

+

page.langage を使わない

diff --git a/files/ja/mdn/structures/macros/commonly-used_macros/index.html b/files/ja/mdn/structures/macros/commonly-used_macros/index.html new file mode 100644 index 0000000000..f7cc685313 --- /dev/null +++ b/files/ja/mdn/structures/macros/commonly-used_macros/index.html @@ -0,0 +1,210 @@ +--- +title: よく使われるマクロ +slug: MDN/Structures/Macros/Commonly-used_macros +tags: + - CSS + - Macros + - Reference + - Structures +translation_of: MDN/Structures/Macros/Commonly-used_macros +--- +

{{MDNSidebar}}

+ +

このページには MDN で使うために作られた汎用のマクロがたくさん掲載されています。これらのマクロの使い方については、 マクロの使い方 と リンクを生成するマクロ を見てください。 その他のマクロ には、めったに使われないマクロ、特殊な文脈でのみ使われるマクロ、使用が推奨されないマクロについての情報が書かれています。また、MDNで使用できるマクロの完全な一覧もあります。

+ +

CSS スタイルガイドも見てください。

+ +

リンク

+ + + +

一般的に、単なるリンクを作成するためにマクロを使う必要はありません。エディターインターフェイスにある リンク ボタンを使えば、リンクを作成できます。

+ + + +

リファレンス内のページへのリンク

+ +

いろいろなマクロがあり、MDN の指定したリファレンスエリア内のページへのリンクを作成することができます。

+ + + +

バグへのリンク

+ + + +

複数のページからなるガイドのためのナビゲーション補助

+ +

{{TemplateLink("Previous")}}、{{TemplateLink("Next")}}、{{TemplateLink("PreviousNext")}} は、一連の記事の中でのナビゲーションコントロールを提供します。一方向用のテンプレートでは、 前の または 次の 記事の Wiki 位置を指す1つの引数が必要です。{{TemplateLink("PreviousNext")}} については、前の記事、次の記事を指す 2つの引数を取ります。最初の引数が前の記事を指し、2番めの引数が次の記事を指します。

+ +

コードのサンプル

+ +

Live サンプル

+ + + + + +

ほぼすべての大きなページの集まりについて、雛形があります。典型的には、リファレンス、ガイド、チュートリアルでメインページに戻るためのリンク (パンくずリストではできないことがある) を提供し、記事を適切なカテゴリに配置します。

+ + + +

汎用の書式

+ +

API 文書のためのインラインインジケーター

+ +

{{TemplateLink("optional_inline")}} と {{TemplateLink("ReadOnlyInline")}} は API 文書の中で通常、オブジェクトのプロパティまたは関数の引数のリストを記述するのに使われます。

+ +

用法: \{{optional_inline()}} または \{{ReadOnlyInline}}. 例:

+ +
+
isCustomObject{{ReadOnlyInline}}
+
true の場合、オブジェクトはカスタムオブジェクトであることを示します。
+
parameterX{{Optional_Inline}}
+
ごにょごにょごにょ...
+
+ +

状態と互換性についての表示

+ +

インラインインジケーター (追加引数なし)

+ +

標準外のもの

+ +

{{TemplateLink("non-standard_inline")}} は、その API が標準化されておらず、また標準化の予定もないことを示すインラインマークを付けます。

+ +
構文
+ +

\{{Non-standard_Inline}}

+ +
例
+ + + +

実験的なもの

+ +

{{TemplateLink("experimental_inline")}} は、その API が広く実装されておらず、また将来変更される可能性があることを示すインラインマークを付けます。

+ +
構文
+ +

\{{Experimental_Inline}}

+ +
例
+ + + +

特定の技術の対応状況を表すインラインインジケーター

+ +

これらのマクロにパラメータを指定する場合は、"html", "js", "css", "gecko",のうちの1つにバージョン番号を加えたものとなります。

+ +

非推奨のもの

+ +

{{TemplateLink("deprecated_inline")}} はインラインの非推奨(deprecated) マークを付け、その API が公式には非推奨であり、使用を控えるべきであることを示します。注: 非推奨 (deprecated) が意味するのは、その項目はもう使用されるべきではないが、まだ機能するものであることです。もう機能しないものを示す用語としては、廃止 (obsolete) を使ってください。

+ +

ブラウザー特有の記述 (HTML, API, JS, CSS, …) では、引数を使用しないでください。

+ +
構文
+ +

\{{Deprecated_Inline}} または \{{Deprecated_Inline("gecko5")}}

+ +
例
+ + + +

廃止

+ +

{{TemplateLink("obsolete_inline")}} はインラインの廃止 (obsolete) マークを付け、例えばその関数、メソッド、またはプロパティ等を使用してはいけないことを示します。

+ +

ブラウザー特有の記述 (HTML, API, JS, CSS, …) では、引数を使用しないでください。

+ +
構文
+ +

\{{Obsolete_Inline}} または \{{Obsolete_Inline("js1.8.5")}}

+ +
例
+ + + +

テンプレートバッジ

+ +

これらのマクロはほとんど WebAPI ページで使われます。{{anch("Creating new badges")}} に新しいバッジを作成するための情報があります。

+ +

ページまたはセクションのヘッダーを示すインジケーター

+ +

これらのテンプレートが示すのは、上記の対応するインラインマークと同じものです。テンプレートはリファレンスページのメインページタイトルの (または、パンくずリストがあるならばその) 直下に置きます。ページ内のセクションをマークアップすることもできます。

+ + + +

ウェブワーカーで使用できる機能であることを示す

+ +

{{TemplateLink("AvailableInWorkers")}} マクロは、その機能がウェブワーカーのコンテキストで有効であることを示すためのローカライズされた注記ボックスを挿入するのに使われます。

+ +

{{AvailableInWorkers}}

diff --git a/files/ja/mdn/structures/macros/index.html b/files/ja/mdn/structures/macros/index.html new file mode 100644 index 0000000000..40cddcf091 --- /dev/null +++ b/files/ja/mdn/structures/macros/index.html @@ -0,0 +1,46 @@ +--- +title: マクロ +slug: MDN/Structures/Macros +tags: + - Guide + - Kuma + - KumaScript + - MDN Meta + - Structures +translation_of: MDN/Structures/Macros +--- +
{{MDNSidebar}}

MDN が動作している Kuma プラットフォームは、幅広い作業の自動化を可能にする強力なマクロシステムである KumaScript を提供しています。この記事は MDN のマクロを記事中で呼び出す方法について情報を提供します。

+ +

KumaScript ガイドでは MDN 上でマクロを利用する方法について詳細な情報を提供しているので、このセクションではむしろ全体の簡潔なまとめをします。

+ +

マクロはどのように実装されているか

+ +

MDN 上で動作するマクロは、サーバーで実行される JavaScript コードを使用して実装され、 Node.js によって解釈されます。そのうえ数多くのライブラリを用意しており、 Wiki 風のサービスを提供します。また、 Wiki プラットフォームとそのコンテンツを、マクロと連携させる機能を提供します。もっと詳細に興味があるのであれば、 KumaScript ガイドを参照して下さい。

+ +

コンテンツでのマクロの利用

+ +

実際にマクロを使うには、マクロの呼び出しを二重の中括弧で囲むだけです。引数があれば括弧で囲みます。つまり以下のようになります。

+ +
\{{macroname(parameter-list)}}
+ +

マクロ呼び出しに関するいくつかのポイント

+ + + +

マクロは高度にキャッシュ化されています。どの入力値についても（引数や、マクロを動作させる URL といった環境変数のいずれでも）、その結果は記憶され再利用されます。つまり、入力が変化した時だけマクロは実行されます。

+ +
+

注: ブラウザーでページを強制的に再読み込み（つまり、 Shift を押しながら再読み込み）すると、そのページのマクロを再評価することが出来ます。

+
+ +

マクロは大きなテキストブロックを挿入したり、 MDN の他記事からの内容で置き換えたりするようなシンプルなこともできますし、サイトを走査して目次をまるごと作り上げたり、出力のスタイリングをしたり、リンクを張ったりといった複雑なこともできます。

+ +

最もよく使われるマクロについて良く使われるマクロのページで学習することが出来ます。また、マクロの完全なリストもあります。そして多くのマクロには最上部のコメントとして、ソースに説明が組み込まれています。

+ +

{{EditorGuideQuicklinks}}

-- cgit v1.2.3-54-g00ecf