Re: Doc: Point-and-Click has wrong default value and ref to SVG output needs adding (issue 61630045)

[pkx166h]

Reviewers: lemzwerg, ul_openlilylib.org,

Message:
On 2014/02/10 19:34:46, ul_openlilylib.org wrote:

> mailto:address@hidden schrieb:
> >

> https://codereview.appspot.com/61630045/diff/1/Documentation/usage/external.itely
> >File Documentation/usage/external.itely (right):
> >

> https://codereview.appspot.com/61630045/diff/1/Documentation/usage/external.itely#newcode32
> >Documentation/usage/external.itely:32: in the @code{PDF} viewer.
This
> >makes it easier to find input that
> >I'm not sure it's a good idea to use @code for acronyms like PDF or
> >SVG.
> >  Shouldn't we reserve this to commands and the like?

> I just came across this when wanting to write a repository name. If I
understood
> the section in the CG right @var would be the command of choice for
this.

> >
> >https://codereview.appspot.com/61630045/
> >
> >_______________________________________________
> >lilypond-devel mailing list
> mailto:>address@hidden
> >https://lists.gnu.org/mailman/listinfo/lilypond-devel


> --
> Urs Liska
> http://openlilylib.org

It's pretty inconsistent. What I have done is take @code{} of all the
'PDF' and 'SVG' and 'PS' references when talking about the file itself
(or a viewer) rather than say a file extension or (obviously) when using
it in a command line.

James

Description:
Doc: Point-and-Click has wrong default value and ref to SVG output needs
adding

Issue 3854

Also made sure that references to Point-and-click are consistent
through lily.scm and external.itely (including TexInfo formatting).

Please review this at https://codereview.appspot.com/61630045/

Affected files (+17, -17 lines):
  M Documentation/usage/external.itely
  M Documentation/usage/running.itely
  M scm/lily.scm


Index: Documentation/usage/external.itely
diff --git a/Documentation/usage/external.itely  
b/Documentation/usage/external.itely
index  
7c386ae733f802bb898d9944a068a5fbc2385fa0..32326ff96d02bbbd8e20ff7fa7e9bd9a2a2bfd58  
100644
--- a/Documentation/usage/external.itely
+++ b/Documentation/usage/external.itely
@@ -29,8 +29,8 @@ LilyPond can interact with other programs in various ways.
 @cindex point and click

 Point and click lets you find notes in the input by clicking on them
-in the PDF viewer.  This makes it easier to find input that causes
-some error in the sheet music.
+in the @code{PDF} viewer.  This makes it easier to find input that
+causes some error in the sheet music.

 @menu
 * Configuring the system for point and click::
@@ -41,12 +41,12 @@ some error in the sheet music.
 @node Configuring the system for point and click
 @subsection Configuring the system

-When this functionality is active, LilyPond adds hyperlinks to the
-PDF file.  These hyperlinks are sent to a @q{URI helper} or a
-web-browser, which opens a text-editor with the cursor in the
-right place.
+When this functionality is active, LilyPond adds hyperlinks to
address@hidden and @code{SVG} files.  These hyperlinks are sent to a
address@hidden helper} or a web-browser, which opens a text-editor with the
+cursor in the right place.

-To make this chain work, you should configure your PDF viewer to
+To make this chain work, you should configure your @code{PDF} viewer to
 follow hyperlinks using the @file{lilypond-invoke-editor} script
 supplied with LilyPond.

@@ -108,7 +108,7 @@ urlCommand     "lilypond-invoke-editor %s"
 @end example

 If you are using Ubuntu, it is likely that the version of Xpdf
-installed with your system crashes on every PDF file: this state
+installed with your system crashes on every @code{PDF} file: this state
 has been persisting for several years and is due to library
 mismatches.  Your best bet is to install a current @samp{xpdf}
 package and the corresponding @samp{libpoppler} package from
@@ -124,7 +124,7 @@ in order to keep Ubuntu from overwriting it with the  
next
 @node Using GNOME 2 for point and click
 @unnumberedsubsubsec Using GNOME 2

-For using GNOME 2 (and PDF viewers integrated with it), the magic
+For using GNOME 2 (and @code{PDF} viewers integrated with it), the magic
 invocation for telling the system about the @samp{textedit:} URI
 is
 @example
@@ -205,11 +205,11 @@ likely that similar configurations will work for  
other viewers.
 @cindex file size, output

 Point and click functionality is enabled by default when creating
-PDF files.
address@hidden or @code{SVG} files.

 The point and click links enlarge the output files significantly.  For
-reducing the size of PDF and PS files, point and click may be switched
-off by issuing
+reducing the size of these (and @code{PS}) files, point and click may
+be switched off by issuing

 @example
 \pointAndClickOff
@@ -231,7 +231,7 @@ lilypond -dno-point-and-click file.ly

 @warning{You should always turn off point and click in any LilyPond
 files to be distributed to avoid including path information about
-your computer in the .pdf file, which can pose a security risk.}
+your computer in the @code{PDF} file, which can pose a security risk.}

 @node Selective point-and-click
 @unnumberedsubsec Selective point-and-click
Index: Documentation/usage/running.itely
diff --git a/Documentation/usage/running.itely  
b/Documentation/usage/running.itely
index  
7e7692c86dff6d536474f45c3a507457c1263af9..51c4d6e1cb005fb31abdbfc5fc99a62dc0081cd2  
100644
--- a/Documentation/usage/running.itely
+++ b/Documentation/usage/running.itely
@@ -551,9 +551,9 @@ escaped double quotes.
 @tab Set GhostScript's output format for pixel images.

 @item @code{point-and-click}
address@hidden @code{#f}
address@hidden Add @q{point & click} links to @code{PDF} output. See
address@hidden and click}.
address@hidden @code{#t}
address@hidden Add @q{point & click} links to @code{PDF} and @code{SVG} output.
+See @ref{Point and click}.

 @item @code{preview}
 @tab @code{#f}
Index: scm/lily.scm
diff --git a/scm/lily.scm b/scm/lily.scm
index  
c27b381bf100cd83892af7cdf103b4fa00c451f1..47e88eef9f4ba19b1a8d338c37596914c4841da9  
100644
--- a/scm/lily.scm
+++ b/scm/lily.scm
@@ -277,7 +277,7 @@ file to given string.")
 to a music font.")
     (point-and-click
      #t
-     "Add point & click links to PDF output.")
+     "Add point & click links to PDF and SVG output.")
     (paper-size
      "a4"
      "Set default paper size.")