Report Magic for Analog Documentation

詳細設定

Report Magicは詳細まで知りたいと思うユーザにとって、意外に複雑で、たくさんの詳細オプション設定があります。 下記ではこれらのオプションの簡単な説明と更なる情報を得るためのソースの場所を紹介しています。

時間別サマリーにて就業時間を設定する

[HOURLY]Summary1Summary2を設定することによって、’就業時間内’と’就業時間外’を比較する表示を行うことができます。 デフォルト設定は下記のとおりです。(ご利用の言語に変更されています) :

[HOURLY]
Summary1 = [8-16],Work Hours (8:00am-4:59pm)
Summary2 = [0-7,17-23],After Hours (5:00pm-7:59am)

上記の各Summaryで、[]内に記述されている時間が各項目の対象となる時間です。(Summayr2のように,で時間範囲を複数設定することができます) "]," の後に記述されている文字列がレポートに表示される文字列です。 例えば、就業時間が10::00amから7:00pmの場合設定は下記のようなものになります。 :

[HOURLY]
Summary1 = [10-18],Work Hours (10:00am-6:59pm)
Summary2 = [0-9,19-23],After Hours (7:00pm-9:59am)

時間での設定をした場合、59分59秒までを含みますので、ご注意ください。 つまり10-18と分を抜かして指定した場合開始時間は10 (10:00:00) で終了時間は18 (18:59:59 or 6:59:59pm)となります。

レポート内のリンクの変更

レポート内のハイパーリンクを変更する場合、IncludeLinksを使用することによって、各レポートの設定を変更することができます。 IncludeLinksは","リストを記述し、一致するものだけにリンクがつきます。 例えば、下記のような設定をすれば指定した対象ファイルのみにリンクをつけることができます。

    [REQUEST]
    IncludeLinks=*/,*.htm,*.html,*.asp,*.php

そのページがどのようなページであるかに依存しますので、その定義に応じて設定してください。

挿入コード

Report Magicのいくつかの設定の中で、挿入コードを設定できるものがあります。 このコードは出力ファイルに特定の文字列を挿入することができます。 全てのファイル名に対しては、[website]TitleやAnalogがレポートに挿入するHEADERFOOTERコマンドと同じようにこの挿入コード( [statistics]File_In[reports]File_Out))を適応できます。

挿入コードには%date format%${something}の2つの形式があります。 日付形式は現在の時間が[statistics]File_In[statistics]Log_Fileに適用され、レポートの終了日が他の設定に適用されます。(これにより、各月始めにの前月末までのレポート解析を実行し、ファイル名とタイトルに正しい期間が表示されます) 日付形式は日付形式 レファレンスに記載されている規則の形式に準じます。

上記以外の挿入コードは、実行しているReport Magicの値を挿入します。 コードの完全なリストは以下のとおりです。 :

     ${infile}          読み込むファイル名を使用 ([statistics]File_Inで設定されているもの)
     ${XX}              全体のサマリーにあるXXで指定したいずれかの行を使用(ここにリストされているもの)
     ${GenerationTime}  全体サマリーのPS行の値を使用, 解析結果に依存
     ${DataStart}       全体サマリーのFR行の値を使用,  解析結果に依存
     ${DataEnd}         全体サマリーのLR行の値を使用,  解析結果に依存
     ${AnalogVersion}	全体サマリーのVE 行の値と同じ

スタイルシートのフォーマット

[navigation][reports]セクションの中にあるスタイルシートを使用することで、BG_ColorFontのような設定をしなくてもスタイル設定することが可能です。 スタイルシートを使用することにより、簡単に出力レポートのスタイルを現在の他のウェブサイトを同じようなすタイルに統一することができます。 スタイルシートは下記のルールに従って使用してください。 :

	h1	各レポートファイルのトップにあるタイトル
	h2	個々のファイルのタイトル
	h4	目次ページのタイトル
	th	データテーブルのヘッダー項目
	td.alt1	テーブルデータの1番目の色設定オプション
	td.alt2	テーブルデータの2番目の色設定オプション
	th.total	テーブル下の統計列のスタイルオプション
	.fineprint	時間とレポート範囲のスタイル
	.smallfont	シンプルレポートの'SmallFonts'オプションのスタイル

スタイルシートを使用しても、設定ファイルにて指定されているスタイル設定([reports] Fontなど)の方が優先のため、スタイルシートの設定は、設定ファイルで設定されているスタイルに上書きされます。 もしスタイルシート設定しているスタイルを使用したい場合、設定ファイルに記述されているスタイル設定を削除してください。

レポートファイル内のHTML記述に関する注意

Report Magicがレポートファイルを作成する際、HTMLコードを1行で記述します。 これにより、ファイルサイズを15%ほど節約でき、またレポートの読み込み時間の際に使用する帯域を減らすことができますが、 diffを使用して、2つのファイルを比較したり、ファイル変更をしたい場合には不便です。 HTMLをもっと見やすいものにするには、W3Cから便利なユーティリティを入手することをお勧めします。 ここからたくさんのプラットフォーム用にプリコンパイルされたユーティリティをダウンロードできます。 これを使用することにより、オプションを使用するより、もっと見やすいHTMLフォーマットを作成することができます。

レポートの文字列のカスタマイズ

レポートの設定 のページにあるように、設定ファイルのreportセクションにてレポート毎に別途設定することによって、表示や文字列を設定ファイルとは異なるものに変更することができます。 変更できる内容に関しては現在設定されている言語のrdata.iniにて定義されています。 各rdata.iniファイルは言語サブフォルダの中(日本語の場合:lang/ja)に格納されており、rdata.iniファイルは各言語でコメントが記述されているのでどの設定がどのような意味を持ち、何ができるのかを理解することができます。

新しい言語ファイルの作成

各言語ディレクトリの中には、rdata.inicdata.inilang.iniがあり、これらによってReport Magicの各国対応ができるようになっています。特にAnalogが作成したレポートのインターフェイス、説明、レポートやグラフのオプションをが組み込まれています。 他にもAnalog用Report Magicが作成する全てのレポートファイルの文字列の全てを含んでいます。 もし出力の文字列を変更したり、新しい言語のバージョンを作成したい場合はこれらのファイルを編集してください。 その際には、Report Magicが解読できない記述を書いてしまう可能性があるので、必ず編集するファイルのバックアップを取るようにしてください。 Report Magiはlang下にある、[statistics] Languageで設定されている言語のサブディレクトリの言語ファイルを参照します。 そのため、もし既存の言語のカスタム版を作成した場合は、それ用にlang配下にサブディレクトリを作成し(例:'my_es')その中にファイルを格納してください。 その後、そのファイルを読み込ませるために、言語設定をディレクトリ名にします。(上記例のフォルダを作成した場合はlangと記述)

この言語ディレクトリ内のファイルには(少しの場合もあるが)各設定が何をするのかを記述した文章があります。翻訳者用の追加のヘルプはReport Magic websiteの'Developers and Translators'ページで入手できます。

カスタムレポートの作成

Report Magicでは同梱されている定義済みのレポートの変わりに、カスタマイズしたレポートを使用することが可能です。
カスタマイズしたレポートを作成するには、まずPerlに精通している必要があります。 wadg::rm::Reportの内容を引き継ぐPerlモジュールを作成し、それを使用したいレポートの新しいclassをReportTypeとして指定します。 Report.pmには、各メソッドで何のメソッドを使用しているかが記載されています。 ただし、APIの変更はReport Magicの今後のバージョンになります。 これはレポートをカスタマイズしてはいけないという意味ではありません。そうではなく、もしカスタマイズを行う場合は、Report Magic Announce listに参加して、 未決の変更を確認するようにしてください。また、APIに対する変更リクエストがある場合は、Wadsack-Allen Digital Groupにご連絡ください。

[はじめに] [ドキュメント の目次] [Index] [よくある質問] [ライセンス]
質問やコメントはWadsack-Allen Digital Group Support宛に送付してください。
Report Magic 2.21 Documentation. Copyright © 1999-2003 Wadsack-Allen. All Rights Reserved.