PHP

PHPマニュアルのビルドツール「PhD」が4年半ぶりにアップデート

PHPマニュアルのビルドツール「PhD」が4年半ぶりにアップデートされました。

変更点は多々ありますが、ぼくのユースケースで一番うれしいのは、XHTML版のビルド結果にCSSが適用される点です。

以前のビルド結果は無味乾燥で、公式のPHPマニュアルと印象がだいぶ違うのが気になっていました。

その他の点では、ビルド実行時に出ていた多数の警告がなくなったのもうれしいです。


PhDによるビルドがブラウザでできるようになるツールがあります。ぼくが開発している「phd-ja」です。

さきほどDockerイメージを更新し、PhD最新版が使われるようにしました。よろしければデモサイトを触ってみてください。(2019年9月5日に閉鎖しました)

ついでに、コンテナのOSをAlpine Linuxに変えることでイメージを軽量化しました。圧縮後のサイズが259MBから130MBに減っています。

Dockerがインストールされている環境であれば、下記のコマンドだけで導入できます。お気軽にお試しください。

docker pull iwamot/phd-ja

PHPマニュアルのビルドを試せるサイトが登場!(というか作りました)

docker-phd-ja のデモ環境を用意しました。あなたもPHPマニュアルのビルドを試してみませんか?

ソースファイルの編集、マニュアルのビルド、生成されたマニュアルの参照など、簡単にお試しいただけます。

注意事項

  • 非力なサーバなので、ビルドには時間がかかります(止まっていると思うかもしれません)
  • 複数ユーザの同時利用を考慮していないので、おかしな動作をする可能性があります
  • メンテナンス等で予告なく止まることがあります

あくまでデモ環境とお考えください。あきらかにバグの場合は、お知らせいただけるとありがたいです。

導入手順

ご自身の環境には、下記の手順で導入できます。

sudo docker pull iwamot/phd-ja
sudo docker create -it -p 8080:80 --name phd-ja iwamot/phd-ja  # ポートは任意です
sudo docker start phd-ja

関連リンク

docker-phd-ja、管理画面を充実させました

PHPマニュアルの翻訳作業を簡単にしたくて、docker-phd-ja というソフトウェアを開発しています。今週は管理画面を充実させ、ブラウザ上でのファイルの編集やマニュアルのビルドを可能にしました。

edit

build

使い方

Docker がインストールされていれば、下記のコマンドですぐに実行できます。

docker pull iwamot/phd-ja
docker create -it -p 8080:80 --name phd-ja iwamot/phd-ja
docker start phd-ja

http://localhost:8080/phd-ja-admin/ にアクセスすると、管理画面が開きます。ポートは 8080 でなくてもOKなので、必要に応じてご変更ください。

実装済みの機能

  • ソースファイルの編集
  • マニュアルのビルド
  • 生成されたマニュアルの参照
  • 作業コピーの diff 出力(svn diff)
  • 作業コピーのリセット(svn revert)
  • 作業コピーの更新(svn update)

ぼくが推奨する翻訳手順

  1. オンラインエディタで翻訳を進める
  2. 翻訳結果をソースに反映し、マニュアルをビルドする
  3. 生成されたマニュアルを見て、違和感がないか確認する
  4. オンラインエディタからパッチを送る

この2と3の手間を減らすのが docker-phd-ja の開発の目的です。

ちなみに、PHPマニュアルの日本語翻訳に参加すると、PHPマニュアル序文に翻訳者として名前が載るかもしれません。ぼくも「Takashi Iwamoto」として載せていただきました。

関連リンク

プロフィール

ENECHANGE株式会社VPoT兼CTO室マネージャー。AWS Community Builder (Cloud Operations)。前職はAWS Japan技術サポート。社内外を問わず開発者体験の向上に取り組んでいます

カテゴリ別アーカイブ
月別アーカイブ
ブログ内検索