Skip to content

Commit

Permalink
Improve documents
Browse files Browse the repository at this point in the history
  • Loading branch information
crazymaster committed Aug 2, 2015
1 parent e1f9e2b commit acfefb7
Show file tree
Hide file tree
Showing 19 changed files with 111 additions and 91 deletions.
8 changes: 4 additions & 4 deletions doc/ku-ref.txt
Expand Up @@ -18,15 +18,15 @@ CHANGELOG |ku-ref-changelog|
==============================================================================
INTRODUCTION *ku-ref-introduction*

*ku-ref* is a source for |ku| to treat the completion list of |ref|.
*ku-ref* is a source for |ku| to treat the completion list of |ref.vim|.

- There is a heavy possibility according to |ref-sources|.


Requirements:
- Vim 7.2 or later
- |ku| 0.2.0 or later (vimscript#2337)
- |ref| 0.3.3 or later
- |ref.vim| 0.3.3 or later


==============================================================================
Expand Down Expand Up @@ -68,10 +68,10 @@ on_source_leave() |ku#{source}#on_source_leave()|
CHANGELOG *ku-ref-changelog*

0.2.1 2010-05-18
- Updated for |ref| 0.3.3.
- Updated for |ref.vim| 0.3.3.

0.2.0 2010-04-07
- Updated for |ref| 0.3.0.
- Updated for |ref.vim| 0.3.0.

0.1.0 2009-08-20
- Initial version.
Expand Down
6 changes: 3 additions & 3 deletions doc/ref-clojure.jax
Expand Up @@ -16,10 +16,10 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
==============================================================================
概要 *ref-clojure-introduction*

*ref-clojure* は clojure 用の |ref| のソースです。
*ref-clojure* は clojure 用の |ref.vim| のソースです。

Requirements:
- |ref| 0.4.1 以降
要件:
- |ref.vim| 0.4.1 以降
- clojure


Expand Down
16 changes: 8 additions & 8 deletions doc/ref-clojure.txt
Expand Up @@ -16,10 +16,10 @@ CHANGELOG |ref-clojure-changelog|
==============================================================================
INTRODUCTION *ref-clojure-introduction*

*ref-clojure* is a source for |ref| to clojure.
*ref-clojure* is a source for |ref.vim| to clojure.

Requirements:
- |ref| 0.4.1 or later
- |ref.vim| 0.4.1 or later
- clojure


Expand Down Expand Up @@ -54,17 +54,17 @@ b:ref_clojure_classpath *b:ref_clojure_classpath*
Specifies the $CLASSPATH by string or |List|.
|b:ref_clojure_classpath| is added ahead of the
|g:ref_clojure_classpath|.
When none of them are given ref-clojure automatically
adds the following line in order to enable using
doc and find-doc. >
(ns vim-ref (:use [clojure.repl :only (doc find-doc)]))

g:ref_clojure_precode *g:ref_clojure_precode*
b:ref_clojure_precode *b:ref_clojure_precode*
Specifies the code executed before searching.
It is assumed that "use" and "require" are specified.
|b:ref_clojure_classpath| is added after the value of
the |g:ref_clojure_classpath|.
|b:ref_clojure_precode| is added after the value of
the |g:ref_clojure_precode|.
When none of them are given ref-clojure automatically
adds the following line in order to enable using
doc and find-doc. >
(ns vim-ref (:use [clojure.repl :only (doc find-doc)]))
g:ref_clojure_overview *g:ref_clojure_overview*
If true, each function of the search result is
Expand Down
8 changes: 4 additions & 4 deletions doc/ref-erlang.jax
Expand Up @@ -17,13 +17,13 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
==============================================================================
概要 *ref-erlang-introduction*

*ref-erlang* は Erlang の man(erl -man) を閲覧するための |ref| のソースです。
Erlang の man は Unix 系 OS でのみ動作します。よって、このソースも Unix 系 OS
のみをサポートします
*ref-erlang* は Erlang の man(erl -man) を閲覧するための |ref.vim| のソースで
す。Erlang の man は Unix 系 OS でのみ動作します。よって、このソースも Unix 系
OSのみをサポートします


要件:
- |ref| 0.4.1 以降
- |ref.vim| 0.4.1 以降
- |ref-man| 0.4.1 or later
- UNIX 系 OS

Expand Down
8 changes: 4 additions & 4 deletions doc/ref-erlang.txt
Expand Up @@ -17,13 +17,13 @@ CHANGELOG |ref-erlang-changelog|
==============================================================================
INTRODUCTION *ref-erlang-introduction*

*ref-erlang* is a source for |ref| to Erlang's man(erl -man). Erlang's man
works only on UNIX-like operating system. So, this source supports similarly
only UNIX-like operating system.
*ref-erlang* is a source for |ref.vim| to Erlang's man(erl -man). Erlang's
man works only on UNIX-like operating system. So, this source supports
similarly only UNIX-like operating system.


Requirements:
- |ref| 0.4.1 or later
- |ref.vim| 0.4.1 or later
- |ref-man| 0.4.1 or later
- UNIX-like operating system

Expand Down
19 changes: 11 additions & 8 deletions doc/ref-man.jax
Expand Up @@ -10,23 +10,22 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス

概要 |ref-man-introduction|
カスタマイズ |ref-man-customizing|
バグ |ref-man-bugs|
更新履歴 |ref-man-changelog|


==============================================================================
概要 *ref-man-introduction*

*ref-man* は man コマンド用の |ref| ソースです。man は Unix 系 OS でオンライン
マニュアルを表示するコマンドです
*ref-man* は man コマンド用の |ref.vim| ソースです。man は Unix 系 OS でオン
ラインマニュアルを表示するコマンドです

|<Plug>(ref-keyword)| を使う際には、[count] が利用できます。
例えば、"printf" というテキストの上で "3K" とタイプすると、printf 関数の
manpage が開かれるでしょう。


要件:
- |ref| 0.4.0 以降
- |ref.vim| 0.4.0 以降
- man


Expand All @@ -46,6 +45,10 @@ g:ref_man_cmd *g:ref_man_cmd*
g:ref_man_lang *g:ref_man_lang*
空文字列以外を指定した場合、$LANG の値に使われます。

g:ref_man_manpath *g:ref_man_manpath*
man pages の検索を行うディレクトリのリストを指定しま
す。ディレクトリはコロンで区切ります。



==============================================================================
Expand All @@ -62,7 +65,7 @@ g:ref_man_lang *g:ref_man_lang*
- filetype c に対して man を登録するようにした。

0.4.0 2010-05-31
- |ref| 0.4.0 に対応。
- |ref.vim| 0.4.0 に対応。
- |vimproc| を使わないようにした。
- man は setuid されていることがあるが、vimproc は setuid に対応して
いないため。
Expand All @@ -74,14 +77,14 @@ g:ref_man_lang *g:ref_man_lang*
- いくつかのマルチバイト記号をアスキー文字に置き換えるようにした。

0.3.1 2010-05-07
- |ref| 0.3.2 に対応。
- |ref.vim| 0.3.2 に対応。

0.3.0 2010-04-15
- |ref| 0.3.0 に対応。
- |ref.vim| 0.3.0 に対応。
- |g:ref_man_lang| オプションを追加。

0.2.0 2010-01-28
- |ref| 0.2.0 に対応。
- |ref.vim| 0.2.0 に対応。
- |g:ref_man_cmd||List| だと動作しないバグを修正。

0.1.3 2010-01-18
Expand Down
13 changes: 6 additions & 7 deletions doc/ref-man.txt
Expand Up @@ -10,14 +10,13 @@ CONTENTS *ref-man-contents*

INTRODUCTION |ref-man-introduction|
CUSTOMIZING |ref-man-customizing|
BUGS |ref-man-bugs|
CHANGELOG |ref-man-changelog|


==============================================================================
INTRODUCTION *ref-man-introduction*

*ref-man* is a source for |ref| to man command. man is a command to view
*ref-man* is a source for |ref.vim| to man command. man is a command to view
manual pages on UNIX-like operating systems.

You can use [count] when you use |<Plug>(ref-keyword)|.
Expand All @@ -26,7 +25,7 @@ function will be opened.


Requirements:
- |ref| 0.4.0 or later
- |ref.vim| 0.4.0 or later
- man


Expand Down Expand Up @@ -68,7 +67,7 @@ CHANGELOG *ref-man-changelog*
- C language uses ref-man by default.

0.4.0 2010-05-31
- Updated for |ref| 0.4.0.
- Updated for |ref.vim| 0.4.0.
- Don't use |vimproc|.
- As for man command, setuid might be applied, but vimproc doesn't
correspond setuid.
Expand All @@ -80,14 +79,14 @@ CHANGELOG *ref-man-changelog*
- Some multi byte signs were replaced with ASCII character.

0.3.1 2010-05-07
- Updated for |ref| 0.3.2.
- Updated for |ref.vim| 0.3.2.

0.3.0 2010-04-15
- Updated for |ref| 0.3.0.
- Updated for |ref.vim| 0.3.0.
- Added |g:ref_man_lang| option.

0.2.0 2010-01-28
- Updated for |ref| 0.2.0.
- Updated for |ref.vim| 0.2.0.
- Fixed a bug that doesn't work when |g:ref_man_cmd| is a |List|.

0.1.3 2010-01-18
Expand Down
14 changes: 8 additions & 6 deletions doc/ref-perldoc.jax
Expand Up @@ -9,6 +9,8 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
目次 *ref-perldoc-contents*

概要 |ref-perldoc-introduction|
インターフェース |ref-perldoc-interface|
キーマッピング |ref-perldoc-key-mappings|
カスタマイズ |ref-perldoc-customizing|
引数 |ref-perldoc-arguments|
変数 |ref-perldoc-variables|
Expand All @@ -19,12 +21,12 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
==============================================================================
概要 *ref-perldoc-introduction*

*ref-perldoc* は perldoc コマンド用の |ref| のソースです。perldoc は Perl のリ
ファレンスマニュアルを見るためのコマンドラインツールです
*ref-perldoc* は perldoc コマンド用の |ref.vim| のソースです。perldoc は Perl
のリファレンスマニュアルを見るためのコマンドラインツールです


要件:
- |ref| 0.3.2 以降
- |ref.vim| 0.3.2 以降
- perldoc


Expand Down Expand Up @@ -128,14 +130,14 @@ b:ref_perldoc_word *b:ref_perldoc_word*
- 補完候補にないモジュールも探すようにした。

0.3.1 2010-05-07
- |ref| 0.3.2 に対応。
- |ref.vim| 0.3.2 に対応。

0.3.0 2010-04-18
- |ref| 0.3.0 に対応。
- |ref.vim| 0.3.0 に対応。
- |g:ref_perldoc_complete_head| オプションを追加。

0.2.0 2010-01-28
- |ref| 0.2.0 に対応。
- |ref.vim| 0.2.0 に対応。
- -f オプションが使えないバグを修正。
- |g:ref_perldoc_cmd||List| だと動作しないバグを修正。

Expand Down
14 changes: 8 additions & 6 deletions doc/ref-perldoc.txt
Expand Up @@ -9,6 +9,8 @@ License: Creative Commons Attribution 2.1 Japan License
CONTENTS *ref-perldoc-contents*

INTRODUCTION |ref-perldoc-introduction|
INTERFACE |ref-perldoc-interface|
KEY MAPPINGS |ref-perldoc-key-mappings|
CUSTOMIZING |ref-perldoc-customizing|
ARGUMENTS |ref-perldoc-arguments|
VARIABLES |ref-perldoc-variables|
Expand All @@ -19,12 +21,12 @@ CHANGELOG |ref-perldoc-changelog|
==============================================================================
INTRODUCTION *ref-perldoc-introduction*

*ref-perldoc* is a source for |ref| to perldoc command. perldoc is a command
line tool to view the reference manual on Perl.
*ref-perldoc* is a source for |ref.vim| to perldoc command. perldoc is a
command line tool to view the reference manual on Perl.


Requirements:
- |ref| 0.3.2 or later
- |ref.vim| 0.3.2 or later
- perldoc


Expand Down Expand Up @@ -132,14 +134,14 @@ CHANGELOG *ref-perldoc-changelog*
- Look for the module also that the completion candidate doesn't have.

0.3.1 2010-05-07
- Updated for |ref| 0.3.2.
- Updated for |ref.vim| 0.3.2.

0.3.0 2010-04-18
- Updated for |ref| 0.3.0.
- Updated for |ref.vim| 0.3.0.
- Added |g:ref_perldoc_complete_head| option.

0.2.0 2010-01-28
- Updated for |ref| 0.2.0.
- Updated for |ref.vim| 0.2.0.
- Fixed a bug that doesn't work the -f option.
- Fixed a bug that doesn't work when |g:ref_perldoc_cmd| is a |List|.

Expand Down
10 changes: 5 additions & 5 deletions doc/ref-phpmanual.jax
Expand Up @@ -16,11 +16,11 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
==============================================================================
概要 *ref-phpmanual-introduction*

*ref-phpmanual* は PHP マニュアル用の |ref| のソースです。
*ref-phpmanual* は PHP マニュアル用の |ref.vim| のソースです。


要件:
- |ref| 0.3.2 以降
- |ref.vim| 0.3.2 以降
- PHP Manual (Many HTML files) (http://php.benscom.com/download-docs.php)


Expand Down Expand Up @@ -48,13 +48,13 @@ g:ref_phpmanual_cmd *g:ref_phpmanual_cmd*
更新履歴 *ref-phpmanual-changelog*

0.3.1 2010-05-07
- |ref| 0.3.2 に対応。
- |ref.vim| 0.3.2 に対応。

0.3.0 2010-04-18
- |ref| 0.3.0 に対応。
- |ref.vim| 0.3.0 に対応。

0.2.0 2010-01-28
- |ref| 0.2.0 に対応。
- |ref.vim| 0.2.0 に対応。
- |g:ref_phpmanual_cmd||List| だと動作しないバグを修正。
- クエリが空の際にリストを表示するようにした。
- コマンドの実行がうまくいかないことがあるバグを修正。
Expand Down
10 changes: 5 additions & 5 deletions doc/ref-phpmanual.txt
Expand Up @@ -16,11 +16,11 @@ CHANGELOG |ref-phpmanual-changelog|
==============================================================================
INTRODUCTION *ref-phpmanual-introduction*

*ref-phpmanual* is a source for |ref| for PHP manual.
*ref-phpmanual* is a source for |ref.vim| for PHP manual.


Requirements:
- |ref| 0.3.2 or later
- |ref.vim| 0.3.2 or later
- PHP Manual (Many HTML files) (http://php.benscom.com/download-docs.php)


Expand Down Expand Up @@ -49,13 +49,13 @@ g:ref_phpmanual_cmd *g:ref_phpmanual_cmd*
CHANGELOG *ref-phpmanual-changelog*

0.3.1 2010-05-07
- Updated for |ref| 0.3.2.
- Updated for |ref.vim| 0.3.2.

0.3.0 2010-04-18
- Updated for |ref| 0.3.0.
- Updated for |ref.vim| 0.3.0.

0.2.0 2010-01-28
- Updated for |ref| 0.2.0.
- Updated for |ref.vim| 0.2.0.
- Fixed a bug that doesn't work when |g:ref_phpmanual_cmd| is a
|List|.
- Show the list when query is empty.
Expand Down

0 comments on commit acfefb7

Please sign in to comment.