logoWebRelease 2 ユーザーズマニュアル
Version 2.75Y 版
menu
1章 はじめに
  • 1. はじめに
  • 2. WebRelease の利用環境
  • 3. 製品のライセンスについて
2章 ユーザ管理
  • 1. WebRelease のユーザ管理
  • 2. ユーザの登録
  • 3. ユーザの休止
  • 4. ユーザの削除
  • 5. ログインユーザ一覧
  • 6. ログイン履歴
  • 7. ユーザ登録情報の一括処理
3章 サイトの作成
  • 1. サイトの作成
  • 2. サイト設定
  • 3. スタッフ設定
    • 1. スタッフごとのテンプレート設定
    • 2. スタッフのフォルダへのアクセス制限
    • 3. スタッフの承認ステップ
    • 4. スタッフの解任
  • 4. サイトリソース
    • 1. リソースの登録
    • 2. リソースの編集
    • 3. リソースの一括移動
    • 4. リソース名の一括設定
    • 5. リソースの一括削除
    • 6. リソースフォルダ
  • 5. 辞書の管理
  • 6. 外部リンクのチェック
  • 7. サイトのエキスポート
  • 8. サイトのインポート
  • 9. サイトの閉鎖
  • 10. サイトの削除
  • 11. サイトの操作履歴
4章 FTPの設定
  • 1. FTP の設定
  • 2. プライマリチャネルの設定
  • 3. FTP 記録の参照
  • 4. FTP の実行状況
  • 5. FTP 予約(定時起動)の設定
5章 テンプレート
  • 1. テンプレート
  • 2. テンプレートの作成
  • 3. 文書型の定義
  • 4. 要素のタイプ
    • 1. 1行テキスト
    • 2. 複数行テキスト
    • 3. WYSIWYG エディタ
    • 4. ラジオボタン
    • 5. ポップアップボタン
    • 6. チェックボックス
    • 7. 年月日/時分/秒
    • 8. 目次
    • 9. リンク
    • 10. イメージ (GIF/JPG/PNG)
    • 11. 添付ファイル
    • 12. XMLリーダ
    • 13. コンポーネント
    • 14. グループ項目
    • 15. セレクタ
    • 16. 各要素に共通の設定項目
  • 5. テンプレートの展開
    • 1. 要素参照
    • 2. 関数呼び出し
    • 3. 演算子
    • 4. テンプレートリソース
    • 5. リソース参照
    • 6. メソッド
    • 7. 拡張タグ wr-if wr-then wr-else
    • 8. 拡張タグ wr-switch wr-case wr-default
    • 9. 拡張タグ wr-conditional wr-cond
    • 10. 拡張タグ wr-for
    • 11. 拡張タグ wr-break
    • 12. 拡張タグ wr-variable
    • 13. 拡張タグ wr-append
    • 14. 拡張タグ wr-clear
    • 15. 拡張タグ wr-return
    • 16. 拡張タグ wr-error
    • 17. 拡張タグ wr-- と wr-comment
  • 6. WYSIWYG エディタ設定
  • 7. テンプレート・プロファイラ
  • 8. テンプレートのリビジョン
  • 9. テンプレートのダウンロード
  • 10. テンプレートのアップロード
  • 11. テンプレートの上書きアップロード
  • 12. テンプレートのフォルダ
  • 13. テンプレートの状態
  • 14. テンプレートの削除
  • 15. ページ作成後のテンプレート修正
  • 16. 入力フィールドの短縮表示
  • 17. 作成したページの一覧
  • 18. テンプレートを利用可能なスタッフの設定
  • 19. テンプレートの操作履歴
  • 20. テンプレートを参照している目次の一覧
  • 21. テンプレートの検索
6章 コンポーネント
  • 1. コンポーネント
  • 2. コンポーネントの使用例
  • 3. コンポーネントとセレクタ
7章 ページの作成
  • 1. ページの作成の手順
  • 2. ページのプレビュー
  • 3. 実機でのプレビュー
  • 4. ページの状態
  • 5. ページの編集と編集完了
  • 6. ページリソース
    • 1. リソースの登録
    • 2. リソースの編集
    • 3. リソースの一括移動
    • 4. リソースの一括削除
    • 5. リソースフォルダ
  • 7. ページの公開と公開終了
  • 8. ページの削除
  • 9. ページのリビジョン管理
  • 10. ページのリビジョン間の比較表示
  • 11. リンク元一覧
  • 12. ページ内の外部リンク一覧
  • 13. ページの公開状況
  • 14. スケジュール一覧
  • 15. フォルダ
  • 16. バージョニングフォルダ
  • 17. ページの一括処理
  • 18. 一括ページ登録
  • 19. html と関連リソースの zip 取り込み
  • 20. WYSIWYG エディタの使い方
  • 21. Markdown の使い方
  • 22. ページの操作履歴
  • 23. コンテンツ中の語句のチェック
  • 24. ページの検索
8章 マルチデバイス配信
  • 1. 多チャネル化
  • 2. チャネル別コンテンツの生成
  • 3. チャネル選択機能
9章 承認プロセスの設定
  • 1. 承認ステップの定義
  • 2. 承認プロセスの定義
  • 3. 承認プロセスをフォルダに関連付ける
  • 4. 承認プロセスによる公開管理
    • 1. ページの公開承認依頼
    • 2. 承認と差戻
    • 3. 承認プロセスとページの公開終了
    • 4. 承認依頼フォルダ
    • 5. 一括承認依頼
    • 6. 一括承認
    • 7. 緊急対応としてのページの公開と公開終了
    • 8. 承認依頼の削除
    • 9. 進行中の承認依頼の管理
10章 その他の機能
  • 1. ダッシュボード
  • 2. 英語インタフェース
  • 3. タイムゾーンの指定
11章 システムの運用管理
  • 1. WebRelease の停止と起動
  • 2. データのバックアップ
  • 3. メモリ設定
  • 4. メールサーバの設定
  • 5. Proxy サーバの設定
  • 6. その他のシステム設定
  • 7. 証明書のインポート
  • 8. ストレージの管理
  • 9. 操作履歴
  • 10. ログファイルのダウンロード
  • 11. ログインエラーへの対応
  • 12. WebRelease のバージョンアップ
  • 13. ライセンスのアップグレード
  • 14. 期間ライセンスコードの更新
  • 15. WebRelease の Uninstall
12章 索引
  • 1. 関数索引
    • 1. add
    • 2. allObjects
    • 3. allPages
    • 4. channel
    • 5. channelCookieName
    • 6. channelName
    • 7. codePointAt
    • 8. comma3
    • 9. concatenate
    • 10. contentType
    • 11. count
    • 12. currentTime
    • 13. divide
    • 14. encoding
    • 15. fileName
    • 16. fileSize
    • 17. find
    • 18. firstElement
    • 19. folder
    • 20. formatDate
    • 21. formatDateRFC2822
    • 22. formatDateW3CDTF
    • 23. fullURL
    • 24. gengou
    • 25. getXML
    • 26. group
    • 27. halfwidth
    • 28. hasElement
    • 29. hasMethod
    • 30. head
    • 31. indexOfPage
    • 32. isEven と isOdd
    • 33. isFirstElement と isNotFirstElement
    • 34. isFirstPage
    • 35. isLastElement と isNotLastElement
    • 36. isLastPage
    • 37. isNull と isNotNull
    • 38. isNumber
    • 39. isPreview と isNotPreview
    • 40. jstr
    • 41. kmg1000
    • 42. kmg1024
    • 43. lastElement
    • 44. lastModifiedDate
    • 45. length
    • 46. multiply
    • 47. nextElement
    • 48. nextPage
    • 49. number
    • 50. pageCreatedDate と revisionCreatedDate
    • 51. pageID
    • 52. pageRevision
    • 53. pageTitle
    • 54. pageWithPageID
    • 55. parseDate
    • 56. parseDateRFC2822 と parseDateRFC2822Relaxed
    • 57. parseDateW3CDTF
    • 58. parseHtml
    • 59. path
    • 60. prevElement
    • 61. prevPage
    • 62. previewClock
    • 63. quote
    • 64. remainder
    • 65. replaceAll と replaceFirst
    • 66. resourceURL
    • 67. resourceWithName
    • 68. rtlCount
    • 69. rtlRatio
    • 70. scheduledEndDate
    • 71. scheduledStartDate
    • 72. searchText
    • 73. setScale
    • 74. siteTimeZone
    • 75. sort
    • 76. split
    • 77. startsWith と endsWith
    • 78. string
    • 79. stripTags
    • 80. substring
    • 81. subtract
    • 82. suffix
    • 83. tail
    • 84. templateName
    • 85. thisPage
    • 86. toEntityRef
    • 87. toLowerCase と toUpperCase
    • 88. trim
    • 89. unescapeEntities
    • 90. unsplit
    • 91. width と height
  • 2. オブジェクト索引
    • 1. Channel オブジェクト
    • 2. CheckBox オブジェクト
    • 3. Folder オブジェクト
    • 4. HTMLComment オブジェクト
    • 5. HTMLDataNode オブジェクト
    • 6. HTMLDocument オブジェクト
    • 7. HTMLElement オブジェクト
    • 8. HTMLElements オブジェクト
    • 9. HTMLTextNode オブジェクト
    • 10. Page オブジェクト
    • 11. Selector オブジェクト
    • 12. XMLFeed オブジェクト
13章 Appendix
  • 1. サポートされているタイムゾーン
  • 2. プレビュー時の URL 書き換え機能
  • 3. 正規表現
  • 4. 要素名・リソース名・変数名・メソッド名

7章 ページの作成

21. Markdown の使い方

WebRelease では、ページ編集画面の「複数行テキスト」形式の入力エリアで Markdown を使うことができます。Markdown を使用可能な入力エリアの右側には Markdown を ON にするチェックボックスが表示されています。

Markdown を ON にするチェックボックスが表示されている状態

このチェックボックスを ON にすると、その入力エリアに入力されたテキストは Markdown であるものとして処理されます。

このチェックボックスは、テンプレート側で、その「複数行テキスト」形式の入力エリアでの Markdown の使用を許可する設定になっている場合にのみ表示されます。

関連項目
  • 要素のタイプ

Markdown 記法

Markdown は容易にテキストをマークアップできる記法です。一定のルール(記法)で文書を作成することで、それを html のマークアップに変換することができます。

Markdown では下記の文書構造を表現できます。

  • パラグラフ
  • 見出し
  • 強調(単語やフレーズを太字などで強調表示する)
  • 引用
  • コードブロック(プログラムコードなどを文書中にブロックとして埋めこむ)
  • コード(プログラムコードなどを文書中にインラインで埋めこむ)
  • 区切り線
  • リンク
  • イメージ
  • 略語の説明 (Abbreviations)
  • 箇条書き

ここでは、Markdown の記法と、その記法によってかかれた文書がどのように html マークアップされるかを紹介いたします。 なお、Markdown については Daring Fireball: Markdown Syntax Documentation が仕様の源流となっているようです。詳細につきましては、これらのドキュメントも参考にしてください。

Markdown 記法一覧

  • パラグラフ
  • 見出し
  • 強調
  • 引用
  • 引用の入れ子
  • コードブロック
  • コード
  • 区切り線
  • リンク
  • 自動リンク
  • イメージ
  • 参照式のイメージ
  • 略語の説明
  • 箇条書き
  • 箇条書きの入れ子
  • 順序付き箇条書き
  • 順序付き箇条書きの入れ子
  • 箇条書きの中の複数段落
  • 箇条書きの中の引用
  • 箇条書きの中のコードブロック
  • 見出しに id 属性を付ける
  • 箇条書きの項目に id 属性を付ける

パラグラフ

Markdown では、普通にプレーンテキストとして書かれたテキストはパラグラフとして扱われます。

Markdown 記述
これはパラグラフです。
パラグラフは連続する複数の行から構成されます。

パラグラフは空行で区切ることができます。この行の前には空行があるので、
前のパラグラフとは別のパラグラフとしてマークアップされます。

パラグラフ中に<br> タグを挿入したい場合には、  
その行の行末に 2 つ以上のスペースを入力してから改行します。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>これはパラグラフです。 パラグラフは連続する複数の行から構成されます。</p> 
<p>パラグラフは空行で区切ることができます。この行の前には空行があるので、 前のパラグラフとは別のパラグラフとしてマークアップされます。</p> 
<p>パラグラフ中に<br> タグを挿入したい場合には、<br> その行の行末に 2 つ以上のスペースを入力してから改行します。</p>  

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

これはパラグラフです。 パラグラフは連続する複数の行から構成されます。

パラグラフは空行で区切ることができます。この行の前には空行があるので、 前のパラグラフとは別のパラグラフとしてマークアップされます。

パラグラフ中に
タグを挿入したい場合には、
その行の行末に 2 つ以上のスペースを入力してから改行します。

見出し

見出しの書き方は3種類あります。

  • イコール記号 (=) を見出しの次の行にアンダーラインのように書くと h1 でマークアップすることができます。
  • ハイフン (-) を見出しの次の行にアンダーラインのように書くと h2 でマークアップすることができます。
  • 記号 # を行頭に 1 から 6 個書くと # 記号の数に応じて h1 から h6 でマークアップすることができます。

Markdown 記述
これは H1 でマークアップされます
===================
これは H2 でマークアップされます
-----------------------
# 行頭の#の数でヘッダを表すことができます(h1 です)
## 行頭の#の数でヘッダを表すことができます(h2 です)
###### 行頭の#の数でヘッダを表すことができます(h6 です)
# 行末に、ヘッダ閉じを表す#を書いても構いません #
## 行末に、ヘッダ閉じを表す#を書いても構いません ##
###### 行末に、ヘッダ閉じを表す#を書いても構いません ######

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<h1>これは H1 でマークアップされます</h1> 
<h2>これは H2 でマークアップされます</h2> 
<h1>行頭の#の数でヘッダを表すことができます(h1 です)</h1> 
<h2>行頭の#の数でヘッダを表すことができます(h2 です)</h2> 
<h6>行頭の#の数でヘッダを表すことができます(h6 です)</h6> 
<h1>行末に、ヘッダ閉じを表す#を書いても構いません</h1> 
<h2>行末に、ヘッダ閉じを表す#を書いても構いません</h2> 
<h6>行末に、ヘッダ閉じを表す#を書いても構いません</h6>  

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

これは H1 でマークアップされます

これは H2 でマークアップされます

行頭の#の数でヘッダを表すことができます(h1 です)

行頭の#の数でヘッダを表すことができます(h2 です)

行頭の#の数でヘッダを表すことができます(h6 です)

行末に、ヘッダ閉じを表す#を書いても構いません

行末に、ヘッダ閉じを表す#を書いても構いません

行末に、ヘッダ閉じを表す#を書いても構いません

強調

強調を表現するために * と を使います。ひとつの * または で強調したい部分を囲むと、その部分は <em> タグで囲まれた形にマークアップされます。ふたつの * または _ で囲むと <strong> タグで囲まれた形にマークアップされます。

markdown 記述
強調する部分は*アスタリスク*で囲みます。
強調として扱われては困る場合は\*バックスラッシュでエスケープ\*できます。

強調する部分は**アスタリスク**で囲みます。
アスタリスクの代わりに__アンダースコア__も使用できます。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>強調する部分は<em>アスタリスク</em>で囲みます。 強調として扱われては困る場合は*バックスラッシュでエスケープ*できます。</p> 
<p>強調する部分は<strong>アスタリスク</strong>で囲みます。アスタリスクの代わりに<strong>アンダースコア</strong>も使用できます。</p> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

強調する部分はアスタリスクで囲みます。 強調として扱われては困る場合は*バックスラッシュでエスケープ*できます。

強調する部分はアスタリスクで囲みます。 アスタリスクの代わりにアンダースコアも使用できます。

引用

markdown では「引用」を表現することができます。引用は行頭に > 記号をつけて表現します。引用の内側には、箇条書、ヘッダ、コードブロックなどの markdown 記法が使えます。

markdown 記述
この部分は引用ではありません。普通の段落を構成しています。

> この部分は「引用」 (block quote) としてマークアップされます。
>
> 行頭が > で始まる連続した行が
> 引用として処理されます。

この部分は引用ではありません。普通の段落を構成しています。

この markdown 記述を markdown プロセッサで処理すると下記の html が得られます。

markdown 処理結果
<p>この部分は引用ではありません。普通の段落を構成しています。</p> 
<blockquote>
  <p>この部分は「引用」 (block quote) としてマークアップされます。</p> 
  <p>行頭が > で始まる連続した行が 引用として処理されます。</p> 
</blockquote> 
<p>この部分は引用ではありません。普通の段落を構成しています。</p> 

この markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

markdown 処理結果表示例

この部分は引用ではありません。普通の段落を構成しています。

この部分は「引用」 (block quote) としてマークアップされます。

行頭が > で始まる連続した行が 引用として処理されます。

この部分は引用ではありません。普通の段落を構成しています。

引用するすべての行の先頭に > を書かなくても、先頭の行にだけ > を付ければ全体を引用とすることもできます。

markdown 記述
この部分は引用ではありません。普通の段落を構成しています。

> 最初の行にだけ > を付けるだけでも引用を表現できます。
この行の先頭には > がありませんが引用の一部です。

この部分は引用ではありません。普通の段落を構成しています。

この markdown 記述を markdown プロセッサで処理すると下記の html が得られます。

markdown 処理結果
<blockquote>
   <p>最初の行にだけ > を付けるだけでも引用を表現できます。 この行の先頭には > がありませんが引用の一部です。</p> 
</blockquote>

この markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

markdown 処理結果表示例

この部分は引用ではありません。普通の段落を構成しています。

最初の行にだけ > を付けるだけでも引用を表現できます。 この行の先頭には > がありませんが引用の一部です。

この部分は引用ではありません。普通の段落を構成しています。

引用の入れ子

引用は入れ子(ネスト)することができます。

Markdown 記述
> 引用は入れ子(ネスト)することができます。
>> この部分は一段深い引用レベルです。
>
> この行の引用レベルはひとつ浅いレベルに戻ります。
レベルを戻す場合には > だけの行を挿入する必要があります。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<blockquote>
   <p>引用は入れ子(ネスト)することができます。</p> 
   <blockquote>
     <p>この部分は一段深い引用レベルです。</p> 
   </blockquote> 
   <p>この行の引用レベルはひとつ浅いレベルに戻ります。 レベルを戻す場合には > だけの行を挿入する必要があります。</p> 
</blockquote> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

引用は入れ子(ネスト)することができます。

この部分は一段深い引用レベルです。

この行の引用レベルはひとつ浅いレベルに戻ります。 レベルを戻す場合には > だけの行を挿入する必要があります。

コードブロック

Markdown 内にはコードブロックを書くことができます。行頭が 4 個の半角スペースでインデントされている行はコードブロックとして扱われます。

Markdown 記述
Markdown 中には「コードブロック」を記述することができます。

    // ここはコードブロックです
    // コードブロックを構成する各行は半角スペース 4 個でインデントします。
    if ( a === b && c === d) {
        confirm('ok') ;
    }

ここはコードブロックの外です。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p> Markdown 中には「コードブロック」を記述することができます。</p> 
<pre><code>// ここはコードブロックです
// コードブロックを構成する各行は半角スペース 4 個でインデントします。
if ( a === b && c === d) {
    confirm('ok') ;
}
</code></pre> 
<p>ここはコードブロックの外です。</p> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

Markdown 中には「コードブロック」を記述することができます。

// ここはコードブロックです
// コードブロックを構成する各行は半角スペース 4 個でインデントします。
if ( a === b && c === d) {
    confirm('ok') ;
}

ここはコードブロックの外です。

引用するすべての行の先頭に > を書かなくても、先頭コードブロックの内側では & は &amp; に自動的にエスケープされます。また < は &lt; に、> は &gt; に自動的にエスケープされます。自動エスケープ機能があるので、コードブロック中に html などのサンプルコードなどを埋め込む場合でも、& < > を一々エスケープして回る必要はありません。コードブロック内では Markdown 記法は使えません。

コードブロックの表現方法はもうひとつあります。コードブロックを、3つの \` (バッククオート)で初め、同じく3つの ` (バッククオート)で終える記法です。すべての行をインデントする必要がない、使いやすい記法です。また開始側のバッククオート列の末尾に、生成される code タグに付ける class= 属性を指定できるので、コードブロック内の言語(JavaScript / CSS / Objective-C など) によって異なるスタイルの適用を実現することもできます。

下記の例では、code の class 属性には java と smallfont を指定してみました。の行にだけ > を付ければ全体を引用とすることもできます。

Markdown 記述
ここはコードブロックの外です。
```java smallfont
// ここはコードブロックです。
public static void main(String[] argv)
{
    System.out.println("Hello World!") ;
}
// コードブロック終わり。
```
ここはコードブロックの外です。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>ここはコードブロックの外です。</p> 
<pre><code class="java smallfont">// ここはコードブロックです。
public static void main(String[] argv)
{
    System.out.println("Hello World!") ;
}
// コードブロック終わり。
</code></pre> 
<p>ここはコードブロックの外です。</p>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

ここはコードブロックの外です。

// ここはコードブロックです。
public static void main(String[] argv)
{
    System.out.println("Hello World!") ;
}
// コードブロック終わり。

ここはコードブロックの外です。

コード

プログラムコードなどの断片を、インラインで文書中に埋めこむことができます。コード部分は ` (バッククオート) で囲みます。コード部分は html の <code> タグで囲まれた形にマークアップされます。

Markdown 記述
文章の途中にコードを埋めこむ場合は`trim()` のように、
コード部分をバッククオートで囲みます。

コード中にバッククオートを含めたい場合は、
コード部分を2個のバッククオートで囲みます。
例えば``There is a literal backquote (`) here.``という記述にします。

コード部分の先頭にバッククオートがある場合、
開始を示すふたつのバッククオートの後ろにひとつのスペースを置きます。

コード部分の末尾にバッククオートがある場合、
終了を示すふたつのバッククオートの前にひとつのスペースを置きます。

例:A single backtick in a code: `` ` ``

`コード部分では & と <  と > は自動でエスケープされます`

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>文章の途中にコードを埋めこむ場合は<code>trim()</code> のように、 コード部分をバッククオートで囲みます。</p> 
<p>コード中にバッククオートを含めたい場合は、 コード部分を2個のバッククオートで囲みます。 例えば<code>There is a literal backquote (`) here.</code>という記述にします。</p> 
<p>コード部分の先頭にバッククオートがある場合、 開始を示すふたつのバッククオートの後ろにひとつのスペースを置きます。</p> 
<p>コード部分の末尾にバッククオートがある場合、 終了を示すふたつのバッククオートの前にひとつのスペースを置きます。</p> 
<p>例:A single backtick in a code: <code>`</code></p> 
<p><code>コード部分では &amp; と &lt; と &gt; は自動でエスケープされます</code></p> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

文章の途中にコードを埋めこむ場合はtrim() のように、 コード部分をバッククオートで囲みます。

コード中にバッククオートを含めたい場合は、 コード部分を2個のバッククオートで囲みます。 例えばThere is a literal backquote (`) here.という記述にします。

コード部分の先頭にバッククオートがある場合、 開始を示すふたつのバッククオートの後ろにひとつのスペースを置きます。

コード部分の末尾にバッククオートがある場合、 終了を示すふたつのバッククオートの前にひとつのスペースを置きます。

例:A single backtick in a code: `

コード部分では & と < と > は自動でエスケープされます

区切り線

Markdown を使って、区切り線として html の <hr> タグを生成することができます。

3 個以上の * または - または _ は <hr> タグに変換されます。文字間にスペースを混ぜて記述することもできます。

markdown 記述
* * *
***
*****
- - -
---------------------------------------

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

markdown 処理結果
<hr>
<hr>
<hr>
<hr>
<hr>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

markdown 処理結果表示例





リンク

リンクを表現する場合は下記の表現を使います。

[リンクテキスト](リンク先URL)

<a> タグの title= 属性を持たせたい場合には

[リンクテキスト](リンク先URL "title")

という表記を使います。title 属性はダブルクオートで囲みます。

Markdown 記述
title 属性のあるリンクの例[an example](https://example.com/ "title属性") です。

title 属性のないリンクの例[an example](https://example.net/) です。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>title 属性のあるリンクの例:<a href="https://example.com/" title="title属性">an example</a> です。</p> 
<p>title 属性のないリンクの例:<a href="https://example.net/">an example</a> です。</p> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

title 属性のあるリンクの例an example です。

title 属性のないリンクの例an example です。

参照式のリンク

ひとつの Markdown の中に、同じ URL へのリンクが複数回出現する場合などには、参照式のリンクを使うこともできます 参照式のリンクを使う場合、まずリンクを定義します。文書の任意の場所に、

[frameworks]: https://www.frameworks.co.jp/ "FrameWorks Software, Inc."

という形式でリンクを定義します。[]: に囲まれている frameworks という部分がリンクのラベルになります。ラベルにはわかりやすい名前をつけてください。このリンク定義を使用する時にはこのラベルでリンク定義を参照します。ラベルに続いて URL を記述します。最後に、ダブルクオートで囲まれた<a>タグの title 属性を指定します。title 属性はなくても構いません。

リンクを参照する側では

くわしくは[www.frameworks.co.jp][frameworks]をご参照ください。

という形式でリンク定義を参照します。連続する [][] でリンクを参照しますが、前がリンクテキスト、後ろが定義してあるリンクのラベルになります。リンクテキストが、リンクのラベルと同じ場合、リンクラベルは省略可能です。

くわしくは[frameworks][]をご参照ください。

という形式で、リンクラベルを表す[] を空にしてリンクを参照することができます。

Markdown 記述
リンクを定義します。

[frameworks]: https://www.frameworks.co.jp/  "FrameWorks Software, Inc."

定義されているリンクを参照します。

くわしくは[フレームワークスソフトウェアのホームページ][frameworks]をご参照ください。

リンクのラベルを省略することもできます。

くわしくは[frameworks][]をご参照ください。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>title 属性のあるリンクの例<a href="https://example.com/" title="title属性">an example</a> です。</p> 
<p>title 属性のないリンクの例<a href="https://example.net/">an example</a> です。</p> 
<p>リンクを定義します。</p> 
<p>定義されているリンクを参照します。</p> 
<p>くわしくは<a href="https://www.frameworks.co.jp/" title="FrameWorks Software, Inc.">フレームワークスソフトウェアのホームページ</a>をご参照ください。</p> 
<p>リンクのラベルを省略することもできます。</p> 
<p>くわしくは<a href="https://www.frameworks.co.jp/" title="FrameWorks Software, Inc.">frameworks</a>をご参照ください。</p> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

リンクを定義します。

定義されているリンクを参照します。

くわしくはフレームワークスソフトウェアのホームページをご参照ください。

リンクのラベルを省略することもできます。

くわしくはframeworksをご参照ください。

自動リンク

Markdown では、URL や メールアドレスに自動でリンクを付けることができます。自動リンクしたい場合には、その URL やメールアドレスを < と > で囲みます。

mailto リンクを生成する場合は、そのメールアドレスを少しだけ難読化するための処理が施されます。

Markdown 記述
<https://example.com/>
<address@example.com>

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p><a href="https://example.com/">https://example.com/</a></p> 
<p><a href="&#x6d;&#97;&#105;&#108;&#x74;&#111;&#x3a;&#97;&#x64;&#100;&#x72;&#x65;&#115;&#x73;&#x40;&#x65;&#x78;&#x61;&#x6d;&#x70;&#108;&#101;&#x2e;&#x63;&#111;&#x6d;">&#97;&#x64;&#x64;&#114;&#x65;&#115;&#115;&#64;&#x65;&#x78;&#x61;&#109;&#x70;&#108;&#x65;&#x2e;&#x63;&#x6f;&#x6d;</a></p>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

https://example.com/ address@example.com

イメージ

Markdown では、リンクに似た方法で画像を扱います。

Markdown で画像を表示する場合

![Alt text](/path/to/img.jpg)

という記述を使います。![] で囲まれている内側は、<img> タグの alt 属性になります。() に囲まれている部分に、画像ファイルへのパスを指定します。

<img> タグの title 属性を指定したい場合には、

![Alt text](/path/to/img.jpg "Optional title")

という記述を使います。title 属性はダブルクオートで囲みます。

この書式でイメージを表示する場合には <img> タグが生成されますが、生成される <img> タグに対して style 属性を指定する方法はありません。 style="float: left;" などの指定は行えないので、そのような属性指定が必要であれば <img> タグで直接 html を記述してください。

下記の例は、ページに、ページリソースとして top_banner.png という画像が登録されていて、ページ内の「複数行テキスト」型の要素に対して Markdown を ON にして記述する場合の例です。

Markdown 記述
![banner](kingyo.gif)
![banner](kingyo.gif "Top Banner")

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p><img src="kingyo.gif" alt="banner" />
<img src="kingyo.gif" alt="banner" title="Top Banner" /></p>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

banner banner

参照式のイメージ

リンクの場合と同様に、ひとつの markdown の中に複数回同じ画像が使用されるような場合には、参照型の画像参照を使うこともできます。参照型の画像参照を行う場合は、まず画像の定義を行います。文書の任意の場所に、

[banner]: top_banner.png "Top Banner."

という形式で画像を定義します。[]: に囲まれている banner という部分が画像のラベルになります。この画像定義を使用する時にはこのラベルで画像定義を参照します。ラベルに続いて画像の URL を記述します。最後に、ダブルクオートで囲まれたタグの title 属性を指定します。title 属性はなくても構いません。

画像を参照する側では

![top banner][banner]

という形式で画像定義を参照します。連続する [][] で画像を参照しますが、前が <img> タグの alt 属性、後ろが定義してある画像のラベルになります。alt 属性が、画像のラベルと同じ場合、画像のラベルは省略可能です。

![banner][]

という形式で、画像ラベルを表す[] を空にして画像を参照することができます。

下記の例は、ページに、ページリソースとして top_banner.png という画像が登録されていて、ページ内の「複数行テキスト」型の要素に対して markdown を ON にして記述する場合の例です。

markdown 記述
[banner]: kingyo.gif "Top Banner."
![top banner][banner]
![banner][]

この markdown 記述を markdown プロセッサで処理すると下記の html が得られます。

markdown 処理結果
<p><img src="kingyo.gif" alt="top banner" title="Top Banner." />
<img src="kingyo.gif" alt="banner" title="Top Banner." /></p>

この markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

markdown 処理結果表示例

top banner banner

略語の説明

略語の定義を指定しておくと、それを文章中で参照することができます。参照部分は <abbr> タグで囲まれた形でマークアップされます。記法はリンクと似ています。まず、略語の定義を行います。定義は文書中のどこでも行えます。リンクの場合に URL を指定する箇所に * を書きます。

[ASAP]: * "As soon as possible"

定義を文章中で参照します。参照は、定義してある語を角括弧で囲うことで行います。

Markdown 記述
[ASAP]: * "As soon as possible"

できるだけ早く([ASAP])お願いします。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<p>できるだけ早く(<abbr title="As soon as possible">ASAP</abbr>)お願いします。</p> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例

できるだけ早く(ASAP)お願いします。

箇条書き

Markdown で箇条書きを表現できます。

行頭が「*」と「スペース」で始まる連続する行は、箇条書としてマークアップされます。行頭は + または - でも構いません。

Markdown 記述
*   Red
*   Green
*   Blue

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<ul> 
   <li>Red</li> 
   <li>Green</li> 
   <li>Blue</li> 
</ul>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例
  • Red
  • Green
  • Blue

箇条書きの入れ子

箇条書きを入れ子にすることができます。下位のレベルの箇条書きの項目は、行頭を 4 つの半角スペースでインデントします。

Markdown 記述
* レベル1
    * レベル2
        * レベル3
        * レベル3
    * レベル2
* レベル1

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<ul> 
   <li>レベル1
    <ul> 
     <li>レベル2
      <ul> 
       <li>レベル3</li> 
       <li>レベル3</li> 
      </ul> </li> 
     <li>レベル2</li> 
    </ul> </li> 
   <li>レベル1</li> 
</ul>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例
  • レベル1
    • レベル2
      • レベル3
      • レベル3
    • レベル2
  • レベル1

順序付き箇条書き

行頭が「1」と「ピリオド」と「スペース」で始まる連続する行は、順序付きの箇条書としてマークアップされます。先頭の数字は 1 をならべるのが簡単で良いと思いますが、数字はなんでも構いません。

Markdown 記述
1.  Bird
1.  McHale
1.  Parish

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<ol> 
   <li>Bird</li> 
   <li>McHale</li> 
   <li>Parish</li> 
</ol> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

markdown 処理結果表示例
  1. Bird
  2. McHale
  3. Parish

順序付き箇条書きの入れ子

順序付き箇条書きの場合も同様です。箇条書きを入れ子にすることができます。下位のレベルの箇条書きの項目は、行頭を 4 つの半角スペースでインデントします。

markdown 記述
1. レベル1
    1. レベル2
        1. レベル3
        1. レベル3
    1. レベル2
1. レベル1

この markdown 記述を markdown プロセッサで処理すると下記の html が得られます。

markdown 処理結果
<ol> 
   <li>レベル1
    <ol> 
     <li>レベル2
      <ol> 
       <li>レベル3</li> 
       <li>レベル3</li> 
      </ol> </li> 
     <li>レベル2</li> 
    </ol> </li> 
   <li>レベル1</li> 
</ol>

この markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

markdown 処理結果表示例
  1. レベル1
    1. レベル2
      1. レベル3
      2. レベル3
    2. レベル2
  2. レベル1

箇条書きの中の複数段落

箇条書の各項の中には、複数の段落を置くことができます。箇条書の中で段落を分けたい場合には、後続の段落の先頭を 4 個以上の半角スペースでインデントします。

Markdown 記述
* この部分は箇条書きの先頭の項です。

    ここも箇条書きの先頭の項の一部ですが、2番目の段落になっています。

* ここは箇条書の二番目の項です。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<ul> 
   <li><p>この部分は箇条書きの先頭の項です。</p> <p>ここも箇条書きの先頭の項の一部ですが、2番目の段落になっています。</p> </li> 
   <li><p>ここは箇条書の二番目の項です。</p></li> 
</ul> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例
  • この部分は箇条書きの先頭の項です。

    ここも箇条書きの先頭の項の一部ですが、2番目の段落になっています。

  • ここは箇条書の二番目の項です。

箇条書きの中の引用

箇条書きの中には、引用(blockquote)を置くことができます。箇条書き内に引用を置く場合は、引用の開始を表す行頭の > を 1 個以上のスペースでインデントします。

Markdown 記述
1. これは箇条書きの1番目の項です。

 > ここが箇条書きの中の引用部分です。
この行も引用です。

1. これは箇条書きの2番目の項です。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
  <ol> 
   <li><p>これは箇条書きの1番目の項です。</p> 
    <blockquote>
     <p>ここが箇条書きの中の引用部分です。 この行も引用です。</p> 
    </blockquote> </li> 
   <li><p>これは箇条書きの2番目の項です。</p></li> 
  </ol> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例
  1. これは箇条書きの1番目の項です。

    ここが箇条書きの中の引用部分です。 この行も引用です。

  2. これは箇条書きの2番目の項です。

箇条書きの中のコードブロック

箇条書きの中には、コードブロック(codeblock)を置くことができます。コードブロック部分は、普通は 4 つのスペースでインデントして記述しますが、箇条書きの中に置く場合には2倍の8つのスペースでインデントしてください。

Markdown 記述
1. これは箇条書きの1番目の項です。

        // ここが箇条書きの中のコードブロック部分です。
        // この行もコードブロックです。

1. これは箇条書きの2番目の項です。

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<ol> 
   <li><p>これは箇条書きの1番目の項です。</p><pre><code>// ここが箇条書きの中のコードブロック部分です。
// この行もコードブロックです。
</code></pre></li> 
   <li><p>これは箇条書きの2番目の項です。</p></li>
</ol> 

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例
  1. これは箇条書きの1番目の項です。

    // ここが箇条書きの中のコードブロック部分です。
    // この行もコードブロックです。
    
  2. これは箇条書きの2番目の項です。

見出しに id 属性を付ける

見出しには、id 属性を指定することができます。この id を使ってページ内の他の場所からリンクしておくことができます。id 属性は {#idstring} という形で指定します。id 属性なので、複数の見出しに同じ id を振らないように注意してください。

id は、普通に <a> タグで参照するか、または markdonw のリンクの記法で参照することができます。

Markdown 記述
## 見出しです ##  {#header20}

見出しです  {#header21}
----------------------------------

以下のようにして参照します。

[見出しへ](#header20)

<a href="#header21">見出しへ</a>

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<h2 id="header20">見出しです</h2> 
<h2 id="header21">見出しです</h2> 
<p>以下のようにして参照します。</p> 
<p><a href="#header20">見出しへ</a></p>
<p><a href="#header21">見出しへ</a></p>

箇条書きの項目に id 属性を付ける

箇条書きの項目には id 属性を付けることができます。id 属性の使い道は自由ですが、主な用途はリンク先に指定することでしょう。ヘッダの場合と同様に {#idstring} という記述を箇条書きの先頭の行の最後に付け加えます。

Markdown 記述
* この部分は箇条書きの先頭の項です。  {#item1}
* ここは箇条書の二番目の項です。  {#item2}

この Markdown 記述を Markdown プロセッサで処理すると下記の html が得られます。

Markdown 処理結果
<ul> 
   <li id="item1"><p>この部分は箇条書きの先頭の項です</p></li> 
   <li id="item2"><p>ここは箇条書の二番目の項です。</p></li> 
</ul>

この Markdown 処理結果をブラウザに表示した場合の例は下記のとおりです。

Markdown 処理結果表示例
  • この部分は箇条書きの先頭の項です。
  • ここは箇条書の二番目の項です。

バックスラッシュによるエスケープ

Markdown で使用されている文字を、Markdown としてではなく普通の文字として使いたい場合には \ (バックスラッシュ) でそれらの文字をエスケープしてください。例えば、Markdown では * で囲まれた部分は強調として <em> タグで囲まれますが、ただ単に単語を * で囲みたい場合には

\*literal asterisks\*

というように記述することで <em> タグで囲まれることを防ぐことができます。

また、行の先頭が「1」と「ピリオド」と「スペース」で始まってしまっていると、そこが箇条書として認識されてしまいます。箇条書を意図していないる場合には、ピリオドの前にひとつ \ (バックスラッシュ)を挿入してください。

1. Bird
1. McHale
1\. Parish

上記に記述の場合、3行目の Parish の項目は箇条書きとして扱われません。

エスケープ対象になる文字は下記のとおりです。

  • \ backslash
  • ` backtick (backquote)
  • * asterisk
  • _ underscore
  • {} curly braces
  • [] square brackets
  • () parentheses
  • # hash mark
  • + plus sign
  • - minus sign (hyphen)
  • . dot
  • ! exclamation mark

Markdown 中の html の使用

Markdown の中には html を書くことができます。Markdown 中に html を書く場合、html での表記の開始や終了を宣言する必要はありません。ただ単に、html で記述するだけです。(このことは、同時に、Markdown 中で < > & を使用する場合には、それぞれ &lt; &gt; &amp; という表現にエスケープして記述する必要があるということでもあります)

Markdown 中でブロック系の html タグ、例えば <table> , <pre>, <p> などを使用する場合には注意が必要です。

  • 開始タグの前には空行が必要です。
  • 終了タグの次にも空行が必要です。
  • タグはいずれもは行の先頭から記述する必要があります。スペースでインデントできません。
  • これらのブロック系のタグの内側では Markdown の書式は認識されません。

Markdown は下記のタグをブロック系のタグとして扱います。

address, article, aside, blockquote, canvas, del, div,
dl, fieldset, figcaption, figure, footer, form, h1, h2, h3, h4, h5, h6,
header, hgroup, hr, ins, main, nav, noscript, ol, output, p, pre, section,
script, style, table, tfoot, video, ul

Markdown 中にブロック系の html を埋め込む場合のコーディング例
この部分はパラグラフです。<table> の前に空行が必要です。

<table>
    <tr>
        <td>ここでは Markdown 記法は使えません。</td>
    </tr>
</table>

<div>
ここにも Markdown 記法は使えません。
</div>

この部分はパラグラフです。</table> の後ろに空行が必要です。

インライン系の html タグ、例えば <span> <cite> <del> などは、Markdown のパラグラフ、箇条書、ヘッダーの中で自由に使うことができます。

Markdown 中にインライン系のタグを使う場合のコーディング例
ここはパラグラフです。
パラグラフ中には、インライン系の html のタグを自由に使うことができます。
例えば <del>抹消</del> というような記述が可能です。

反対に、Markdown 記法でのリンクの設置や画像の挿入ではなく、それらを直接 html でコーディングしたいと思うのであれば <a> タグや <img> タグを使ってコーディングしても構いません。

Markdown 記法ではなく、直接 a タグを使ってリンクを定義する例
Markdown 中では、リンクは

[an example](https://example.com/ "Title")

と記述しますが、必ずしもこの記法を使わなければならない訳ではありません。直接 html を使って

<a href="https://example.com/" title="TItle">an example</a>

と記述することも可能です。

Markdown とスタイルシート

WebRelease では、Markdown でマークアップされた html には、基本的に、それが Markdown で生成されたものであることを示す class 属性は付いていません。これは、あるマークアップ、例えば <ol><li></li></ol> などの箇条書きが、直接 html 入力されたものなのか、または、Markdown によって生成された物なのかを、テンプレート側で区別する手段がないということでもあります。

Markdown で入力された物についてのみ、Markdown 専用の特別なスタイルシートが適用される方法を採ることの是非については、いくらか議論の余地があるでしょう。特別なスタイルシートを使用してしまうと、Markdown で入力できないケースに、その部分に Markdown 用のスタイルシートを適用させることが難しくなるかもしれません。

前

次

© 2000 - 2024  FrameWorks Software, Inc.