]> matita.cs.unibo.it Git - helm.git/blob - matita/help/C/sec_gettingstarted.xml
better documentation both with -h and with F1
[helm.git] / matita / help / C / sec_gettingstarted.xml
1
2 <!-- ============= Getting started ============================== -->
3
4 <chapter id="sec_gettingstarted">
5   <title>Getting started</title>
6   <para> If you are already familiar with the Calculus of (Co)Inductive
7   Constructions (CIC) and with interactive theorem provers with procedural
8   proof languages (expecially Coq), getting started with Matita is relatively
9   easy. You just need to learn how to type Unicode symbols, how to browse
10   and search the library and how to author a proof script.</para>
11
12   <sect1 id="unicode">
13    <title>How to type Unicode symbols</title>
14    <para>Unicode characters can be typed in several ways:</para>
15     <itemizedlist>
16       <listitem><para>Using the &quot;Ctrl+Shift+Unicode code&quot; standard Gnome shortcut. E.g. Ctrl+Shift+3a9 generates &quot;Ω&quot;.</para>
17      </listitem>
18      <listitem><para>Typing the ligature &quot;\name&quot; where &quot;name&quot;
19       is a standard Unicode or LaTeX name for the character. Pressing
20       &quot;Alt+L&quot; just after the last character of the name converts
21       the ligature to the Unicode symbol. This operation is
22       not required since Matita understands also the &quot;\name&quot;
23       sequences. E.g. &quot;\Omega&quot; followed by Alt+L generates
24       &quot;Ω&quot;.</para>
25      </listitem>
26      <listitem><para>Typing one of the following ligatures (and optionally
27          converting the ligature to the Unicode character has described before):
28          &quot;:=&quot; (which stands for ≝); &quot;->&quot; (which stands for
29          &quot;→&quot;); &quot;=>&quot; (which stands for &quot;⇒&quot;).</para>
30      </listitem>
31     </itemizedlist>
32   </sect1>
33   <sect1 id="cicbrowser">
34    <title>Browsing and searching</title>
35    <para>The CIC browser is used to browse and search the library.
36     You can open a new CIC browser selecting &quot;New Cic Browser&quot;
37     from the &quot;View&quot; menu of Matita, or by pressing &quot;F3&quot;.
38     The CIC browser is similar to a traditional Web browser.</para>
39    <sect2 id="browsinglib">
40     <title>Browsing the library</title>
41     <para>To browse the library, type in the location bar the absolute URI of
42     the theorem, definition or library fragment you are interested in.
43     &quot;cic:/&quot; is the root of the library. Contributions developed
44     in Matita are under &quot;cic:/matita&quot;; all the others are
45     part of the library of Coq.</para>
46     <para>Following the hyperlinks it is possible to navigate in the Web
47     of mathematical notions. Proof are rendered in pseudo-natural language
48     and mathematical notation is used for formulae. For now, mathematical
49     notation must be included in the current script to be activated, but we
50     plan to remove this limitation.</para>
51    </sect2>
52    <sect2 id="aboutproof">
53     <title>Looking at a proof under development</title>
54     <para>A proof under development is not yet part of the library.
55      The special URI &quot;about:proof&quot; can be used to browse the
56      proof currently under development, if there is one.
57      The &quot;home&quot; button of the CIC browser sets the location bar to
58      &quot;about:proof&quot;.
59     </para>
60    </sect2>
61    <sect2 id="whelp">
62     <title>Searching the library</title>
63     <para>The query bar of the CIC browser can be used to search the library
64      of Matita for theorems or definitions that match certain criteria.
65      The criteria is given by typing a term in the query bar and selecting
66      an action in the drop down menu right of it.</para>
67     <sect3 id="locate">
68      <title>Searching by name</title>
69      <para>     &TODO;</para>
70    </sect3>
71     <sect3 id="hint">
72      <title>List of lemmas that can be applied</title>
73      <para>     &TODO;</para>
74    </sect3>
75     <sect3 id="match">
76      <title>Searching by exact match</title>
77      <para>     &TODO;</para>
78    </sect3>
79     <sect3 id="elim">
80      <title>List of elimination principles for a given type</title>
81      <para>     &TODO;</para>
82    </sect3>
83     <sect3 id="instance">
84      <title>Searching by instantiation</title>
85      <para>     &TODO;</para>
86    </sect3>
87    </sect2>
88   </sect1>
89   <sect1 id="authoring">
90    <title>Authoring</title>
91    <sect2 id="compilation">
92    <title>How to compile a script</title>
93    <para>
94         Scripts are compiled to base URIs. Base URIs are of the form
95         &quot;cic:/matita/path&quot; and are give once for all for a given set of 
96         scripts using the &quot;root&quot; file. For example, imagine a directory
97         &quot;dir1&quot; containing a script file &quot;file1.ma&quot; and a
98         subdirectory &quot;dir2&quot; containing &quot;file2.ma&quot;. A 
99         regular text file called &quot;root&quot; has to be placed in &quot;dir1&quot;
100         ad must contain a line like &quot;baseuri=cic:/matita/example&quot;.
101         Then, running &quot;matitac&quot; from &quot;dir1&quot; will compile
102         both script files, placing objects defined in &quot;file1.ma&quot; in 
103         &quot;cic:/matita/example/file1&quot; while objects defined in &quot;file2.ma&quot;
104         are placed in &quot;cic:/matita/example/dir2/file2&quot;.
105         Before you can compile the scripts you have to generate a &quot;depend&quot; file
106         running &quot;matitadep&quot; from the root directory.
107         You can divide you work in many roots, just place a proper root file in each of them.
108         If a root depends on files living under another one, you can add an extra line in the root 
109         file like &quot;include_paths=../other_root1 ../foo/bar&quot; and &quot;matitac&quot;
110         will enter these patsh to eventually compile needed files.
111    </para>
112  </sect2>
113    <sect2 id="authoringinterface">
114     <title>The authoring interface</title>
115     <para>&TODO;</para>
116    </sect2>
117  </sect1>
118 </chapter>
119
120