Develop and Download Open Source Software

Browse CVS Repository

Diff of /malonnote/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1 by maloninc, Fri Jul 29 10:59:24 2005 UTC revision 1.1.2.1 by maloninc, Fri Jul 29 10:59:24 2005 UTC
# Line 0  Line 1 
1    
2    *Malon Note
3    
4    MalonNote は、ちょっとしたメモをすばやく保存・検索できるようにするアプリケーションです。
5    メモデータはテキストデータで保存されるので Malon Note が気に入らなくなってしまっても
6    情報を流用することができます。
7    
8    Wiki を知っている方は「ローカル一人 Wiki」のようなものと思っていただければ良いと思います。
9    Wiki の影響を強く受けていますのでデータ形式もWiki 互換となるようにしました。
10    
11    
12    *インストール方法
13    
14    **Mac の場合
15    mnote.app(あるいはmnote)のアイコンをアプリケーションフォルダにコピーしてください
16    
17    **Windows の場合
18    mnote.exeを任意のディレクトリにコピーしてください
19    
20    **UNIXの場合
21    mnoteを任意のディレクトリにコピーしてください
22    
23    
24    *使い方
25    
26    **初めて使用する場合
27    初めて起動する場合、メモデータを保存するディレクトリを訪ねてきます。
28    お好みの空ディレクトリを指定して下さい。
29    
30    
31    **検索
32    1行入力用のテキストボックスに検索文字列を入力して、リターンキーを押すと
33    検索文字列を親として、検索結果がツリー状に表示されます。
34    
35    
36    **新しいメモの作成
37    メニューから「New」を選択してください。
38    
39    
40    **メモの削除
41    削除したいメモをツリーから選択し、メニューから「Remove」を選択してください。
42    メモに対応するファイルも一緒に削除されます。
43    
44    
45    **検索結果の削除
46    削除したい検索文字列をツリーから選択し、メニューから「Remove」を選択してください。
47    データファイルは削除されません。
48    
49    
50    **メモの件名修正
51    修正したいメモをツリーから選択し、件名を再度クリックしてください。
52    
53    **保存
54    明示的な保存手順はありません。
55    アプリケーションの終了とツリー上でメモを選択した際に
56    自動的に保存されます。
57    
58    
59    *メモフォーマット
60    
61    基本的にフリーフォーマットですが、最初の4行は
62    以下のフォーマットを崩さないようにしてください。
63    
64    :''DATE'':YYYY/MM/DD HH:MI:SS
65    
66    :''TYPE'':メモの種別(任意の単語。/で区切ることも可 例:memo/todo/参考)
67    ----
68    本文
69    
70    また、Wikiとの互換性を保つため本文には以下のような
71    Wikiテキスト整形フォーマットを推奨します。
72    
73    ※Malon Noteでは整形機能が実装されていませんので
74      単なるテキスト表示になります。
75     将来はリンク機能を実装する予定です。d
76    
77    ・連続した複数行は連結されます。
78    ・空行は段落の区切りとなります。
79    ・行頭がスペースで始まると、その行はそまま表示されます。
80    ・シングルクォート2個ではさんだ部分は、ボールドになります。
81    ・シングルクォート3個ではさんだ部分は、イタリックになります。
82    ・アスタリスク(*)を行頭に書くと、大見出しになります。
83    ・アスタリスク2個(**)を行頭に書くと小見出しになります。
84    ・-を行頭に書くと箇条書きになります。
85    ・http://www.maloninc.com/のようなURLは自動的にリンクになります。
86    ・file://hoge.txtのようなものも自動的にリンクになります。
87    ・[[]]でくくった文字列は他のメモを検索するリンクになります。
88    
89    
90    *TODO
91    
92    -リンク機能の実装
93    -メニューなどの日本語翻訳
94    -分類機能
95    
96    
97    *バグの報告
98    
99    **メールでの報告
100    バグを発見した場合には以下のメールアドレスまでご連絡ください。
101    
102        hiroyuki@maloninc.com
103    
104    また、以下の点について記載していただけますと大変助かります。
105    
106    ・OSの種類とバージョン(例: MacOS X 10.2)
107    ・バグの事象を再現させる方法(例:同じ文字で検索を何回か繰り返すと強制終了する)
108    
109    以下のファイルを取得できる場合は添付していただけますと非常に助かります。
110    ・Windowsであれば、C:\Documents and Settings\All Users\Documents\DrWatson\drwtsn32.log
111    ・MacOS Xであれば、/User/あなたのユーザー名/Library/Logs/CrashReporter/mnote.crash.log
112    ・UNIXであれば、coreファイル
113    
114    **sourceforgeを使える方
115    以下のURLからバグトラッカーへ登録していただけます助かります。
116    http://sourceforge.jp/projects/malonnote/tracker/
117    
118    
119    *開発者向けの情報
120    
121    **GUIライブラリ
122    Macだけではなくて、UNIXやWindowsでも稼動させるためにクロスプラットフォームのGUIライブラリであるwxWidgets(旧名:wxWindows)を
123    使用しています。wxWidgetsについては以下のURLを参照してください。
124    
125    -wxWindows本家
126    http://www.wxwindows.org/
127    
128    -wxWindows日本語プロジェクト
129    http://wxwindowsjp.sourceforge.jp/
130    
131    -wxWidgets でクロスプラットフォーム GUIアプリを作ろう
132    http://namazu.org/~satoru/pub/uu-2004-08/
133    ※このサイトを見て初めてwxWidgesを知りました。高林哲さんに感謝。
134    
135    **設計思想
136    
137    MalonNoteを構成するオブジェクトはMVC(Model-View-Controller)モデルで
138    作られています。
139    筆者のMVCモデルの理解を以下にまとめます。
140    
141    -Model(ロジック)
142        アプリケーションロジックを担当する。
143        ただし、データの表示方法については実装しない。(それはViewの役割)
144    
145    -View(表示)
146        Modelの状態を表示する。また、ControllerからModelの状態変更通知を受けた場合には
147        再表示する。
148        ViewはModelの状態を変更するような処理は行わない。(それはControllerの役割)
149    
150    -Controller(イベント処理)
151        Viewで発生したイベントに応じてModelの状態を変更し、Viewへ状態変更を通知する。
152    
153    
154    **各クラスの機能
155    
156    -mnModelクラス(Model)
157        メモデータであるWikiファイルやデータの管理と検索結果の管理を行います。
158    
159    -mnFrameクラス(View)
160        mnModelの内容(状態)を画面(ツリーやテキストボックス)に表示します。
161    
162    -mnControllerクラス(Controller)
163        mnFrame上で発生したイベントに応じてmnModelの状態を変更したり、
164        mnFrameへmnModelの状態変更を通知する役割を担います。
165    
166    *謝辞
167    -高林哲さんに感謝。wxWidgetsの記事を書いていただかなければ、MalonNoteは存在しなかったでしょう。
168    -Hitomiさんに感謝。りんごちゃんのアイコンを生み出してくれました。
169    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.1.2.1

Back to OSDN">Back to OSDN
ViewVC Help
Powered by ViewVC 1.1.26