]> www.fi.muni.cz Git - evince.git/commitdiff
Synctex: adding support and searching.
authorTiffany Antopolski <antopolski@src.gnome.org>
Thu, 4 Nov 2010 22:18:43 +0000 (18:18 -0400)
committerTiffany Antopolski <antopolski@src.gnome.org>
Thu, 4 Nov 2010 22:18:43 +0000 (18:18 -0400)
17 files changed:
help/C/annotation-properties.page
help/C/annotations-delete.page
help/C/annotations-disabled.page
help/C/annotations-navigate.page
help/C/annotations-save.page
help/C/annotations-view.page
help/C/annotations.page
help/C/bookmarks.page
help/C/index.page
help/C/synctex-and-evince.page [deleted file]
help/C/synctex-beamer.page [new file with mode: 0644]
help/C/synctex-compile.page [new file with mode: 0644]
help/C/synctex-editors.page
help/C/synctex-search.page [new file with mode: 0644]
help/C/synctex-support.page
help/C/synctex.page
help/C/textselection.page

index 9ea3730ace7bc113053cb218ad0e4567dd24581c..4a66973f30f5603190620b007f49fea06cd5c34e 100644 (file)
@@ -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>
index 63eef2983a7a04822912689b81ec4f8a0a5ff7c4..f5e2e4dd44bac6376804f34d8cab36d18a354a64 100644 (file)
@@ -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>
index 2f393e1ec59f13e86bde31efc74c9a340a7b5bbd..4496dae69d47d893f0d64b9d90e65d90e9173d9f 100644 (file)
@@ -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>
index d16a23f444c59b4878a34c90f7b98a073f5076a5..5d233e9adb85cd4623ac5f9155b3d8d95e939fc2 100644 (file)
@@ -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>
index 48a00dfc9a8e9807adaa9efc0c74773785764641..410ea7056891562ceedd15055bb5c70f8b15ba1b 100644 (file)
@@ -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>
index dcc6c71ec3285308ab85d8186beb508a333690a2..0f6fb55b1c150890211c9dfa88297b37c9ecd49d 100644 (file)
@@ -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>
index 33caacc35da944263e66529afc1ef949317dc9da..0824558e7311c5c545824cfdfd3e4ea8e136059e 100644 (file)
@@ -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>
index 0a14b95750d42c860ca2e881147750ee38c98617..0d893ac84c5b38999c88ee2c9cb23a2230ab6b89 100644 (file)
@@ -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>
index e14b81913cf15f2308fab778e708dcf53eceb738..e299207cd5e1ddee2e5f39dd46e9e55cd49139c8 100644 (file)
@@ -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-and-evince.page b/help/C/synctex-and-evince.page
deleted file mode 100644 (file)
index f06ff10..0000000
+++ /dev/null
@@ -1,34 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      type="topic" style="task"
-      id="synctex-and-evince">
-
-  <info>
-    <link type="guide" xref="index#synctex" group="fourth"/>
-    <desc>Flip between <app>Evince</app> and editor.</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>Using SyncTex to Search</title>
-
-<section id="forward search">
-    <title>Forward Search: From TEX to PDF</title>
-     <p>
-     </p>
-</section>
-
-<section id="inverse search">
-    <title>Inverse Search: From PDF to TEX</title>
-     <p>
-     </p>
-</section>
-
-</page>
diff --git a/help/C/synctex-beamer.page b/help/C/synctex-beamer.page
new file mode 100644 (file)
index 0000000..a5283cf
--- /dev/null
@@ -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 (file)
index 0000000..c2322a7
--- /dev/null
@@ -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>
index 5aec25eb892ffd728d722f680512b195a5ae5cd7..404ed5f336937dfde5275e975d94d5ce8d9d1e59 100644 (file)
@@ -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>
   </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 (file)
index 0000000..67d51ba
--- /dev/null
@@ -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>
index e711a85ba29f84527926f011a9b9620e60a9507f..54f2798ed5b2df506eb48933fe90887e34ca8916 100644 (file)
@@ -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>
 
 <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>
index f19c60064c85e44bee9d1ff9975c95b7ba8f388d..d80fc6d722c2280cc09d876f22df958291986691 100644 (file)
@@ -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>
index 9238abb2df9b6f92f9aada06c22af611466296ae..27f415fa944eeb7672c848846d232d1bb71972f1 100644 (file)
@@ -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>