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

Back to archive index

null+****@clear***** null+****@clear*****
Fri Feb 10 13:59:04 JST 2012


yuta yamada	2012-02-10 13:59:04 +0900 (Fri, 10 Feb 2012)

  New Revision: 2933b70bb3a60ac2ec7624ce0f41a2295fd78431

  Log:
    improve document for logalimacs

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

  Modified: logalimacs/about.md (+6 -6)
===================================================================
--- logalimacs/about.md    2012-02-09 21:27:37 +0900 (6c46259)
+++ logalimacs/about.md    2012-02-10 13:59:04 +0900 (425c904)
@@ -5,8 +5,8 @@ title: logalimacsについて
 
 # logalimacsについて
 
-## logalimacsはlogaling-command用のフロントエンドです。
-   特徴としては以下のようになります:
+## logalimacsはlogaling-command用のフロントエンド
+次のような特徴になります:
 
 ### 英語のドキュメントを見ている時に...
 英語のドキュメントを見ている時に、カーソル位置より手前の単語を調べられます。
@@ -14,11 +14,11 @@ title: logalimacsについて
 
 ### 一つのキーバインドで複数の機能
 logalimacsは、[logaling-command](/about.html)のフロントエンドなので、logaling-commandが利用できるコマンドはEmacs経由で実行できます。
-ターミナルでlogaling-commandを利用する場合、`% loga [行いたいタスク] [任意の引数]..`となりますがlogalimacsでは、`_M-x loga-interactive-command_`とタイプするか、これを割り当てたキーバインドを入力すると対話的に、logalingコマンドを呼び出す事が出来ます。これを行うとミニバッファ上に利用できるコマンドが出るので、その頭文字をタイプする事で、そのコマンドを利用できます。
+ターミナルでlogaling-commandを利用する場合、`% loga [行いたいタスク] [任意の引数]..`となりますがlogalimacsでは、`M-x loga-interactive-command`とタイプするか、これを割り当てたキーバインドを入力すると対話的に、logalingコマンドを呼び出す事が出来ます。これを行うとミニバッファ上に利用できるコマンドが出るので、その頭文字をタイプする事で、対応するコマンドを利用できます。
 
 ### ターミナルからの入力に比べlogalimacsだと少ない入力で済みます。
 
-良く使うであろう検索と単語の追加、更新については、  ターミナル上では、英語で複数の単語をスペース区切りで登録するのに、クオートする必要がありますがlogalimacsの場合は、元の単語、翻訳された単語、注釈(任意)の順にミニバッファにリクエストが出るので、この点を気にする必要はありません。(loga addの場合)
+良く使うであろう検索と単語の追加、更新については、  ターミナル上では、英語で複数の単語をスペース区切りで登録するのに、クオートする必要がありますがlogalimacsの場合は、元の単語、翻訳された単語、注釈(任意)の順にミニバッファにリクエストが出るので、この点を気にする必要はありません。
 
 ※ 詳しい使い方は、[チュートリアル](/logalimacs_tutorial.html) や [コマンド](/logalimacs_commands.html) を参照して下さい。
 
@@ -34,9 +34,9 @@ logalimacsは、[logaling-command](/about.html)のフロントエンドなので
 logaling-command共通の問題点、要望などはlogalingと同じ[コミュニティ](/contribution.html)からお願いします。
 logalimacsに対する問題点、要望は[issues](https://github.com/logaling/logalimacs/issues)にお願いします。
 
-## バージョン情報 1.0.0
+## バージョン情報
 
-2012/2/13にリリース予定です。
+Version:0.9.0(2012/2/13) : 初版
 
 ## ライセンス
 このプラグラムは、フリーソフトウェアです。あなたはこれを、フリーソフトウェア財団によって発行された[GNU GENERAL PUBLIC LICENSE Version 3](www.gnu.org/licenses/gpl-3.0.txt)の定める条件の下で再頒布または、改変する事が出来ます。

  Modified: logalimacs/commands.md (+10 -12)
===================================================================
--- logalimacs/commands.md    2012-02-09 21:27:37 +0900 (cdbc34e)
+++ logalimacs/commands.md    2012-02-10 13:59:04 +0900 (a1e8ec1)
@@ -24,7 +24,7 @@ title: logalimacsで利用できるコマンド
 この例で打ち込む内容は、loga-add-wordの項を参照してください。
 他のタスクも頭文字を指定して同様に、選択可能です。
 
-## loga-add-word
+## loga-add
 ターミナルからの"% loga add SOURCE TARGET NOTE"をラップするコマンドです。
 ターミナル上では、英語で複数の単語をスペース区切りで登録するのに、クオートする必要がありますがlogalimacsでこのコマンドを利用する場合は、必要ありません。
 コマンド実行後、source(元の単語)、target(翻訳後の単語)、note(任意の注釈)を個別に聞いてきます。
@@ -45,7 +45,7 @@ popup(ツールチップ)で検索内容を表示します。
 C-uのuniversal-argumentを押してから実行すると挙動が変わります。
 
 ### C-u無し:
-カーソル位置の文字※1を検索対象にしてlogalingでlookup検索します。
+カーソル位置の文字※を検索対象にしてlogalingでlookup検索します。
 入力後popupで検索結果を表示します。
 
 ### C-u有り:
@@ -61,8 +61,6 @@ popup表示後に特定のキーを押すと動作します。
 --------|------
 d | bufferに表示を切り替えます。
 q | popupの表示を消します。
-p | bufferを上に画面移動します。
-n | bufferを下に画面移動します。
 
 ※ カーソル位置の検索についての注意点:
 ひらがなと漢字を含んだ文字の場合、漢字が名詞の場合が多いので、漢字だけで検索するようにしています。
@@ -76,15 +74,15 @@ buffer表示後に受付けるコマンドが違います。
 
 コマンド | 動作
 --------|------
-d | bufferをdeleteします。
-q | bufferをdeleteします。
+d | bufferを削除します。
+q | bufferを削除します。
 p | bufferを上に画面移動します。
 n | bufferを下に画面移動します。
 
-## loga-fly-mode
-logalimacs独自の機能で、カーソル位置にある単語を`loga lookup (検索)`します。
-(空白では、その位置より左側の単語になります。)
-この機能は、通常はoffで`_loga-interactive-command_`から実行するか、`_M-x loga-fly-mode_`または、任意のキーバインドで実行する事で、onとoffをトグルで実行できます。
+<!-- ## loga-fly-mode -->
+<!-- logalimacs独自の機能で、カーソル位置にある単語を`loga lookup (検索)`します。 -->
+<!-- (空白では、その位置より左側の単語になります。) -->
+<!-- この機能は、通常はoffで`loga-interactive-command`から実行するか、`M-x loga-fly-mode`または、任意のキーバインドで実行する事で、onとoffをトグルできます。 -->
 
-## loga-get-flymake-error
-実行するとflymakeでのエラーをlogalimacsバッファに出力します。
+<!-- ## loga-get-flymake-error -->
+<!-- 実行するとflymakeでのエラーをlogalimacsバッファに出力します。 -->

  Modified: logalimacs/index.md (+1 -1)
===================================================================
--- logalimacs/index.md    2012-02-09 21:27:37 +0900 (3f18341)
+++ logalimacs/index.md    2012-02-10 13:59:04 +0900 (1ea1111)
@@ -5,7 +5,7 @@ title: logalimacs
 
 # What's New
 
-## varsion 1.0.0
+## varsion 0.9.0
 1. カーソル位置の単語を辞書から検索し、popupまたはbufferに表示
 2. リージョンで指定した単語を辞書から検索し、popupまたはbufferに表示
 3. ミニバッファに入力した文字から検索してbufferに表示

  Modified: logalimacs/install.md (+29 -49)
===================================================================
--- logalimacs/install.md    2012-02-09 21:27:37 +0900 (a1fe371)
+++ logalimacs/install.md    2012-02-10 13:59:04 +0900 (ffa5622)
@@ -5,25 +5,15 @@ title: logalimacsのインストール方法
 
 # logalimacsのインストール方法,設定
 
-
-※ logaling-commandをインストールする必要があります。
-
-<a href="/"><img src="/logalimacs/images/commonLogalingLink.png" width="550" height="100" alt="logaling-commandのインストールはこちら"></a>
-
 ## 1. logaling-commandをインストールする
-[logaling-command](/about.html)を既にインストールしている場合は、次の項へ飛ばして下さい。(またlogaling-commandを翻訳用の対訳用語集として使用したい場合は
-[こちら](/tutorial.html)をご覧ください)
-
-### システムのruby1.9を使っている場合:
+logalimacsではlogaling-commandをインストールする必要があります。
+もしインストールしていない場合次のリンクを参照してインストールして下さい。
 
-    % sudo gem install logaling-command
 
-### rvmを使っている場合:
-(rvmを使っていてruby1.9系をインストールしていなかったら "% rvm install 1.9.2" でインストールできます。)
+<a href="/"><img src="/logalimacs/images/commonLogalingLink.png" width="550" height="100" alt="logaling-commandのインストールはこちら"></a>
 
-    % gem install logaling-command
 
-### rvmをEmacsで使う場合の設定:
+### rvmを利用している場合の設定:
 [rvm.el](https://github.com/senny/rvm.el)が必要です。
 端末で先に % rvm use 1.9.2 --defaultでデフォルトを1.9系にして、以下のコードを.emacs等に書きます。
 (パスを通した所にrvm.elを置くかloadして下さい。わからなければ_6. 雑多な設定_へ)
@@ -31,6 +21,18 @@ title: logalimacsのインストール方法
 	(require 'rvm)
 	(rvm-use-default)
 
+### logalingのconfig設定をする
+登録したい翻訳元の言語と翻訳された後の言語を、
+ホームディレクトリの~/.logaling/configに設定します。
+以下はmy-dictionaryという用語集名で、翻訳元が英語(en)で翻訳後が日本語(ja)で
+設定しています。
+
+    --glossary my-dictionary
+    --source-language en
+    --target-language ja
+
+詳しくは[こちら](/tutorial.html)をご覧ください
+
 ## 2. Emacs24でのインストール方法
 Emacs24でない方は、次の項へ飛ばして下さい。
 
@@ -68,50 +70,28 @@ Emacs24以外の方はgitが使用可能であれば、下記のコマンドで
     % cd YOUR-CLONE-DIRECTORY
     % git clone https://github.com/logaling/logalimacs.git
 
-ダウンロードしたら、./logalimacs/の中のlogalimacs.elを、あなたのパッケージを管理している所へ写すか、インストールした場所へパスを通してください(わからなければ雑多な設定の項へ)。その後に.emacsへの設定の項へ進んで下さい。
-
-logalimacsはpopwin.elとpopup.elを利用するとより便利になります。
-もし興味があれば、popwin.el,popup.el用の便利な設定を試して見て下さい。
+ダウンロードしたら、./logalimacs/の中へロードパスを通します。  
+次の.emacsへの設定をご覧下さい。  
 
 ## 4. .emacsへの設定
 
 あなたの設定用の.emacsへ(~/.emacs.d/init.elでもいいですし、他にload関数で読み込んだ所でもいいです)以下のように書込みます。
-これで、logalimacsを利用できるようになります。
-
-注意1: もしエラーが出るのであれば、閉じ括弧後ろでC-x C-e(または、M-x eval-last-sexp)をタイプする事で、その行を評価でき行単位でのチェックができます。
-注意2: キーバインド(kbd "ここの部分")は、あなたが使いやすい所に設定して下さい。
-
-
-	;;; keybinds
-	;; Emacs起動時から動作させる場合
-	(when (require 'logalimacs nil t)
-	(global-set-key (kbd "M-g M-i") 'loga-interactive-command)
-	(global-set-key (kbd "M-g M-l") 'loga-lookup-region-or-manually)
-	(global-set-key (kbd "M-g M-a") 'loga-add-word)
-	(global-set-key (kbd "C-:") 'loga-lookup-for-popup))
 
+    ;; "~/.emacs.d/package/hoge/以下にパスを通す場合
+    (add-to-list 'load-path "~/.emacs.d/package/hoge")
 
-## 5. popwin.el、popup.el用の設定
-
-注意:この設定を利用する為には、
-[_popwin.el_](https://github.com/m2ym/popwin-el)と[_popup.el_](https://github.com/m2ym/popup-el)が必要です。
-Emacs24経由でlogalimacsをインストールした場合は、自動で設定されます。
-
-	;; configuration for popwin.el
-	(require 'popwin)
-	(setq display-buffer-function 'popwin:display-buffer)
-	(setq popwin:special-display-config
-	      (append '(
-	            ("*logalimacs*" :position bottom :height 10 :noselect t :stick t)
-	            ;; if need to other configuration, add for like below:
-	            ;("*Backtrace*")
-	            )
-	          popwin:special-display-config))
+    ;;; keybinds
+    (when (require 'logalimacs nil t)
+      (global-set-key (kbd "M-g M-i") 'loga-interactive-command)
+      (global-set-key (kbd "M-g M-l") 'loga-lookup-at-manually)
+      (global-set-key (kbd "M-g M-a") 'loga-add)
+      (global-set-key (kbd "C-:") 'loga-lookup-in-popup))
 
 
-	;; configuration for popup.el
-	(require 'popup)
 
+注意1: もしエラーが出るのであれば、閉じ括弧後ろでC-x C-e(または、M-x eval-last-sexp)をタイプする事で、その行を評価でき行単位でのチェックができます。  
+注意2: キーバインド(kbd "ここの部分")は、あなたが使いやすい所に設定して下さい。  
+注意3: logalimacsは[_popwin.el_](https://github.com/m2ym/popwin-el)と[_popup.el_](https://github.com/m2ym/popup-el)を利用しています。githubからcloneしたファイルを移動する場合、これらも必要となります。  
 
 ## 6. 雑多な設定
 

  Modified: logalimacs/tutorial.md (+1 -3)
===================================================================
--- logalimacs/tutorial.md    2012-02-09 21:27:37 +0900 (d918cf9)
+++ logalimacs/tutorial.md    2012-02-10 13:59:04 +0900 (db1971a)
@@ -43,9 +43,7 @@ gene95とedictをインポートしただけでは通常表示されません。
 
 ### 方法1
 
-例えば、テレビで見た英単語の意味を調べる等、コピペではなくどうしても、自分で検索する用語を入力したい時は、`M-x loga-lookup-at-manually`と入力するか、インストールの項であったglobal-set-keyで自分で、loga-lookup-at-manuallyを登録したキーバインドを入力するとミニバッファに調べたい単語を聞かれるので、あなたが調べたい単語を入力して、入力が終わったらRETを押すとlogalingで検索され結果が\*logalimacs\*バッファに表示されます。  
-
-注意: Emacs23の方でもしpopwinの設定をしていない場合は、選択していないバッファに表示されますのでご注意ください。  
+例えば、テレビで見た英単語の意味を調べる等、コピペではなくどうしても、自分で検索する用語を入力したい時は、`M-x loga-lookup-at-manually`と入力するか、インストールの項であったglobal-set-keyで自分で登録したキーバインドを入力するとミニバッファに調べたい単語を聞かれるので、あなたが調べたい単語を入力して、入力が終わったらRETを押すとlogalingで検索され結果が\*logalimacs\*バッファに表示されます。  
 
 
 ![自分で入力して検索](/logalimacs/images/outputBuffer.png)




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