• R/O
  • HTTP
  • SSH
  • HTTPS

sandbox: 提交

個人用


Commit MetaInfo

修訂04279b5ebe9dd939941e6058e65bf5a0e5c727e4 (tree)
時間2011-11-23 09:50:21
作者takezoe <takezoe@871d...>
Commitertakezoe

Log Message

コメントとドキュメントを修正。

Change Summary

差異

--- a/takezoe/plugin/book/README.txt
+++ b/takezoe/plugin/book/README.txt
@@ -1,108 +1,122 @@
1-!!!書籍執筆用プラグインの使い方
2-
3-!!章、見出しの作成
4-
5-1ページで1章分の原稿を執筆することを想定しています。各ページにはchapterプラグインで章の情報を記述します。また、見出しは普通のWikiの見出しの記法で記述するのですが、title1、title2、title3プラグインで見出し番号を表示できるようにしました。title1、title2、title3プラグインは見出しへの相互参照にも使用しますが、相互参照の方法については後述します。
6-
7- {{chapter 1,章のタイトル}}
8- !!!{{title1}}見出し1
9- ...
10- !!{{title2}}見出し2
11- ...
12- !{{title3}}見出し3
13- ...
14-
15-!!ソースコード
16-
17-FSWikiにはpreタグで囲んで出力するための記法やプラグインがあるのでそれを使ってもいいのですが、Web上で参照するときはシンタックスハイライトされていたほうが見やすいよね、ということで[google-code-prettify|http://code.google.com/p/google-code-prettify/]を使用して強調表示を行うためのプラグインを用意しています。
18-
19- {{list
20- public class HelloWorld {
21- public static void main(String[] args){
22- System.out.println("Hello World!");
23- }
24- }
25- }}
26-
27-!!図表番号
28-
29-captionプラグインを使用すると図表番号を付与することができます。第一引数に種別(表、図、リストなど)、第二引数にキャプションに表示する文字列を指定します。
30-
31- {{caption 表,StringUtilsのメソッド一覧}}
32- ,メソッド名,説明
33- ,boolean isEmpty(String str),文字列がnullまたは空文字列かどうかを判定
34- ,boolean isNotEmpty(String str),文字列がnullまたは空文字列でないかを判定
35- ...
36-
37-見出し同様、図表にも相互参照をはることができますが、相互参照の方法については後述します。
38-
39-!!アウトラインの表示
40-
41-FSWikiではoutlineプラグインでページの見出しのアウトラインを表示することができますが、新たにtocプラグインというプラグインを追加しています。tocプラグインを使用すると見出し番号付きのアウトラインを表示することができます。
42-
43-
44- {{toc}}
45-
46-また、tocプラグインはデフォルトでは現在表示しているページのアウトラインを表示しますが、引数にページ名を指定することで指定したページのアウトラインを表示することができます。このため以下のようなページを作成しておくことで書籍全体の目次を作成することができます。
47-
48-
49- !!!目次
50- !!第一章
51- {{toc Chapter1}}
52- !!第二章
53- {{toc Chapter2}}
54- ...
55-
56-outlineプラグインはページの先頭に入れて使うことが多いですが、tocプラグインをサイドメニューに入れておくことでWordの見出しマップのような感じで使うことができるはずです。
57-
58-!!相互参照
59-
60-linkプラグインを使用するとtitle1〜title3プラグインで定義した見出し、およびcaptionプラグインで定義した図表番号へのリンクを出力することができます。
61-
62-見出しへのリンクを作成する場合、title1〜title3プラグインの引数でリンク用のラベルを定義しておき、linkプラグインではそのラベルを参照するようにします。linkプラグインを記述した位置に見出しの文字列が見出し番号付きでリンクが出力されます。
63-
64- !!!{{title1 installation}}インストール
65- ...
66- 詳細については{{link installation}}を参照のこと。
67-
68-図表の場合はcaptionプラグインの第三引数に同じくリンク用のラベルを定義し、linkプラグインではそのラベルを参照します。linkプラグインを記述した位置に図表番号付きでリンクが出力されます。
69-
70- {{caption 表,StringUtilsのメソッド一覧,StringUtils_method_list}}
71- ...
72- {{link StringUtils_method_list}}
73-
74-なお、linkプラグインは第二引数にページ名を指定することで、他のページの見出しやリストにジャンプするリンクを出力することも可能です。
75-
76- インストール方法については{{link installation,Chatper1}}を参照のこと。
77-
78-!!コメントの記述
79-
80-memoプラグインを使用すると執筆中にTODOコメントを入れたり、レビュー時のコメントを記述することができます。ページ内の任意の箇所に以下のように記述しておくと、表示時にはコメント部分(以下の例の場合は「TODO:あとで書く」の部分)が強調して表示されます。
81-
82- {{memo TODO:あとで書く}}
83-
84-memolistプラグインを使用すると現在のページ内のmemoコメントが一覧表示され、リンクをクリックするとそのコメントにジャンプすることができます。
85-
86- !!!コメント一覧
87- {{memolist}}
88-
89-執筆中はmemolistプラグインをサイドメニューに入れておくと便利っぽいです。
90-
91-!!ワードカウント
92-
93-原稿の執筆時は文字数、ページ数を意識する必要がある場合があります。wordcountプラグインで現在表示しているページの文字数、pagecountプラグインでページ数(1ページ2000文字で計算)を表示することができます。
94-
95- *文字数:{{wordcount}}
96- *ページ数:{{pagecount}}
97-
98-これも執筆中はサイドメニューに入れておくとよいでしょう。
99-
100-!!コラムの記述
101-
102-本文の内容とは少し外れる内容だったり、特に注意が必要な点などをコラムとして記述したい場合があります。このような場合、columnプラグインを使用します。
103-
104- {{column コラムのタイトル
105- ここにコラム等の内容をWiki形式で記述すします。
106- ブロックプラグインなので複数行の記述が可能です。
107- }}
108-
1+!!!ス?メシケノョヘム・ラ・鬣ー・、・?ホサネ、、ハ?
2+
3+!!セマ。「クォスミ、キ、ホコ?ョ
4+
5+1・レ。シ・ク、ヌ1セマハャ、ホクカケニ、?ケノョ、ケ、?ウ、ネ、?ロト熙キ、ニ、、、゙、ケ。」ウニ・レ。シ・ク、ヒ、マchapter・ラ・鬣ー・、・?ヌセマ、ホセ???ュスメ、キ、゙、ケ。」、゙、ソ。「クォスミ、キ、マノ眛フ、ホWiki、ホクォスミ、キ、ホオュヒ。、ヌオュスメ、ケ、?ホ、ヌ、ケ、ャ。「title1。「title2。「title3・ラ・鬣ー・、・?ヌクォスミ、キネヨケ讀?スシィ、ヌ、ュ、?隍ヲ、ヒ、キ、゙、キ、ソ。」title1。「title2。「title3・ラ・鬣ー・、・?マクォスミ、キ、リ、ホチ?゚サイセネ、ヒ、篏ネヘム、キ、゙、ケ、ャ。「チ?゚サイセネ、ホハ?ヒ。、ヒ、ト、、、ニ、マク蠖メ、キ、゙、ケ。」
6+
7+ {{chapter 1,セマ、ホ・ソ・、・ネ・?}
8+ !!!{{title1}}クォスミ、キ1
9+ ...
10+ !!{{title2}}クォスミ、キ2
11+ ...
12+ !{{title3}}クォスミ、キ3
13+ ...
14+
15+、゙、ソ。「section・ラ・鬣ー・、・??ネヘム、ケ、?ネ1・レ。シ・ク、?オ、鬢ヒハ」ソ?ホ・サ・ッ・キ・逾?ヒカ霏レ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」
16+
17+ {{chapter 1,セマ、ホ・ソ・、・ネ・?}
18+ {{section ・サ・ッ・キ・逾?}}
19+ !!!{{title1}}クォスミ、キ1
20+ ...
21+ !!{{title2}}クォスミ、キ2
22+ ...
23+ {{section ・サ・ッ・キ・逾?}}
24+ !{{title3}}クォスミ、キ3
25+ ...
26+
27+section・ラ・鬣ー・、・?マ・レ。シ・クセ螟ヒ、マイソ、篆ミホマ、キ、゙、サ、?ャ。「toc・ラ・鬣ー・、・?ヌクォスミ、キ、?「・ヲ・ネ・鬣、・?スシィ、ケ、?ン、ヒオュスメ、キ、ソーフテヨ、ヒ・サ・ッ・キ・逾?ホカ霏レ、熙ャヂニ?、オ、?゙、ケ。」
28+
29+!!・ス。シ・ケ・ウ。シ・ノ
30+
31+FSWiki、ヒ、マpre・ソ・ー、ヌーマ、?ヌスミホマ、ケ、?ソ、皃ホオュヒ。、茹ラ・鬣ー・、・?ャ、「、?ホ、ヌ、ス、??ネ、テ、ニ、筅、、、、ホ、ヌ、ケ、ャ。「Webセ螟ヌサイセネ、ケ、?ネ、ュ、マ・キ・?ソ・テ・ッ・ケ・マ・、・鬣、・ネ、オ、?ニ、、、ソ、ロ、ヲ、ャクォ、荀ケ、、、隍ヘ。「、ネ、、、ヲ、ウ、ネ、ヌ[google-code-prettify|http://code.google.com/p/google-code-prettify/]、?ネヘム、キ、ニカットエノスシィ、?ヤ、ヲ、ソ、皃ホ・ラ・鬣ー・、・??ムーユ、キ、ニ、、、゙、ケ。」
32+
33+ {{list
34+ public class HelloWorld {
35+ public static void main(String[] args){
36+ System.out.println("Hello World!");
37+ }
38+ }
39+ }}
40+
41+!!ゾノスネヨケ
42+
43+caption・ラ・鬣ー・、・??ネヘム、ケ、?ネゾノスネヨケ讀?ユヘソ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」ツ隹???ヒシ?フ。ハノス。「ゾ。「・?ケ・ネ、ハ、ノ。ヒ。「ツ霹???ヒ・ュ・罕ラ・キ・逾?ヒノスシィ、ケ、?クサ???リト熙キ、゙、ケ。」
44+
45+ {{caption ノス,StringUtils、ホ・皈ス・テ・ノー??}
46+ ,・皈ス・テ・ノフセ,タ篶タ
47+ ,boolean isEmpty(String str),ハクサ??ャnull、゙、ソ、マカ?クサ??ォ、ノ、ヲ、ォ、?スト
48+ ,boolean isNotEmpty(String str),ハクサ??ャnull、゙、ソ、マカ?クサ??ヌ、ハ、、、ォ、?スト
49+ ...
50+
51+クォスミ、キニアヘヘ。「ゾノス、ヒ、簔?゚サイセネ、?マ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ、ャ。「チ?゚サイセネ、ホハ?ヒ。、ヒ、ト、、、ニ、マク蠖メ、キ、゙、ケ。」
52+
53+!!・「・ヲ・ネ・鬣、・?ホノスシィ
54+
55+FSWiki、ヌ、マoutline・ラ・鬣ー・、・?ヌ・レ。シ・ク、ホクォスミ、キ、ホ・「・ヲ・ネ・鬣、・??スシィ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ、ャ。「ソキ、ソ、ヒtoc・ラ・鬣ー・、・?ネ、、、ヲ・ラ・鬣ー・、・??ノイテ、キ、ニ、、、゙、ケ。」toc・ラ・鬣ー・、・??ネヘム、ケ、?ネクォスミ、キネヨケ賈ユ、ュ、ホ・「・ヲ・ネ・鬣、・??スシィ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」
56+
57+
58+ {{toc}}
59+
60+、゙、ソ。「toc・ラ・鬣ー・、・?マ・ヌ・ユ・ゥ・?ネ、ヌ、マクスコ゚ノスシィ、キ、ニ、、、?レ。シ・ク、ホ・「・ヲ・ネ・鬣、・??スシィ、キ、゙、ケ、ャ。「ー??ヒ・レ。シ・クフセ、?リト熙ケ、?ウ、ネ、ヌサリト熙キ、ソ・レ。シ・ク、ホ・「・ヲ・ネ・鬣、・??スシィ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」、ウ、ホ、ソ、皺ハイシ、ホ、隍ヲ、ハ・レ。シ・ク、??ョ、キ、ニ、ェ、ッ、ウ、ネ、ヌス?メチエツホ、ホフワシ。、??ョ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」
61+
62+
63+ !!!フワシ。
64+ !!ツ隹?マ
65+ {{toc Chapter1}}
66+ !!ツ霹?マ
67+ {{toc Chapter2}}
68+ ...
69+
70+outline・ラ・鬣ー・、・?マ・レ。シ・ク、ホタ霹ャ、ヒニ?、?ニサネ、ヲ、ウ、ネ、ャツソ、、、ヌ、ケ、ャ。「toc・ラ・鬣ー・、・??オ・、・ノ・皈ヒ・蝪シ、ヒニ?、?ニ、ェ、ッ、ウ、ネ、ヌWord、ホクォスミ、キ・゙・テ・ラ、ホ、隍ヲ、ハエカ、ク、ヌサネ、ヲ、ウ、ネ、ャ、ヌ、ュ、?マ、コ、ヌ、ケ。」
71+
72+!!チ?゚サイセネ
73+
74+link・ラ・鬣ー・、・??ネヘム、ケ、?ネtitle1。チtitle3・ラ・鬣ー・、・?ヌト?チ、キ、ソクォスミ、キ。「、ェ、隍モcaption・ラ・鬣ー・、・?ヌト?チ、キ、ソゾノスネヨケ讀リ、ホ・??ッ、?ミホマ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」
75+
76+クォスミ、キ、リ、ホ・??ッ、??ョ、ケ、??遑「title1。チtitle3・ラ・鬣ー・、・?ホー??ヌ・??ッヘム、ホ・鬣ル・???チ、キ、ニ、ェ、ュ。「link・ラ・鬣ー・、・?ヌ、マ、ス、ホ・鬣ル・??イセネ、ケ、?隍ヲ、ヒ、キ、゙、ケ。」link・ラ・鬣ー・、・??ュスメ、キ、ソーフテヨ、ヒクォスミ、キ、ホハクサ??ャクォスミ、キネヨケ賈ユ、ュ、ヌ・??ッ、ャスミホマ、オ、?゙、ケ。」
77+
78+ !!!{{title1 installation}}・、・?ケ・ネ。シ・
79+ ...
80+ セワコル、ヒ、ト、、、ニ、マ{{link installation}}、?イセネ、ホ、ウ、ネ。」
81+
82+ゾノス、ホセ?遉マcaption・ラ・鬣ー・、・?ホツ霆ーー??ヒニア、ク、ッ・??ッヘム、ホ・鬣ル・???チ、キ。「link・ラ・鬣ー・、・?ヌ、マ、ス、ホ・鬣ル・??イセネ、キ、゙、ケ。」link・ラ・鬣ー・、・??ュスメ、キ、ソーフテヨ、ヒゾノスネヨケ賈ユ、ュ、ヌ・??ッ、ャスミホマ、オ、?゙、ケ。」
83+
84+ {{caption ノス,StringUtils、ホ・皈ス・テ・ノー??StringUtils_method_list}}
85+ ...
86+ {{link StringUtils_method_list}}
87+
88+、ハ、ェ。「link・ラ・鬣ー・、・?マツ霹???ヒ・レ。シ・クフセ、?リト熙ケ、?ウ、ネ、ヌ。「ツセ、ホ・レ。シ・ク、ホクォスミ、キ、茹?ケ・ネ、ヒ・ク・罕?ラ、ケ、???ッ、?ミホマ、ケ、?ウ、ネ、箚トヌス、ヌ、ケ。」
89+
90+ ・、・?ケ・ネ。シ・??ヒ。、ヒ、ト、、、ニ、マ{{link installation,Chatper1}}、?イセネ、ホ、ウ、ネ。」
91+
92+!!・ウ・皈?ネ、ホオュスメ
93+
94+memo・ラ・鬣ー・、・??ネヘム、ケ、?ネシケノョテ讀ヒTODO・ウ・皈?ネ、??、?ソ、遙「・?モ・蝪シサ?、ホ・ウ・皈?ネ、?ュスメ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」・レ。シ・クニ筅ホヌ、ーユ、ホイユス熙ヒーハイシ、ホ、隍ヲ、ヒオュスメ、キ、ニ、ェ、ッ、ネ。「ノスシィサ?、ヒ、マ・ウ・皈?ネノ?ャ。ハーハイシ、ホホ网ホセ?遉マ。ヨTODO。ァ、「、ネ、ヌス?ッ。ラ、ホノ?ャ。ヒ、ャカットエ、キ、ニノスシィ、オ、?゙、ケ。」
95+
96+ {{memo TODO。ァ、「、ネ、ヌス?ッ}}
97+
98+memolist・ラ・鬣ー・、・??ネヘム、ケ、?ネクスコ゚、ホ・レ。シ・クニ筅ホmemo・ウ・皈?ネ、ャー??スシィ、オ、?「・??ッ、?ッ・?テ・ッ、ケ、?ネ、ス、ホ・ウ・皈?ネ、ヒ・ク・罕?ラ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」
99+
100+ !!!・ウ・皈?ネー?
101+ {{memolist}}
102+
103+シケノョテ讀マmemolist・ラ・鬣ー・、・??オ・、・ノ・皈ヒ・蝪シ、ヒニ?、?ニ、ェ、ッ、ネハリヘ?テ、ン、、、ヌ、ケ。」
104+
105+!!・?シ・ノ・ォ・ヲ・?ネ
106+
107+クカケニ、ホシケノョサ?、マハクサ??「・レ。シ・クソ??ユシア、ケ、?ャヘラ、ャ、「、??遉ャ、「、熙゙、ケ。」wordcount・ラ・鬣ー・、・?ヌクスコ゚ノスシィ、キ、ニ、、、?レ。シ・ク、ホハクサ??「pagecount・ラ・鬣ー・、・?ヌ・レ。シ・クソ?ハ1・レ。シ・ク2000ハクサ?ヌキラササ。ヒ、?スシィ、ケ、?ウ、ネ、ャ、ヌ、ュ、゙、ケ。」
108+
109+ *ハクサ??ァ{{wordcount}}
110+ *・レ。シ・クソ?ァ{{pagecount}}
111+
112+、ウ、?箴ケノョテ讀マ・オ・、・ノ・皈ヒ・蝪シ、ヒニ?、?ニ、ェ、ッ、ネ、隍、、ヌ、キ、遉ヲ。」
113+
114+!!・ウ・鬣爨ホオュスメ
115+
116+ヒワハク、ホニ簣ニ、ネ、マセッ、キウー、??簣ニ、タ、テ、ソ、遙「ニテ、ヒテ?ユ、ャノャヘラ、ハナタ、ハ、ノ、?ウ・鬣爨ネ、キ、ニオュスメ、キ、ソ、、セ?遉ャ、「、熙゙、ケ。」、ウ、ホ、隍ヲ、ハセ?遑「column・ラ・鬣ー・、・??ネヘム、キ、゙、ケ。」
117+
118+ {{column ・ウ・鬣爨ホ・ソ・、・ネ・
119+ 、ウ、ウ、ヒ・ウ・鬣倏?ホニ簣ニ、?ikiキチシー、ヌオュスメ、ケ、キ、゙、ケ。」
120+ ・ヨ・?テ・ッ・ラ・鬣ー・、・?ハ、ホ、ヌハ」ソ?ヤ、ホオュスメ、ャイトヌス、ヌ、ケ。」
121+ }}
122+
--- a/takezoe/plugin/book/Section.pm
+++ b/takezoe/plugin/book/Section.pm
@@ -1,12 +1,15 @@
11 ################################################################################
22 #
3-# <p>章の見出しを出力するパラグラフプラグイン。</p>
3+# <p>章の中を複数のセクション区切るためのパラグラフプラグイン。</p>
44 # <pre>
5-# {{chapter 1,はじめに}}
5+# {{section 文字列処理}}
6+# ...
7+# {{section 正規表現}}
8+# ...
69 # </pre>
710 # <p>
8-# 他のプラグインではこのプラグインで定義した章番号を使って図表番号などを振って
9-# いるため、1ページに最低1つはこのプラグインを記述しておく必要があります。
11+# このプラグインはページ上には何も出力しませんが、tocプラグインで見出しの
12+# アウトライン表示を行う際に記述した位置にセクション区切りが挿入されます。
1013 # </p>
1114 #
1215 ################################################################################
Show on old repository browser