1. Download

ソフト名 plusplit0.5.7
リリース 2011/07/19
推奨動作環境 ubuntulinux 10.10,11.04,12.04
必須環境 python2.6.6以降が動作する環境。windowsでは動作未確認。
license・plusplit本体:BSD ・plusplit付属のテンプレートファイル(.py) 及び plusplit付属のテンプレートで作成したhtmlファイル:   改変・再配布は自由かつ無償です。商用・非商用も問いません。   権利者表示は不要です。削除しても構いません。   無保証であり、利用に関して発生した一切の損害を免れます。   なお、plusplit付属のテンプレートで作成したhtmlファイル中、   テンプレート以外の内容部分の著作権は、   html作成者各自に帰属します。
作者 織戸しすた
size 8.1kb
インストール方法 makefile。手動も可。下記参照。
備考 当初、webplusという名称で配布していましたが、 同種同名のソフト発見したので名前を変えました。

2. About

plusplitはツリー構造のwebページ(htmlファイル)を簡易に作成するための
linux向けソフトウェアです。


3. Install

3.1. コマンドによるインストール

ファイルをダウンロード後、解凍し、以下のコマンドを実行します
sudo make install

3.2. 手動インストール

plusplitとplusplit_dataをPATHの通っている場所にコピーし、
plusplitに実行権限を与えて下さい。

4. how to use

4.1. 例

例として、次の構造のwebページを作ることとします。
トップページ
 |ーはじめに
 |ーコンテンツ
  |ーコンテンツ1
  |ーコンテンツ2
  |ーコンテンツ3

①テキストエディタ等で以下の内容のファイルを作成します。
test.plusp ※行頭の半角スペースは削除してください。


②test.pluspのある場所を端末で開いて、以下のコマンドを実行します。
plusplit test.plusp -o output

③outputの中にデータができています。

4.2. 文法について

4.2.1. +記号の意味

+から始まる行は、ページを表します。
+1個がトップページで、++はその直下に属するページ、+++はさらにその下のページ
を意味します。

+TOP
++SUB

とすれば、TOP.htmlとSUB.htmlが作成されます。ファイル名をページ名と異なるようにするには、

+TOP:index.html
++SUB:subcontent.html

のように、:に続いてファイル名を指定します。

4.2.2. ページ本文

+から始まらない行は、ページの本文を意味します。
例)
 +TOP:index.html
 これが、index.htmlの本文です。
 複数行に渡って記載できます。

ページ本文を別のファイルに記載することもできます。その場合は、以下のように:記号で
別のファイルを引用します
例)
 +TOP:index.html
 :./data/別ファイル

4.2.3. 引用先のファイルでの文法

引用した場合、引用先のファイルでは+記号の意味が異なってきます。
すなわち、引用先ファイルで+記号は、ページ本文中の見出しを意味し、
++、+++と数が増えるごとに小さな見出しとなってゆきます。

なお、その際、見出しにはデフォルトでナンバリングがされます。
これを無効にするには、+に引き続いてーを入力します
例)
 引用元のファイル
  +TOP:index.html
  :./引用先のファイル

 引用先のファイル
  +-ナンバリング無効です

4.3. テンプレート作成

4.3.1. はじめに

作成されるhtmlファイルのデザインを独自のものにすることができます。
そのためには、まず、plusplitの基本構造を知る必要があります。

すなわち、plusplitでは、html作成の際、以下の過程を辿ります。

plusplitデータ
  ↓
plusplit本体
→plusplitファイル解析
  ↓関数呼び出し
~/.plusplit_template/template名/plusplit_frame.py
→htmlデータ生成

4.3.2. plusplitの構造

plusplit本体自体は、plusplitデータの構造解析をするのみで、
htmlデータの生成はテンプレートと呼ばれる外部pythonプログラムが行なっています。

plusplit本体は、データ解析後、
~/.plusplit_template/template名/plusplit_frame.pyの中にある
plusplit_frameクラス中の、create()とpre()というメンバ関数を呼び出し、
これらの関数がhtmlデータを生成し、それをplusplit本体に戻り値として返しています。

pre()は、plusplitファイルの+以外の行を走査するごとに呼ばれます。
ここでは、例えば:記号による他のファイルのロード処理等をすることが
期待されます。
特に、そういった機能を実装しないのであれば、引数で与えられたデータを
そのまま返せば足ります。

create()は、ページごとに呼ばれます。
ここで生成したデータがそのままhtmlデータになります。
メニュー作成や、全体のデザイン等あらゆることを行うことが期待されます。
引数として、ページタイトル等が渡されます。

標準ではdefaultという名前のテンプレートが呼ばれますが、
plusplitコマンドライン引数により、使用するテンプレートを変更することができます。
これにより、独自のデザインのhtmlファイルを生成することができるようになります。

4.3.3. plusplit template雛形