GNOME.org
 

[evince/mallard-docs] Synctex: adding support and searching.

commit aadb0ffc70b1ab9d9d192caee891759df9e33403
Author: Tiffany Antopolski <antopolski src gnome org>
Date:   Thu Nov 4 18:18:43 2010 -0400

    Synctex: adding support and searching.

 help/C/annotation-properties.page |    2 +-
 help/C/annotations-delete.page    |    2 +-
 help/C/annotations-disabled.page  |    2 +-
 help/C/annotations-navigate.page  |    2 +-
 help/C/annotations-save.page      |    2 +-
 help/C/annotations-view.page      |    2 +-
 help/C/annotations.page           |    2 +-
 help/C/bookmarks.page             |    2 +-
 help/C/index.page                 |    2 +-
 help/C/synctex-and-evince.page    |   34 ------------------
 help/C/synctex-beamer.page        |   25 +++++++++++++
 help/C/synctex-compile.page       |   35 ++++++++++++++++++
 help/C/synctex-editors.page       |   37 ++++++++++++++++++-
 help/C/synctex-search.page        |   70 +++++++++++++++++++++++++++++++++++++
 help/C/synctex-support.page       |   31 +++++++++++++++-
 help/C/synctex.page               |    7 ++--
 help/C/textselection.page         |    2 +-
 17 files changed, 207 insertions(+), 52 deletions(-)
---
diff --git a/help/C/annotation-properties.page b/help/C/annotation-properties.page
index 9ea3730..4a66973 100644
--- a/help/C/annotation-properties.page
+++ b/help/C/annotation-properties.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.33.0" version="0.1" date="2010-10-02" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/annotations-delete.page b/help/C/annotations-delete.page
index 63eef29..f5e2e4d 100644
--- a/help/C/annotations-delete.page
+++ b/help/C/annotations-delete.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.32.3" version="0.1" date="2010-09-28" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/annotations-disabled.page b/help/C/annotations-disabled.page
index 2f393e1..4496dae 100644
--- a/help/C/annotations-disabled.page
+++ b/help/C/annotations-disabled.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.32.3" version="0.1" date="2010-09-28" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/annotations-navigate.page b/help/C/annotations-navigate.page
index d16a23f..5d233e9 100644
--- a/help/C/annotations-navigate.page
+++ b/help/C/annotations-navigate.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.33.0" version="0.1" date="2010-10-02" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/annotations-save.page b/help/C/annotations-save.page
index 48a00df..410ea70 100644
--- a/help/C/annotations-save.page
+++ b/help/C/annotations-save.page
@@ -8,7 +8,7 @@
     <revision pkgversion="2.32.3" version="0.1" date="2010-09-28" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/annotations-view.page b/help/C/annotations-view.page
index dcc6c71..0f6fb55 100644
--- a/help/C/annotations-view.page
+++ b/help/C/annotations-view.page
@@ -8,7 +8,7 @@
     <revision pkgversion="2.32.3" version="0.1" date="2010-09-28" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/annotations.page b/help/C/annotations.page
index 33caacc..0824558 100644
--- a/help/C/annotations.page
+++ b/help/C/annotations.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.33.0" version="0.1" date="2010-09-28" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/bookmarks.page b/help/C/bookmarks.page
index 0a14b95..0d893ac 100644
--- a/help/C/bookmarks.page
+++ b/help/C/bookmarks.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.30.3" version="0.1" date="2010-09-28" status="review"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
diff --git a/help/C/index.page b/help/C/index.page
index e14b819..e299207 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -51,7 +51,7 @@ Evince Document Viewer</title>
     <title>Tips and Tricks</title>
 </section>
 
-<section id="synctex" style="2column" groups="first second third fourth">
+<section id="synctex" style="2column" groups="first second third fourth fifth sixth">
     <title>SyncTex</title>
 </section>
 </page>
diff --git a/help/C/synctex-beamer.page b/help/C/synctex-beamer.page
new file mode 100644
index 0000000..a5283cf
--- /dev/null
+++ b/help/C/synctex-beamer.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="synctex-beamer">
+
+  <info>
+    <link type="guide" xref="index#synctex" group="sixth"/>
+    <desc>Using SyncTex with the LaTeX Beamer class.</desc>
+
+    <revision pkgversion="2.32" version="0.1" date="2010-09-28" status="draft"/>
+    <credit type="author">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Beamer with SyncTex</title>
+<p>
+
+</p>
+
+
+</page>
diff --git a/help/C/synctex-compile.page b/help/C/synctex-compile.page
new file mode 100644
index 0000000..c2322a7
--- /dev/null
+++ b/help/C/synctex-compile.page
@@ -0,0 +1,35 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="synctex-compile">
+
+  <info>
+    <link type="guide" xref="index#synctex" group="third"/>
+    <desc>How to compile your TeX document with SyncTex</desc>
+
+    <revision pkgversion="2.32" version="0.1" date="2010-09-28" status="draft"/>
+    <credit type="author">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Compile TeX with SyncTex</title>
+<p>
+Adding the line <em>\synctex=1</em> in the preamble of your TeX file will trigger synchronization with SyncTeX.
+</p>
+<code>
+\documentclass{article}
+\synctex=1
+\usepackage{fullpage}
+\begin{document}
+...
+\end{document}
+</code>
+<p>
+  Alternatively, you can run the pdflatex command with the <em>-synctex=1</em> option:
+</p>
+<screen>pdflatex -synctex=1 yourFile.tex</screen>
+</page>
diff --git a/help/C/synctex-editors.page b/help/C/synctex-editors.page
index 5aec25e..404ed5f 100644
--- a/help/C/synctex-editors.page
+++ b/help/C/synctex-editors.page
@@ -3,13 +3,13 @@
       id="synctex-editors">
 
   <info>
-    <link type="guide" xref="index#synctex" group="third"/>
+    <link type="guide" xref="index#synctex" group="fourth"/>
     <desc>Which editor can you use to edit your TEX file?</desc>
 
     <revision pkgversion="2.32" version="0.1" date="2010-09-28" status="draft"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
@@ -18,8 +18,41 @@
   </info>
 
 <title>Supported Editors</title>
+
+<section><title><app>Gedit</app></title>
 <p>
+<link xref="synctex-search#forward-search">Forward Search</link> (from <app>Gedit</app> to <app>Evince</app>) and <link xref="synctex-search#backward-search">Backward search</link> (from <app>Evince</app> to <app>Gedit</app>) are both supported.
+</p>
+</section>
 
+<section><title>Vim-latex</title>
+<p>
+The <app>Gedit</app> plugin contains a python script (evince_dbus.py) that can be used to get Synctex working with Vim.
+In order to use vim-latex together with <app>Evince</app> you need to follow the next steps:
 </p>
+<steps>
+ <item>
+  <p>
+     Copy the evince_dbus.py to some directory in your path and give it +x permissions.
 
+ </p>
+ </item>
+ <item>
+  <p>
+     Modify your ~/.vimrc file and add the following lines.
+    </p>
+<code>
+let g:Tex_ViewRule_pdf = 'evince_dbus.py'
+let g:Tex_DefaultTargetFormat = 'pdf'
+let g:Tex_CompileRule_pdf = 'pdflatex --synctex=1 -interaction=nonstopmode $*'
+</code>
+  
+  </item>
+  <item>
+   <p>
+     Now you can use Forward search from vim-latex by typing \ls. Backward search is not yet supported.
+   </p>
+  </item>
+</steps>
+</section>
 </page>
diff --git a/help/C/synctex-search.page b/help/C/synctex-search.page
new file mode 100644
index 0000000..67d51ba
--- /dev/null
+++ b/help/C/synctex-search.page
@@ -0,0 +1,70 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="synctex-search">
+
+  <info>
+    <link type="guide" xref="index#synctex" group="fifth"/>
+    <desc>Flip between <app>Evince</app> and <app>Gedit</app>.</desc>
+
+    <revision pkgversion="2.32" version="0.1" date="2010-09-28" status="draft"/>
+    <credit type="author">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+
+  </info>
+
+<title>Search with SyncTex</title>
+<p>
+   After you <link xref="synctex-compile">compile your TeX file with SyncTex</link>, you will be able to search.  SyncTex even supports forward and backward search from an included file.
+</p>
+
+<section id="forward-search">
+    <title>Forward Search: From TeX to PDF (<app>Gedit</app> to <app>Evince</app>)</title>
+     <p>
+     Forward search allows you to click on a specific section of TeX source code, and jump to the associated position in the PDF.  To perform forward search:
+ </p>
+<steps>
+<item>
+<p>
+  Click on a line in the TeX file.
+</p>
+</item>
+<item>
+<p>
+  In <app>Gedit</app>, click <guiseq><gui>Tools</gui> <gui>Forward Search</gui></guiseq>.  The corresponding line in the PDF will be outlined in red.
+</p>
+<p>
+Alternatively, you can click <keyseq><key>Ctrl</key><key>Alt</key><key>F</key></keyseq>. The corresponding line in the PDF will be outlined in red.
+</p>
+</item>
+</steps>
+<note>
+<p>
+   If the corresponding PDF file is not open, performing a forward search will open the PDF in <app>Evince</app>.
+</p>
+</note>
+<p>
+ If you add a complex project with several TeX files you can put
+</p>
+<code>% mainfile: mainfile.tex</code>
+<p>
+either in the first or last three lines of each included TeX file, and forward search will work. Backward search should always work, even if you don't add the modeline.
+</p>
+
+</section>
+
+<section id="backward-search">
+    <title>Backward Search: From PDF to TeX (<app>Evince</app> to <app>Gedit</app>)</title>
+     <p>
+ Backward search allows you to click on a specific line in the PDF file, and jump to the associated line in the TeX source code. 
+</p>
+<p>
+You can perform a backward search by pressing <key>Ctrl</key>+ Left Click in <app>Evince</app>. The corresponding line in the TeX source code will be hightlighted.
+     </p>
+</section>
+
+</page>
diff --git a/help/C/synctex-support.page b/help/C/synctex-support.page
index e711a85..54f2798 100644
--- a/help/C/synctex-support.page
+++ b/help/C/synctex-support.page
@@ -9,7 +9,7 @@
     <revision pkgversion="2.32" version="0.1" date="2010-09-28" status="draft"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
@@ -19,7 +19,34 @@
 
 <title>Set-up SyncTex</title>
 <p>
-
+The following packages need to be installed in order to add support for SyncTex:
 </p>
+<list>
+  <item>
+    <p>
+      texlive-extra-utils
+    </p>
+  </item>
+  <item>
+    <p>
+      gedit-plugins 
+    </p>
+  </item>
+</list>
 
+<p> 
+  In <app>Gedit</app>, enable the SyncTex Plugin:
+</p>
+<steps>
+   <item>
+    <p>
+     Click <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui></guiseq> tab.
+    </p>
+   </item>
+   <item>
+    <p>
+     Check <gui>SyncTex</gui>.
+    </p>
+   </item>
+</steps>
 </page>
diff --git a/help/C/synctex.page b/help/C/synctex.page
index f19c600..d80fc6d 100644
--- a/help/C/synctex.page
+++ b/help/C/synctex.page
@@ -4,22 +4,21 @@
 
   <info>
     <link type="guide" xref="index#synctex" group="first"/>
-    <desc>Introduction to SyncTex.</desc>
+    <desc>SyncTeX support is available in <app>Evince</app>.</desc>
 
     <revision pkgversion="2.32" version="0.1" date="2010-09-28" status="draft"/>
     <credit type="author">
       <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski com</email>
+      <email>tiffany antopolski com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
     </license>
-
   </info>
 
 <title>What is SyncTex?</title>
 <p>
-
+   SyncTeX is a method that enables synchronization between a TeX source file and the resulting PDF output. 
 </p>
 
 </page>
diff --git a/help/C/textselection.page b/help/C/textselection.page
index 9238abb..27f415f 100644
--- a/help/C/textselection.page
+++ b/help/C/textselection.page
@@ -34,7 +34,7 @@ application, the formatting may alter.  It may also contain different characters
 
  <p> 
   Unfortunately, there is no real way of fixing this problem. Copying 
-  less text at a time, or copying the text into a text editor may minimise the problem. You can locate a text editor by clicking <guiseq><gui>Applications</gui><gui>Accessories</gui><gui>gedit Text Editor</gui></guiseq>.
+  less text at a time, or copying the text into a text editor may minimise the problem. You can locate a text editor by clicking <guiseq><gui>Applications</gui><gui>Accessories</gui><gui>Text Editor</gui></guiseq>.
   </p>
 
 </page>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]