[green]概要[/green]
前後、最初と最後のドキュメント、ホームページ、親ドキュメントへのリンクを表示するスニペットです。
あらかじめ同梱されているテンプレートとスタイルを利用することで、簡単にナビゲーションを作成することができます。
また、link要素を出力するテンプレートを利用することによって、ユーザー・検索エンジンなどに対しても優しいサイトになります。
テンプレートは完全にカスタマイズ可能で、リンクの文字列はドキュメントタイトルなどにも変更できます。
(基本的に、PrevJumpNextやDittoのpaginateなどと同じ類のものです。
DittoやPHxとの併用の際に、PrevJumpNextなどのプレースホルダーが消去されてしまう場合や、
テンプレートを細かくカスタマイズしたい場合、外部ファイルに分けたい場合などに便利だと思います。
前後のページがあるときだけdiv要素を出力したりもできるので、余分なXHTMLが出力されることもありません。)
ダウンロード
[green]インストールとアンインストール[green]
インストール
1.doclink/フォルダを /assets/snippets/ にコピー。
2.「DocLink」という名前のスニペットを新規作成。
3.doclink.snippet.tpl.phpの内容を「スニペットコード」にコピー&ペースト。
4.スニペットを保存。
アンインストール
1.スニペットとファイルを削除。
[green]使い方[/green]
標準では、前後のドキュメントへのシンプルなナビゲーションリンクを表示します。
表示したいドキュメントの中でスニペットをコールします。
テンプレート「full」のナビゲーションをスタイル「modx」で出力する場合
[[DocLink? &template=`full` &style=`modx`]]
ナビゲーション用のlink要素を出力する場合
<head>
...省略...
[[DocLink? &template=`link` &style=`none`]]
</head>
[green]詳しい説明[/green]
パラメーターを指定することで見栄えや機能を変えることができます。
詳しくは、同梱のDocLink.ja.pdfを参照してください。
[green]リソースの情報[/green]
[table]
[tr][td]
作者[/td][td]Phize[/td][/tr]
[tr][td]
Webサイト[/td][td]
http://phize.net[/td][/tr]
[tr][td]
リソース名[/td][td]DocLink[/td][/tr]
[tr][td]
バージョン[/td][td]1.0.0[/td][/tr]
[tr][td]
ライセンス[/td][td]GPL[/td][/tr]
[tr][td]
動作環境[/td][td]MODx 0.9.6[/td][/tr]
[tr][td]
リソースの種別[/td][td]スニペット[/td][/tr]
[tr][td]
タグ[/td][td]リンク/ナビゲーション/link/navigation[/td][/tr]
[/table]