このページはJavaScriptを使用しています。JavaScriptを有効にして対応ブラウザでご覧下さい。

DOCUMENTSドキュメント

SitemapHelper

はじめに

Movable Type で管理・出力されるファイルの一覧作成を補助するプラグインです。主にサイトマップの作成に役立ちます。次のような特徴があります。

  1. Movable Type からテンプレートを用いて出力されるファイルの一覧を出力することができます。
  2. ファイルに紐づくオブジェクト（記事・コンテンツデータなど）の更新日時を出力できるほか、実際に出力されたファイルの更新日時を取得することもできます。
  3. 複数のサイトをまたいだファイル一覧を一括で処理することができます。
  4. ダイナミック・パブリッシングで運用されているサイトにも対応します。（ただしサイトマップ自体は静的出力を行います）
  5. サイトの構成に応じてサイトマップのテンプレートを細かく変更する必要がありません。

動作条件

本プラグインは Movable Type 7 / 8 にて動作します。

このプラグインの利用、及び著作権や保証について

このプラグインの著作権は作者であるエムロジック株式会社 / M-Logic, Inc.が所有しています。著作権者の許可なく本プラグインを使用、改変、再配布することはできません。

インストール

本パッケージに含まれる「plugins」ディレクトリ内の「SitemapHelper」ディレクトリを、Movable Typeインストールディレクトリの「plugins」ディレクトリの下にコピーしてください。

なお、Movable TypeをPSGI/Plack環境で実行している場合、プラグインのインストールを認識させるためにアプリケーションのリロードが必要になる場合があります。

インストール後、以下のような構成になります(一部省略しています)。

mt (Movable Typeインストールディレクトリ)
└── plugins
    └── SitemapHelper
        ├── lib
        │   ├── SitemapHelper
        │   │   ├── L10N
        │   │   │   ├── en_us.pm
        │   │   │   └── ja.pm
        │   │   ├── CMS.pm
        │   │   ├── L10N.pm
        │   │   ├── Tags.pm
        │   │   └── Util.pm
        │   └── SitemapHelper.pm
        └── config.yaml

作業後、Movable Typeにログインするとデータベースのアップグレードが必要になる場合がありますので「アップグレード開始」をクリックしアップグレードを完了させてください。

次に、Movable Type のシステムのプラグイン設定画面を表示し、プラグインの一覧に「SitemapHelper」が表示されていることを確認してください。これでインストール完了です。

準備

本プラグインを使用するためにはいくつかの作業が必要となります。ここでは例として基本的なXMLサイトマップの作成を行います。
XMLサイトマップのフォーマットについては、こちらを参照してください。

サイトマップ用テンプレートの作成

XMLサイトマップの出力を行いたいサイトに次の内容でインデックステンプレートを作成します。

出力ファイル名は「sitemap.xml」に、公開設定は「スタティック」もしくは「公開キュー経由」にしてください。（自動的にサイトマップを更新する必要がない場合には「手動」にしてください）

サイトマップ出力設定

XMLサイトマップの一覧に含めたいファイルのテンプレート編集画面を開き、サイトマップ設定を「含める」に変更します。
この設定はインデックステンプレートとアーカイブテンプレートのアーカイブマッピングに行うことができます。

インデックステンプレートの設定
インデックステンプレートの設定
アーカイブマッピングの設定
アーカイブマッピングの設定

XMLサイトマップへの出力設定を一通り終えると、XMLサイトマップ出力の準備は完了となります。
最初に作成したインデックステンプレートの再構築を行い、サイトマップが出力されていることを確認してください。

テンプレートタグの使用

本プラグインでは、Movable Type で管理・出力されるファイルの一覧作成を補助するテンプレートタグを複数提供しています。

ブロックタグ

MTFileInfo

サイトのテンプレートから出力されるファイルの一覧を扱うブロックタグです。モディファイアを用いて複数のサイトのファイルを一括で扱うことができます。

モディファイア

include_sites="all | children | siblings | ID"

対象とする複数のサイトを指定します。詳しくはマルチサイト機能が利用できるテンプレートタグとモディファイアを参照してください。

exclude_sites="children | siblings | ID"

include_sites モディファイアで複数のサイトを対象としたとき、除外するサイトを指定します。詳しくはマルチサイト機能が利用できるテンプレートタグとモディファイアを参照してください。

sort_by="blog_id | file_path | url"

ファイル一覧を並び替える際のソートキーを指定します。初期値は url です。

sort_order="ascend | descend"

ファイル一覧を並べる順序を指定します。初期値は ascend(昇順。sort_by="url" を指定した場合、アルファベット順) です。

root_url="url"

ファイルのURLを生成する際のサイトURLを上書きします。CMS上のサイトURLと公開URLが異なる場合に使用します。

archive_url="url"

ファイルのURLを生成する際のアーカイブURLを上書きします。

MTFileInfoEntry

一覧のファイルが記事アーカイブである場合に、記事を参照するためのブロックタグです。このタグの中では記事関係のテンプレートタグを使用することができます。

MTFileInfoIfVirtual

一覧のファイルがダイナミックパブリッシングで公開されている場合に実行する条件（コンディショナル）タグです。

MTFileInfoIfExists

一覧のファイルが存在する場合に実行する条件タグです。ダイナミックパブリッシングで公開されている場合には常に実行されます。

MTFileInfoHasEntry

一覧のファイルが１つの記事を用いてビルドされる場合（記事アーカイブである場合）に実行する条件タグです。

MTFileInfoHasCategory

一覧のファイルが１つのカテゴリーを用いてビルドされる場合（カテゴリーアーカイブである場合）に実行する条件タグです。

MTFileInfoHasAuthor

一覧のファイルが１つのユーザーデータを用いてビルドされる場合（ユーザーアーカイブである場合）に実行する条件タグです。

MTFileInfoIfArchiveType

一覧のファイルが特定のアーカイブタイプであった場合に実行する条件タグです。

モディファイア

eq="Individual | Page | ..."

比較するアーカイブタイプを１つ指定します。指定できるアーカイブについてはこちらを参照してください。

ファンクションタグ

MTFileInfoArchiveType

ファイルのアーカイブタイプを表示します。

MTFileInfoFilePath

ファイルのファイル・システム上のパスを表示します。

MTFileInfoLastUpdate

ファイルの更新日時を表示します。再構築に使用するオブジェクト（記事・コンテンツデータ等）をもつファイルでは、オブジェクトの更新日時を優先して表示しますが、それ以外の場合には出力されたファイルの更新日時を表示します。
モディファイアには、タグ独自の filetime 以外に日付に関するテンプレートタグのモディファイアを使用することができます。

モディファイア

filetime="0 | 1"

出力されたファイルの更新日時を優先して表示したい場合には 1 を指定します。初期値は 0 です。

MTFileInfoURL

ファイルのURLを表示します。

更新履歴

  • ドキュメント更新
  • Movable Type 7に対応した
  • 最初のリリース
INFORMATION