]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): DocBook syntax variable scopes are not clearly documented master
authorBogdan Barbu <l4b.bogdan.barbu@gmail.com>
Sat, 8 Aug 2026 17:11:42 +0000 (17:11 +0000)
committerChristian Brabandt <cb@256bit.org>
Sat, 8 Aug 2026 17:11:42 +0000 (17:11 +0000)
Problem:  DocBook syntax variable scopes of docbk_type and docbk_ver
          are not clearly documented: docbk_type uses the wrong scope
          (it should be buffer-local) and docbk_ver also has an
          undocumented buffer-local version.
Solution: Correct the docbk_type examples and describe the docbk_ver
          precedence.

closes: #20977

Signed-off-by: Bogdan Barbu <l4b.bogdan.barbu@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/syntax.txt

index 80f9baa4a9ec925a2b3fe008b82897bd1756e291..577229ae371b25307ae509a7cc17e1f44d16a717 100644 (file)
@@ -1,4 +1,4 @@
-*syntax.txt*   For Vim version 9.2.  Last change: 2026 Aug 02
+*syntax.txt*   For Vim version 9.2.  Last change: 2026 Aug 08
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -1407,18 +1407,20 @@ are using the "b:docbk_type" variable should be set.  Vim does this for you
 automatically if it can recognize the type.  When Vim can't guess it the type
 defaults to XML.
 You can set the type manually: >
-       :let docbk_type = "sgml"
+       :let b:docbk_type = "sgml"
 or: >
-       :let docbk_type = "xml"
+       :let b:docbk_type = "xml"
 You need to do this before loading the syntax file, which is complicated.
 Simpler is setting the filetype to "docbkxml" or "docbksgml": >
        :set filetype=docbksgml
 or: >
        :set filetype=docbkxml
 
-You can specify the DocBook version: >
-       :let docbk_ver = 3
-When not set 4 is used.
+You can specify the DocBook version for the current buffer: >
+       :let b:docbk_ver = 3
+When "b:docbk_ver" is not set, "g:docbk_ver" is used as a global fallback: >
+       :let g:docbk_ver = 3
+When neither variable is set, version 4 is used.
 
 
 DOSBATCH                               *dosbatch.vim* *ft-dosbatch-syntax*