navix.inc.php

Top > Plugin > navix.inc.php
First Edition. 08/15/2008
Last Modified. 08/15/2008
Tag: PukiWiki Plugin

ページナビゲーションを表示する navi.inc.php の拡張

Table of Contents

説明

ページナビゲーションを表示する navi.inc.php の拡張です。 lsx.inc.php と同様の機能を使えるので、lsx のリストに合わせたナビゲーションを表示することが出来ます。

標準プラグイン navi との違い

  • $non_list をデフォルトで除外する
  • navi では2度目以降呼び出しで勝手に DocBook footer スタイルに変わるが、オプションで明示的指定するように
    • navi では、複数ページを include すると第一 navi 以外全て DocBook footer スタイルになってしまう
  • DocBook footer スタイルの際のスタイルシートが不十分なので修正(ページ名が長い場合崩れる)
  • 水平線をデフォルトでは表示しない。
  • lsx.inc.php 互換のオプションでページを絞りこめる。sort 順序も変えられる。

などなど

使い方

書式

#navix([オプション])
#navix(ホーム[,オプション])

ホーム or home=ホーム

ナビゲーションのホーム(根幹)となるページ。例えば、

#navix(Plugin)

とすれば Plugin ページがホームになり、Plugin ページ下位のページ(Plugin/ で始まるページ群)をナビゲーションします。

  • 省略時は dirname(現在ページ) が指定されます。現在ページが Plugin/Hoge/Hoge の場合は、Plugin/Hoge です。
  • 最上位を指定するには、UNIX の / (ルート)のようなニュアンスで、 / を指定してください。

lsx との関連

lsx.inc.php でいえば、prefix=ホーム/ です。 navi 系プラグインでは / をつけないので注意してください。

look = header | footer

look オプションでどちらのスタイルを使用するかを選べます。デフォルトは header です。

DocBook header スタイル

Prev          Home          Next

DocBook footer スタイル

Prev          Home          Next
<pagename>     Up     <pagename>

navi プラグインでは、2度目呼び出し以降、勝手に footer スタイルになりますが、 footer スタイルを使いたくない場合や、複数ページの include の際に第一 navi 以外全て footer になってしまうなどの不具合があるため、navix ではオプションで明示的に指定するようにしました。

border = off | top | bottom

水平線を表示します。

off ではなし、top では上部に、bottom では下部に表示します。デフォルトは off です。navi.inc.php と違い表示しません。

look は header のままで、ページ下部に設置したいこともあるかもしれないので、border オプションで明示指定するようにしました。

もしくは、off のままで、(----) で水平線を表示する方法もあると思い、デフォルトでは off にしました。

その他

その他オプションは lsx.inc.php とほぼ共通です。 lsx.inc.php を参照してください。

filter, except, tag, sort, reverse オプションなどが使用可能です。

lsx.inc.php を用いて、オプションを指定、表示順序を確認しておくと、 同じオプションを使用することで navix でも同順序でナビゲーションできるはずです。

動作例

#navix(Plugin,look=header,border=bottom)

このページの上部参照

#navix(Plugin,look=footer,border=top)

このページの下部参照

追加設定

css

デフォルトでは、css も style="" アトリビュートで html と一緒に出力させています。 なんらかの変更を行いたくなった場合、外部 css に分離しそちらの css ファイルを変更することで、プラグインを改変せずにすむようにできます。

navix.inc.php を開き、以下の箇所だけ、改変しておきます。

 // configuration
 static $conf = array(
-'printcss' => true,
+'printcss' => false,
 );

デフォルトと同等の css ファイルは index.php?cmd=navix&pcmd=css で参照することができます。これをコピーしてご使用ください。

html 構造は次のようになります(例:look=footer, border=bottom の場合)。

<div class="wrap_navix">
<ul class="navi">
<li class="left">Prev<br />ページ名</li>
<li class="center">Home<br />Up</li>
<li class="right">Next<br />ページ名</li>
</ul>
<hr class="full_hr bottom" />
</div>

技術的詳細

定義

  • Home
    • Home には、Home 引数で指定したページへのリンクが表示されます。Home/ な接頭字(prefix) にマッチするページ群がナビゲーション対象となります.
  • Prev
    • Prev には、カレントページの直前のページへのリンクが表示されます。最先頭は Home ページになります。
  • Next
    • Next には、カレントページの直後のページへのリンクが表示されます。カレントページが最後尾の場合は何も表示されません。
  • Up
    • Up には、カレントページの一つ上の階層のページへのリンクが表示されます。よって、Home とは一致しない場合もあります。
  • DocBook header スタイル
    • Prev          Home          Next
      のような表示を意味します。
  • DocBook footer スタイル
    • Prev          Home          Next
      <pagename>     Up     <pagename>
      のような表示を意味します。

ダウンロード

まだ、完全なお試しα版です

Sonots PukiWiki Plugin Collection に含まれています。

lsx-vX.XX.zip をダウンロードし、plugin ディレクトリ以下に展開してください。
同時梱包されているその他のプラグインは上述ページ内の「Release Notes」リンクから参照できます。