[latexila] SyncTeX: documentation



commit f248ada9b7c94ee055776c379cea86b9fb68c044
Author: SÃbastien Wilmet <swilmet gnome org>
Date:   Mon Sep 10 04:25:27 2012 +0200

    SyncTeX: documentation
    
    There are links to the Evince documentation, which is more complete.

 help/C/projects.page |    4 ++-
 help/C/synctex.page  |   66 ++++++++++++++++++++++++++++++++++++++++++++++++++
 help/Makefile.am     |    3 +-
 3 files changed, 71 insertions(+), 2 deletions(-)
---
diff --git a/help/C/projects.page b/help/C/projects.page
index c30efa5..b81cd0b 100644
--- a/help/C/projects.page
+++ b/help/C/projects.page
@@ -19,7 +19,7 @@
 
   <p>
     All actions related to projects are located in the <gui style="menu">Projects</gui>
-    menu. A project contain only two pieces of information:
+    menu. A project contains only two pieces of information:
   </p>
   <list>
     <item><p>The directory where the project is located.</p></item>
@@ -36,6 +36,8 @@
   <list>
     <item><p>A <link xref="build_tools">build tool</link> is executed on the
     project's main file.</p></item>
+    <item><p>The <link xref="synctex#forward_search">forward search</link>
+    works for a secondary file of a project.</p></item>
   </list>
 </section>
 </page>
diff --git a/help/C/synctex.page b/help/C/synctex.page
new file mode 100644
index 0000000..b44cd7b
--- /dev/null
+++ b/help/C/synctex.page
@@ -0,0 +1,66 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic"
+      id="synctex">
+
+<info>
+  <link type="guide" xref="index" />
+</info>
+
+<title>Forward and Backward Search</title>
+
+<synopsis>
+  <p>Synchronization between the document's *.tex files and the resulting PDF output,
+  opened with the <app>Evince</app> document viewer.</p>
+</synopsis>
+
+<note>
+<p>For more information, read the
+<link href="help:evince#synctex"><app>Evince</app> documentation</link>.</p>
+</note>
+
+<section id="forward_search">
+  <title>Forward Search: from .tex to PDF</title>
+
+  <p>From a certain position in the .tex source file, jump to the corresponding position
+  in the PDF file.</p>
+
+  <p>There are different ways to do a forward search:</p>
+  <list>
+    <item><p>In the menu:
+      <guiseq>
+        <gui style="menu">Search</gui>
+        <gui style="menu">Search Forward</gui>
+      </guiseq>
+    </p></item>
+    <item><p>By pressing
+      <keyseq>
+        <key>Ctrl</key>
+        <key>left click</key>
+      </keyseq>
+    </p></item>
+  </list>
+
+  <p>If a document is split into several .tex files, create a
+  <link xref="projects">project</link>. There is no need to mention the main file
+  with a LaTeX comment in each secondary .tex file, like it is explained in the
+  <link href="help:evince/synctex-search#forward-search">
+    <app>Evince</app> documentation.
+  </link></p>
+</section>
+
+<section id="backward_search">
+  <title>Backward Search</title>
+
+  <p>In <app>Evince</app>, press
+    <keyseq>
+      <key>Ctrl</key>
+      <key>left click</key>
+    </keyseq>,
+    and the corresponding position in the .tex file will be opened in
+    <app>LaTeXila</app>.</p>
+
+  <p><app>Evince</app> have to be launched by <app>LaTeXila</app>. Else, the backward
+  search will not work.</p>
+</section>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 7373e66..0b598b8 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -8,7 +8,8 @@ HELP_FILES = \
 	index.page		\
 	projects.page		\
 	spell_checking.page	\
-	structure.page
+	structure.page		\
+	synctex.page
 
 HELP_LINGUAS = cs de es fr gl
 



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