You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
501 lines
22 KiB
Plaintext
501 lines
22 KiB
Plaintext
INTSourceChangelist:2033300
|
||
Availability:Docs
|
||
Title:
|
||
Crumbs:
|
||
Description:
|
||
|
||
Keywords:メタデータはセミコロンでドキュメントの上部に追加します。
|
||
Title:Epic で使用している Markdown 記法と拡張機能
|
||
Crumbs:DocumentationGuidelines
|
||
Description:Epic がカスタマイズした Markdown 拡張機能を用いたドキュメンテーションソースファイルの作成方法
|
||
DoIndex:false
|
||
|
||
[TOC (start:2 end:3)]
|
||
|
||
[REGION:note]
|
||
**注記：**本ドキュメントも Epic の Markdown で書かれています。 [こちらをご覧ください](DocumentationGuidelines\SyntaxSource)
|
||
[/REGION]
|
||
|
||
## 概要
|
||
|
||
Epic 版の Markdown は [MarkdownSharp](http://code.google.com/p/markdownsharp/) をベースとしています。MarkdownSharp は [PHP Markdown Extra](http://michelf.com/projects/php-markdown/) の機能をいくつか備えた [Markdown](http://daringfireball.net/projects/markdown/) をベースとしています。
|
||
|
||
本ドキュメントの目的は Epic の機能に対応するための拡張機能、特にMarkdown Extra のどの機能が対応しているのかを説明することです。本ドキュメントはオリジナルの [Markdown 記法](http://daringfireball.net/projects/markdown/syntax) の補足資料です。
|
||
|
||
## Epic 版の機能
|
||
|
||
### 目次と見出しの自動生成
|
||
|
||
ヘッダ生成を変更して、スペースを削除した見出しとなるブックマークが含まれるようにしました。複数のヘッダ名が同じ場合は、後続のヘッダに 2 で開始するインデックスを付け足して対応します。
|
||
正しいインデントのヘッダリストを生成してドキュメントの上部のタグ \[TOC\] に置き換えます。
|
||
|
||
\[TOC (start:HeadingStartLevel end:HeadingEndLevel)\] を指定すると、目次に含まれる見出しレベルを設定することができます。開始と終了をオプションの変数で、指定のない場合、開始は 1 、終了は 6 が与えられます。両方設定する場合は、終了変数は開始変数の後にきます。
|
||
|
||
スペースを削除した見出しにブックマークが含まれるように、ヘッダ生成を変更します。ヘッダの最初の文字が !! の時、目次にヘッダは含まれません。
|
||
|
||
#### Markdown 記法
|
||
# 見出し
|
||
[TOC(start:2)]
|
||
|
||
#### HTML 出力
|
||
<h1 id="Heading1">Heading</h1>
|
||
<ul><li><a href="#Heading">Heading</a></ul>
|
||
|
||
|
||
#### 結果
|
||
ページの冒頭にある目次は本セクション \[TOC\] (start:2 end:3) で説明した方法で生成されています。
|
||
|
||
### ドキュメント内のブックマークへのリンク付け
|
||
|
||
ユーザはドキュメント内へリンクするブックマークを付けるだけでなく、ドキュメント内のヘッダにもリンクを付けることができます。
|
||
|
||
#### Markdown 記法
|
||
ファイル [目次と見出しの自動生成](#目次と見出しの自動生成) 内の見出しにリンクを付けた例です。ヘッダ テキストはテキスト内のスペースを削除するとリンク付けされます。さらに、 1 つ以上のヘッダに同じ名前が付いている場合、後に続くヘッダの名前の後にスペースをいれずに 2,3 などを付けて参照できます [Markdown 記法](#Markdown記法) [Markdown 記法2](#Markdown記法2) [Markdown 記法3](#Markdown記法3)
|
||
ドキュメント内にユーザー定義のブックマークをリンク付けした例です [ブックマーク 1](#ブックマーク1)。
|
||
(#ブックマーク1) ブックマーク テキストは行頭文字でなければなりません。
|
||
|
||
#### HTML 出力
|
||
<p> ファイル内の見出しにリンク付けした例です <a href="#AutogenerationofTableofContents">Auto generation of Table of Contents</a>.ヘッダ テキストはテキスト内のスペースを削除するとリンク付けされます。さらに、 1 つ以上のヘッダに同じ名前が付いている場合、後に続くヘッダの名前の後にスペースをいれずに 2,3 などを付けて参照できます <a href="#MarkdownSyntax">Markdown Syntax 1</a> <a href="#MarkdownSyntax2">Markdown Syntax 2</a> <a href="#MarkdownSyntax3">Markdown Syntax 3</a> </p>
|
||
<p>ドキュメント内にユーザー定義のブックマークをリンク付けした例です <a href="#Bookmark1">Bookmark 1</a>.</p>
|
||
<p><a id="Bookmark1"/> ブックマーク テキストは行頭文字でなければなりません。</p>
|
||
|
||
#### 結果
|
||
|
||
ファイル [目次と見出しの自動生成](#目次と見出しの自動生成) 内の見出しにリンクを付けた例です。ヘッダ テキストはテキスト内のスペースを削除するとリンク付けされます。さらに、 1 つ以上のヘッダに同じ名前が付いている場合、後に続くヘッダの名前の後にスペースをいれずに 2,3 などを付けて参照できます [Markdown 記法](#Markdown記法) [Markdown 記法2](#Markdown記法2) [Markdown 記法3](#Markdown記法3)
|
||
|
||
ドキュメント内にユーザー定義のブックマークをリンク付けした例です [ブックマーク 1](#ブックマーク1)。
|
||
|
||
(#ブックマーク1) ブックマーク テキストは行頭文字でなければなりません。
|
||
|
||
### ドキュメントの他のページへのリンク付け
|
||
|
||
他のページへは相対リンクを使用します。 「 markdown 」 フォルダにあるドキュメントは、 \%ROOT\% を使って参照します。リンク内では言語は指定されていません。今ご覧頂いている言語のファイルへリンク付けを前提としています。
|
||
|
||
#### Markdown 記法
|
||
[UE4 Home](\%ROOT\%)
|
||
[Unreal Editor User Guide](Engine/UI)
|
||
|
||
#### HTML 出力
|
||
<a href="./../../../INT\index.html">UE4 Home</a>
|
||
<a href="./../../../INT\Editor\index.html">Unreal Editor User Guide</a>
|
||
|
||
#### 結果
|
||
[UE4 Home](\%ROOT\%)
|
||
|
||
[Unreal Editor User Guide](Engine/UI)
|
||
|
||
### ローカル画像へのリンク付け
|
||
|
||
画像フォルダを参照する必要はありません。画像がドキュメント内の他のページに属している場合のみ他のパスを参照する必要があります。リンク内で言語の指定がなければ、まず言語フォルダの画像ディレクトリで画像を探し、次に INT 画像フォルダを探します。
|
||
|
||
#### Markdown 記法
|
||
|
||
|
||
|
||
#### HTML 出力
|
||
<img alt="Logo" src="./../../../images\EpicMarkdownDocGuides\EpicMarkdownExtension\Logo_Epic-New.jpg"/>
|
||
<img alt="Editor Viewprot" src="./../../../images\Editor\viewport.png"/>
|
||
|
||
#### 結果
|
||
|
||
|
||
|
||
|
||
###画像調整
|
||
画像のフォーマット指示および変換方法は指定できる方がよいです。
|
||
|
||
* 画像情報の後に (w: h: a: convert: type: quality: fill: ) を用いて以下を示します。
|
||
* **w:** 幅
|
||
* **h:** 高さ
|
||
* **a:** は、左、右、通常（初期値）のフロートスタイルが画像に指定されていることを表します。
|
||
* **convert:** は、画像を異なるタイプに圧縮 / 変換すべきかを false または true で表します。
|
||
* **type:** は jpg 、png 、gif のいずれかになります。
|
||
* **quality:** は圧縮の品質が jpeg となります。
|
||
* **fill:** はフォーマットが jpg に変換されている場合、画像の背景色番号です。
|
||
* オプションの順番は重要ですが、それぞれ任意で省略可能、または画像情報の後ろのブラケットをまるまる省略することが可能です。
|
||
* 変換パラメータがない場合、「 app.config 」ファイルのデフォルト値が使用されます。
|
||
* 既存の Markdown 画像包含方法であるインライン方法と参照方法は、両方とも拡張して初期化に対応しています。
|
||
* 画像を右または左に並べると、新しいセクションの開始時にヘッダが関係のない画像の横に流れるなど、関係のないコンテンツに画像が囲まれてしまうことがあります。その場合、テキストは画像の横に配置されます。clear: both; を指定しフロートスタイルを解除するためにスタイルシート要素を使用すると、現在の見出しレベル 1 、2 と hr 要素の回り込みが解除されます。
|
||
|
||
|
||
#### Markdown 記法
|
||
右 (a:right) 指定フロート、高さ、幅をブランクのままにしたインライン イメージです。
|
||
幅、高さ、左をフローとにしたリファレンス イメージ ![Epic Logo][RefEpicLogo] です。
|
||
[RefEpicLogo]:Logo_Epic-New.jpg "Here's a title"(w:50 h:50 a:left convert:true quality:75 fill:#000000)
|
||
段落内のテキストは画像に平行になります。特別な div 要素がフロートの終わりにきます。
|
||
[REGION:clear]
|
||
<!-- clear float -->
|
||
[/REGION]
|
||
#### HTML 出力
|
||
|
||
<p>右 <img style="float: right;" title="Here's a title" alt="Epic Logo" src="./../../../images\EpicMarkdownDocGuides\EpicMarkdownExtension\Logo_Epic-New.jpg"/> 指定フロート、高さ、幅をブランクのままにしたインライン イメージです。</p>
|
||
<p>幅、高さ、左をフローとにしたリファレンス イメージ <img width="50" height="50" style="float: left;" title="Here's a title" alt="Epic Logo" src="./../../../images\EpicMarkdownDocGuides\EpicMarkdownExtension\Logo_Epic-New.jpg"/> です。</p>
|
||
<p>段落内のテキストは画像に平行になります。特別な div 要素がフロートの終わりにきます。</p>
|
||
[REGION:clear]
|
||
<!-- clear float -->
|
||
[/REGION]
|
||
|
||
#### 結果
|
||
右フロート指定で、高さと幅の左をブランクにしたインライン イメージです (a:right)。
|
||
|
||
幅、高さ、左をフローとにしたリファレンス イメージ ![Epic Logo][RefEpicLogo] です。
|
||
|
||
[RefEpicLogo]:Logo_Epic-New.jpg "Here's a title"(w:50 h:50 a:left convert:true quality:75 fill:#000000)
|
||
|
||
段落内のテキストは画像に平行になります。特別な div 要素がフロートの終わりにきます。
|
||
|
||
[REGION:clear]
|
||
<!-- clear float -->
|
||
[/REGION]
|
||
|
||
### テーブル
|
||
テーブルが実装されています。 MultiMarkdown 記法で利用できるフォーマットはかなり融通がききますので、 Epic のベースとして選びました。
|
||
|
||
* ヘッダ行のテーブルデータのアライメントを示すためにコロンを記述します。
|
||
* 行の最初と最後にパイプ文字を記述することもできますし、省略することもできます。
|
||
* キャプションの追加が可能です。
|
||
* コルスパンが使用できます。
|
||
* ロースパンを使用するにはセルに ^ を使います。
|
||
|
||
|
||
#### Markdown 記法
|
||
[Table 1 - Headers to top]
|
||
| | Grouping ||
|
||
First Header | Second Header | Third Header |
|
||
------------ | :------------: | ------------: |
|
||
Content | *Long Cell* ||
|
||
Content | **Cell** | Cell |
|
||
New section | More | Data |
|
||
^ | And more ||
|
||
|
||
|
||
------------ | :------------: | ------------: |
|
||
Content | *Long Cell* ||
|
||
Content | **Cell** | Cell |
|
||
New section | More | Data |
|
||
^ | And more ||
|
||
|
||
[Table 2 - Headers to the right]
|
||
| ------------ | :------------: | ------------: |
|
||
| Content | *Long Cell* ||
|
||
| Content | **Cell** | Cell |
|
||
| New section | More | Data |
|
||
| ^ | And more ||
|
||
|
||
|
||
#### HTML 出力
|
||
|
||
<table>
|
||
<caption> Table 1 - Headers to top </caption>
|
||
<colgroup><col/>
|
||
<col align="center"/>
|
||
<col align="right"/>
|
||
</colgroup><thead>
|
||
<tr>
|
||
<th colspan="1"/>
|
||
<th colspan="2">Grouping</th>
|
||
</tr>
|
||
<tr>
|
||
<th colspan="1">First Header</th>
|
||
|
||
<th colspan="1">Second Header</th>
|
||
<th colspan="1">Third Header</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td colspan="1">Content</td>
|
||
<td align="center" colspan="2"><em>Long Cell</em></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td colspan="1">Content</td>
|
||
<td align="center" colspan="1"><strong>Cell</strong></td>
|
||
<td align="right" colspan="1">Cell</td>
|
||
</tr>
|
||
<tr>
|
||
<td rowspan="2" colspan="1">New section</td>
|
||
<td align="center" colspan="1">More</td>
|
||
|
||
<td align="right" colspan="1">Data</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center" colspan="2">And more</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<table>
|
||
<caption>Table 2 - Headers to the right</caption>
|
||
<colgroup><col/>
|
||
<col align="center"/>
|
||
<col align="right"/>
|
||
</colgroup><tbody>
|
||
<tr>
|
||
<th colspan="1">Content</th>
|
||
<td align="center" colspan="2"><em>Long Cell</em></td>
|
||
</tr>
|
||
<tr>
|
||
|
||
<th colspan="1">Content</th>
|
||
<td align="center" colspan="1"><strong>Cell</strong></td>
|
||
<td align="right" colspan="1">Cell</td>
|
||
</tr>
|
||
<tr>
|
||
<th rowspan="2" colspan="1">New section</th>
|
||
<td align="center" colspan="1">More</td>
|
||
|
||
<td align="right" colspan="1">Data</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center" colspan="2">And more</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
#### 結果
|
||
|
||
[Table 1 - Headers to top]
|
||
| | Grouping ||
|
||
First Header | Second Header | Third Header |
|
||
------------ | :-----------: | -----------: |
|
||
Content | *Long Cell* ||
|
||
Content | **Cell** | Cell |
|
||
New section | More | Data |
|
||
^ | And more ||
|
||
|
||
アライメント行上にヘッダ情報を持たない場合、一番左のカラムをヘッダと見なします。
|
||
|
||
[Table 2 - Headers to the right]
|
||
| ------------ | :------------: | ------------: |
|
||
| Content | *Long Cell* ||
|
||
| Content | **Cell** | Cell |
|
||
| New section | More | Data |
|
||
| ^ | And more ||
|
||
|
||
### メタデータ
|
||
メタデータは、メタデータ用 MultiMarkdowns 記法に沿って、以下のルールで実装されます。
|
||
|
||
* メタデータはドキュメントの一番上から開始します。前に行を挿入しないでください。
|
||
* メタデータはキーと値で構成されます。
|
||
* メタデータキーは行頭から開始します。先頭文字は文字まはた数字とします。ただし、 2 文字目以降は文字、数字、スペース、ハイフン、下線で組み合わせることができます。
|
||
* メタデータキーの終わりをコロンで指定します。
|
||
* コロンの後にメタデータ値を入れます。この値はほぼどんな文字の組み合わせでも大丈夫です (新しい行を除く)
|
||
* メタデータが完了したら、ブランク行が残りの文書の開始をトリガーします。
|
||
|
||
|
||
メタデータはすべてドキュメントのヘッダにある <meta name="Key" content="Value"/> html ブロックに置かれます。
|
||
上記以外にも特殊な機能をもつキーがあります。
|
||
|
||
* タイトルメタデータはヘッダブロック <title>タイトル</title> で使用されます。
|
||
* HtmlDocumentType のメタデータは、 「include/templates」 フォルダの中で html 生成に使用するテンプレートを定義するために使用されます。テンプレートがない場合は、 default.html テンプレートファイルを使用します。
|
||
* DoIndex:false からインデクサに、インデックスからドキュメントを排除し結果を検索するよう指示がでます。文書はすべて true がデフォルト値になっています。
|
||
* ForcePublishFiles: を使用して、添付と画像を「 html 」フォルダに強制的に公開することができます。
|
||
|
||
|
||
#### Markdown 記法
|
||
Keywords:メタデータはセミコロンでドキュメントの上部に追加します。
|
||
Title:これによりドキュメント タイトルが指定されますが、マテリアルが見つからない場合、ドキュメントへのパスがタイトルとして使用されます。
|
||
|
||
|
||
#### HTML 出力
|
||
<title>これによりドキュメント タイトルが指定されますが、マテリアルが見つからない場合、ドキュメントへのパスがタイトルとして使用されます。</title>
|
||
<meta name="Keywords" content="メタデータはセミコロンでドキュメントの上部に追加します" />
|
||
<meta name="Title" content="これによりドキュメント タイトルが指定されますが、マテリアルが見つからない場合、ドキュメントへのパスがタイトルとして使用されます。" />
|
||
|
||
#### 結果
|
||
タイトル メタ タグにおいてドキュメント タイトル バーが更新されているのがわかります。
|
||
ドキュメント ソースを表示するとドキュメント ヘッドにメタ データが表示されます。
|
||
|
||
### 定義リスト
|
||
|
||
定義リストに対応する記法が変換に追加されています。定義リストのアライメントと埋め込みについては、 Markdown スタンダードリストと同じルールが適用されます。
|
||
|
||
#### Markdown 記法
|
||
定義リスト要素を上位にした場合:
|
||
$ Definition 1 :Description 1
|
||
$ Definition 2 :Description 2
|
||
* List element 1
|
||
1. Ordered
|
||
1. Ordered
|
||
* List element 2
|
||
$ Definition 3:Description 3
|
||
|
||
|
||
Definition list elements embeded:
|
||
* List element 1
|
||
$ Definition 1 :Description 1
|
||
$ Definition 2 :Description 2
|
||
* List element 2
|
||
|
||
#### HTML 出力
|
||
|
||
<dl>
|
||
<dt>Definition 1 </dt>
|
||
<dd>Description 1</dd>
|
||
<dt>Definition 2 </dt>
|
||
<dd>Description 2
|
||
|
||
<br/>
|
||
<ul>
|
||
<li>List element 1
|
||
<br/>
|
||
<ol>
|
||
<li>Ordered</li>
|
||
<li>Ordered</li>
|
||
</ol></li>
|
||
<li>List element 2</li>
|
||
</ul></dd>
|
||
<dt>Definition 3</dt>
|
||
<dd>Description 3</dd>
|
||
|
||
</dl>
|
||
|
||
<ul>
|
||
<li>List element 1
|
||
<br/>
|
||
<dl>
|
||
<dt>Definition 1 </dt>
|
||
<dd>Description 1</dd>
|
||
<dt>Definition 2 </dt>
|
||
<dd>Description 2</dd>
|
||
|
||
</dl></li>
|
||
<li>List element 2</li>
|
||
</ul>
|
||
|
||
#### 結果
|
||
|
||
Defintion list elements at top level:
|
||
$ Definition 1 :Description 1
|
||
$ Definition 2 :Description 2
|
||
* List element 1
|
||
1. Ordered
|
||
1. Ordered
|
||
* List element 2
|
||
$ Definition 3:Description 3
|
||
|
||
|
||
Definition list elements embeded:
|
||
* List element 1
|
||
$ Definition 1 :Description 1
|
||
$ Definition 2 :Description 2
|
||
* List element 2
|
||
|
||
|
||
###バックスラッシュ以外に使用できるエスケープ文字
|
||
|
||
Markdown 記法で使用できるエスケープ文字に加えて、以下の文字も可能です。
|
||
|
||
> より大きい
|
||
| パイプ
|
||
\% パーセント記号
|
||
|
||
## Markdown Extra で使用されている機能
|
||
|
||
### ボールドとイタリック
|
||
|
||
File_names_including_underscores で使用する場合の誤検出をなくすため、 _italics_ と _bold_ 記法の左右にはスペースを入れてください。
|
||
|
||
### フェンスド コード ブロック
|
||
|
||
#### Markdown 記法
|
||
`~~~`
|
||
|
||
3 つ以上のフェンスラインで囲まれたコード
|
||
|
||
`~~~`
|
||
|
||
#### HTML 出力
|
||
<pre class="prettyprint"><code> 3 つ以上のフェンスラインで囲まれたコード
|
||
</code></pre>
|
||
|
||
#### 結果
|
||
~~~
|
||
3 つ以上のフェンスラインで囲まれたコード
|
||
~~~
|
||
|
||
### リージョン
|
||
|
||
リージョンとは一般的に、 HTML の div など、スタイルを適用できるエリアを指します。この記法を用いてリージョンを指定することができます。
|
||
|
||
[REGION:stylename]
|
||
...
|
||
[/REGION]
|
||
|
||
HTML では以下のように変換されます。
|
||
|
||
<div class="stylename">
|
||
...
|
||
</div>
|
||
|
||
css ファイルのスタイル ルールに従って作成しなければなりません。
|
||
|
||
.stylename
|
||
{
|
||
background:#123456;
|
||
border:1px solid #654321;
|
||
}
|
||
|
||
#### ビルトイン リージョン
|
||
|
||
リージョンに適用するスタイルの中には、注記事項、ヒント、警告、引用など共通項目に対しては既に存在するものもあります。
|
||
|
||
[REGION:note]
|
||
これはノートです。黄色のボックス内の左上に注記事項を表すアイコンが表示されています。
|
||
[/REGION]
|
||
|
||
[REGION:note]
|
||
これはノートです。黄色のボックス内の左上に注記事項を表すアイコンが表示されています。
|
||
[/REGION]
|
||
|
||
[REGION:tip]
|
||
これはヒントです。緑色のボックス内の左上にヒントを表すアイコンが表示されています。
|
||
[/REGION]
|
||
|
||
[REGION:tip]
|
||
これはヒントです。緑色のボックス内の左上にヒントを表すアイコンが表示されています。
|
||
[/REGION]
|
||
|
||
[REGION:warning]
|
||
これは警告です。赤のボックス内の左上に警告を表すアイコンが表示されます。
|
||
[/REGION]
|
||
|
||
[REGION:warning]
|
||
これは警告です。赤のボックス内の左上に警告を表すアイコンが表示されます。
|
||
[/REGION]
|
||
|
||
[REGION:quote]
|
||
これは引用テキストです。青のボックス内の左上に引用を表すアイコンが表示されます。
|
||
[/REGION]
|
||
|
||
[REGION:quote]
|
||
これは引用テキストです。青のボックス内の左上に引用を表すアイコンが表示されます。
|
||
[/REGION]
|
||
|
||
### ファイルと抜粋をインクルード
|
||
|
||
1 ページ全部のコンテンツまたはサブセクションを別の場所へインクルードすることができます。
|
||
|
||
ページ全体をインクルードするには、以下のように記述します。
|
||
|
||
[INCLUDE:Engine/Landscape]
|
||
|
||
この記法で 1 ページがまるごと変換され、上記の行が含まれるページへ挿入されます。
|
||
|
||
以下のように記述すると、ページ内に抜粋を定義することができます。
|
||
|
||
[EXCERPT:TerrainLayerCoords]
|
||
...
|
||
[/EXCERPT:TerrainLayerCoords]
|
||
|
||
この抜粋をインクルードするには以下のように記述します:
|
||
|
||
[INCLUDE:Engine/Landscape/Materials#TerrainLayerCoords]
|
||
|
||
結果 (引用リージョンに表示)：
|
||
|
||
[REGION:quote]
|
||
[INCLUDE:Engine/Landscape/Materials#TerrainLayerCoords]
|
||
[/REGION]
|