cssj.inc.php

サマリ高品質印刷用PDF出力プラグイン
リビジョン1.3.2
対応バージョン1.4.7
投稿者miyabe
投稿日2005-07-24 (日) 03:56:52

概要

#ref(): File not found: "copper-pdf.gif" at page "自作プラグイン/cssj.inc.php"

Copper PDFを用いてPDFを出力できるようにするプラグインです。

動作環境

Copper PDF 2.0.0以降またはCSSJ Server 1.2.0以降が必要です。

Copper PDF(またはCSSJ)を動かすためには、JavaVM(J2SE 1.4.1以降)が必要です。

主な機能

以下の機能を利用するにはCopper PDFの製品ライセンスの購入が必要です。

ダウンロード

こちらのページ からcssj-pukiwikiの最新のリリースをダウンロードしてください。

基本的な導入方法

アーカイブ内にはEUC-JP用のプラグインとUTF-8用のプラグインがそれぞれ別のディレクトリ(euc_jp, utf8))に格納されています。使用するPukiWikiのエンコーディングに合わせて選択してください。

各ディレクトリ内のpluginディレクトリとskinディレクトリを、PukiWikiの同名のディレクトリにそのまま上書きしてください。

次に、skin/cssj/global.inc.phpをテキストエディタで開き、$host, $port, $user, $passwordの値をCopper PDFに接続できるように設定してください。

プラグインの設定

さらに詳細な設定をする場合は、以下のファイルを編集してください。

skin/cssj/print-skin
PDF出力のためのスタイルシートが格納されたディレクトリ。
skin/cssj/global.ini.php
Copper PDFの接続設定、入出力オプション、利用可能なスタイルシート、その他の設定(詳細はファイル中のコメント参照)。

スタイルシートは、print-skinディレクトリ内に .css という拡張子で配置してください。

Copper PDFの入出力オプション等はCopper PDFのドキュメントを参照してください。

CSSによるスタイル付けはW3CのCSS 2.1に従います。 印刷に関するものはPaged mediaの章で解説されています。

また、CSS2の邦訳と CSS2.1での変更点が公開されています。

URL指定でのプラグインの呼び出し

URL指定でのプラグインで使用できるパラメータの概要は次のとおりです。

パラメータ名説明必須
plugin必ず cssj としてください。
title文書タイトル
author文書作者
pagesPDF化するページ名。複数の場合はカンマ区切り。
style使用するスタイルシート名。
attachments添付ファイル('use'=使用, 'attach'=PDFに添付)

また、Copper PDFの入出力プロパティを使用できます。ただし、プロパティ名中のピリオド'.'はカンマ','に置き換えて使用してください。

1つまたは複数のページのPDF化

?plugin=cssj&title=タイトル&pages=ページ名1,ページ名2,ページ名3..という文字列をURLの後につけてPukiWikiにアクセスすることで、1つまたは複数のページをまとめて指定されたタイトルのPDFに変換することができます。タイトルを省略した場合は、最初のページの名前が使われます。

例えば、http://localhost/pukiwiki.php?FrontPageのPDF出力が欲しい場合はhttp://localhost/pukiwiki.php?plugin=cssj&pages=FrontPageへアクセスしてください

スタイルシートの切り替え

スタイルシートは style パラメータで切り替えることができます。スタイルシート名は、print-skinディレクトリ内のCSSファイルから、拡張子(.css)を省略したものです。

ファイルの添付

global.ini.phpの設定で$attachmentsが'attach'に設定されている場合は、ページに添付されたファイルがPDFにも自動的に添付されます。ファイルを添付したくない場合は、$attachmentsを'use'にしておいてください。また、attachmentsパラメータでも設定を上書きすることができます。

入出力プロパティの設定

Copper PDFの入出力プロパティはglobal.ini.phpで設定できますが、パラメータにより上書きすることもできます。ただし、パラメータではプロパティ名の'.'を','に置き換えてください。

例えば、トンボを表示する場合は output,marks=both というパラメータを付加してください。

「このページのPDF」メニュー

「このページのPDF」メニューは、現在表示されているページを手軽にPDF化する機能です。

#ref(): File not found: "pdf-skin.png" at page "自作プラグイン/cssj.inc.php"

Copper PDFスキン

Copper PDFスキンを有効にすることで、「このページのPDF」メニューが表示されます。PukiWikiの設定ファイル(pukiwiki.ini.php)の、SKIN_DIR定数を'skin/cssj/'に設定することでCopper PDFスキンを有効にすることができます。

「このページのPDF」メニューだけ使用する場合

お使いのスキン(pukiwiki.skin.phpファイル)の「このページのPDF」メニューを表示させたい場所に、以下のコードを記述してください。

<?php include('skin/cssj/pdfmenu.php'); ?>

ページ内でのプラグインの呼び出し

PDFへのリンクはインラインプラグインを利用して作ることもできます。以下の書式で記述してください。

&cssj(title,page1,page2,page3...){content};

titleはPDFのタイトルで、page1,page2,page3...は変換対象のページ名です。 ページ名を省略すると、インラインプラグインが記述されたページ自身が対象となります。

contentはリンクに表示される文字列です。省略すると、タイトルが使われます。

生成されるリンクの横には、PDFアイコンが表示され、Copper PDFスキンの「このページのPDF」と同じ機能が利用できます。

プラグインの動作についての注意点

バージョン1.2.1まであった、出力したPDFをキャッシュする機能は廃止しました。Copper PDFはキャッシュがなくても十分な速度でPDFを出力します。

他のページの画像を参照している場合(例えばページAに添付された画像ファイルを、ページB上に表示する場合)、Copper PDFはHTTPでPukiWikiが動作しているウェブサーバーにアクセスして画像を取得しようとします。そのため、ファイヤーウォールやDNSの名前解決の問題により、ネットワーク環境によって画像などが表示できない可能性があります。

ページに直接添付されている画像ファイル(例えばページAに添付された画像ファイルを、ページA上に表示する場合)は、ドライバによってCopper PDFに直接送られるため上記のような問題は発生しません。

ライセンス

Apache License Version 2.0 です。 詳細はパッケージに含まれる文書(README.txt)を参照してください。

バグ報告、要望などはSourceForgeプロジェクトページまでお願いいたします。

http://sourceforge.jp/projects/copper/

©2005-2009 GNN & Co.,Ltd.

動作デモ

こちらでデモサーバーを動かしています

毎日リセットされますので、遠慮なく編集してみてください。




トップ   編集 凍結 差分 履歴 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2023-11-21 (火) 23:42:13
Site admin: PukiWiki Development Team

PukiWiki 1.5.4+ © 2001-2022 PukiWiki Development Team. Powered by PHP 8.2.12. HTML convert time: 0.308 sec.

SourceForge