]> matita.cs.unibo.it Git - helm.git/blobdiff - matita/matita/help/C/authoring.html
Manual(s) fixed and committed to avoid rebuilding them in dune
[helm.git] / matita / matita / help / C / authoring.html
diff --git a/matita/matita/help/C/authoring.html b/matita/matita/help/C/authoring.html
new file mode 100644 (file)
index 0000000..1bfc17d
--- /dev/null
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Authoring</title><link rel="stylesheet" type="text/css" href="docbook.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="Matita V0.99.5 User Manual (rev. 0.99.5 )" /><link rel="up" href="sec_gettingstarted.html" title="Chapter 3. Getting started" /><link rel="prev" href="cicbrowser.html" title="Browsing and searching" /><link rel="next" href="sec_terms.html" title="Chapter 4. Syntax" /></head><body><a xmlns="" href="../../../"><div class="matita_logo"><img src="figures/matita.png" alt="Tiny Matita logo" /><span>Matita Home</span></div></a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Authoring</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="cicbrowser.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Getting started</th><td width="20%" align="right"> <a accesskey="n" href="sec_terms.html">Next</a></td></tr></table><hr /></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="authoring"></a>Authoring</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="compilation"></a>How to compile a script</h3></div></div></div><p>
+       Scripts are compiled to base URIs. Base URIs are of the form
+       "cic:/matita/path" and are given once for all for a set
+       of scripts using the "root" file. 
+   </p><p>
+       A "root" file has to be placed in the root of a script set,
+       for example, consider the following files and directories, and
+       assume you keep files in "list" separated from files
+       in "sort" (for example the former directory may contain
+       functions and proofs about lists, while latter sorting algorithms
+       for lists):
+</p><pre class="programlisting">
+  list/
+    list.ma (* depending just on the standard library *)
+    utils/
+      swap.ma (* including list.ma *)
+  sort/
+    qsort.ma (* including utils/swap.ma *)
+</pre><p>
+       To be able to compile properly the contents of "list"
+       a file called root has to be placed in it. The file should be like
+       the following snippet.
+</p><pre class="programlisting">
+  baseuri=cic:/matita/mydatastructures
+</pre><p>
+       This file tells Matita that objects generated by 
+       "list.ma" have to be placed in 
+       "cic:/matita/mydatastructures/list" while 
+       objects generated by 
+       "swap.ma" have to be placed in 
+       "cic:/matita/mydatastructures/utils/swap".
+  </p><p>
+       Once you created the root file, you must generate a depend file.
+       Enter the "list" directory (the root of yuor file set)
+       and type "matitadep". Remember to regenerate the depend file
+       every time you alter the dependencies of your files (for example 
+       including other scripts).
+       You can now compile you files typing "matitac".
+  </p><p>
+         To compile the "sort" directory, create a root file
+         in "sort/" like the following one and then run 
+         "matitadep".
+</p><pre class="programlisting">
+  baseuri=cic:/matita/myalgorithms
+  include_paths=../list
+</pre><p>
+       The include_paths field can declare a list of paths separated by space.
+       Please omit any "/" from the end of base URIs or paths.
+  </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="authoringinterface"></a>The authoring interface</h3></div></div></div><p><span class="emphasis"><em>TODO</em></span></p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="cicbrowser.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="sec_gettingstarted.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sec_terms.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Browsing and searching </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 4. Syntax</td></tr></table></div></body></html>
\ No newline at end of file