VLitとは何か

** この機能はまだ実験段階にあります **

VLitは文書の一部を直接引用する方法です。テキストタイプのmime-type（ text/plainやtext/htmlなど）を持つ公開ドキュメントの任意のファイルで使用できます。文書全体ではなく、ある範囲を抽出することができます。外部システムはこの機能を使って、オリジナルテキストの引用箇所を切り張りするのではなく、オリジナルテキストの本文を直接引用することができます。

この機能を使用する場合は、/opt/eprints2/archives/foo/cfg/static/en/vlit.xpageを修正して、この機能の使用条件を指定してください。「human」モードを使うと、以下で述べるように、このページが著作権マークからリンクされるデフォルトのページになります。

generate_staticコマンドを再実行することを忘れないでください。

この機能を使用したくない場合

何らかの理由でVLitを無効にしたい場合は、ArchiveConfig.pmで設定します。設定後、generate_apacheconfコマンドを再実行して、Webサーバをリスタートする必要があります。

（上で述べた）vlitページを修正して、このアーカイブではVLit機能が利用できないことを示してください。

VLitの呼び出し法

簡単なパラメータによる

トランスクルージョンを実現する簡単な方法は、mime-typeがtext/*の文書のURLに以下を追加することです。

 ?xuversion=1.0&locspec=charrange:offset/length

「offset」と「length」には整数を指定します。たとえば、offsetを0に、lengthに1を指定すると最初の文字が返ります。

 http://www.weebleprints.co.uk/archive/00000543/01/notfalldown.txt
 ?xuversion=1.0&locspec=charrange:1403/130

（表示の都合で2行に分かれていますが、実際は1行です。）この例では、ファイルの先頭から1403文字目の文字から1533文字目の文字までが返ります。

オプションとして「mode」パラメータを使用できます。「human」モードでは、指定範囲がHTMLで返されます。&のような文字は適切にエスケープされ、改行は「br」タグに変換されます。また、テキストの前に2つのリンクが付加されます。1つは、（c）リンクで、トランスコピーライトの説明ページへのリンクです。これを変更したい場合は、Vlit.pmを修正する必要があります。もう1つは、TRANSリンクで、引用箇所のコンテキストビューへのリンクです。ここでは、引用箇所と前後の1024文字が表示され、引用箇所は赤字で強調表示されます。このコンテキストビューでTRANSリンクをクリックすると、オリジナルのドキュメントが表示されます。

XML-Entityモード

たとえば次のように指定して、xml-entityモードに設定することもできます。

 http://lemur1.ecs.soton.ac.uk/archive/00000134/01/xuDation-d18.txt?
 locspec=charrange:10429/488&xuversion=1.0&mode=xml-entity

これはトランスクルージョンをXMLの断片として返します。他のXML文書はこの断片を外部エンティティとして取り込むことができます。

XML断片の例は以下のとおりです。

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <transclusion xlmns="http://xanadu.net/transclusion/xu/1.0"; 
 href="http://lemur1.ecs.soton.ac.uk/archive/00000134/01/xuDation-d18.txt"; 
 offset="10429" length="488">A more recent interactive screen 
 implementation of transpointing windows（screen shot fig. 5）was created 
 by Ka-Ping Yee in 1999.  This was served, like Walker's, from our xu88 
 server（rechristened as Udanax Green）.  Yee's PYXI is a skeleton front 
 end that shows and edits text, links and transclusions, and may be 
 extended to reach more of the server's functionality.  Both Udanax Green 
 and PYXI were released under an open source license in 1999（120）, and are 
 available at udanax.com. </transclusion>

locspecのareaオプション

locspecに指定するオプションとしてunixの「convert」コマンドを必要とする「area」があります。locspec=area:page=n/hrange=startx,endx/vrange=starty,endyのように指定すると画像領域を返します。ここで、startx/endx/starty/endy/nはすべて正の整数です。いずれも省略することができます。 3ページの最初の50行を指定するには、locspec=area:page=3/vrange=,50と指定します。