File: dtd2vim.xml

package info (click to toggle)
vim-scripts 20130814
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 4,608 kB
  • ctags: 2,511
  • sloc: perl: 452; xml: 95; makefile: 25
file content (118 lines) | stat: -rw-r--r-- 3,880 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

  <!ENTITY dhfirstname "<firstname>Stefano</firstname>">
  <!ENTITY dhsurname   "<surname>Zacchiroli</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>05 Feb 2007</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>zack@debian.org</email>">
  <!ENTITY dhusername  "Stefano Zacchiroli">
  <!ENTITY dhucpackage "<refentrytitle>dtd2vim</refentrytitle>">
  <!ENTITY dhpackage   "dtd2vim">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2007</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>creates XML data file for Vim7 omni completion from
      DTDs</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg choice="req"><replaceable>filename</replaceable>.dtd</arg>
      <arg choice="opt"><replaceable>dialectname</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para> This manual page documents brieftly the
      <command>&dhpackage;</command> program. For more information see its HTML
      documentation in
      <filename>/usr/share/doc/vim-scripts/html/dtd2vim.html</filename>.
    </para>

    <para>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). </para>

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

    <para><command>&dhpackage;</command> is the program that creates XML data
      files from DTDs. Given as input a DTD
      <filename><replaceable>file</replaceable>.dtd</filename> it will create a
      <filename>file.vim</filename> XML data file.
      <replaceable>dialectname</replaceable> will be part of dictionary name
      and will be used as argument for the <command>:XMLns</command> command.
    </para>

  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <para>None. </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>vim (1).</para>

    <para>In the Vim online help: <userinput>:help compl-omni</userinput>,
      <userinput>:help ft-xml-omni</userinput>, <userinput>:help
	:XMLns</userinput>. </para>

    <para>dtd2vim is fully documented in
      <filename>/usr/share/doc/vim-scripts/html/dtd2vim.html</filename>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for the
      &debian; 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. </para>

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

</refentry>