Nucleusプラグインポップアップ・ヘルプ

テンプレートの名前

テンプレートの名前は、aからzと0から9のみで構成され、かつスペースを含まないものを付けてください。

表示しない/するブログ

ContentsListで表示しない、または表示するブログを設定できます。まず、表示する・しないをラジオボタンで選択してから対象となるブログをチェックしてください。これらはテンプレートごとに別々に設定することができます。

なお、「表示するブログ」の方が選択されていて、かつ、どのブログにもチェックが付いてないと何も表示されなくなりますので設定を変える際は気をつけてください。

ブログのデフォルトの並び順

同じランクのブログが存在するとき、それらはここで指定した順序で上から並べられます。テンプレートごとに別々に設定することができます。

カテゴリーのデフォルトの並び順

同じランクのカテゴリーが存在するとき、それらはここで指定した順序で上から並べられます。テンプレートごとに別々に設定することができます。

ブログリストテンプレート

以下のテンプレート変数が利用できます

全てのパーツで利用可能な変数

テンプレート変数 説明
<%skinfile%> スキンフォルダのURL

ブログリスト本体で利用可能な変数

テンプレート変数 説明
<%blogid%> ブログID
<%blogurl%> ブログのURL
<%blogname%> ブログの名前
<%bshortname%> ブログの短縮名
<%blogdesc%> ブログの説明
<%categorylist%> そのブログのカテゴリーリスト。「カテゴリーリストテンプレート」で設定した形式で表示されます。
<%flag%> そのブログが現在選択されているときだけ、「カレントブログのフラグ」で設定した内容がこの部分に出力されます。

カテゴリーリストテンプレート

以下のテンプレート変数が利用できます

全てのパーツで利用可能な変数

テンプレート変数 説明
<%skinfile%> スキンフォルダのURL

カテゴリーリスト本体で利用可能な変数

テンプレート変数 説明
<%blogid%> ブログID
<%blogurl%> ブログのURL
<%blogname%> ブログの名前
<%bshortname%> ブログの短縮名
<%blogdesc%> ブログの説明
<%self%>
<%catid%> カテゴリーID
<%catlink%> カテゴリーのURL
<%catname%> カテゴリーの名前
<%catdesc%> カテゴリーの説明
<%amount%> そのカテゴリーの記事数
<%subcategorylist%> そのカテゴリーのサブカテゴリーリスト。「サブカテゴリーリストテンプレート」で設定した形式で表示されます。
<%catflag%> そのカテゴリーが現在選択されているときだけ、「カレントカテゴリーのフラグ」で設定した内容がこの部分に出力されます。
<%if(subcategory)%>
 ~
<%else%>
 ~
<%endif%>
サブカテゴリーが設定されていて、かつ、1つ以上のサブカテゴリーに1つ以上記事がある場合、ifからelse(elseが無い場合はendif)までが出力されます。(その必要は無いはずですが、入れ子はできません)

サブカテゴリーリストテンプレート

私タカのサイトで配布しているNP_MultipleCategories改造版でサブカテゴリーの作成ができるのですが、それらを表示するためのテンプレートです。

全てのパーツで利用可能な変数

テンプレート変数 説明
<%skinfile%> スキンフォルダのURL

サブカテゴリーリスト本体で利用可能な変数

カテゴリーリストテンプレート本体で使える変数(<%if(subcategory)%>を除く)プラス、以下の変数が利用できます。

テンプレート変数 説明
<%subcatid%> サブカテゴリーID
<%sublink%> サブカテゴリーのURL
<%subname%> サブカテゴリーの名前
<%subdesc%> サブカテゴリーの説明
<%subamount%> そのサブカテゴリーの記事数
<%subflag%> そのサブカテゴリーが現在選択されているときだけ、「カレントサブカテゴリーのフラグ」で設定した内容がこの部分に出力されます。

カレントのフラグ

ここで設定した内容がテンプレートのそれぞれ

<%flag%>(ブログリスト)

<%catflag%>(カテゴリーリスト)

<%subflag%>(サブカテゴリーリスト)

の部分に、そのブログ、カテゴリー、サブカテゴリーが現在選択されている時のみ出力されます。選択されていないブログ、カテゴリー、サブカテゴリーでは何も出力されません。

スキン/テンプレート変数:skinfile

インポートされたスキンから、スキンのurlに相対リンクを張るときに使う。最良の結果を得るためには、パーサーのプロパティIncludePrefixと共に使うこと。

引数

スキンタイプ

すべて

<%skinfile(mystyle.css)%>

パーサーのプロパティ

利用可能なパーサーオプションを以下に記述する。

パーサーのプロパティ
オプション名
Includeモード
  • normal:通常の動作;ページを作成する.phpファイルのディレクトリ/urlから相対位置のファイルを取り出しインクルード。
  • skindir:スキンディレクトリ/スキンurlから相対位置のファイルを取り出しインクルード。
includeプリフィックス

このプロパティはインクルードするファイルそれぞれの頭に追加されるプリフィックスです。例えば、プリフィックスがbase/でインクルードするファイルがsomefile.txtなら、最終的にはbase/somefile.txtをインクルードすることになります。

このプロパティはIncludeModeのプロパティと共に使われることが意図されています。この方法で、skindir/somename/にインポートされたスキンは、includemodeskindirを使うIncludePrefixsomename/に設定しておくことができます。

IncludeプリフィックスIncludeモードのプロパティは、「スキンの一般的設定」において該当スキンでの包括的な設定が可能です。なお、プロパティが設定されてしまうと、例えばテンプレートも含めたすべてのパースデータにそれが適用されることを心にとめておいてください。

既定のテンプレート

スキン変数(<%ContentsList%>)のパラメーターで特に別のテンプレートを指定していない場合に、利用されるテンプレートを選んで下さい。

パラメーター記述方法

表示ランク

好きな順番に表示順を並べ替えることができます。同じランクのものが複数ある場合は、各テンプレート編集ページにある

という項目にて設定された順序にしたがって表示されます。

また、カテゴリーのランク選択リストの一番下に、「非表示」という項目があります。これを選択するとそのカテゴリーを隠すことができます。(v2.0から)
※ブログの表示非表示は、各テンプレートに設定項目がありますのでそちらから行えます。

使用方法

このプラグインをインストール後、まずは「Contents List」の行にある「編集」というリンクをクリックすると現れるオプションページで基本の設定を行ってください。(設定項目の解説)

基本設定が終わったら、スキンに<%ContentsList%>と書き込むと、その部分にリストが表示されます。デフォルトでは全ブログでカテゴリ展開されます。

表示順や各テンプレートの設定は、Nucleusの管理エリア内、プラグイン一覧ページで「Contents List」の行にある「管理」というリンクをクリックすると編集ページが現れますので、そこから行ってください。

パラメーター指定方法(基本)

パラメーターでは基本的にカテゴリーリストの展開についての設定ができます。

  1. <%ContentsList(@)%>

    パラメーターに「@」を指定すると、現在選択されているブログのみ、カテゴリーリストが表示されます。他のブログのカテゴリーは表示されません。

  2. <%ContentsList(-blogname)%>

    ブログのショートネームの頭に「-」をつけて記入すると、「そのブログのカテゴリーは表示しない(他のブログは表示する)」という意味になります。カンマで区切って複数指定可能ですが、下の「表示する」パラメーターとは併用できません。

  3. <%ContentsList(blogname)%>

    頭に何も付けずにブログのショートネームを記入すると、今度は「そのブログはカテゴリーを表示する(他のブログのカテゴリーは表示しない)」という意味になります。カンマで区切って複数指定可能ですが、上の「表示しない」パラメーターとは併用できません。

ex.<%ContentsList(ablog,bblog)%>
   <%ContentsList(-ablog,-bblog)%>

パラメーター指定方法(高度)

  1. <%ContentsList(-*)%>

    全てのブログのカテゴリーを展開しない

  2. <%ContentsList(>xxx)%>

    テンプレートを変更します。xxxの部分を変更するテンプレート名に変えて記入してください。

  3. <%ContentsList(bshortname!='static')%>

    フィルターです。以下を読んで意味のわかる人のみ利用するようにしてください。

    このパラメーターは直接SQL文のWHERE句のところに(複数あるときは and 接続で)渡されます。他のパラメーターでできないことは、これを使うとできるかもしれません。上記の場合だと

    SELECT xxx FROM xxx WHERE bshortname!='static'

    となります。ブログの短縮名が'static'以外のものが表示されます。

    プラグインスクリプトを見ると、b. を頭に付けたくなるかもしれませんが、前バージョンからの兼ね合いでスクリプトの方で補完するようにしてますので付けないようにしてください。

    [!<>=]のどれかがパラメーター中に入っていれば、そのパラメーターはこのフィルターだとみなされるようにしてます。

これらは「基本」の方で説明したパラメーターも含めて併用できます。カンマで区切ってください。順番はどうでもいいです。

ex.<%ContentsList(bshortname!='static',bpublic=1,myblog)%>

プラグインオプション設定項目の解説

  1. [URLMode:Normal] When a blog URL ends with "/", add "index.php" before query strings.

    通常のURI形式で運用の場合の設定です。各blogのURIがスラッシュで終わる場合、そのblogへのリンクにパラメーター(?blogid=2 のような)が付く場合は、"index.php"を補うか否か。

    例)BlogIDが2のブログのURIがhttp://yourblog.com/だった場合
    「はい」なら : http://yourblog.com/index.php?blogid=2
    「いいえ」なら : http://yourblog.com/?blogid=2
    のようになります。

  2. [URLMode:FancyURLs] Name of categoryID parameter.

    FancyURLs(MagicalURLs)で運用の場合の設定です。各カテゴリーのURIはFancyURLsだと「http://yourblog.com/category/1」、MagicalURLs(mod_rewriteの進化版(?))だと「http://yourblog.com/catid_1.html」の形式がデフォルトとなり、「category」と「catid」という違いがあります。それぞれの運用モードや好みにしたがってどちらかに設定してください。

  3. [URLMode:FancyURLs] Magical URLs mode?

    MagicalURLsで運用している場合は、ここを「はい」にしてください。

  4. Parameter order

    各カテゴリーのURIのパラメーターの順序を設定できます。

    例)
    catid -> blogid
    • http://yourblog.com/index.php?catid=3&blogid=2
    • http://yourblog.com/category/3/blog/2
    • http://yourblog.com/catid_3_blog_2.html
      (Magicalは2番目の設定を「catid」にした場合)
    blogid -> catid
    • http://yourblog.com/index.php?blogid=2&catid=3
    • http://yourblog.com/blog/2/category/3
    • http://yourblog.com/blog_2_catid_3.html
      (Magicalは2番目の設定を「catid」にした場合)

  5. A-1 : Add blogid to default blog URL. -When default blog URL is completely the same as Site URL, always does not add.-

    デフォルトブログへのリンクにblogidを付けるか否か。(サイトのURIとデフォルトブログのURIが全く同じの場合は設定に関わらず付きません)

  6. A-2 : Add blogid to its category URLs.

    デフォルトブログのカテゴリーへのリンクにはblogidを付けるか否か。

  7. B-1 : When a blog URL is different from default blog URL, add blogid to the URL.

    あるブログのURIがデフォルトブログのURIと異なる場合に、そのブログへのリンクにblogidを付けるか否か。ブログごとに「diary.php」など別ファイルで運用していてURI にblogidが付くのが嫌な場合は、これを「はい」にしてください。

    注意 : 「はい」に設定した場合、デフォルトブログのURIに何らかの値が入力されている時は、1字でも違うと「異なるURI」とみなされるので注意してください。
    例えばデフォルトブログのURIが
    http://yourblog.com/」、
    BlogID2のブログのURIが
    http://yourblog.com/index.php
    だった場合は「異なるURI」とみなされblogidが付かず、このブログを表示できなくなってしまいます。
    なお、もしデフォルトブログのURIが空欄の場合は、各自のNucleus設定・環境により挙動が異なります。

  8. B-2 : Add blogid to its category URLs.

    B-1の状態の場合、そのカテゴリーへのリンクにはblogidを付けるか否か。

  9. Use sub category template.(require NP_MultipleCategories0.30j-)

    NP_MultipleCategories0.30j以降がインストールされている場合、サブカテゴリー用のテンプレートを使用するかどうか。

    「はい」を選択してもNP_MultipleCategories0.30j以降がインストールされていない場合は、強制的に「いいえ」に戻されます。
    それ以外でこれを「はい」にした場合、テンプレート編集画面の最後にサブカテゴリー用のフィールドが出現します。あとで「いいえ」に戻した場合、表示はされなくなりますが、データは消えません。このフィールドでサブカテゴリー用の記述をしたあとは、カテゴリーリストのテンプレート内のサブカテゴリーリストを表示したい位置に<%subcategorylist%>と記述してください。これを忘れると表示されません。

  10. Show in quick menu

    管理画面の左メニューに「ContentsList」というメニューを表示するか否か。(このメニューをクリックすると、テンプレートやランクの編集画面へ移動します。)

  11. Delete tables on uninstall

    ContentsListをアンインストールする時に、テンプレートやランクのデータを格納しているテーブルも一緒に削除するか否か。