The LilyPond Documentation Browser

Frescobaldi has a built-in browser for LilyPond's extensive documentation, accessible by clicking on its tab at the right or by pressing Meta+Alt+D. The browser can display locally installed documentation (e.g. installed in a local directory or via your operating system distribution) or the documentation at the LilyPond website.

Frescobaldi first searches the LilyPond documentation on the local system; if it isn't found the documentation pages from lilypond.org/doc are shown. You can configure the URL or path to the LilyPond documentation under Settings » Configure Frescobaldi... » Paths. If you configure a local path, specify it including the index.html filename.

The documentation browser works just like a normal browser. The Home button brings up the documentation start page. By right-clicking the browser view you can open any page in your default browser. By right-clicking a link in the browser view you can open the link in a new browser or other suitable application.

You can also get context-sensitive help by right-clicking a LilyPond statement in the text editor. The LilyPond Help context submenu then displays the relevant entries both from the Learning Manual and the Notation Reference.

The other small buttons correspond with the so-called "rellinks" (related links) in the LilyPond documentation. This way you can easily navigate the documentation or jump to the table of contents, etcetera. (Different versions of the LilyPond documentation have subtle differences in the navigation.)

If you click an image of music that links to a LilyPond snippet, the snippet is shown in a read-only editor view with LilyPond syntax highlighting.

Keyboard shortcuts

(Click once in the browser view to give it the keyboard focus, by default the keyboard focus remains in the text editor when the browser is opened.)

BackSpace Go back a page in the browser view.
/ Start entering a short search phrase to search for in the current page.
ESC Quit entering a search phrase.
Enter When in the search phrase entry, finds the next occurence.
Tab Navigate the links in the page.
Arrows / PgUp / PgDn Scroll the page or move the cursor.
Last modified: 16 nov 2009