既存HTMLのテンプレート制作ガイド
既存の静的HTMLをAIHP CMS用テンプレートに変換する手順とファイル配置ルールを解説します。
既存HTMLのテンプレート制作ガイド
対象: デザイナー、HTMLコーダー
AIHP CMSでは、制作者が作成したHTMLへdata-aihp-*属性を追加し、DBの記事データを表示します。PHPを書く必要はありません。
基本の考え方
src内のHTML DBの記事データ
見出し、class、レイアウト タイトル、本文、カスタム項目
\ /
CMSが組み合わせる
↓
公開HTML
例えば次の仮タイトルは、記事生成時にDBのタイトルへ変わります。
<h1 data-aihp="title">記事タイトルが入ります</h1>
src/の構成例
aihp/cms/src/
├── index.html
├── company.html
├── info/
│ ├── index.html
│ ├── _entry.html
│ ├── _category.html
│ ├── _year.html
│ └── _month.html
└── parts/
├── _head.html
├── _header.html
├── _footer.html
└── _info_item.html
_で始まるHTMLは、そのHTML自身を直接公開しません。_entry.htmlは記事詳細テンプレートです。ファイル名を変えられません。- それ以外の
_付きHTMLは、include部品や一覧部品などに使えます。 parts/は整理のための推奨ディレクトリで、必須ではありません。- アーカイブ用途はファイル名ではなく、HTML内の属性で決まります。
記事詳細テンプレート
必須:ファイル名は
_entry.htmlにしてください。CMSは
src/{type.path}/_entry.htmlという名前だけを記事詳細テンプレートとして扱います。kiji.htmlやdetail.htmlのような別の名前で作ると、次の2つが同時に起こります。
- 記事詳細ページが生成されません。 CMSがテンプレートを見つけられないため、 そのコンテンツタイプは一覧専用として扱われます。
- そのファイル自体が公開されます。
_で始まらないHTMLは通常の固定ページとして 公開されるため、制作中のサンプル記事がそのまま本番サイトへ出ます。デザイナーが記事サンプルとしてHTMLを作る場合も、最初から
_entry.htmlという名前で 作成してください。 別名で作ってから配置する場合は、src/へ置く前にリネームします。
コンテンツタイプの公開パスと同じ場所へ_entry.htmlを置きます。
type.path = info
テンプレート = src/info/_entry.html
type.path = company/news
テンプレート = src/company/news/_entry.html
基本例:
<!DOCTYPE html>
<html lang="ja">
<head data-aihp-include="parts/_head.html">
<meta charset="UTF-8">
<title data-aihp="title">記事タイトル</title>
</head>
<body>
<header data-aihp-include="parts/_header.html"></header>
<main>
<article>
<h1 data-aihp="title">記事タイトル</h1>
<div class="article-body" data-aihp-html="content">記事本文</div>
</article>
</main>
<footer data-aihp-include="parts/_footer.html"></footer>
</body>
</html>
_entry.htmlがないコンテンツタイプは、一覧データとして使用できますが、記事ごとの詳細HTMLは生成しません。
このとき、一覧の項目を<a>でリンクにできません。詳細ページがないためloop.urlが常に空になり、
リンク要素ごと削除されて項目が消えます。
使えません <li><a data-aihp-href="loop.url" data-aihp="loop.title">仮タイトル</a></li>
正しい書き方 <li data-aihp="loop.title">仮タイトル</li>
記事本文
本文は次の専用属性を使います。
<div class="article-body" data-aihp-html="content">記事本文</div>
data-aihp="content"ではHTMLタグが文字として表示されるため、本文には使用しません。data-aihp-htmlでHTML表示できるキーはcontentだけです。
共通部品
<header data-aihp-include="parts/_header.html"></header>
<footer data-aihp-include="parts/_footer.html"></footer>
includeパスはsrc/を起点に書きます。src/自体は指定しません。
<!-- 正しい -->
<header data-aihp-include="parts/_header.html"></header>
<!-- 使用できない -->
<header data-aihp-include="src/parts/_header.html"></header>
<header data-aihp-include="../outside.html"></header>
- 読み込めるのは、実体も
src/内にあるHTMLだけです。 ..、.、絶対パス、バックスラッシュ、HTML以外は使用できません。- include内へ別のincludeを書くこともできます。
- DB記事の
headでは、head自体を残して中身を差し替えます。
固定HTMLのhead
固定ページと一覧ページのheadは、そのHTMLへ直接書きます。CMSはtitle、description、OGP、canonicalを自動選択しません。
<head>
<meta charset="UTF-8">
<title>会社概要</title>
<meta name="description" content="会社概要です">
<link rel="stylesheet" href="/assets/css/style.css">
</head>
固定HTMLのheadへ誤ってdata-aihp-includeを指定した場合、includeを実行せず、元のheadを維持して警告を記録します。
CSS・JavaScript・デザイン画像
CMSはCSS、JavaScript、デザイン画像をsrc/から公開ルートへコピーしません。
ドメインルート/
└── assets/
├── css/style.css
├── js/site.js
└── img/logo.svg
<link rel="stylesheet" href="/assets/css/style.css">
<script src="/assets/js/site.js" defer></script>
<img src="/assets/img/logo.svg" alt="サイト名">
制作者が公開サーバーへ配置し、HTMLの参照先と一致させます。投稿画面のfile項目からアップロードした画像・PDFだけはCMSが/uploads/へ保存します。
制作と確認の流れ
- コンテンツタイプの
pathを確認します。 - 詳細ページが必要なら
src/{path}/_entry.htmlを作ります。ファイル名は変えられません。 - タイトルと本文へCMS属性を設定します。
- 必要な一覧、include、特定記事、カスタム項目を設定します。
- HTMLを
src/へ配置します。 - 管理画面で記事を保存します。
- 保存済みプレビューを確認します。
- テンプレート変更後は全体再構築します。
- 公開HTML、CSS、JavaScript、画像、リンク先を確認します。
属性の一覧とアーカイブ制作はdata-aihp属性リファレンス、入力項目の定義はカスタムフィールドを参照してください。
最終チェック
- 記事詳細が
src/{type.path}/_entry.htmlにある。ファイル名が_entry.htmlである。 - 本文へ
data-aihp-html="content"を使用した。 - includeパスに
src/や..を書いていない。 - 固定・一覧HTMLのheadをHTML自身へ書いた。
- CSS、JavaScript、画像を公開ルートへ配置した。
- プレビューと再構築後の公開HTMLを確認した。