EZFileListマニュアル

(Version 2.1)
平成24年1月8日
CREA

1 はじめに

  コンピュータの上にあるファイルやその名称などを 維持、 管理するツールはWindows付属のエクスプローラーはじめ世の中に多数あります。

  その中でEZFileListは、 技術標準として普及しているXMLの形式に基づいて、 ファイルの名称と内容を一覧にしてフォルダ直下のファイルを管理するツールです。 XMLに沿ったツールとすることにより、 多数のファイルに関する情報をまとめてXMLで処理するといった他のツールと連携する 基盤を提供します。 EZFileList単独では、ファイルの一覧をもれ無く、正しく維持、 管理するための機能を持ちます。

  一覧の対象とするファイルの名称が、 機械的でそれだけでは内容が理解しにくいような場合の管理に、 EZFileList適用の効果が期待できます。

  ファイル名を修正して内容や日付を付けた例を見ることがありますが、 多くの場合これらにEZFileListを適用すれば、 ファイル名の変更を避けることができるでしょう。

2 概要

2.1 特徴

  EZFileListは、次の特徴を持ちます。
1) ツールの規模が小さく、インストールとその後の使い方も単純で簡単です。
2) ファイルの一覧の維持において追加されたファイルに対処する場合でも、 ファイル名はブラウザからテキストエディタへの コピー&ペーストを可能にするなど、使いやすさへの工夫が施されています。
3) EZFileListとして提供するものは画像以外は全てテキストファイルなので処理内容を 全て確認できます。

2.2 機能

  EZFileListでは、「ファイル一覧表」をファイルに作成します。 その上でこれをHTMLに変換して 表示した「ファイル一覧」には次の特徴があります( 「図2.1 ファイル一覧の例」を参照して下さい)。
1) 「1.一覧表のファイル」にはファイル名だけでなく、 内容などを示す説明を併せて表示できます。

個々のファイルについては、 さらにそのファイルが現存するか否かの情報を表示します。 またファイル一覧表に記載されず、 別途存在するファイルがあれば「2.追加されたファイル」に、 そのファイル名を表示します。

2) 「1.一覧表のファイル」におけるファイル名の並びの順序は任意です。

ここに表示されるファイルの並びの順序は、 ファイル一覧表において記述された順に従うので、 この記述を調整すれば逆順や全く任意の順序とすることができます。

3) 「1.一覧表のファイル」におけるファイルをグループに分けて記述し、表示できます。

ファイル一覧表でファイルをグループに分けて標題を付けると 表示にもこれを反映します。 これによって、 複数の用途のデータが混在する場合でも用途毎に区切って表示する ようなことができます。
図2.1 ファイル一覧の例

2.3 動作環境

  EZFileListについては、次の環境で動作を確認しています。
# OS 必要なソフトウェア
1) Windows7 a) XSL変換ユーティリティ(msxsl.exe)
b) PERL(Active perl)
必要なソフトウェアのインストールとアンインストールについては、 「付録(4)」を参照して下さい。

3 使用法

  ここでは、EZFileListの具体的な使用法を説明します。 EZFileListは、一覧の対象とするファイル群が置かれたフォルダ毎に導入して使います。 ここでは、EZFileListの導入とその後の通常の使用に分けて説明します。

3.1 導入

  導入は、次の手順によります。

 
1) 一覧の対象とするファイル群があるフォルダをエクスプローラで表示します
このフォルダにダウンロードしたezFileList21.zipの内容を解凍します。 これによって次のフォルダとファイルが追加されます。
a) ezFileList21(フォルダ)
b) ezFileList.bat(バッチファイル)
EZFileListのダウンロードについては、「付録(3) EZFileListのインストールとアンインストール」を参照して下さい。
2) バッチファイルを実行します。
バッチファイルをダブルクリックして実行します。 この時点では、 ファイル一覧表"ezFileList.xml"がバッチファイルと同じフォルダに存在しないので、 ファイル一覧表が自動的に生成されます。 ファイル一覧表にはこの時点でこのフォルダにあるファイルが全て記録されます。 この後はファイル一覧表が存在するので、 バッチファイルを実行してもファイル一覧が変更されることはありません。 バッチファイルの処理では、この後ファイル一覧表をHTMLに変換して "ezFileList.html"を生成するところまで実行します。

バッチ処理においては、処理が始まるとコマンドプロンプトの窓が開き、 正常に処理が終了すると「図3.1」 の内容が表示されます。 表示の第1行目は、実行する環境によって一部異なります。 ここで何かキーを押すとコマンドプロンプトの窓が閉じます。

3) ファイル一覧表をテキストエディタで開き、必要な修正を加えます。
次の内容の追加ないし修正が可能です。
a) 標題「ファイル一覧」の修正
b) 副標題の追加
c) 個別のファイルの内容などの説明を追加
d) 個別のファイルの表示順序の変更
e) グループ要素を使ってファイルを分類
これらの具体的な記述方法については、 「3.3 ファイル一覧表の書き方」を参照して下さい。。
4) バッチファイルを実行する。
ファイル一覧表が存在する場合にバッチファイルを実行すると次の処理を行います。
a) その時点でフォルダの下に存在するファイルについて、 別途現存ファイル一覧として記録します。
b) XML形式のファイル一覧表をHTML形式に変換します。
この時、ファイル名と説明を変換すると共に 現存ファイル一覧の内容を確認して次の処理を合わせて行います。
a) ファイル一覧表に記録されたファイルが存在するか否かの情報を追加。
b) ファイル一覧表に記録されず、存在するファイルの名称を追加。
5) HTML形式のファイル一覧をブラウザで表示します。
既に表示している場合は、ブラウザで「最新の情報に更新」して、 導入したファイル一覧を確認します。

ファイル一覧の内容を確認し、 ファイル一覧表の修正に不十分な箇所があれば3)に戻ります。
図3.1 バッチ処理の正常な終了

3.2 通常の使用

 
1) バッチファイルを実行します。
バッチファイルを実行すると、 この段階ではファイル一覧表が存在するので、 現存ファイル一覧とHTML形式のファイル一覧を更新します。

前回のバッチファイル実行以降にファイルの追加、 削除が無いことがはっきりしているならば、 この項目の処理は省略できます。

2) ファイル一覧表をテキストエディタで開き、必要な修正を加えます。
次の内容の追加ないし修正が可能です。
a) 標題「ファイル一覧」の修正
b) 副標題の追加
c) 個別のファイルの内容などの説明を追加
d) 個別のファイルの表示順序の変更
e) グループ要素を使ってファイルを分類
f) ファイル実体の追加、削除に伴う一覧項目の追加、削除
ファイル一覧表を修正して内容を保存後、 バッチファイルを実行します。
これらの具体的な記述方法については、 「3.3 ファイル一覧表の書き方」を参照して下さい。。
3) HTML形式のファイル一覧をブラウザで表示します。
既に表示している場合は、ブラウザで「最新の情報に更新」して、 ファイル一覧を確認します。

ファイル一覧表に不都合が判明した時は、 2)に戻ります。

3.3 ファイル一覧表の書き方

  ファイル一覧表"ezFileList.xml"は、XML規格に沿ったファイルです。 XMLに馴染みの無い方は、 「付録(2) XML文書」を一読して下さい。 XMLについて簡単に説明してあります。 ファイル一覧表のごく簡単な例を、 「図3.2 ファイル一覧表の内容」に示します。

 
図3.2 ファイル一覧表の内容

  ファイル一覧表の概略の構成は、次のようになります。
1) 最初の行
これはファイルがXML形式に沿ったファイルで、 シフトJISコードを使って書かれていることを示します。
2) 第2行目
ルート要素fileListの開始タグです。
3) <!-- がある行から -->までの行
全てコメントです。 ファイル一覧表を更新する時に要素についてマニュアルを見ずにすむように ここに記述してあります。 コピー&ペーストして使うのに便利です。

最初の行からここまでは、 自動的に生成され、変えることはありません。

4) コメントの次の行から最後の行の前の行まで
ルート要素fileList以下のEZFileListの要素です。
5) 最後の行
ルート要素fileListの終了タグです。

ファイル一覧表で使用することができる要素は次のようなものがあります。 これらの要素については、 「付録(1) ファイル一覧表のXML要素」にまとめてありますので、併せて参照して下さい。 次にこれらの要素の記述の仕方について説明します。
1) 要素fileList
ファイル一覧表のルート要素です。修正することはありません。
2) 要素title
ファイル一覧の標題「ファイル一覧」を変更する時は、 この要素の内容として置き換える標題を記述します。
3) 要素subtitle
ファイル一覧に副標題を付ける時に、副標題を記述します。
4) 要素item
一覧表の項目(ファイル)の内容を記述する親要素です。 したがって、ファイル実体の追加、 削除に伴いファイル一覧表の項目を追加、削除する時は、 この要素を単位として修正します。
5) 要素file
ファイル名を記述します。
6) 要素note
ファイルの内容などの説明はここに記述します。
7) 要素group
ファイル一覧表において一つないし複数のファイルを囲ってグループとし、 他のファイルと区別して標題を付けることができます。 グループの標題は、属性titleに記述します。 次に記述の例を示します。 ここでは分かりやすいようにインデントを入れてあります。
<fileList>
    <group title="EZFileListのファイル">
        <item><file>ezFileList.bat
            </file><note>
            </note></item>
        <item><file>ezFileList.xml
            </file><note>
            </note></item>
        <item><file>ezFileList.html
            </file><note>
            </note></item>
    </group>
</fileList>
上の例は要素groupが一重の例ですが、 要素groupの子要素として要素groupを書くことができ、 要素groupは多重に使うことができます。

3.4 エラーへの対処

  ファイル一覧表をXMLに沿って誤り無く記述してバッチ処理を実行した時の表示については、 「図3.1」に示しています。 しかし、ファイル一覧表は手作業で修正するため誤りを生じる可能性があります。

  誤りがある場合のコマンドプロンプト窓の表示例を 「図3.3 エラー表示」に示します。 これは要素noteとitemの終了タグが無い場合の例です。 このような表示が現れた時は、 表示の内容を参考にファイル一覧表を正しく修正して、 再度バッチ処理を実行します。

 
図3.3 エラー表示

以上


付録(1) ファイル一覧表のXML要素

 
# 要素名 属性 子要素 説明
1) fileList 文書一覧表"ezFileList.xml"のルート要素。
2) title ?
3) subtitle ?
4) group *
5) item +
6) title 標題。
要素が存在して、内容が空でない時は、 内容を既定の表題「ファイル一覧」と置き換えます。
7) subtitle 副標題。
要素が存在する時は、内容を副標題として表示します。
8) group グループの親要素
9) title グループの標題。
10) group * 多重の記述ができます。
11) item +
12) item 項目の親要素。
ファイル一覧で表示される項目はグループ内外を問わず、 ファイル一覧表に記述された要素itemの順序で表示されます。
13) file
14) note ?
15) file ファイル名。
16) note 内容などの説明。
(注)「数」の欄は、小要素の数を示していて、 (空):1個、?:0個または1個、*:0個以上任意、+:1個以上任意、を意味します。


付録(2) XML文書

  XML規則に沿ったファイルはXML文書と呼ばれます。 本ソフトウェアを使う上で必要となる範囲で、 簡単にXML文書について説明します。

  XML 文書は、<xxx>aaaaa</xxx> と表現される一つないし 複数の要素で構成されます。 <xxx> から </xxx> までを要素xxxと呼びます。 この時、<xxx> は開始タグ、</xxx> は終了タグと呼ばれ、 開始タグと終了タグにはさまれた部分(ここでは aaaaa)は、 要素の内容と呼ばれます。

  要素の内容は、文字列から成る場合、別の要素を含む場合があり、さらに両者を 含むこともできます。 また、内容になにも含まない場合は、 <xxx></xxx>もしくは<xxx /> と書きます (例 <br />)。

  要素dの内容に含まれる要素eは次の図ように書くことが でき、2つ要素は入れ子の関係になっていると言います。
         要素d
    |<------------------->|
    |                     |
    <d>...<e>...</e>...</d>
          |        |
          |<------>|
            要素e
この時、要素eは要素dの子要素と呼ばれ、 また 逆に要素dは要素eの親要素と呼ばれます。要素dと 要素eの親子関係は次のように書くこともあります。
   <d>
    |
    +---<e>
2つの要素は次の図にあるようにはできません。入れ子の関係が くずれています。
     +----------+
     |          |
    <d>..<e>..</d>..</e>
          |           |
          +-----------+

  最上位の親要素は、ルート要素と呼ばれXML文書に一つだけ存在します。 他の要素は、ルート要素の子か、子孫になります。 また、 要素の内容の記述の中で、先頭、途中もしくは末尾に連続した見えない文字(例:空白、 改行、タブ)がある時は、1文字の半角空白に置きかえてられたり削除されたり することがあります。

  開始タグには、次のように属性を付けて書くことがあります。
   <要素名 属性名="値">
   
    例: <table border="1">
ここで属性の値はダブルクォーテーションで囲います。XML文書で "<!--"から"-->"の間は、コメントになります。


付録(3) EZFileListのインストールとアンインストール

 
1) ダウンロード
次の手順で、ezFileList21.zip(ファイルサイズ:約150KB) をダウンロードします。

HP「ソフトの道具箱」(URL:http://homepage2.nifty.com/crea-home/) にアクセスし、このページで [EZFileList]をクリックします。 EZFileListのページが開いたら、 ダウンロードのリンクを右クリックして、ファイルに保存を選択します。 ここで、デスクトップなど適当な場所を選定して、OKを押します。

2) インストール
ダウンロードしたファイルのインストールについては、 「3.1 導入」を参照して下さい。
3) アンインストール
ダウンロードした"ezFileList21.zip"、 およびこれを解凍して生成した ファイル"ezFileList.bat"とフォルダ"ezFileList21"、 およびこのフォルダの下のファイルを全て削除します。 複数のフォルダに解凍している場合は、 全てのフォルダについて同様にします。


付録(4) 必要なソフトウェアのインストールと アンインストール

  EZFileListの実行のためには、 PERLとXSLTプロセッサの2つのソフトウェアが必要です。 ここでは、これらのソフトウェアのインストールとアンインストールの 手順について説明します。

  XSLTプロセッサとしては、 ここではMicrosoft社が無償で提供するmsxsl.exeを使います。 またPERLとしては、 ここではActivePerlコミュニティが無償で提供するActivePerlを使用します。

  (1)msxsl.exe

  msxsl.exeは、 マイクロソフト社ホームページから下の手順でダウンロードし、 インストールします。 msxsl.exeは正確にはXSLTプロセッサではなく、 別にMicrosoft社が提供するXSLプロセッサを使うユーティリティですが、 利用者からはmsxsl.exeがXSLプロセッサとして動作するように見えます。 Microsoft社が提供するXSLプロセッサはInternete Explorerと共に提供されていて、 Internete Explorerが動作している環境ではすでにインストールされています。

 
1) YahooないしGoogleで "msxsl.exe"を検索し、 結果からMicrosoft社のDownload Centerのmsxsl.exeの項目を選択して、 ページを開きます。
2) msxsl.exeのDOWNLOADボタンをクリックしてダウンロードし、 PATHが設定されている適当なフォルダに置きます。
[パスの設定]
フォルダにPathを設定する時は、次の手順で行います。

Path変数については、設定を誤ると一部のプログラムやシステムが動作しなくなる 可能性があるので慎重に作業します。

試しにPATHを設定するなど管理者の権限なしで処理する場合は、 下の「ユーザとしての処理」によります。 こちらで処理すれば、仮に設定を誤っても、 他のプログラムやシステムに影響を与える可能性が少なくなります。

例としてD:\usr\binフォルダにPATHを設定する方法について説明します。 OSはWindows7とします。他のOSの場合もほぼ同様です。 管理者の権限で処理する場合には次のように設定します。

<管理者権限での処理>
1) 次の順にリンクないしボタンなどをクリックして進み、 環境変数のメニューを開きます。
[スタート]−[コントロールパネル]−[システムとセキュリティ] −[システム]−[システムの詳細設定]−[環境変数]
2) システム環境変数の側で次の処理をします。
a) 変数"Path"の行を選択して編集ボタンをクリックします。
b) 変数値の最後に";D:\usr\bin"を追加します。
3) その後、OKボタンを2回クリックし、コントロールパネルの窓を閉じます。
<ユーザとしての処理>
設定が必要なユーザについてログオンして次の処理をします。
1) 次の順にリンクないしボタンなどをクリックして進み、 環境変数のメニューを開きます。
[スタート]−[コントロールパネル]−[システムとセキュリティ] −[システム]−[システムの詳細設定]−[環境変数]
2) ユーザ環境変数の側で次の処理をします。
a) 環境変数"PATH"の設定が無ければ、新規ボタンをクリックします。
a) 変数名に"Path"を記入。
b) 変数値に"D:\usr\bin"を記入
b) 環境変数"Path"の行がある時は、 変数Pathを選択して編集ボタンをクリックします。
a) 変数値の最後に";D:\usr\bin"を追加して記入。
3) その後、OKボタンを2回クリックし、コントロールパネルの窓を閉じます。
msxsl.exeのアンインストールは、msxsl.exeを削除して、終わりです。

  (2)ActivePerl

  ActivePerlは、ActiveStateのホームページから次の手順でダウンロードし、 インストールします。
1) ActiveStateのホームページ(URL:http://www.activestate.com/) を開きます。
2) [DOWNLOAD]-[ActivePerl]の順にクリックします。
3) 最新バージョン(執筆時点では、5.14.2.1402) でかつインストールするOSとInstallerを選んでクリックします。 筆者の場合は、Windows(x86)で、Windows Installer(MSI)が該当します。
4) ここでニュース等を送るメールアドレス等を記入するページが開いて、 ダウンロードが始まります。

ブラウザによってセキュリティのためにダウンロードがブロックされる ことがありますが、 その時は警告の黄色い帯を右クリックしてダウンロードを選択します。

5) ダウンロードの最初の段階でセキュリティの警告ウィンドウが開くので、 実行を選択します。
6) 後は、ダウンロードとインストールの自動的な処理が終わるのを待ちます。
7) ニュース等の送付を希望する場合の送り先のメールアドレス等を 記入するフォームについては、空欄のままで良いようです。
8) インストールまで終了したらブラウザを閉じて作業終了です。

  ActivePerlのアンインストールは、OSがWindows7の場合は、次の手順によります。 他のOSの場合もほぼ同様です。
1) [スタートボタン]-[コントロールパネル]-[プログラムのアンインストール]
2) ActivePerlを選択
3) 「ActivePerlをアンインストールしますか」の問いに「はい」を選択します。