]> matita.cs.unibo.it Git - helm.git/blobdiff - matita/help/C/matita.xml
new configuration file sample
[helm.git] / matita / help / C / matita.xml
index 7b3b3d30c00dc43c6151ea7cf1bc744d13d77bc1..0b52d39e5a28dc3515da4f5679016cf62feb2179 100644 (file)
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
-"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-
-  <!ENTITY license SYSTEM "legal.xml">
-  <!ENTITY install SYSTEM "sec_install.xml">
-  <!ENTITY gettingstarted SYSTEM "sec_gettingstarted.xml">
-  <!ENTITY intro SYSTEM "sec_intro.xml">
-  <!ENTITY terms SYSTEM "sec_terms.xml">
-  <!ENTITY tactics SYSTEM "sec_tactics.xml">
-  <!ENTITY tacticals SYSTEM "sec_tacticals.xml">
-  <!ENTITY othercommands SYSTEM "sec_commands.xml">
-  <!ENTITY usernotation SYSTEM "sec_usernotation.xml">
-
-  <!ENTITY manrevision "0">
-  <!ENTITY date "February 2006">
-  <!ENTITY app "<application>Matita</application>">
-  <!ENTITY appname "Matita">
-  <!ENTITY appversion SYSTEM "version.txt">
-
-  <!ENTITY TODO "<emphasis>TODO</emphasis>">
-  <!ENTITY MYSQL "<application> <ulink type='http'
-      url='http://www.mysql.com'>MySQL</ulink> </application>">
-
-  <!-- Entities for BNF -->
-  <!ENTITY id "<emphasis><link linkend='id'>id</link></emphasis>">
-  <!ENTITY uri "<emphasis><link linkend='uri'>uri</link></emphasis>">
-  <!ENTITY char "<emphasis><link linkend='char'>char</link></emphasis>">
-  <!ENTITY uri-step "<emphasis><link linkend='uri-step'>uri-step</link></emphasis>">
-  <!ENTITY nat "<emphasis><link linkend='nat'>nat</link></emphasis>">
-  <!ENTITY term "<emphasis><link linkend='term'>term</link></emphasis>">
-  <!ENTITY match_pattern "<emphasis><link linkend='match_pattern'>match_pattern</link></emphasis>">
-  <!ENTITY args "<emphasis><link linkend='args'>args</link></emphasis>">
-  <!ENTITY args2 "<emphasis><link linkend='args2'>args2</link></emphasis>">
-  <!ENTITY sterm "<emphasis><link linkend='sterm'>sterm</link></emphasis>">
+<?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>Enrico</firstname>">
+  <!ENTITY dhsurname   "<surname>Tassi</surname>">
+  <!ENTITY dhdate      "<date>21 Jun 2007</date>">
+  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
+  <!ENTITY dhemail     "<email>gareuselesinge@debian.org</email>">
+  <!ENTITY dhusername  "Enrico Tassi">
+  <!ENTITY dhucpackage "<refentrytitle>matita</refentrytitle>">
+  <!ENTITY dhpackage   "matita">
+
+  <!ENTITY debian      "<productname>Debian</productname>">
+  <!ENTITY gnu         "<acronym>GNU</acronym>">
+  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
 ]>
 
-<?yelp:chunk-depth 3?>
-
-<book id="matita_manual" lang="en">
-<!-- please do not change the id; for translations, change lang to -->
-<!-- appropriate code -->
-<title>&app; V&appversion; Manual (rev. &manrevision;)</title>
-<bookinfo>
-
- <copyright>
-  <year>2006</year>
-  <holder>The HELM team.</holder>
- </copyright>
-<!-- translators: uncomment this:
-
-  <copyright>
-   <year>2002</year>
-   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
-  </copyright>
-
-   -->
-<!-- An address can be added to the publisher information.  If a role is 
-     not specified, the publisher/author is the same for all versions of the 
-     document.  -->
-<!-- CSC:
-    <publisher> 
-      <publishername> GNOME Documentation Project </publishername> 
-    </publisher> 
--->
-
-    <authorgroup> 
-      <author> 
-       <firstname>Andrea</firstname> 
-       <surname>Asperti</surname> 
-       <affiliation> 
-         <address> <email>asperti@cs.unibo.it</email> </address> 
-       </affiliation> 
-      </author> 
-      <author> 
-       <firstname>Claudio</firstname> 
-       <surname>Sacerdoti Coen</surname> 
-       <affiliation> 
-         <address> <email>sacerdot@cs.unibo.it</email> </address> 
-       </affiliation> 
-      </author> 
-      <author> 
-       <firstname>Enrico</firstname> 
-       <surname>Tassi</surname> 
-       <affiliation> 
-         <address> <email>tassi@cs.unibo.it</email> </address> 
-       </affiliation> 
-      </author> 
-      <author> 
-       <firstname>Stefano</firstname> 
-       <surname>Zacchiroli</surname> 
-       <affiliation> 
-         <address> <email>zacchiro@cs.unibo.it</email> </address> 
-       </affiliation> 
-      </author> 
-<!-- This is appropriate place for other contributors: translators,
-      maintainers,  etc. Commented out by default.
-       <othercredit role="translator">
-       <firstname>Latin</firstname> 
-       <surname>Translator 1</surname> 
-       <affiliation> 
-         <orgname>Latin Translation Team</orgname> 
-         <address> <email>translator@gnome.org</email> </address> 
-       </affiliation>
-       <contrib>Latin translation</contrib>
-      </othercredit>
--->
-    </authorgroup>
-    
-<revhistory>
-      <revision> 
-       <revnumber>&appname; V&appversion; Manual (rev. &manrevision;)</revnumber> 
-       <date>&date;</date> 
-       <revdescription> 
-         <para role="author">The HELM team
-<!--
-           <email>baudais@okstate.edu</email>
--->
-         </para>
-<!--
-         <para role="publisher">GNOME Documentation Project</para>
--->
-       </revdescription> 
-      </revision>
-  <revision>
-   <revnumber>&manrevision;</revnumber>
-   <date>4 February 2006</date>
-   <authorinitials>HELM</authorinitials>
-   <revremark>
-   First draft completed.
-   </revremark>
-  </revision>
-
- </revhistory>
-
-    <releaseinfo>This manual describes version &appversion; of &appname;.
-    </releaseinfo>
-
-    <legalnotice>
-      &license;
-    </legalnotice>
-
-    <!-- The following feedback information only applies to appliactions
-    listed in bugzilla.gnome.org and bugzilla.ximian.com. For other
-    applications, please provide your own feedback info or remove thsi
-    section altogether -->
-    <legalnotice> 
-      <title>Feedback</title> 
-      <para>To report a bug or make a suggestion regarding the &app;
-       application or this manual, follow the directions in the
-       <ulink url="http://bugs.mowgli.cs.unibo.it" type="http">HELM Bug
-         Tracking System Page</ulink>. 
-      </para>
-<!-- Translators may also add here feedback address for translations -->
-    </legalnotice>
-
-</bookinfo>
-
-<!-- ============= Document Body ============================= -->
-
-&intro;
-&install;
-&gettingstarted;
-&terms;
-&usernotation;
-&tactics;
-&tacticals;
-&othercommands;
-
- <!-- ============= Application License ============================= -->
-
- <chapter id="sec_license">
-  <title>License</title>
-  &license;
- </chapter>
-</book>
-
-<!-- CSC: valid element tags
-<sect1 id="intro"> <title>Introduction</title> ...
-<sect2 id="what"> <title>What is Matita?</title>
-<para>
-<note> <title>Note:</title> <para> ...
-<footnote> <para> ...
-<itemizedlist mark="opencircle">
-    <listitem>
-     <para>
-       The computer player for Iagno is easy to beat.
-     </para>
-    </listitem>
- </itemizedlist>
-
-<ulink type="http" url="http://www.gnome.org/gdp">
-<email>itp@gnu.org</email>
-<application>Matita</application>
-<command>iagno</command> on the command line
-<citetitle>Othello</citetitle>
-
-<guimenuitem>Iagno</guimenuitem>
-<guisubmenu>Games</guisubmenu>
-<guibutton>none</guibutton>
-<menuchoice> <guimenu>Settings</guimenu> <guisubmenu>Preferences </guisubmenu> </menuchoice>
-
-<xref linkend="start-shot"/>. 
-<figure id="start-shot">
- <title>Starting Position</title>
- <screenshot>
-   <mediaobject> 
-   <imageobject>
- <imagedata fileref="figures/START.png" format="PNG" srccredit="Eric Baudais"/>
-  </imageobject>
-   <textobject> 
-     <phrase>Screenshot of the starting position.</phrase> 
-   </textobject> 
- </mediaobject>
- </screenshot>
-</figure>
-
--->
+<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>
+