[logaling-commit] logaling/logaling.github.com [master] improve document for logalimacs

Back to archive index

null+****@clear***** null+****@clear*****
Fri Feb 3 15:34:33 JST 2012


yuta yamada	2012-02-03 15:34:33 +0900 (Fri, 03 Feb 2012)

  New Revision: 44da4577076134b956c3db2b9fb4a81d79de45fa

  Log:
    improve document for logalimacs

  Modified files:
    logalimacs/about.md
    logalimacs/commands.md
    logalimacs/index.md
    logalimacs/tutorial.md
    logalimacs/whatsnew.md

  Modified: logalimacs/about.md (+4 -4)
===================================================================
--- logalimacs/about.md    2012-01-27 17:33:42 +0900 (da12d1f)
+++ logalimacs/about.md    2012-02-03 15:34:33 +0900 (27f219e)
@@ -3,7 +3,7 @@ layout: default
 title: logalimacsについて
 ---
 
-## logalimacsについて
+# logalimacsについて
 
 ---
 
@@ -15,14 +15,14 @@ logalimacsはlogaling-command用のフロントエンドです。
 特徴としては以下のようになります:
 
 
-* 英語のドキュメントを見ている時に...
+### 英語のドキュメントを見ている時に...
 英語のドキュメントを見ている時に、
 カーソル位置より手前の単語を調べられます。  
 ツールチップで表示したり、  
 リージョンの単語を検索するか、ミニバッファから任意の単語を入力し  
 logalimacs用のバッファに表示できます。
 
-* 一つのキーバインドで複数の機能
+### 一つのキーバインドで複数の機能
 logalimacsは、[logaling-command](/about.html)のフロントエンドなので、  
 logaling-commandが利用できるコマンドはEmacs経由で実行できます。  
 ターミナルでlogaling-commandを利用する場合、  
@@ -34,7 +34,7 @@ logalingコマンドを呼び出す事が出来ます。
 これを行うとミニバッファ上に利用できるコマンドが出るので、  
 その頭文字をタイプする事で、そのコマンドを利用できます。
 
-* ターミナルからの入力に比べlogalimacsだと少ない入力で済みます。  
+### ターミナルからの入力に比べlogalimacsだと少ない入力で済みます。  
 良く使うであろう検索と単語の追加、更新については、  
 ターミナル上では、英語で複数の単語をスペース区切りで登録するのに、  
 クオートする必要がありますがlogalimacsの場合は、  

  Modified: logalimacs/commands.md (+51 -17)
===================================================================
--- logalimacs/commands.md    2012-01-27 17:33:42 +0900 (88c0c7d)
+++ logalimacs/commands.md    2012-02-03 15:34:33 +0900 (f7f33e0)
@@ -20,40 +20,74 @@ title: logalimacsで利用できるコマンド
 
 上のメッセージで、a)ddから始まる文字が利用可能なタスクです。  
 もしadd(単語の追加)をしたい場合は、キーボードで_a_をタイプします。  
-すると、\*logalimacs\*バッファが開き、へルプメッセージが表示されます。  
+すると、\*logalimacs\*バッファが開き、へルプメッセージが表示されます。(lookup以外)  
 そのメッセージを参考にミニバッファに内容を打ち込みます。  
 (logaling-commandをラップしているものは、全て処理前にヘルプメッセージが表示されます。)
 
-この例で打ち込む内容は、loga-add-wordの項を参照してください。
+この例で打ち込む内容は、loga-add-wordの項を参照してください。  
 他のタスクも頭文字を指定して同様に、選択可能です。
 
 ## loga-add-word
-ターミナルからの"% loga add source target note"をラップするコマンドです。  
+ターミナルからの"% loga add SOURCE TARGET NOTE"をラップするコマンドです。  
 ターミナル上では、英語で複数の単語をスペース区切りで登録するのに、  
 クオートする必要がありますがlogalimacsでこのコマンドを利用する場合は、  
 必要ありません。
-コマンド実行後、source(元の単語)、target(翻訳後の単語)、note(任意の注釈)を
+コマンド実行後、source(元の単語)、target(翻訳後の単語)、note(任意の注釈)を  
 個別に聞いてきます。  
 
 ## loga-update
-ターミナルからの "% loga update source target(old) target(new) note"をラップするコマンドです。  
+ターミナルからの "% loga update SOURCE TARGET(old) TARGET(new) NOTE(optional)"をラップするコマンドです。  
 ターミナル上では、英語で複数の単語をスペース区切りで登録するのに、  
 クオートする必要がありますがlogalimacsでこのコマンドを利用する場合は、  
 必要ありません。
-コマンド実行後、source(元の単語)、target(変更前の単語)、target(変更後の単語)、note(任意の注釈)を個別に聞いてきます。  
+コマンド実行後、SOURCE(元の単語)、TARGET(変更前の単語)、TARGET(変更後の単語)、
+NOTE(任意の注釈)を個別に聞いてきます。  
 
-## loga-lookup-in-hand-or-region
-ターミナルからの "% loga lookup target"をラップするコマンドです。
-logalimacs独自の機能として、リージョンを選択していた場合、
-その単語を、検索します。
-それ以外の場合、ミニバッファに検索する文字を入力し、RETする事で利用できます。
+## loga-lookup-at-manually
+ターミナルからの "% loga lookup TARGET"をラップするコマンドです。  
+logalimacs独自の機能として、リージョンを選択していた場合、  
+その単語を、検索します。  
+それ以外の場合、ミニバッファに検索する文字を入力し、RETする事で利用できます。  
+出力先はbufferになります。
+
+## loga-lookup-in-popup
+popup(ツールチップ)で検索内容を表示します。
+C-uのuniversal-argumentを押してから実行すると挙動が変わります。
+C-u無し:  
+カーソル位置の文字※1を検索対象にしてlogalingでlookup検索します。  
+入力後popupで検索結果を表示します。  
+C-u有り:  
+manualで文字を入力するようminibufferに入力画面が出ます。  
+入力後popupで検索結果を表示します。  
+両方ともリージョン選択をしていた場合、リージョン内の文字列で検索します。  
+
+popup表示後のコマンド:  
+popup表示後に特定のキーを押すと動作します。  
+d: bufferに表示を切り替えます。  
+q: popupの表示を消します。  
+p: bufferを上に画面移動します。  
+n: bufferを下に画面移動します。  
+
+※ カーソル位置の検索についての注意点:  
+ひらがなと漢字を含んだ文字の場合、漢字が名詞の場合が多いので、  
+漢字だけで検索するようにしています。  
+
+## loga-lookup-in-buffer
+loga-lookup-in-popupの
+出力先がbufferに変わったもので違いとしては、
+buffer表示後に受付けるコマンドが違います。
+buffer表示後に受付けるコマンド:  
+d: bufferをdeleteします。
+q: bufferをdeleteします。
+p: bufferを上に画面移動します。  
+n: bufferを下に画面移動します。  
 
 ## loga-fly-mode
-logalimacs独自の機能で、カーソル位置にある単語を"loga lookup"(検索)します。
-(空白では、その位置より左側の単語になります。)
-この機能は、通常はoffで_loga-interactive-command_から実行するか、
-_M-x loga-fly-mode_または、任意のキーバインドで実行する事で、
-onとoffをトグルで実行できます。
+logalimacs独自の機能で、カーソル位置にある単語を"loga lookup"(検索)します。  
+(空白では、その位置より左側の単語になります。)  
+この機能は、通常はoffで_loga-interactive-command_から実行するか、  
+_M-x loga-fly-mode_または、任意のキーバインドで実行する事で、  
+onとoffをトグルで実行できます。  
 
 ## loga-get-flymake-error
-実行するとflymakeでのエラーをlogalimacsバッファに出力します。
+実行するとflymakeでのエラーをlogalimacsバッファに出力します。  

  Modified: logalimacs/index.md (+1 -1)
===================================================================
--- logalimacs/index.md    2012-01-27 17:33:42 +0900 (032099c)
+++ logalimacs/index.md    2012-02-03 15:34:33 +0900 (ceba7c9)
@@ -12,4 +12,4 @@ logaling-commandをインストールする必要があります。
 * [利用可能なコマンド](/logalimacs/commands.html)
 
 
-[logalimacsで何ができるの?](/loglimacs/tutorial.html)
+[logalimacsで何ができるの?](/logalimacs/tutorial.html)

  Modified: logalimacs/tutorial.md (+27 -18)
===================================================================
--- logalimacs/tutorial.md    2012-01-27 17:33:42 +0900 (50a3f74)
+++ logalimacs/tutorial.md    2012-02-03 15:34:33 +0900 (9b59ca0)
@@ -37,11 +37,13 @@ edictの辞書をインポートする
 
 * カーソル上の英単語を検索するには
 
-例えば、英語のドキュメントがありcatという単語があり意味を調べたいとします。
+例えば、英語のドキュメントがありrubyという単語があり意味を調べたいとします。
 調べたい単語の上で"M-x loga-lookup-for-popup"と入力するか、
 インストールの項であったglobal-set-keyで自分で
 loga-lookup-for-popupを登録したキーバインドを
 入力すると、カーソル上の単語が辞書から検索されpopupで表示されます。
+(画像のRubyの部分は私が単語を登録したので、表示されているだけです。  
+gene95とedictをインポートしただけでは通常表示されません。)
 
 ---
 
@@ -51,27 +53,24 @@ loga-lookup-for-popupを登録したキーバインドを
 
 * 自分で検索する英単語を入力するには
 
-例えば、テレビで見た英単語の意味を調べる等、コピペではなく
-どうしても、自分で検索する用語を入力したい時は、
-"M-x loga-lookup-region-or-manually"と入力するか、
-インストールの項であったglobal-set-keyで自分で、
-loga-lookup-region-or-manuallyを登録したキーバインドを
-入力するとミニバッファに調べたい単語を聞かれるので、
-あなたが調べたい単語を入力して、入力が終わったらRETを押すと
-logalingで検索され結果が\*logalimacs\*バッファに表示されます。
+例えば、テレビで見た英単語の意味を調べる等、コピペではなく  
+どうしても、自分で検索する用語を入力したい時は、  
+"M-x loga-lookup-region-or-manually"と入力するか、  
+インストールの項であったglobal-set-keyで自分で、  
+loga-lookup-region-or-manuallyを登録したキーバインドを  
+入力するとミニバッファに調べたい単語を聞かれるので、  
+あなたが調べたい単語を入力して、入力が終わったらRETを押すと  
+logalingで検索され結果が\*logalimacs\*バッファに表示されます。  
+注意:  
+Emacs23の方でもしpopwinの設定をしていない場合は、  
+選択していないバッファに表示されますのでご注意ください。
+
+
+![自分で入力して検索](/logalimacs/images/outputBuffer.png)
 
 * リージョンで選択した単語or文章を検索するには
 
 例えば、以下の英語ドキュメントで辞書から  
-"go up in smoke"のイディオムを検索したい場合、
-go up in smokeの部分をリージョン選択します。"M-x set-mark-command"を入力するか
-"C-SPC"または、"C-@"(Emacsのデフォルトのキーバインドを変更していなければ)で、
-リージョンの開始をマークできます。カーソルを動かして、
-リージョンの範囲指定をしたら、そこで(この場合はgo up in smoke)、
-"M-x loga-lookup-region-or-manually"または"M-x loga-lookup-fof-popup"または、 
-上のコマンドを登録したキーバインドを入力します。
-お気づきかもしれませんが、これらのコマンドはリージョン選択時はリージョンを検索、
-非選択時は、カーソル位置や入力を求めるという動作になっています。
 
 ---
 
@@ -81,6 +80,16 @@ go up in smokeの部分をリージョン選択します。"M-x set-mark-command
 
 ---
 
+"go up in smoke"のイディオムを検索したい場合、  
+go up in smokeの部分をリージョン選択します。"M-x set-mark-command"を入力するか  
+"C-SPC"または、"C-@"(Emacsのデフォルトのキーバインドを変更していなければ)で、  
+リージョンの開始をマークできます。カーソルを動かして、  
+リージョンの範囲指定をしたら、そこで(この場合はgo up in smoke)、  
+"M-x loga-lookup-region-or-manually"または"M-x loga-lookup-fof-popup"または、 
+上のコマンドを登録したキーバインドを入力します。  
+お気づきかもしれませんが、これらのコマンドはリージョン選択時はリージョンを検索、  
+非選択時は、カーソル位置や入力を求めるという動作になっています。  
+
 
 ![リージョンでpopup](/logalimacs/images/popupRegion.png)
 

  Modified: logalimacs/whatsnew.md (+8 -4)
===================================================================
--- logalimacs/whatsnew.md    2012-01-27 17:33:42 +0900 (226dfc9)
+++ logalimacs/whatsnew.md    2012-02-03 15:34:33 +0900 (16504b1)
@@ -1,9 +1,13 @@
+---
+layout: default
+title: 新機能
+---
+
 # What's New
 
 [logalimacsについて](/logalimacs/about.html) | [コマンド](/logalimacs/commands.html) | [インストール方法](/logalimacs/install.html) | [チュートリアル](/logalimacs/tutorial.html) | [github](https://github.com/logaling/logalimacs) |
 
-* varsion 1.0.0
-1. カーソル位置の単語を辞書から検索し、popupで表示
+## varsion 1.0.0
+1. カーソル位置の単語を辞書から検索し、popupまたはbufferに表示
 2. リージョンで指定した単語を辞書から検索し、popupまたはbufferに表示
-3. ミニバッファに入力した文字をから検索してbufferに表示
-
+3. ミニバッファに入力した文字から検索してbufferに表示




More information about the logaling-commit mailing list
Back to archive index