dtd2vim(1) [debian man page]

DTD2VIM(1)							  [FIXME: manual]							DTD2VIM(1)

NAME

       dtd2vim - creates XML data file for Vim7 omni completion from DTDs

SYNOPSIS

       dtd2vim {filename.dtd} [dialectname]

DESCRIPTION

       This manual page documents brieftly the dtd2vim program. For more information see its HTML documentation in
       /usr/share/doc/vim-scripts/html/dtd2vim.html.

       Starting from version 7 Vim supports context aware completion of XML files (and others). In particular, when the file being edited is an
       XML file, completion can be driven by the grammar extracted from a Document Type Definition (DTD).

       For this feature to work the user should put an XML data file corresponding to the desired DTD in a autoload/xml directory contained in a
       directory belonging to Vim's 'runtimepath' (for example ~/.vim/autoload/xml/).

       dtd2vim is the program that creates XML data files from DTDs. Given as input a DTD file.dtd it will create a file.vim XML data file.
       dialectname will be part of dictionary name and will be used as argument for the :XMLns command.

OPTIONS

       None.

SEE ALSO

       vim (1).

       In the Vim online help: :help compl-omni, :help ft-xml-omni, :help :XMLns.

       dtd2vim is fully documented in /usr/share/doc/vim-scripts/html/dtd2vim.html.

AUTHOR

       This manual page was written by Stefano Zacchiroli zack@debian.org for the Debian(TM) system (but may be used by others). Permission is
       granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version
       published by the Free Software Foundation.

       On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

AUTHOR

       Stefano Zacchiroli
	   Author.

COPYRIGHT

       Copyright (C) 2007 Stefano Zacchiroli

[FIXME: source] 						    05 Feb 2007 							DTD2VIM(1)

vim-registry(5) 						    vim addons							   vim-registry(5)

NAME

       vim-registry - syntax for vim-addons registry files

SYNOPSIS

       PACKAGE-NAME.yaml

DESCRIPTION

       A  registry file is a multi-document YAML file (i.e. it can be composed by several different YAML documents separated by "---" lines). Each
       YAML document represents a registry entry, that is the information describing a single addon.

       Ideally, the registry directory contains one file per package shipping addons; with a filename obeying to the convention PACKAGE-NAME.yaml.
       Hence a single package can contribute to the registry with multiple entries described in a single YAML file.

       For example, the "vim-scripts" package should ship a single /usr/share/vim/registry/vim-scripts.yaml file, containing one YAML document per
       shipped addon. The first lines of such file can look like the following:

	   addon: alternate
	   description: "alternate pairing files (e.g. .c/.h) with short ex-commands"
	   basedir: /usr/share/vim-scripts/
	   disabledby: "let loaded_alternateFile = 1"
	   files:
	     - plugin/a.vim
	     - doc/alternate.txt
	   ---
	   addon: whatdomain
	   description: "query the meaning of a Top Level Domain"
	   basedir: /usr/share/vim-scripts/
	   disabledby: "let loaded_whatdomain = 1"
	   files:
	     - plugin/whatdomain.vim
	   ---

       Each registry entry may contain the following fields, to be typeset according to the YAML specification:

       addon (Required)
	      Name of the addon.

       description (Required)
	      Human understandable textual description of the addon.

       files (Required)
	      List of the files which compose the addon and are required to be present in a component of the Vim runtime path for the addon to	be
	      enabled.	Each file is specified relative to a component of the Vim runtime path.

       basedir (Optional)
	      Directory  where the files shipped by the addon (i.e., where the symlinks of the user/sysadm should point to) reside on the filesys-
	      tem.  Default is /usr/share/vim/addons.

       disabledby (Optional)
	      Vim script command that can be used (usually by adding it to ~/.vimrc) to prevent  the  addon  from  being  used	even  when  it	is
	      installed.  The intended usage of this field is to "blacklist" an undesired addon whose files are available, and hence automatically
	      loaded by Vim, in a component of the Vim runtime path.

AUTHOR

       James Vega <jamessan@debian.org>

SEE ALSO

       vim-addons(1), YAML specification <http://www.yaml.org/>

COPYRIGHT

       Copyright (C) 2010 James Vega

       This program is free software, you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as pub-
       lished by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Debian Project							   January 2010 						   vim-registry(5)