Add forward search command for qpdfview.

[lyx.git] / lib / doc / Additional.lyx

diff --git a/lib/doc/Additional.lyx b/lib/doc/Additional.lyx
index eae464c37419e2eba45ee9df47f29111c6a10d01..fdf693f3018465ba53fcdc3eced0027ae42bd88e 100644 (file)
--- a/lib/doc/Additional.lyx
+++ b/lib/doc/Additional.lyx
@@ -131,11 +131,12 @@ End
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings

-\tracking_changes false
+\tracking_changes true

 \output_changes false
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
 \output_changes false
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true

+\author 711066561 "Enrico Forestieri" 

 \end_header
 
 \begin_body
 \end_header
 
 \begin_body


@@ -340,6 +341,10 @@ status collapsed
 \begin_layout Plain Layout
 View\SpecialChar \menuseparator
 Source
 \begin_layout Plain Layout
 View\SpecialChar \menuseparator
 Source

+\begin_inset space ~
+\end_inset
+
+Pane

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -370,7 +375,7 @@ There are several commands that automatically invoke LaTeX.
 status collapsed
 
 \begin_layout Plain Layout
 status collapsed
 
 \begin_layout Plain Layout

-View\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator

 View
 \end_layout
 
 View
 \end_layout
 


@@ -384,7 +389,7 @@ View
 status collapsed
 
 \begin_layout Plain Layout
 status collapsed
 
 \begin_layout Plain Layout

-View\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator

 Update
 \end_layout
 
 Update
 \end_layout
 


@@ -5248,7 +5253,47 @@ lyxpipe"
 
 \end_inset
 
 
 \end_inset
 

- on Windows (but any working path can be used).
+ on Windows (
+\change_deleted 711066561 1405258697
+but
+\change_inserted 711066561 1405258701
+where
+\change_unchanged
+ any working path 
+\change_inserted 711066561 1405258613
+instead of lyxpipe 
+\change_unchanged
+can be used
+\change_inserted 711066561 1405258962
+, for example 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405258868
+"
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+my
+\backslash
+lyx
+\backslash
+pipe"
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ would also work
+\change_unchanged
+).

  You 
 \emph on
 must
  You 
 \emph on
 must


@@ -5337,13 +5382,20 @@ lyx -dbg lyxserver
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-You can find a complete example client written in C in the source distribution
- as 
+You can find a complete example client written in C
+\change_inserted 711066561 1405258366
+++
+\change_unchanged
+ in the source distribution as 

 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
 development/lyxserver/server_monitor.c
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
 development/lyxserver/server_monitor.c

+\change_inserted 711066561 1405258386
+pp
+\change_unchanged
+

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -5352,7 +5404,11 @@ development/lyxserver/server_monitor.c
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-Another useful tool is the command-line based clientfound in 
+Another useful tool is the command-line based client
+\change_inserted 711066561 1405258403
+ 
+\change_unchanged
+found in 

 \begin_inset Flex Code
 status collapsed
 
 \begin_inset Flex Code
 status collapsed
 


@@ -5505,6 +5561,63 @@ read a <~/.lyxpipe.out
 echo $a
 \end_layout
 
 echo $a
 \end_layout
 

+\begin_layout Subsection
+AppleScript (Mac OS X)
+\end_layout
+
+\begin_layout Standard
+Since LyX 2.1, LyX supports basic interactions with AppleScript for normal
+ communication through the command run.
+ This command takes a direct argument (the 
+\series bold
+function
+\series default
+ to perform) and an optional argument.
+ It either returns the output of the function or triggers an error with
+ the error message and code.
+\end_layout
+
+\begin_layout Standard
+Example:
+\end_layout
+
+\begin_layout LyX-Code
+tell application "LyX"
+\end_layout
+
+\begin_layout LyX-Code
+  try
+\end_layout
+
+\begin_layout LyX-Code
+    -- Stores the current file name into f
+\end_layout
+
+\begin_layout LyX-Code
+    set f to (run "server-get-filename" with argument "")
+\end_layout
+
+\begin_layout LyX-Code
+    on error the error_message number the error_number
+\end_layout
+
+\begin_layout LyX-Code
+      display dialog "Error: " & the error_number & ".
+ " ¬
+\end_layout
+
+\begin_layout LyX-Code
+              & the error_message buttons {"OK"} default button 1
+\end_layout
+
+\begin_layout LyX-Code
+  end try
+\end_layout
+
+\begin_layout LyX-Code
+end tell
+\end_layout
+

 \begin_layout Section
 Notification
 \end_layout
 \begin_layout Section
 Notification
 \end_layout


@@ -5635,8 +5748,11 @@ Some DVI/PDF viewers
 status collapsed
 
 \begin_layout Plain Layout
 status collapsed
 
 \begin_layout Plain Layout

-The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Skim on Mac OSX and SumatraPDF on Windows.
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux
+\change_inserted 711066561 1405273809
+, Qpdfview on Unix
+\change_unchanged
+, Skim on Mac OSX and SumatraPDF on Windows.

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -5781,7 +5897,13 @@ synctex=-1
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-Please aöso note that including the 
+Please a
+\change_deleted 711066561 1405259326
+ö
+\change_inserted 711066561 1405259326
+l
+\change_unchanged
+so note that including the 

 \begin_inset Flex Code
 status collapsed
 
 \begin_inset Flex Code
 status collapsed
 


@@ -6073,9 +6195,31 @@ scr-specials
 \emph default
  approach.
  You need at least TeXLive 2008 or a recent MikTeX distribution in order
 \emph default
  approach.
  You need at least TeXLive 2008 or a recent MikTeX distribution in order

- to use it.
- Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
- already provide SyncTeX support.
+ to use it
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For some reason, MikTeX does not understand/obey the command LyX inserts
+ into the preamble when you check the "Enable Forward/Reverse Search" button
+ in the toolbar and does not generate the necessary info.
+\end_layout
+
+\begin_layout Plain Layout
+The generation of the required info can be forced by changing the converter
+ "LaTeX (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
+ from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
+ the -synctex=1 switch).
+\end_layout
+
+\end_inset
+
+.
+ Also note that only a few PDF viewers (
+\change_inserted 711066561 1405273879
+Okular and Qpdfview on Unix, 
+\change_unchanged
+Skim on the Mac, SumatraPDF on Windows) already provide SyncTeX support.

 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard


@@ -6556,6 +6700,68 @@ lyxclient -g %f %l
 
 \begin_layout Standard
 Reverse search is triggered by SHIFT-click.
 
 \begin_layout Standard
 Reverse search is triggered by SHIFT-click.

+\change_inserted 711066561 1405259853
+
+\end_layout
+
+\begin_layout Subsubsection*
+
+\change_inserted 711066561 1405273730
+Qpdfview (Unix)
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 711066561 1405263147
+Qpdfview supports SyncTeX since version 0.3.5.
+ Go to 
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405260331
+Edit\SpecialChar \menuseparator
+Settings\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Behavior
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, click on the input field of the 
+\begin_inset Quotes eld
+\end_inset
+
+Source editor
+\begin_inset Quotes erd
+\end_inset
+
+ item and add the command 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405260473
+lyxclient -g %1 %2
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 711066561 1405260506
+Reverse search is triggered by double-click.
+\change_unchanged
+

 \end_layout
 
 \begin_layout Subsubsection*
 \end_layout
 
 \begin_layout Subsubsection*


@@ -7099,15 +7305,72 @@ $$o
 
 \begin_layout Standard
 Note that only some of the viewers provide full forward search functionality,
 
 \begin_layout Standard
 Note that only some of the viewers provide full forward search functionality,

- among them yap, xdvi, okular and Sumatra PDF.
+ among them yap, xdvi, okular
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You might want to set 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+okular --unique
+\end_layout
+
+\end_inset
+
+ in 
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File
+\begin_inset space ~
+\end_inset
+
+Formats
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted 711066561 1405264317
+, qpdfview
+\change_unchanged
+ and Sumatra
+\change_deleted 711066561 1405264282
+ 
+\change_unchanged
+PDF

 \begin_inset Foot
 status collapsed
 
 \begin_layout Plain Layout
 \begin_inset Foot
 status collapsed
 
 \begin_layout Plain Layout

-For Sumatra CMCDDE is needed --- downloadable from 
+
+\change_deleted 711066561 1405264216
+For 
+\change_unchanged
+Sumatra
+\change_inserted 711066561 1405264265
+PDF can also use DDE commands through the external program
+\change_unchanged
+ CMCDDE
+\change_deleted 711066561 1405264271
+ is needed
+\change_unchanged
+ --- downloadable from 

 \begin_inset CommandInset href
 LatexCommand href
 \begin_inset CommandInset href
 LatexCommand href

-target "http://www.istri.fr/zip/CMCDDE.zip"
+target "ftp://ftp2.commence.com/pub/freebies/"

 
 \end_inset
 
 
 \end_inset
 


@@ -7116,6 +7379,7 @@ target "http://www.istri.fr/zip/CMCDDE.zip"
 
 \end_inset
 
 
 \end_inset
 

+.

  While many of the widespread PDF viewers (most notably Adobe Reader) do
  not support forward search at all, some other viewers -- e.
 \begin_inset space \thinspace{}
  While many of the widespread PDF viewers (most notably Adobe Reader) do
  not support forward search at all, some other viewers -- e.
 \begin_inset space \thinspace{}


@@ -18082,7 +18346,7 @@ ChkTeX
 \emph on
 is
 \emph default
 \emph on
 is
 \emph default

- very configurable and extensible, you shouldn't expect to solve all problems
+ very configurable and extensible, you should not expect to solve all problems

  with 
 \family sans
 ChkTeX
  with 
 \family sans
 ChkTeX


@@ -18104,11 +18368,7 @@ chktex
 \family default
  by using 
 \family sans
 \family default
  by using 
 \family sans

-Edit\SpecialChar \menuseparator
-View
-\begin_inset space ~
-\end_inset
-
+Document\SpecialChar \menuseparator

 LaTeX
 \begin_inset space ~
 \end_inset
 LaTeX
 \begin_inset space ~
 \end_inset


@@ -20022,7 +20282,7 @@ Control
  submenu.
  Please note that if you use password protected access to repository via
  ssh, you will be asked in terminal window.
  submenu.
  Please note that if you use password protected access to repository via
  ssh, you will be asked in terminal window.

- LyX was tested against SVN 1.5 and 1.6
+ LyX was tested against SVN 1.5, 1.6, 1.7 and 1.8

 \begin_inset Foot
 status open
 
 \begin_inset Foot
 status open
 


@@ -20035,6 +20295,8 @@ reference "sub:SVN-Repo-Update"
 \end_inset
 
 .
 \end_inset
 
 .

+ There seems to be currently unresolved permissions problem under SVN 1.8
+ with reverting changes when file is locked.

 \end_layout
 
 \end_inset
 \end_layout
 
 \end_inset


@@ -21516,6 +21778,24 @@ Control
  Please note that if you use password protected access to repository via
  ssh, you will be asked in terminal window.
  LyX was tested against GIT 1.7.
  Please note that if you use password protected access to repository via
  ssh, you will be asked in terminal window.
  LyX was tested against GIT 1.7.

+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Windows users please note that you need to ensure that git is on the path.
+ This can be set from within LyX at 
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths\SpecialChar \menuseparator
+PATH prefix
+\family default
+.
+\end_layout
+
+\end_inset
+
+

 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard


@@ -23043,7 +23323,7 @@ LyX has a range of buttons that are available for tool bar customization.
  In my toolbar I like to combine the six short cuts above with two more:
  One for 
 \family sans
  In my toolbar I like to combine the six short cuts above with two more:
  One for 
 \family sans

-View
+Document

 \family default
 \SpecialChar \menuseparator
 
 \family default
 \SpecialChar \menuseparator
 


@@ -23057,6 +23337,7 @@ DVI
 \family default
  and the other for 
 \family sans
 \family default
  and the other for 
 \family sans

+Document\SpecialChar \menuseparator

 View\SpecialChar \menuseparator
 DVI
 \family default
 View\SpecialChar \menuseparator
 DVI
 \family default