summaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2010-07-25 12:46:44 +0200
committerBram Moolenaar <Bram@vim.org>2010-07-25 12:46:44 +0200
commit7510fe74337599f70ae2044aef4f186b1f1c1bf9 (patch)
treeb61a49e70685408de65b6d6833e72ba2fcc33c3b /runtime/doc
parente6dc573b6e0e8eb59eda14be6f94476e72fd82ca (diff)
downloadvim-git-7510fe74337599f70ae2044aef4f186b1f1c1bf9.tar.gz
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/eval.txt17
-rw-r--r--runtime/doc/syntax.txt10
-rw-r--r--runtime/doc/todo.txt4
3 files changed, 27 insertions, 4 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index f2a9f657a..719822ed3 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1,4 +1,4 @@
-*eval.txt* For Vim version 7.3b. Last change: 2010 May 14
+*eval.txt* For Vim version 7.3b. Last change: 2010 Jul 25
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -5550,6 +5550,21 @@ synID({lnum}, {col}, {trans}) *synID()*
Example (echoes the name of the syntax item under the cursor): >
:echo synIDattr(synID(line("."), col("."), 1), "name")
<
+
+synconcealed({lnum}, {col}) *synconcealed()*
+ The result is a List. The first item in the list is 0 if the
+ character at the position {lnum} and {col} is not part of a
+ concealable region, 1 if it is. The second item in the list is
+ a string. If the first item is 1, the second item contains the
+ text which will be displayed in place of the concealed text,
+ depending on the current setting of 'conceallevel'. The third
+ and final item in the list is a unique number representing the
+ specific syntax region matched. This allows detection of the
+ beginning of a new concealable region if there are two
+ consecutive regions with the same replacement character.
+ For an example use see $VIMRUNTIME/syntax/2html.vim .
+
+
synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
The result is a String, which is the {what} attribute of
syntax ID {synID}. This can be used to obtain information
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index c5215cc6b..e81d55bb5 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -428,8 +428,14 @@ cascading style sheets (CSS1) for the attributes (resulting in considerably
shorter and valid HTML 4 file), use: >
:let g:html_use_css = 1
-Closed folds are put in the HTML as they are displayed. If you don't want
-this, use the |zR| command before invoking 2html, or use: >
+Concealed text is removed from the HTML and replaced with the appropriate
+character from |syn-cchar| or 'listchars' depending on the current value of
+'conceallevel'. If you always want to display all text in your document,
+either set 'conceallevel' to before invoking 2html, or use: >
+ :let g:html_ignore_conceal = 1
+
+Similarly, closed folds are put in the HTML as they are displayed. If you
+don't want this, use the |zR| command before invoking 2html, or use: >
:let g:html_ignore_folding = 1
You may want to generate HTML that includes all the data within the folds, and
diff --git a/runtime/doc/todo.txt b/runtime/doc/todo.txt
index ae1c793aa..c28661d66 100644
--- a/runtime/doc/todo.txt
+++ b/runtime/doc/todo.txt
@@ -1,4 +1,4 @@
-*todo.txt* For Vim version 7.3b. Last change: 2010 Jul 24
+*todo.txt* For Vim version 7.3b. Last change: 2010 Jul 25
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -30,6 +30,8 @@ be worked on, but only if you sponsor Vim development. See |sponsor|.
*known-bugs*
-------------------- Known bugs and current work -----------------------
+concealends does not appear to work.
+
if_python3.c is missing some changes that were applied to if_python.c.
Find the old version of if_python.c from when the copy was made.