litext について

litext は整形後に消えてしまう文字列を極力なくすことを重視した、テキストを整形する変換方式です。

整形後に消えてしまう文字列を極力なくすというという点について説明したいと思います。例えば、Wiki記法では「**太字**」を「<strong>太字</strong>」というHTMLに変換する機能がよく見られますが、このような場合「**」という文字列が変換前のテキストから消えてしまいます。litext では、このような記法を排除しました。理由は入力時に視覚的に閲覧できる内容と、整形後表示した際に視覚的に閲覧できる状態の差を極力減らすことを重視しているからです。

litext の機能は以下の通りとなります。

1. フォントは全て等幅フォントで表示されます。
   TEXTAREA のフォントは通常等幅フォントなので、表示時と同様の視覚効果が得られるためです。
   
2. 改行は <br /> に変換します。
   
3. パラグラフは <p> で囲います。
   
4. 「・」「* 」で始まる行は、箇条書きリスト（ulタグ）として表示します。
   
5. (数字).」「#.」で始まる行は、番号付きリスト（olタグ）として表示します。
   
6. スペースで始まるパラグラフは、ソースコードまたはコマンドラインと解釈して、<pre> で囲います。
   
7. 「http://」「https://」で始まる文字列は <a> でリンクを生成します。

litextは、機能自体を抑えることによって、以下のような特徴があります。

• プレーンテキストとして表示させた場合と近い表示を維持できます。
  
• 記法を気にせずにプレーンテキストとして記述した場合でも、想定外の表示なるケースもまれなので、
  Wikiに慣れていない人にも使用可能となります。
  
• プレーンテキストしても見ても違和感がないので、データのポータビリティが高いといえます。

変換ライブラリの使用方法は以下のようになります。

    <?php
    require_once 'litext.inc.php';

    $text = ...;
    $html = litext( $text );
    echo $text;
    ?>