diff --git a/doc/changes.md b/doc/changes.md index b9c9bf7..7dbbd1f 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -4,13 +4,13 @@ ## New Options {#new-options_v1.4} -* [`ac-use-dictionary-as-stop-words`](manual.html#ac-use-dictionary-as-stop-words) -* [`ac-non-trigger-commands`](manual.html#ac-non-trigger-commands) +* [`ac-use-dictionary-as-stop-words`](manual.md#ac-use-dictionary-as-stop-words) +* [`ac-non-trigger-commands`](manual.md#ac-non-trigger-commands) ## New Sources {#new-sources_v1.4} -* [`ac-source-ghc-mod`](manual.html#ac-source-ghc-mod) -* [`ac-source-slime`](manual.html#ac-source-slime) +* [`ac-source-ghc-mod`](manual.md#ac-source-ghc-mod) +* [`ac-source-slime`](manual.md#ac-source-slime) ## New Dictionaries {#new-dictionaries_v1.4} @@ -24,7 +24,7 @@ * Fixed help-mode error ("help-setup-xref: Symbol's value as variable is void: help-xref-following") * Fixed auto-complete couldn't use pos-tip on Windows -* [Added workaround for linum-mode displaying bug](manual.html#linum-mode-bug) +* [Added workaround for linum-mode displaying bug](manual.md#linum-mode-bug) # v1.3.1 Changes {#changes_v1.3.1} @@ -42,20 +42,20 @@ Major changes in v1.3. ## New Options {#new-options_v1.3} -* [`ac-disable-faces`](manual.html#ac-disable-faces) -* [`ac-show-menu-immediately-on-auto-complete`](manual.html#ac-show-menu-immediately-on-auto-complete) -* [`ac-expand-on-auto-complete`](manual.html#ac-expand-on-auto-complete) -* [`ac-use-menu-map`](manual.html#ac-use-menu-map) +* [`ac-disable-faces`](manual.md#ac-disable-faces) +* [`ac-show-menu-immediately-on-auto-complete`](manual.md#ac-show-menu-immediately-on-auto-complete) +* [`ac-expand-on-auto-complete`](manual.md#ac-expand-on-auto-complete) +* [`ac-use-menu-map`](manual.md#ac-use-menu-map) ## New Sources {#new-sources_v1.3} -* [`ac-source-semantic-raw`](manual.html#ac-source-semantic-raw) -* [`ac-source-css-property`](manual.html#ac-source-css-property) +* [`ac-source-semantic-raw`](manual.md#ac-source-semantic-raw) +* [`ac-source-css-property`](manual.md#ac-source-css-property) ## New Source Properties {#new-source-properties_v1.3} -* [`summary`](manual.html#summary) -* [`available`](manual.html#available) +* [`summary`](manual.md#summary) +* [`available`](manual.md#available) ## New Dictionaries {#new-dictionaries_v1.3} @@ -74,7 +74,7 @@ Major changes in v1.3. ## Others {#others-v1.3} * Improved word completion performance (#18) -* Cooperate with [pos-tip.el](manual.html#show-help-beautifully) +* Cooperate with [pos-tip.el](manual.md#show-help-beautifully) * Yasnippet 0.61 support * Fix many bugs @@ -84,37 +84,37 @@ Major changes in v1.2 since v1.0. ## New Features {#new-features_v1.2} -* [Completion by Fuzzy Matching](manual.html#completion-by-fuzzy-matching) -* [Completion by Dictionary](manual.html#completion-by-dictionary) -* [Incremental Filtering](manual.html#filtering-completion-candidates) -* [Intelligent Candidate Suggestion](manual.html#candidate-suggestion) -* [Trigger Key](manual.html#trigger-key) -* [Help](manual.html#Help) +* [Completion by Fuzzy Matching](manual.md#completion-by-fuzzy-matching) +* [Completion by Dictionary](manual.md#completion-by-dictionary) +* [Incremental Filtering](manual.md#filtering-completion-candidates) +* [Intelligent Candidate Suggestion](manual.md#candidate-suggestion) +* [Trigger Key](manual.md#trigger-key) +* [Help](manual.md#Help) ## New Commands {#new-commands_v1.2} -* [`auto-complete`](manual.html#auto-complete-command) +* [`auto-complete`](manual.md#auto-complete-command) ## New Options {#new-options_v1.2} -* [`ac-delay`](manual.html#ac-delay) -* [`ac-auto-show-menu`](manual.html#ac-auto-show-menu) -* [`ac-use-fuzzy`](manual.html#ac-use-fuzzy) -* [`ac-use-comphist`](manual.html#ac-use-comphist) -* [`ac-ignores`](manual.html#ac-ignores) -* [`ac-ignore-case`](manual.html#ac-ignore-case) -* [`ac-mode-map`](manual.html#ac-mode-map) +* [`ac-delay`](manual.md#ac-delay) +* [`ac-auto-show-menu`](manual.md#ac-auto-show-menu) +* [`ac-use-fuzzy`](manual.md#ac-use-fuzzy) +* [`ac-use-comphist`](manual.md#ac-use-comphist) +* [`ac-ignores`](manual.md#ac-ignores) +* [`ac-ignore-case`](manual.md#ac-ignore-case) +* [`ac-mode-map`](manual.md#ac-mode-map) ## New Sources {#new-sources_v1.2} -* [`ac-source-dictionary`](manual.html#ac-source-dictionary) +* [`ac-source-dictionary`](manual.md#ac-source-dictionary) ## Changed Behaviors {#changed-behaviors_v1.2} * Completion is now delayed to start - ([`ac-delay`](manual.html#ac-delay)) + ([`ac-delay`](manual.md#ac-delay)) * Completion menu is now delayed to show - ([`ac-auto-show-menu`](manual.html#ac-auto-show-menu)) + ([`ac-auto-show-menu`](manual.md#ac-auto-show-menu)) ## Others {#others_v1.2} diff --git a/doc/manual.md b/doc/manual.md index 386e3b3..f571128 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -80,7 +80,7 @@ Inputting characters is basic. Completions will never be shown without any character. So when completion will be started, what character causes completion to be started? It is a good question but it is difficult to answer here. In simple words, completion will be started -when a character is inserted. See [`ac-trigger-commands`][] for more +when a character is inserted. See [`ac-trigger-commands`](#ac-trigger-commands) for more details. ![Inputting Characters](ac.png) @@ -140,7 +140,7 @@ is not bad idea to remember how to select candidates. Selecting candidates is not a complex operation. You can select candidates forward or backward by cursor key or `M-p` and `M-n`. According to settings, a behavior of completion by TAB will be -changed as a behavior of completion by RET. See [`ac-dwim`]() for more +changed as a behavior of completion by RET. See [`ac-dwim`](#ac-dwim) for more details. There are other ways to select candidates. `M-1` to select candidate @@ -153,8 +153,8 @@ There are other ways to select candidates. `M-1` to select candidate displaying. Quick help will appear at the side of completion menu, so you can easily see that, but there is a problem if there is no space to display the help. Quick help will be shown automatically. To use -quick help, you need to set [`ac-use-quick-help`][] to `t`. Delay time -to show quick help is given by [`ac-quick-help-delay`][]. +quick help, you need to set [`ac-use-quick-help`](#ac-use-quick-help) to `t`. Delay time +to show quick help is given by [`ac-quick-help-delay`](#ac-quick-help-delay). On the other side, buffer help will not be shown without any instructions from users. Buffer help literally displays help in a @@ -208,14 +208,14 @@ original automatic completion. * Case that no candidates remains Attempt to complete with fuzzy matching. See - [Completion by Fuzzy Matching][] for more details. + [Completion by Fuzzy Matching](#completion-by-fuzzy-matching) for more details. * Otherwise Otherwise start completion with/without expanding a whole common part and showing completion menu. See also - [`ac-show-menu-immediately-on-auto-complete`][] and - [`ac-expand-on-auto-complete`][]. + [`ac-show-menu-immediately-on-auto-complete`](#ac-show-menu-immediately-on-auto-complete) and + [`ac-expand-on-auto-complete`](#ac-expand-on-auto-complete). ## Completion by Fuzzy Matching @@ -268,8 +268,8 @@ key is used with `ac-auto-start` being `nil`. (setq ac-auto-start nil) ``` -As of `ac-auto-start`, see [Not to complete automatically][] or -[`ac-auto-start`][] for more details. +As of `ac-auto-start`, see [Not to complete automatically](#not-to-complete-automatically) or +[`ac-auto-start`](#ac-auto-start) for more details. ## Candidate Suggestion @@ -306,7 +306,7 @@ top after `find-` as it seems to learn from users' operations. Dictionary is a simple list of string. There is three types of dictionary: user defined dictionary, major mode dictionary, and extension dictionary. You need to add `ac-source-dictionary` to -`ac-sources` (default). See [Source][] for more details. +`ac-sources` (default). See [Source](#source) for more details. ### User Defined Dictionary# @@ -352,7 +352,7 @@ adding to `ac-user-dictionary-files`. You can use other dictionaries for every major-modes and extensions. A dictionary will loaded from a directory specified with `ac-dictionary-directories`. `ac-dictionary-directories` may be the -following setting if you followed [Installation][] instructions. +following setting if you followed [Installation](#installation) instructions. ```emacs-lisp (add-to-list 'ac-dictionary-directories "~/.emacs.d/ac-dict") @@ -381,7 +381,7 @@ changes. * How to show Anybody who knows a little Emacs Lisp can define a source easily. See -[Extend][] for how to define a source. Here we will explain how to use +[Extend](#extend) for how to define a source. Here we will explain how to use built-in sources. Usually a source name starts with `ac-source-`. So you can list @@ -470,7 +470,7 @@ default value of `ac-sources` by registering a hook for that adds `ac-source-filename` to the first of `ac-sources` by default. So all `auto-complete-mode` enabled buffer will have `ac-source-filename` at the first of `ac-sources`. A reason why adding -to the first is relating to [Omni Completion][]. Anyway you don't care +to the first is relating to [Omni Completion](#omni-completion). Anyway you don't care about it here. So if you want to change `ac-sources` of all buffer, you can redefine `ac-common-setup` function to do that. @@ -496,7 +496,7 @@ A source for CSS property. ### `ac-source-dictionary` -A source for dictionary. See [Completion by Dictionary][] about +A source for dictionary. See [Completion by Dictionary](#completion-by-dictionary) about dictionary. ### `ac-source-eclim` @@ -563,7 +563,7 @@ A source for completing Emacs Lisp symbols. ### `ac-source-words-in-all-buffer` A source for completing words in all buffer. Unlikely -[`ac-source-words-in-same-mode-buffers`][], it doesn't regard +[`ac-source-words-in-same-mode-buffers`](#ac-source-words-in-same-mode-buffers), it doesn't regard major-mode. ### `ac-source-words-in-buffer` @@ -625,15 +625,15 @@ completion candidates, because there will be so many candidates necessarily. If you feel `auto-complete-mode` is stalling, change `ac-auto-start` to a larger number or `nil`. -See [`ac-auto-start`][] for more details. +See [`ac-auto-start`](#ac-auto-start) for more details. -And consider to use [Trigger Key][]. +And consider to use [Trigger Key](#trigger-key). ## Not to show completion menu automatically There is another approach to solve the annoying problem is that not to show completion menu automatically. Not to show completion menu -automatically, set [`ac-auto-show-menu`][] to `nil`. +automatically, set [`ac-auto-show-menu`](#ac-auto-show-menu) to `nil`. ```emacs-lisp (setq ac-auto-show-menu nil) @@ -699,7 +699,7 @@ completion menu which is enabled when `ac-use-menu-map` is `t`. (define-key ac-menu-map "\C-p" 'ac-previous) ``` -See [`ac-use-menu-map`][] and [`ac-menu-map`][] for more details. +See [`ac-use-menu-map`](#ac-use-menu-map) and [`ac-menu-map`](#ac-menu-map) for more details. ## Not to use quick help @@ -783,7 +783,7 @@ use `set-face-underline`. ## Change default sources -Read [Source][] first if you don't familiar with sources. To change +Read [Source](#source) first if you don't familiar with sources. To change default of sources, use `setq-default`: ```emacs-lisp @@ -820,7 +820,7 @@ like: Generally, such commands will be automatically available when sources are defined. Assume that a source named `ac-source-foobar` is being defined for example, a command called `ac-complete-foobar` will be -also defined automatically. See also [Builtin Sources][] for available +also defined automatically. See also [Builtin Sources](#builtin-sources) for available commands. If you want to use multiple sources for a command, you need to define @@ -911,17 +911,17 @@ Whether or not to stop Flymake on completion. ## `ac-use-fuzzy` -Whether or not to use [fuzzy matching](#Completion_by_Fuzzy_Matching). +Whether or not to use [fuzzy matching](#completion-by-fuzzy-matching). ## `ac-fuzzy-cursor-color` Change cursor color to specified color when -[Completion by Fuzzy Matching][] is started. `nil` means never +[Completion by Fuzzy Matching](#completion-by-fuzzy-matching) is started. `nil` means never changed. Available colors can be seen with `M-x list-colors-display`. ## `ac-use-comphist` -Whether or not to use [Candidate Suggestion][]. `nil` means never +Whether or not to use [Candidate Suggestion](#candidate-suggestion). `nil` means never using it and get performance better maybe. ## `ac-comphist-threshold` @@ -931,7 +931,7 @@ whole scores. ## `ac-comphist-file` -Specify a file stores data of [Candidate Suggestion][]. +Specify a file stores data of [Candidate Suggestion](#candidate-suggestion). ## `ac-use-quick-help` @@ -983,12 +983,12 @@ automatically. `self-insert-command` is one of default. ## `ac-trigger-commands-on-completing` -Same as [`ac-trigger-commands`][] expect this will be used on +Same as [`ac-trigger-commands`](#ac-trigger-commands) expect this will be used on completing. ## `ac-trigger-key` -Specify a [Trigger Key][]. +Specify a [Trigger Key](#trigger-key). ## `ac-auto-start` @@ -1055,21 +1055,21 @@ general. ## `ac-user-dictionary` Specify a dictionary as a list of string for -[Completion by Dictionary][]. +[Completion by Dictionary](#completion-by-dictionary). ## `ac-user-dictionary-files` Specify a dictionary files as a list of string for -[Completion by Dictionary][]. +[Completion by Dictionary](#completion-by-dictionary). ## `ac-dictionary-directories` Specify a dictionary directories as a list of string for -[Completion by Dictionary][]. +[Completion by Dictionary](#completion-by-dictionary). ## `ac-sources` -Specify sources as a list of [Source][]. This is a buffer local +Specify sources as a list of [Source](#source). This is a buffer local variable. ## `ac-completing-map` @@ -1079,7 +1079,7 @@ Keymap for completion. ## `ac-menu-map` Keymap for completion on completion menu. See also -[`ac-use-menu-map`][]. +[`ac-use-menu-map`](#ac-use-menu-map). ## `ac-mode-map` @@ -1088,7 +1088,7 @@ Keymap for `auto-complete-mode` enabled buffers. # Extend A meaning to extend `auto-complete-mode` is just defining a -[Source][]. This section describe how to define a source. +[Source](#source). This section describe how to define a source. ## Prototype @@ -1105,7 +1105,7 @@ by combining pairs of defined property and its value. ## Example -The most important property for source is [`candidates`][] +The most important property for source is [`candidates`](#candidates) property. This property describes how to generate completion candidates by giving a function, an expression, or a variable. A result of evaluation should be a list of strings. Here is an example @@ -1230,7 +1230,7 @@ functionality. ## Action -[Completion by RET][] will evaluate a function or an expression +[Completion by RET](#completion-by-ret) will evaluate a function or an expression specified in `action` property. A builtin sources `ac-source-abbrev` and `ac-source-yasnippet` use this property. @@ -1269,7 +1269,7 @@ of group 1 or group 0 as a beginning point of completion target string by doing `re-search-backward`[^1] with the regexp. If you want to do more complicated, use a function or an expression instead. The beginning point that is evaluated here will be stored into -[`ac-point`][]. In above example, regexp is enough. +[`ac-point`](#ac-point). In above example, regexp is enough. ``` ^To: \(.*\) @@ -1320,7 +1320,7 @@ compatibility, it is difficult to answer which you should use `defvar` and `ac-define-source`. Builtin sources are defined with `ac-define-sources`, so you can use them alone by binding some key to these commands such like `ac-complete-filename`. See also -[Completion with specific source][]. +[Completion with specific source](#completion-with-specific-sourc). ### Source Properties @@ -1332,13 +1332,13 @@ completion is started. #### `candidates` Specify a function, an expression, or a variable to calculate -candidates. Candidates should be a list of string. If [`cache`][] +candidates. Candidates should be a list of string. If [`cache`](#cache-1) property is enabled, this property will be ignored twice or later. ### `prefix` Specify a regexp, a function, or an expression to find a point of -completion target string for [Omni Completion][]. This +completion target string for [Omni Completion](#omni-completion). This source will be ignored when `nil` returned. If a regexp is specified, a start point of group 1 or group 2 will be used as a value. @@ -1346,12 +1346,12 @@ a start point of group 1 or group 2 will be used as a value. Specify a required number of characters of completion target string. If nothing is specified, `auto-complete-mode` uses -[`ac-auto-start`][] instead. +[`ac-auto-start`](#ac-auto-start) instead. ### `action` Specify a function or an expression that is executed on -[Completion by RET][]. +[Completion by RET](#completion-by-ret). ### `limit` @@ -1379,7 +1379,7 @@ summarizing the candidate in short string. ### `cache` -Use [Cache][]. +Use [Cache](#cache). ### `require` @@ -1389,12 +1389,12 @@ string. `nil` means nothing ignored. ### `candidate-face` -Specify a face of candidate. It overrides [`ac-candidate-face`][] +Specify a face of candidate. It overrides [`ac-candidate-face`](#ac-candidate-face) partially. ### `selection-face` -Specify a face of selection. It overrides [`ac-selection-face`][] +Specify a face of selection. It overrides [`ac-selection-face`](#ac-selection-face) partially. ### `depends` @@ -1431,7 +1431,7 @@ A string of completion target. ### `ac-limit` A limit of candidates. Its value may be one of -[`ac-candidate-limit`][] and [`limit`][] property. +[`ac-candidate-limit`](#ac-candidate-limit) and [`limit`](#limit) property. ### `ac-candidates` @@ -1450,7 +1450,7 @@ performance. For a larger number, it reduces a cost of generating completion candidates. Or you can remove the cost by setting `nil` and you can -use when you truly need. See [Not to complete automatically][] for +use when you truly need. See [Not to complete automatically](#not-to-complete-automatically) for more details. ### `ac-delay` {#trouble-ac-delay} @@ -1463,8 +1463,8 @@ For a larger number, it reduces a displaying cost of completion menu. ### `ac-use-comphist` {#trouble-ac-use-comphist} -Setting [`ac-use-comphist`][] to `nil` to disable -[Candidate Suggestion][], it reduces a cost of suggestion. +Setting [`ac-use-comphist`](#ac-use-comphist) to `nil` to disable +[Candidate Suggestion](#candidate-suggestion), it reduces a cost of suggestion. ### `ac-candidate-limit` {#trouble-ac-candidate-limit}