HyperBibDB
User's Guide

目次

概要

HyperBibDBとは
HyperBibDBはBibTeXの参考文献データベースを編集するためのプログラムです。文献の整理、検索と引用を容易にするだけでなく、PDFファイルやURLへリンク設定することで、文献の本文へのアクセスも容易に行うことができます。また、文献リストの出力機能もあります。
本ソフトのデータベース形式は完全にBibTeX形式に互換します(但し、日本語はShift-JISのみ)。 "@STRING" マクロやプリアンブル宣言等を含む既存のデータベースも問題なく読めるはずです。既存の bib ファイルを最初に読み込む前に こちら の注意を読んで下さい。
本ソフトでは標準以外の文献形式(例えばPATENT等)や標準以外のユーザ定義フィールド(例えばyomi)もサポートします。但し、ユーザ定義フィールドは標準文献形式では1つ、ユーザ定義の文献形式では5つまでに制限されます。
本ソフトで取り扱うことが可能な文献数は実質的に使用するコンピュータのメモリと処理能力に依ってのみ制限されますが、1ファイルで数百件を超えると快適な処理速度で作業できる動作環境は極めて限られると思われますので、文献の種類別にデータベースを作成することをお勧めします。
なお、Macintosh上のTeXに関しては 慶応大内山さんのページ が大変参考になります。

動作環境
OS条件:
CarbonLibが使用できるMacOS 8.6以降のMacOS及びMacOS X、MacOS Xでの使用を推奨。一応動作はしますが、MacOS 9以前の環境に対しては原則サポートしませんのでご了承下さい。またMacOS Xも10.0.xはサポートしません。最新版の動作チェックは10.2.5で行っています。
ハードウェア条件:
上記OSを実行可能なMacintosh。ただし、快適に作業するためには400MHz以上のCPUを推奨します。メモリとディスク容量は編集する文献データベースの量に依って変化しますが、通常上記のOSが快適に動作する環境であれば問題ないはずです。Classic MacOSで作業するときは、アプリケーション使用メモリ量の調整が必要になる場合があります。
作者の環境(PowerBook G4/400, 512MB RAM)ではMacOS Xの方がMacOS 9よりも快適に動作します。

使用条件

作者の連絡先及び最新版の入手先

作者の連絡先
nakahara@nuqe.nagoya-u.ac.jp
最新版の入手先
http://www.surf.nuqe.nagoya-u.ac.jp/~nakahara/software.html

使用方法

文献データの入力
ソフトウェアを起動すると次のような文献リストウィンドウが開きます。

右下の [Add New Item] ボタンを押すと文献データ入力ウィンドウ(下図)が開きます。

黒字のフィールドは選択した文献形式(例えばARTICLE)の必須フィールド、青地はオプションフィールドです。文献形式をメニューから選択し、該当する欄に情報を記入します。各欄は日本語を含んでもかまいませんが、特殊な表記(ウムラルト等)は必ずTeX形式で記述して下さい。
ARTICLE文献形式の場合にはJournalフィールドをユーザが定義したマクロメニューから選択することが可能です(デフォルトでは何も定義されていません。マクロ作成法は後述)。マクロ定義を含む欄は行頭に '@' を付ける必要があります。書式の詳細も後述します。なおマクロ定義は、メニューからの選択はできませんがJournalフィールド以外でも使用可能です。表記を統一するために、雑誌名にはマクロの使用を推奨します。
下方のCross Refフィールドの下の欄はユーザ定義フィールドです。yomi等のフィールドが必要であればここに記述して下さい。
Annotationは標準定義されていないフィールドですが、文献に関するコメント(255文字以下)を記述できます。キーワードを記述しておくと、検索の時に便利です。
E-mailフィールドには電子メールのアドレスを記述できます。また、右のボタンを押すと記載されたメールアドレスへのメール送信ウィンドウが開きます(システム標準のメールソフトが起動します)。
URLフィールドにはwebページ等のURLが記述できます。また、右のボタンを押すと記載されたURLを開きます(システム標準のWEBブラウザが起動します)。
File Linkフィールドには例えば文献の全文を含むPDFファイル等を指定できます。この欄が空欄の時は右のボタン(Choose)を押すとファイルを選択できます。この欄が記載されているときは右のボタン(Open)を押すと該当のファイルを開きます。ここには任意の種類のファイル(テキストや画像等)を指定可能で、Openボタンはその文書の標準アプリケーションで開きます。
左上のBib KeyフィールドはTeXから引用するときのキーですが、マニュアルでの指定の他、 [Generate Key] ボタンで著者名と発行年から自動生成することも可能です。この場合、キーの書式は例えば第一著者が Hitoshi Nakahara で発行年が2002年であれば "NakaharaH:2002" のようになります。同一作者で同一年のものが既に存在する場合には "NakaharaH:2002.2" のように枝番号を付加します(このとき、既存のキーへの枝番号は自動付加されませんが、該当の文献を開いて再度自動生成を行うと枝番号1が付加されます)。
右上のMarkのチェックボックスは例えば現在作成中の論文に関するものにチェックするといった用途に使用できます。マークのチェック・アンチェックは文献リストウィンドウでも行うことが可能です。マークした文献のみをリストで表示するといったことが可能です。

マクロ定義の方法と使用方法
BibList メニューから Edit Macros を選ぶと、マクロ編集ウィンドウが開きます。

左下の [Add] ボタンを押してマクロ名とデータを入力します。マクロを選択して [Remove] ボタンを押すとマクロを削除できます。データ文字列の前後のスペースは無視されます。どうしても空白を入れる必要がある場合には '¥ ' 或は '{ }' 或は '~' を用いて下さい。'~' を用いた場合にはTeXはその位置での改行は行いません。マクロは相互参照することも可能です。以下の例は "_APPHY" と "_LETTERS" を "APL" で参照しています。記述方法はBibTeXの方式に準拠しますが、通常のデータと区別するために行頭に必ず '@' を付加して下さい。'#' はBibTeXの文字列結合演算子です。また、マクロ名以外の文字列は必ず二重引用符で囲む必要があります (例: @"Appl. Phys."#_LETTERS)。このようなマクロ相互参照を用いると、雑誌によって 'Lett.' であったり 'Letters' であったりする表記の違いに容易に対応することができます。

マクロを文献データで用いるときの記述方法はマクロの相互参照と全く同じです。すなわち、 "APL" マクロを使用する場合にはフィールドの欄に @APL と書くだけです(大文字小文字は無視されます)。結合演算子 '#' を使って @APL#" Special Ed." といった表記も可能です。なお、Articleの文献では、journal欄にマクロメニューが表示されますので、メニューから選択するだけでマクロ名を使用することが可能です。
以下は文献データの例です。

プリアンブルの編集
Bib List メニューから Edit Preambles を選ぶと BibTeX データベースに埋め込むプリアンブルを編集できます。マクロ同様 [Add]、[Remove] ボタンで追加、削除ができます。TeXではプリアンブルは出現順に処理されます。プリアンブルの順序を変更したいときは項目を選択して [Up]/[Down] ボタンを押して下さい。BibTeXのプリアンブル機能や使い方は 「LaTeX美文書入門」等の書籍を参考にして下さい。

既存のbibファイルを読み込む
HyperBibDBはBibTeXのデータベース形式と完全互換しています。但し、機能の制約から、変換の際には以下の点に注意し、また、必ず元のデータベースのバックアップを残しておいて下さい。変換の結果重要な情報が失われても作者はいっさい補償しません。 リスト表示では著者名等やタイトル、コメントは適宜省略されますが、255文字の制限にかからなければ読み込みは正常にできているはずです。該当の文献をダブルクリックして確認して下さい。
リスト表示ではマクロは展開して表示されますが、データの編集ウィンドウではマクロ名のまま編集できます。全てのフィールドでマクロを用いた記述が可能です。また、明示的に定義されていないマクロ(jan, feb等)はリスト表示でも展開されませんが、BibTeXを通すことで正しく変換されます。

リストの絞り込み
HyperBibDBは著者名や雑誌等から文献を容易に絞り込むため、検索キーの自動生成を行います。以下は文献リストの例です(リストの表示内容はデフォルトとは異なります。リスト項目は環境設定で変更できます; 後述)。リストの上部に絞り込みメニューが並んでいます。これらのメニューから例えば雑誌名を [Journal etc. Filter] から選択すると選択した雑誌のみの文献リストになります。フィルタは追加的に動作しますので、引き続いて [Year Filter] から年代を選ぶと、先ほどの雑誌の中で選択した年代のものだけがリストに残ります。全体のリストから絞り込みたい場合には左上の [Show All Items] ボタンを押して、絞り込みをリセットします。

以下に各メニューについて解説します。
[Author/Editor Filter] メニューを開くと、現在表示されている文献の著者数に応じて

といったメニューが表示されます。すなわち、著者数が多い時には姓の頭文字のみ、ある程度少なくなると2文字、リストが絞り込まれてくるとフルネームがリストアップされます。リストは第一著者だけでなく全ての著者・編者が対象です。メニューではウムラルト等の記号は無視します。また、J. M. van Hove といった名前は名字が van Hove ですので、頭文字 'V' として扱われます。
[Journal etc. Filter] メニューは次のように表示されます。ここには journal/publisher/organization/institution/school がリストアップされます。これらの項目は、それぞれの項目ごとにアルファベット順にソートされます。

[Year Filter] メニューを開くと、文献内の年代の数に応じて

のようなメニューが表示されます。
[Bib Type Filter] メニューを開くと文献形式のリストから文献を絞り込むことができます。

[Mark Filter] メニューは各文献にチェックしたマークを元に文献を絞り込むことができます。

マークがセットされている文献は、文献リストで左端に黒丸が表示されています。黒丸の部分をダブルクリックするとチェックを反転できます。また、BibList メニューから Mark/Unmark All Items を選ぶと現在表示されているリストの文献全てにチェックをつけたり外したりすることができます。文献を選択(複数可)して BibList メニューから Mark/Unmark Selected Items を選んで選択部分だけマークするといったことも可能です。マークはファイルに保存されますので、例えば現在執筆中の論文に関連する文献にチェックしておくと、[Mark Filter] から関連文献をすぐに絞り込むことができて便利です。

[Free Keyword] ボタンを押すと、キーワード検索ダイアログが開きます。

Searchフィールドに検索すべき文字を入力し、[Search] ボタンを押します。このとき、検索する文献フィールドにチェックマークを付けておきます。これらの文献フィールドのうち、Journal etc. は journal/publisher/organization/institution/school/Type/HowPublished を、Volume etc. は volume/number/year/month/chapter/pages/series/edition を、E-Mail etc. は e-mail/url/file を、Others は crossref/address/user-defined を含みます。また、Search Options で (in the Current List) を選ぶと現在表示されているリストからの検索、 (in the Whole Database) を選ぶと、すべての文献データからの検索になります。[Whole Word] にチェックすると、検索文字列が単語と一致した場合のみ一致したと判断します(例えば、"Naka" を検索したときに、"A. Naka, and B. Taka" は一致したと見なしますが、"H. Nakahara" は一致したとは見なしません)。[Case Sensitive] にチェックすると、大文字小文字を区別して検索します。

文献リストの操作
文献リストには上図で示したようにマークの他にメールアドレス()、URL()、File()のリンクの有無をアイコンで表示可能です。これらのアイコンの上をダブルクリックすると該当する文献のアドレスへメールを送信したり、URLやファイルを開くことができます。リストウィンドウから文献のリンクされたメールアドレス等へアクセスするにはリストを Control-クリック(2ボタンマウスであれば右クリック)して現れるメニューを使う方法もあります。この方法は、メールアドレス等のアイコンをリストに表示していなくても使用可能です。
リストのその他の部分をダブルクリックするとそれらの文献の編集ウィンドウを開くことができます。但し、大量の文献編集ウィンドウを同時に開こうとすると警告が出ます(誤操作で大量のウィンドウが表示されるのを防ぐため)。

TeX文書への文献キーの張り付け
TeX文書へ挿入したい文献を文献リストで選択(複数可)し、そのままテキストエディタへDrag&Dropするか或はCopy&Pasteすることで、文献キーをTeX文書に簡単にペーストすることができます。この時、キーのみをコピーするか、¥cite{文献キー} の形式でコピーするかは環境設定で指定できます(後述)。また Control-クリック(2ボタンマウスであれば右クリック)して現れるメニュー(下図)からコピーの形式を指定してペーストすることも可能です。左下の図は複数の項目を選択しているときのメニューの例、右下の図は一つの項目を選択しているときのメニューの例です。

上記のメニューのうち上の3つはTeX本文中への文献参照のためにあり、中3つのうち Copy List as \bibitem を使うとBibTeXを使わずに半自動で文献リストをTeX文中に埋め込む時に使用できます。HTML形式や単純テキスト形式はTeX以外の文書へ文献リストを貼付けたい時便利です。なお、これら文献リストの形式は環境設定で自由に変更可能です(後述)。また、HTML形式の場合ウムラルトなどで表現可能なものはHTML形式へ自動変換します。なお、リスト形式への変換は下記の書き出しメニューでも行うことが可能です。

文献リストの作成
File メニューの Export Bib List As を選択すると、以下のような書き出しダイアログが現れます。

左の3つの選択肢は書き出す範囲を、右の3つの選択肢は形式を指定します。範囲で Whole を選ぶと全文献、Listed を選ぶと現在表示されているリスト(絞り込んだ結果のリスト)、Selected を選ぶとリスト中で選択している文献が対象になります。TeX Source 形式を選ぶと文献リストのTeXソースファイルを作成します。出力されたTeXファイルをコンパイルすると例えば、

のようになります。\bibitem 形式を選択すると、BibTeXの出力(bblファイル)に相当するファイルを出力します(リスト部分のみです)。HTML 形式で出力したものWEBブラウザで見ると このように なります。 \bibitemやHTML形式のリストのフォーマットは下記の環境設定で自由に設定可能です。また、HTML形式の場合ウムラルトなどで表現可能なものはHTML形式へ自動変換します(ブラウザによっては表示できない文字もあります)。

環境設定
環境設定ダイアログは次のようになっています。

General Settings
ここではアプリケーションを起動したときの動作(On Open Application)とリストをDrag&Dropしたときの動作(Drag&Drop Copies)、データベースの改行コード(New Line Code)を設定します。On Open Application で Do Nothing を選ぶと起動時に何も行いません。Create New Bib を選ぶと、新規文献データベースを作成します。Open Dialog を選ぶと文献データベースを開くダイアログが表示されます。Open Last Bib を選ぶと最後に使用していたデータベースを開きます。Drag&Drop Copies で BibKey Only を選ぶとDrag&Dropで文献キーのみをコピーします。複数選択しているときは文献キーがカンマで区切られます。¥cite{BibKey} を選ぶとDrag&Dropで¥cite{文献キー}がコピーされます。複数選択しているときは一つの¥citeコマンドに複数の文献が指定されます。New Line Code では DOS/Mac/UNIX 形式からデータベース保存時の改行コードを指定します。HyperBibDB自身はどの改行コードでも読むことができますが、こちらで試した範囲では Mac を選ぶと BibTeX がエラーを出すようです。
Bib List Templates
この欄は文献リスト(TeX形式)のフォーマットを指定します。[Edit TeX Preambles] ボタンを押すと、

のようなウィンドウが開きます。通常はこれらを変更する必要はあまりないと思いますが、標準の出力のマージン等が気に入らない場合は数値を修正して下さい。出力との対応関係は試しに Export した結果と比較すれば簡単に分かると思います。[Edit List Item Template] ボタンを押すと、

のようなウィンドウが開きます。ここでは各文献形式毎に文献リストに出力するときのフォーマットを指定します。リストの中からフォーマットを選択すると右上に選択したフォーマットが対応している文献形式が表示され、下段の編集ウィンドウでフォーマット編集ができます。見た目はちょっと煩雑ですが、ルールは比較的単純です。
  • 出力の各項目は '[ ]' で囲まれている。 '[ ]' の外の空白は無視される。
  • '[ ]' 内には通常の文字列、フィールド置換指定、特殊記号の3種類が記述できる。'[ ]' 内の空白は無視されない。
  • フィールド指定は '< >' でフィールド名を囲んで指定する。
  • フィールド指定を持つ項目は、該当するフィールドが空欄であった場合には項目自体が出力されない。
  • フィールド指定を持たない項目は常に出力される。
  • 特殊記号は4種類
    • !B と B! で囲まれた範囲はボールド体になる。
    • !I と I! で囲まれた範囲は斜体になる(英大文字のアイです)。
    • !U と U! で囲まれた範囲は下線を引く。
    • !N は改行が入る。
    これらのうち上の3つはクロスしてネストしてはいけません。すなわち、!B<volume>!U<pages>B!U! は不可。!B<volume>!U<pages>U!B! であればOK。
設定がおかしくなってしまったら左下の [Set Default] ボタンでデフォルト設定に戻すことが可能です。

Bib Item Template Sets
この欄は \bibitem/HTML 形式で出力するときのフォーマットを指定します。このフォーマットは投稿する雑誌によって異なるため、複数の設定を覚えておくことが可能です。いわば、BibTeXのスタイルファイルのようなものです(BibTeXに比べると貧弱ですが)。デフォルトでは Default Set のセットが一つ定義されています。セットを追加する場合には [Add New Set]、メニューで選択したセットを削除するには [Remove Set]、セット内容を編集するには [Edit Set] ボタンを押します。なお、実際に出力する時には環境設定でメニュー選択しているセットのフォーマットに従って出力が行われます。[Edit Set] すると、

というウィンドウが現れます。ほとんど前述のリスト出力時のフォーマットと同じです。唯一の違いは左上のセット名が変更可能であると言う点です。記述方法は前述の通りですので、ここでは省略します。なお、セット名はアルファベット順にソートされます。
List Items
ここでは文献リスト表示で表示する項目とその詳細を設定します。チェックボックスにチェックした項目がリストに表示されます。表示の順序は変更できません。このうちJournal/Publisher欄はjournal/publisher/institution/organization/school/howpublishedフィールドのうち設定されている一つが表示されます。Type/Note欄はtypeフィールドかnoteフィールドのいずれかが表示されます。著者/編者(Author/Editor)、タイトル(Title/Book Title)、ノート(Type/Note)、コメント(Annotation)の欄は詳細設定ができます。Author/Editorでは最大表示人数と名前の形式が選択できます。最大表示数(n)を超える著者等がある場合には最初のn-1人と最後の一人がリストに表示され、途中が '...' で省略されます。名前の形式でFam./Givenを選ぶと姓/名の順で名前が表示されます。Given/Fam.を選ぶと名/姓の順で表示されます(但し、日本語の名前は姓/名)。Familyを選ぶと姓のみ表示されます。タイトル、ノート、コメント欄では最大文字数を指定します。この値を超える部分は '...' で省略されます。
Creators Settings
このボタンを押すと、ファイル書き出し時のファイルのクリエータを指定することができます。クリエーターとはそのファイルをFinderでダブルクリックしたときに開くアプリケーションのことです。MacOS Xの場合にはこれら3つは空欄にしておくとシステム標準のソフトで開きます。MacOS Xを使用しており、Classic MacOSで開かないのであればこれらは空欄にすることを勧めます。

その他
HyperBibDBは最近使用したファイルを記憶しておき、ファイルメニューから簡単にアクセスできるようになっています。[File - Recent Items] メニューに最大16個のファイルが記憶されますので、このメニューを選ぶことでデータベースを簡単に開くことができます。なお、フォルダを移動したり削除して見つからないファイルはリストから削除されます。