ブロック

SOY CMSのどのページでも使用できるブロックの属性

前回の記事では、どのページでも使えるブロックについて解説しました。

どのページでも使えるブロックは、「標準ブロック」と言ったりもします。ただ、標準ブロックという言い方だと標準ページでしか使えないと思われるかもしれないので、どのページでも使えるブロックと言っています。

今回は、どのページでも使えるブロックで使えるcms:idの属性について解説していきます。

どのページでも使えるブロックで使えるcms:idの属性

どのページでも使えるブロックで使えるcms:idの属性は以下になります。

※使用可能なHTMLタグとは、cms:idの使用できるHTMLタグになります。全てというのは、全てのHTMLタグで使用でき、<A>タグというのは、HTMLのAタグで使用できるということです。

どのページでも使えるブロックで使えるcms:idの属性の詳細

cms:id entry_id
使用可能なHTMLタグ 全て
働き 対象記事のIDを出力します。
使用場面 なし
解説 ブロックで指定した記事のIDを出力します。
実際の場面では、ほとんど使うことはないかと思います。
cms:id title(※1)
使用可能なHTMLタグ 全て
働き 対象記事のタイトルを記事毎ページへのリンク付きで出力します。
使用場面 ブロク記事の新着情報などをタイトルだけで紹介する(例:最近の投稿)
解説 このcms:idは、下にある「title_plain」と「entry_link」を合わせた効果を持ちます。
使う場面としては、ブログと連携して最近の投稿などでタイトルのみ表示させているところなどです。
画像を使わないのであれば、こちらを使ったほうがシンプルなコードになります。
実際の実用例 <div><cms:id="title" cms:alt="タイトル">タイトル</div>
cms:id title_plain(※1)
使用可能なHTMLタグ 全て
働き 対象記事のタイトルのみを出力します。
使用場面 ブロク記事の新着情報などで、タイトルと画像を一緒に表示する(例:画像付きの最近の投稿)
解説 リンクのないタイトルだけを表示します。会社案内のページのタイトルやプロフィールページのタイトルなど、リンクを張り必要がない場合はこちらを使用します。
また、ブログと連携して画像付きで新着情報を表示させる場合も、こちらを使います。
実際の実用例 <div><cms:id="title_plain">タイトル</div>
cms:id content(※1)
使用可能なHTMLタグ 全て
働き 対象記事の本文を出力します。
使用場面 必要になる、ほぼすべての場面で使用します。
解説 記事の内容を出力するという機能の特性上、ほぼすべての場面で使用できます。ヘッダーやフッターなどもエントリー(記事)の本文で設定を行うのであれば、そこでも使う事が出来ます。
ブログと連携してブログの本文を出力することも出来ます。
意味のある文を表示する場面で使われます。
実際の実用例 <div><cms:id="content">エントリー(記事)の内容(本文)</div>
cms:id more(※1)
使用可能なHTMLタグ 全て
働き 対象記事の本文に追記記事を出力します。
使用場面 あまり無い
解説 エントリー(記事)の本文に追加して記事を表示させる場合に使うものです。ただ、**content**に記事の内容を全て記述してしまえば、こちらは使わないと思います。
ブログと連携してブログの追加記事を出力させることが出来ます。
テンプレートが対応していないと表示されません。
実際の実用例 <div><cms:id="more">エントリー(記事)の内容(追記)</div>
cms:id create_date(※2)
使用可能なHTMLタグ 全て
働き 対象記事の作成日付を出力します。「cms:format」を使うことで書式を指定することが出来ます。
使用場面 最新の情報を発信する場合やプレスリリースを発信する場合で日付が重要な意味を持つとき。
解説 ブログと連携して最新の情報を発信する場合や企業などがプレスリリースを発信する場合に使います。
実際の実用例 <!-- cms:id="create_date" cms:format="Y年n月j日" -->2022年12月24日<!-- /cms:id="create_date" -->
cms:id create_time(※2)
使用可能なHTMLタグ 全て
働き 対象記事の作成時刻を出力します。「cms:format」を使うことで書式を指定することが出来ます。
使用場面 最新の情報を発信する場合やプレスリリースを発信する場合で日付と時間が重要な意味を持つとき。
解説 ブログと連携して最新の情報を発信する場合などに使います。
実際の実用例 <!-- cms:id="create_time" cms:format="H:i:s" -->17:20:35<!-- /cms:id="create_time" -->
cms:id update_date(※2)
使用可能なHTMLタグ 全て
働き 対象記事の更新日付を出力します。「cms:format」を使うことで書式を指定することが出来ます。
使用場面 最新の情報を更新する場合など日付が重要な意味を持つとき。
解説 ブログと連携して最新の情報を更新する場合などに使います。
実際の実用例 <!-- cms:id="update_date" cms:format="Y年n月j日" -->2022年12月24日<!-- /cms:id="update_date" -->
cms:id update_time(※2)
使用可能なHTMLタグ 全て
働き 対象記事の更新時刻を出力します。「cms:format」を使うことで書式を指定することが出来ます。
使用場面 最新の情報を更新する場合などで日付と時間が重要な意味を持つとき。
解説 ブログと連携して最新の情報を更新する場合などに使います。
実際の実用例 <!-- cms:id="update_time" cms:format="H:i:s" -->17:20:35<!-- /cms:id="update_time" -->
cms:id entry_link
使用可能なHTMLタグ <A>タグ
働き 対象記事の記事毎ページへのリンクを生成します。
使用場面 ブログ記事の新着情報などで、タイトルと画像を一緒に表示する(例:画像付きの最近の投稿)等。
解説 標準ページで新着情報を表示させる場合、画像と一緒にタイトルを表示させたいことがあります。そういったときに、この「entry_link」を使うことで、それらを1つのブロックとしてリンクを張ることが出来ます。
実際の実用例 <a cms:id="entry_link">
    <div><!-- cms:id="title_plain"-->ニュースタイトル<!-- /cms:id="title_plain"--></div>
</a>
cms:id more_link
使用可能なHTMLタグ <A>タグ
働き 対象記事の追記の表示された記事毎ページへのリンクを生成します。
使用場面 ブログの新着情報等で、「続きを読む」にリンクを張る。
解説 ブログ記事の新着情報などで、本文を新着情報に表示させて「続きを読む」をクリックしたときに、そのブログの追記のあるエントリー(記事)へのリンクを張ります。
実際の実用例 <div cms:id="content">本文です</div>
<div><a cms:id="more_link">続きを読む</a></div>
cms:id category_list
使用可能なHTMLタグ 全て
働き 対象記事につけられているカテゴリーのブロックを出力します。
後述のcategory_link、category_nameを使用するためにブロックの設定を行ってください。
使用場面 ブログ記事の新着情報などで、カテゴリー名を表示させる場合
解説 SOY CMSではエントリー(記事)にカテゴリーを複数個付けることが可能です。そのため、ブログ記事の新着情報などでカテゴリー名を表示させる場合、そのカテゴリーを表示させるブロックをこれで作ります。
実際の実用例 <!-- cms:id="category_list" -->
    <a cms:id="category_link"><!-- cms:id="category_name" -->カテゴリー名<!-- /cms:id="category_name" --></a>
<!-- /cms:id="category_list" -->
cms:id category_link
使用可能なHTMLタグ <A>タグ
働き 対象記事につけられているカテゴリーのアーカイブページへのリンクを生成します。
前述のcategory_list内で使用することが可能です。
使用場面 ブログ記事の新着情報などで表示されるカテゴリー名にリンクを張る。
解説 ブログ記事の新着情報などでカテゴリー名を表示させた時に、そのカテゴリー名にリンクを張ります。こうすることで、そのカテゴリー名がクリックされると、そのカテゴリー名のアーカイブページへジャンプします。
実際の実用例 <!-- cms:id="category_list" -->
    <a cms:id="category_link"><!-- cms:id="category_name" -->カテゴリー名<!-- /cms:id="category_name" --></a>
<!-- /cms:id="category_list" -->
cms:id category_name
使用可能なHTMLタグ 全て
働き 対象記事につけられているカテゴリーの名前を出力します。
前述のcategory_list内で使用することが可能です。
使用場面 ブログ記事の新着情報などでカテゴリー名を表示する時に使用する。
解説 ブログ記事の新着情報などでタイトルとともにカテゴリー名を表示させる場合に使用する。SOY CMSではエントリー(記事)にカテゴリーを複数付けることが可能なので、全てのカテゴリー名が表示される。
実際の実用例 <!-- cms:id="category_list" -->
<a cms:id="category_link"><!-- cms:id="category_name" -->カテゴリー名<!-- /cms:id="category_name" --></a>
<!-- /cms:id="category_list" -->

(※1) title, title_plain,content, moreの中身が空の時に表示する値をcms:altで指定することが出来ます。

(※2) 日付関連のフォーマット(cms:format)はPHPのdateと同じものを使うことが出来ます。
例:cms:format="Y-m-d H:i:s" → 2009-03-18 16:08:03,
  cms:format="Y年n月j日" → 2009年3月9日
詳しくはPHP: date - Manualを参照してください。


終わりに

今回解説してきたcms:idの属性は、どのページでも使えるブロックで使えるようになってはいますが、実際には標準ページで使うことがほとんどではないかと思います。

ブログページにはブログブロックというものがあり、ブログブロックを使うことでブログのテンプレートを作成することが出来るからです。

それでも、会社概要やプロフィール、プライバシーポリシーなどの1ページで完結するところでは必要になってきます。

今回と前回の記事を参考に、標準ページを作成してみてください。