Dumps wiki outputs into static HTMLs

Table of Contents

Abstract Related 使用法 - 開発版 プラグイン設定項目一覧 一括ダンプ（アクション型） 使用法 出力HTMLファイル名の変更 css へのリンクがおかしい Compatibility Check Download

Abstract

This plugin dumps wiki outputs into static HTMLs.

Related

• org:自作プラグイン/snapshot.inc.php - This does not outputs skins
• dev:BugTrack2/114 - HTML出力機能を実装して欲しい(PukiWikiをCMSとして使う)
• namazuTamer/PukiWiki/bodycache - 出力HTMLをキャッシュし表示の高速化を図る。これもスキンまでは対応していないが、スキンの処理はさほど重いわけでもないのでそれで良いと考える。
• 0hitぷき - Convert_Cache - 同上。ls など別ページの変化によって出力が変わるプラグインはキャッシュしないように除外設定しておくことが可能（消失？）
• pkwkdownloader.php -- PukiWiki のソース(Wiki または HTML)を http 経由でダウンロード
• ecache.inc.php -- お手軽部分キャッシュ
• statichtml.inc.php -- PukiWiki の軽量化

使用法 - 開発版

プラグイン設定項目一覧

必要ならば変更できる設定項目です。

dump2html.inc.php を開いて以下の部分を編集するか、 plugin ディレクトリと同階層の init ディレクトリ（なければ作成）に dump2html.ini.php を作成し、上書き項目を記述します。設定を別ファイルに分離しておくと、プラグインアップデートの際に楽なのでお奨めです。 サンプル：dump2html.ini.php

$this->CONF['DUMPDIR']              = DATA_HOME . 'html/';
$this->CONF['POSTFIX']              = '.html';
$this->CONF['readauth']             = TRUE;
$this->CONF['username']             = ''; // for BasicAuth on http GET
$this->CONF['userpass']             = '';
// config for action plugin
$this->CONF['ADMINONLY']            = TRUE;
$this->CONF['WAITTIME']             = 200000; // for method=http in micro seconds
$this->CONF['overwrite']            = FALSE;
// config for pkwklinkmodifier
$this->modifier->CONF['modify_href']      = TRUE;
$this->modifier->CONF['modify_linkrel']   = TRUE;
$this->modifier->CONF['href_urlstyle']    = 'relative'; // 'relative' or 'absolute'
$this->modifier->CONF['linkrel_urlstyle'] = 'relative'; // 'relative' or 'absolute'

• DUMPDIR
  • HTML ファイル出力先。デフォルトでは index.php ファイルのあるディレクトリ以下の html ディレクトリになります（作成、書き込み許可を出します）

• POSTFIX
  • 拡張子。通常 '.html'

• readauth=bool
  • 閲覧制限されているページもダンプ。

• username
  • 閲覧制限ページ用ユーザ名。閲覧制限されているページを取得する際にユーザ名、パスワードが必要になります。
    補足: この機能を使用する場合 PEAR の HTTP/Request.php が必要になります（インストール方法の解説はしません）。

• userpass
  • Username に対するパスワード。

アクションプラグイン用設定

• ADMINONLY=bool
  • デフォルトではアクション型で一括ダンプの際に管理者権限を必要とします。FALSE にすることで無効にもできます。

• WAITTIME=秒
  • 一括ダンプの際に HTTP 要求を出すまでに待つ時間。短くしすぎるとサーバに負荷がかかりすぎる可能性があります。

• overwrite=bool
  • 強制上書き。off の場合、html ファイルと wiki ページのタイムスタンプを比べ wiki ページが新しければ上書きダンプします。

HTML 間リンク修正フォーマッタ用設定

• modify_href=bool
  • HTML ファイル内のWikiページ間のリンク置き換え処理を行う。デフォルトで有効

• modify_linkrel=bool
  • HTML ファイル内のcss, javascript, img ファイルへのリンク置き換え処理を行う。デフォルトで有効

• href_urlstyle=relative|absolute
  • relative: リンク置き換え処理の際に相対URLを使用
  • absolute: リンク置き換え処理の際に絶対URLを使用

• linkrel_urlstyle=relative|absolute
  • relative: リンク置き換え処理の際に相対URLを使用
  • absolute: リンク置き換え処理の際に絶対URLを使用

一括ダンプ（アクション型）

アクション型プラグインとしてアクセスしてください。

http://あなたのPukiWikiサイト/index.php?cmd=dump2html

cmd=dump2html

項目は以下の意味です。

• Admin Password
  • 管理者パスワード
• Filter Pages (ereg)
  • 対象ページを絞りこむときに使用。指定しなければ全ページ。
• A Page
  • 特定の１ページだけ指定するときに使用。
• Force to Overwrite
  • 強制上書き。未チェックの場合、html ファイルと wiki ページのタイムスタンプを比べ wiki ページが新しければ上書きダンプします。

使用法

1. ファイル群を plugin ディレクトリにダウンロード
2. html ファイルが保存されるディレクトリ（デフォルトでは wiki ディレクトリと同階層の html ディレクトリ）を作成、書き込み許可を出す。
3. 一括ダンプ（アクション型）する。
4. ダンプ先ディレクトリ、skin, image ディレクトリを大事にとっておく。

出力HTMLファイル名の変更

出力されるHTMLファイル名が気にいらない場合変更できます。 例として md5(ページ名).html を使用するものを書いておきます。

plugin ディレクトリと同階層の init ディレクトリ（なければ作成）内の dump2html.ini.php （なければ作成）に以下の内容を追加

<?php
exist_plugin('PluginDump2html');
class PluginDump2htmlUser extends PluginDump2html
{
    function encode($page)
    {
        return md5($page);
    }
}
?>

css へのリンクがおかしい

ひょっとしたら以下の対策が必要かもしれません

PukiWiki Plus!

index.php にて

-define('ROOT_URI', '');
+define('ROOT_URI', 'あなたのPukiWikiサイト絶対アドレス/');

PukiWiki 本家

init/dump2html.ini.php ファイルを以下の内容で作成

<?php
exist_plugin('PluginDump2html');
$plugin = new PluginDump2html();
$plugin->CONF['DUMPDIR'] = '';
class PluginDump2htmlUser extends PluginDump2html
{
    function encode($page)
    {
        return md5($page);
    }
}
?>

index.php ファイルのあるディレクトリに書き込み許可を出します。

HTML ファイル出力先が html ディレクトリではなく index.php ファイルのあるディレクトリになります。 それによって index.php からの css へのパスと html ファイルからの css へのパスが同一でありさえすれば（一切の置換なく）正しく表示できます。

Compatibility Check

Please join us to check compatibilities.

Compatible

Selection	Vote
PHP4	7
PHP5	7
1.3.7	0
1.4.3	1
1.4.4	0
1.4.5_1	0
1.4.6	0
1.4.7	8
1.4.5plus-eucjp	0
1.4.6plus-u1-eucjp	0
1.4.6plus-u2-eucjp	0
1.4.5plus-u2-i18n	0
1.4.6plus-u1-i18n	0
1.4.6plus-u2-i18n	0
1.4.7plus-i18n	2
1.4.7plus-u2-i18n	3

Incompatible

Selection	Vote
PHP4	0
PHP5	2
1.3.7	0
1.4.3	0
1.4.4	0
1.4.5_1	0
1.4.6	1
1.4.7	4
1.4.5plus-eucjp	0
1.4.6plus-u1-eucjp	0
1.4.6plus-u2-eucjp	0
1.4.5plus-u2-i18n	1
1.4.6plus-u1-i18n	0
1.4.6plus-u2-i18n	0
1.4.7plus-i18n	0
1.4.7plus-u2-i18n	0

Download

右クリックから３つのファイルを保存し、plugin ディレクトリにおいてください。

開発版

• dump2html.inc.php 現在の dump2html は pkwklinkmodifier と statichtml のコネクタ的な存在です
• pkwklinkmodifier.inc.php リンク置換処理
• statichtml.inc.php 静的HTML変換

旧版

更新履歴

What's new viewcvs Previous viewcvs.old