[ << External programs ]	[Top][Contents][Index]	[ Suggestions for writing files >> ]
[ < Point and click ]	[ Up : Point and click ]	[ Using GNOME for point and click > ]

4.1.1 Configuring the system

When this functionality is active, LilyPond adds hyperlinks to PDF and SVG files. These hyperlinks are sent to a ‘URI 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 follow hyperlinks using the ‘lilypond-invoke-editor’ script supplied with LilyPond.

The program ‘lilypond-invoke-editor’ is a small helper program. It will invoke an editor for the special textedit URIs, and run a web browser for others. It looks up the environment variables EDITOR and LYEDITOR to find out and launch the favorite editor to use. LYEDITOR will have priority over EDITOR, so we recommend using the former especially if you want to use one editor in the terminal and another editor for LilyPond point and click.

Every editor may have a different syntax to open a file in a specific line and column. For user’s convenience, LilyPond comes with ready commands for several editors, listed in ‘scripts/lilypond-invoke-editor.py’. This means that you can simply write the editor binary name, e.g.:

export LYEDITOR=atom

and this will invoke

atom %(file)s:%(line)s:%(column)s

where %(file)s, %(line)s and %(column)s are replaced with the file, line and column respectively.

In order to use an editor not listed in the script, you should find its specific syntax and assign the full command to LYEDITOR. Here’s an example for Visual Studio Code editor:

export LYEDITOR="code --goto %(file)s:%(line)s:%(column)s"

Using GNOME
Extra configuration for Evince

---

[ << External programs ]	[Top][Contents][Index]	[ Suggestions for writing files >> ]
[ < Configuring the system for point and click ]	[ Up : Configuring the system for point and click ]	[ Extra configuration for Evince > ]

Using GNOME

In GNOME, URIs are handled via ‘.desktop’ files. Create a file in a local directory such as ‘/tmp’ that is called ‘lilypond-invoke-editor.desktop’ and has the contents;

[Desktop Entry]
Version=1.0
Name=lilypond-invoke-editor
GenericName=Textedit URI handler
Comment=URI handler for textedit:
Exec=lilypond-invoke-editor %u
Terminal=false
Type=Application
MimeType=x-scheme-handler/textedit;
Categories=Editor
NoDisplay=true

and then execute the commands

xdg-desktop-menu install ./lilypond-invoke-editor.desktop
xdg-mime default lilypond-invoke-editor.desktop x-scheme-handler/textedit

After that invocation;

xdg-open textedit:///etc/issue:1:0:0

should call ‘lilypond-invoke-editor’ for opening files.

---

[ << External programs ]	[Top][Contents][Index]	[ Suggestions for writing files >> ]
[ < Using GNOME for point and click ]	[ Up : Configuring the system for point and click ]	[ Enabling point and click > ]

Extra configuration for Evince

If xdg-open works, but Evince still refuses to open point and click links due to denied permissions, you might need to change the Apparmor profile of Evince which controls the kind of actions Evince is allowed to perform.

For Ubuntu, the process is to edit the file ‘/etc/apparmor.d/local/usr.bin.evince’ and append the following lines:

# For Textedit links
/usr/local/bin/lilypond-invoke-editor Cx -> sanitized_helper,

After adding these lines, call

sudo apparmor_parser -r -T -W /etc/apparmor.d/usr.bin.evince

Now Evince should be able to open point and click links. It is likely that similar configurations will work for other viewers.

---

[ << External programs ]	[Top][Contents][Index]	[ Suggestions for writing files >> ]
[ < Extra configuration for Evince ]	[ Up : Point and click ]	[ Selective point-and-click > ]

Enabling point and click

Point and click functionality is enabled by default when creating PDF or SVG files.

The point and click links enlarge the output files significantly. For reducing the size of these (and PS) files, point and click may be switched off by issuing

\pointAndClickOff

in a ‘.ly’ file. Point and click may be explicitly enabled with

\pointAndClickOn

Alternately, you may disable point and click with a command-line option:

lilypond -dno-point-and-click file.ly

---

[ << External programs ]	[Top][Contents][Index]	[ Suggestions for writing files >> ]
[ < Enabling point and click ]	[ Up : Point and click ]	[ Text editor support > ]

Selective point-and-click

For some interactive applications, it may be desirable to only include certain point-and-click items. For example, if somebody wanted to create an application which played audio or video starting from a particular note, it would be awkward if clicking on the note produced the point-and-click location for an accidental or slur which occurred over that note.

This may be controlled by indicating which events to include:

• Hard-coded in the ‘.ly’ file:

  \pointAndClickTypes #'note-event
  \relative {
    c'2\f( f)
  }
  

  or

  #(ly:set-option 'point-and-click 'note-event)
  \relative {
    c'2\f( f)
  }
  

• Command-line:

  lilypond -dpoint-and-click=note-event   example.ly
  

Multiple events can be included:

• Hard-coded in the ‘.ly’ file:

  \pointAndClickTypes #'(note-event dynamic-event)
  \relative {
    c'2\f( f)
  }
  

  or

  #(ly:set-option 'point-and-click '(note-event dynamic-event))
  \relative {
    c'2\f( f)
  }
  

• Command-line:

  lilypond \ -e"(ly:set-option 'point-and-click '(note-event dynamic-event))" \ example.ly

---

[ << External programs ]	[Top][Contents][Index]	[ Suggestions for writing files >> ]
[ < Enabling point and click ]	[ Up : Point and click ]	[ Text editor support > ]

<< Back to Documentation Index

LilyPond — Usage v2.24.4 (stable-branch).