[latexila] Documentation: projects



commit 4e73e2cfc0f2b14afd311eabbf01de451e12a2cb
Author: SÃbastien Wilmet <swilmet src gnome org>
Date:   Sun Feb 5 21:00:02 2012 +0100

    Documentation: projects

 help/C/build_tools.page |    2 +-
 help/C/projects.page    |   41 +++++++++++++++++++++++++++++++++++++++++
 help/Makefile.am        |    1 +
 3 files changed, 43 insertions(+), 1 deletions(-)
---
diff --git a/help/C/build_tools.page b/help/C/build_tools.page
index 011c476..165742a 100644
--- a/help/C/build_tools.page
+++ b/help/C/build_tools.page
@@ -121,7 +121,7 @@ $ ps2pdf document.ps</screen>
   </list>
 
   <p>The build tool is executed on the currently opened file. If the file belongs to a
-  project, it is executed on the project's main file.</p>
+  <link xref="projects">project</link>, it is executed on the project's main file.</p>
 
   <note style="important">
     <title>Hidden Build Tools</title>
diff --git a/help/C/projects.page b/help/C/projects.page
new file mode 100644
index 0000000..c30efa5
--- /dev/null
+++ b/help/C/projects.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic"
+      id="projects">
+
+<info>
+  <link type="guide" xref="index" />
+</info>
+
+<title>Projects</title>
+
+<synopsis>
+  <p>When a LaTeX document is split into several *.tex files, creating a project
+  is useful.</p>
+</synopsis>
+
+<section>
+  <title>Manage projects</title>
+
+  <p>
+    All actions related to projects are located in the <gui style="menu">Projects</gui>
+    menu. A project contain only two pieces of information:
+  </p>
+  <list>
+    <item><p>The directory where the project is located.</p></item>
+    <item><p>The main *.tex file.</p></item>
+  </list>
+
+  <p>
+    As a consequence, a directory can contain only one project, which is quite logical.
+  </p>
+</section>
+
+<section>
+  <title>Usefulness of projects</title>
+  <list>
+    <item><p>A <link xref="build_tools">build tool</link> is executed on the
+    project's main file.</p></item>
+  </list>
+</section>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index d7cca85..0962f0d 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -6,6 +6,7 @@ HELP_FILES = \
 	build_tools.page	\
 	completion.page		\
 	index.page		\
+	projects.page		\
 	spell_checking.page
 
 HELP_LINGUAS = cs de es fr gl



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]