Permalink
Browse files

Merge pull request #59 from crazymaster/doc

Improve documents
  • Loading branch information...
2 parents a1f5d40 + d95dc33 commit ff743ab0c3fb596951a78253f83a11bc18ac79ae @thinca committed Aug 6, 2015
Showing with 133 additions and 8 deletions.
  1. +4 −2 doc/ref-clojure.jax
  2. +4 −2 doc/ref-clojure.txt
  3. +1 −0 doc/ref-phpmanual.jax
  4. +1 −1 doc/ref-phpmanual.txt
  5. +1 −1 doc/ref-refe.jax
  6. +1 −1 doc/ref-refe.txt
  7. +4 −1 doc/ref-webdict.jax
  8. +111 −0 doc/ref-webdict.txt
  9. +3 −0 doc/ref.jax
  10. +3 −0 doc/ref.txt
View
@@ -44,8 +44,10 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
g:ref_clojure_cmd *g:ref_clojure_cmd*
clojure のコマンドを指定します。コマンドとその引数を含
む|List| も指定できます。
- デフォルト値は、実行可能ならば "clj" です。そうでなけ
- れば "" です。
+ デフォルト値は以下の物でコマンドが実行可能なものです。
+ 実行可能なものがない場合は "" です。
+ - 'clj'
+ - 'clojure-1.5'
設定例: >
['java', '-cp', 'clojure.jar' 'clojure.main']
View
@@ -44,8 +44,10 @@ CUSTOMIZING *ref-clojure-customizing*
g:ref_clojure_cmd *g:ref_clojure_cmd*
Specifies the clojure command. This allows a |List|
that includes command and arguments.
- The default value is "clj" if it is executable.
- Otherwise, it is "".
+ The default value is the executable one of the
+ following. If no executable one, it is "".
+ - 'clj'
+ - 'clojure-1.5'
Example: >
['java', '-cp', 'clojure.jar' 'clojure.main']
@@ -37,6 +37,7 @@ g:ref_phpmanual_cmd *g:ref_phpmanual_cmd*
に置き換えられます。コマンドとその引数を含む |List| も
指定できます。
デフォルト値は以下の物でコマンドが実行可能なものです。
+ 実行可能なものがない場合は "" です。
- 'elinks -dump -no-numbering -no-references %s'
- 'w3m -dump %s'
- 'links -dump %s'
@@ -37,7 +37,7 @@ g:ref_phpmanual_cmd *g:ref_phpmanual_cmd*
the html file name. This allows a |List| that
includes command and arguments.
The default value is the executable one of the
- following:
+ following. If no executable one, it is "".
- 'elinks -dump -no-numbering -no-references %s'
- 'w3m -dump %s'
- 'links -dump %s'
View
@@ -23,7 +23,7 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
要件:
- |ref.vim| 0.4.0 以降
-- ReFe (http://i.loveruby.net/ja/prog/refe.html)
+- ReFe (http://docs.ruby-lang.org/ja/2.2.0/doc/ReFe.html)
オプション:
- |ref-man|
View
@@ -23,7 +23,7 @@ tool to view the reference manual of Ruby.
Requirements:
- |ref.vim| 0.4.0 or later
-- ReFe (http://i.loveruby.net/en/projects/refe/)
+- ReFe (http://docs.ruby-lang.org/ja/2.2.0/doc/ReFe.html)
Optional:
- |ref-man|
View
@@ -26,6 +26,7 @@ License: zlib License
- w3m
- links
- lynx
+ - wwwrenderer-vim (https://github.com/mattn/wwwrenderer-vim)
@@ -77,11 +78,13 @@ g:ref_source_webdict_sites *g:ref_source_webdict_sites*
g:ref_source_webdict_cmd *g:ref_source_webdict_cmd*
Webページを表示するためのコマンドです。%s はキーワードを引くための url
に置き換えられます。コマンドとその引数を含む |List| も指定できます。
- デフォルト値は以下の物でコマンドが実行可能なものです。
+ デフォルト値は以下の物でコマンドが実行可能なものです。実行可能なものが
+ ない場合は "" です。
- 'elinks -dump -no-numbering -no-references %s'
- 'w3m -dump %s'
- 'links -dump %s'
- 'lynx -dump -nonumbers %s'
+ - '=wwwrenderer#render("%s")'
g:ref_source_webdict_encoding *g:ref_source_webdict_encoding*
|g:ref_source_webdict_cmd| で指定したコマンドの出力のエンコードを指定
View
@@ -0,0 +1,111 @@
+*ref-webdict.txt* A ref source for Web dict.
+
+Version: 1.0
+Author : thinca <thinca+vim@gmail.com>
+License: zlib License
+
+==============================================================================
+CONTENTS *ref-webdict-contents*
+
+INTRODUCTION |ref-webdict-introduction|
+ARGUMENTS |ref-webdict-arguments|
+CUSTOMIZING |ref-webdict-customizing|
+CHANGELOG |ref-webdict-changelog|
+
+
+
+==============================================================================
+INTRODUCTION *ref-webdict-introduction*
+
+*ref-webdict* is a source for |ref.vim| to manipulate the dictionary on Web.
+
+Requirements:
+- |ref.vim| 0.3.2 or later
+- Optional text browser
+ - elinks
+ - w3m
+ - links
+ - lynx
+ - wwwrenderer-vim (https://github.com/mattn/wwwrenderer-vim)
+
+
+
+==============================================================================
+ARGUMENTS *ref-webdict-arguments*
+
+For this source, specify the setting name of a using site and the keyword that
+you want to look up. For a name, see |g:ref_source_webdict_sites|. >
+
+ :Ref webdict {site-name} {keyword}
+
+If you specify "default" for |g:ref_source_webdict_sites|, or if {site-name}
+is omitted and {keyword} doesn't match an existing {site-name}, the value of
+"default" is used as {site-name}. >
+
+ :Ref webdict {keyword}
+
+
+
+==============================================================================
+CUSTOMIZING *ref-webdict-customizing*
+
+g:ref_source_webdict_sites *g:ref_source_webdict_sites*
+ Specify the using Web dictionary by a dict variable. Put the name of
+ setting for a key, specify the URL or the dictionary having the
+ following key for a value.
+
+ "url"
+ A URL for the Web dictionary. %s is replaced by a keyword.
+ "keyword_encoding"
+ Encoding for the keyword. If not specified, "utf-8" is used.
+ "output_encoding"
+ Encoding for output. If not specified,
+ |g:ref_source_webdict_encoding| is used.
+ "cache"
+ Whether cache the page you opened once. If not specified,
+ |g:ref_source_webdict_use_cache| is used.
+ "filter"
+ |Funcref| to format output. The function gets output as
+ arguments.
+ "line"
+ Focus the line number when you open a buffer.
+
+ Specify the name putting a key of each setting for the head of
+ arguments.
+ If specify "default" for a key and put the name of a setting for a
+ value by string, it is used when a site name is omitted. For more
+ detail, see |ref-webdict-arguments|.
+
+g:ref_source_webdict_cmd *g:ref_source_webdict_cmd*
+ A command to show the Web page. %s is replaced by the url to look up
+ a keyword. This allows a |List| that includes command and arguments.
+ The default value is the executable one of the following. If no
+ executable one, it is "".
+ - 'elinks -dump -no-numbering -no-references %s'
+ - 'w3m -dump %s'
+ - 'links -dump %s'
+ - 'lynx -dump -nonumbers %s'
+ - '=wwwrenderer#render("%s")'
+
+g:ref_source_webdict_encoding *g:ref_source_webdict_encoding*
+ Put a encoding for the command output specified with
+ |g:ref_source_webdict_cmd|. When this variable is empty, output isn't
+ converted.
+ The default value is 'termencoding'.
+
+g:ref_source_webdict_use_cache *g:ref_source_webdict_use_cache*
+ Cache the page you opened once.
+ The default value is 0.
+
+
+
+==============================================================================
+CHANGELOG *ref-webdict-changelog*
+
+1.0 2012-05-12
+ - Initial version.
+
+
+
+==============================================================================
+vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl
View
@@ -39,6 +39,9 @@ License: クリエイティブ・コモンズの表示 2.1 日本ライセンス
- rfc
- webdict (|ref-webdict.txt|)
+標準添付以外のソースの一覧:
+https://github.com/thinca/vim-ref/wiki/sources
+
他のインターフェースも利用できます:
- ku-ref (|ku-ref.txt|)
- unite-ref (|unite-ref.txt|)
View
@@ -39,6 +39,9 @@ Following sources are included in this plugin:
- rfc
- webdict (|ref-webdict.txt|)
+External sources list:
+https://github.com/thinca/vim-ref/wiki/sources
+
Other interfaces are also available:
- ku-ref (|ku-ref.txt|)
- unite-ref (|unite-ref.txt|)

0 comments on commit ff743ab

Please sign in to comment.