[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Visual Index to Documentation
From: |
Noeck |
Subject: |
Visual Index to Documentation |
Date: |
Tue, 22 Jan 2013 23:03:58 +0100 |
User-agent: |
Mozilla/5.0 (X11; Linux i686; rv:17.0) Gecko/20130106 Thunderbird/17.0.2 |
Hi,
since the beginning of the year, I have worked on an alternative access
to the LilyPond documentation, which I call a visual index.
It is intended especially for tweaking purposes, if a user wants to
change a property of an object.
Here it is:
http://joramberger.de/files/lilypond_visualindex.pdf
With this index the user does not need to know the names of LilyPond
objects. It links to the corresponding section of the documentation.
Currently, this index covers most graphical objects and their engravers.
Both are sorted according to the contexts, they usually appear in. I
hope this is a fitting representation of the internal structure of
LilyPond, the user might want to interact with. Please correct me if it
is wrong.
How to use it:
You can click on almost everything:
- objects: link to the notation manual (how to use/produce this)
- blue text: link to the internals reference of this layout object
- light blue text: link to the corresponding engraver
(if the name is known from the object, only a circled symbol is used)
- red: typical context the described object is in
All this is a first draft and not complete. Interfaces are not (yet)
covered by this index (because I have no idea how) and many objects,
engravers and contexts are missing (the ones I do not need or the ones I
do not even know how to use them).
I hope you find it useful, any feedback and suggestion for improvement
is welcome!
Joram
PS: If anyone knows if that could be done in html instead of pdf, I
would like to know. It is produced by LilyPond from a ly file.
- Visual Index to Documentation,
Noeck <=