elcome and congratulations on obtaining the Virtual Page
Turner program. Virtual Page Turner was written by a performer for performance
purposes. I think you will find this to be a valuable tool if you do performing
and have found the need for a page turner at times. I know I have. I have tried to make this
program as easy to use as possible. If there are any improvements you would
like to see, please contact virtualpianist.com and we will be happy to do what
we can to improve on the program.
To install the Virtual Page Turner (vpt), you run the
installer that comes on the distribution disk.
For Windows XP and Windows Vista, the file is called vpt.msi. For Apple OS X, the file is called
vpt.dmg.
Installing under Windows
Run setup.exe found on the disk to install Virtual Page
Turner. The first panel you will see is
the license agreement. The license is
the Gnu Public License Version 3. For more information about the GPL, see www.fsf.org.
Figure 1. License Agreement
Click on the box to accept the terms of the license and
then click on Next>.
Then you will see the panel to determine where the program
will be placed on the start menu.
Figure 2. Start Menu Panel
Click on Install.
You should see a command window briefly appear during the font
installation and then you will see the install panel for ImageMagick. ImageMagick is an open source program which
Virtual Page Turner depends on for converting pdf images to gif files. Once you install ImageMagick, you will then
be prompted to install Ghostscript.
Ghostscript is another open source program which is used to do pdf
conversions and is necessary if you want to work with pdf files in Virtual Page
Turner. Once you install both
ImageMagick and Ghostscript, you will be done with the Virtual Page Turner
installation. On some machines there is
an error when installing ImageMagick when it tries to open an html file. You can ignore this error.
To run Virtual Page Turner, simply double-click on the vpt
icon. You should see the initial splash screen and a blank canvas with a frame
as shown below:
Menu Bar
Canvas
Status Bar
|
|
Figure 3. Initial Virtual Page Turner
Window
Along the top of the window are the menus, File, Edit, and Help. You will use these menus to load and create pieces, create
programs, set options, and add and remove annotations from the piece.
This is where your piece is displayed. When you load a
piece or a program, the music will fill this area. By default, Virtual Page
Turner takes the maximum size allowable on your screen. You can resize the
window if you desire however.
Messages about the program or piece which is loaded appear
here as well as other informational status messages.
To terminate the program, select Quit from the File menu.
When you first run Virtual Page Turner, you will see the
following panel.
Figure 4. Initial Start Panel
For the music directory, simply pick a directory in which
you want to store your pieces. If you
have a wide screen laptop or monitor you will be using (17 inches or greater)
then “Two Page” mode is appropriate. For
smaller screens, two pages presents the music in too small a format so you will
want to use “Fit Width” mode. The scroll
amount and timer speed can be left alone for now. We won’t be using these
parameters for the quick start section.
After selecting the music directory, click on OK and you
should see the following startup panel.
Figure 5. Startup Panel
(The image for the Helper Robot is not yet created for the
Beta release)
Since you have not previously run Virtual Page Turner,
there is no last piece or last collection to select. There is however a piece of music included
with the distribution of Virtual Page Turner which you can use as a way of
getting familiar with the program until you have scanned your own music into
the computer.
Click on Select Piece and navigate to the installation directory for
Virtual Page Turner (typically C:\Program Files\Virtual Page Turner) and then
navigate to the directory called sample\FurElise under that. (See panel below)
Figure 6. Selecting Sample Piece
Click on OK and you should see the music on your monitor.
The options for Virtual Page Turner are stored in a text
file located in the same directory in which it was installed. The file is
called vptoptions.txt and does not
typically need to be edited by hand. This file is created by Virtual Page
Turner when you set and change options. To change the program options, select Options… from the
File
menu.
Figure 7. Options Panel
Below is a list of the options available in Virtual Page
Turner.
There are two viewing modes in Virtual Page Turner; Two Page and Fit Width. The viewing mode is an option you set by selecting Options… from the
File
menu. When the viewing mode is Two Page,
two pages of music will appear on the canvas at once. In this viewing mode,
when you turn a page, the page on the right hand side moves to the left and the
following page appears on the right. This is useful when you want to continue
to see the music you are playing while preparing for the next page of music.
When the viewing mode is Fit Width, only
one page of music is shown on the screen and the width of the page is the same
as the width of the canvas. This is useful for smaller monitors and smaller
laptops which cannot display two pages at once and still have the music
readable.
Figure 8. Two Different Viewing Modes
This is the music directory that Virtual Page Turner goes
to when you are loading or saving a piece of music. You can set this to any
convenient place on your computer where you like to keep your music.
When the viewing mode is Fit Width, often a whole page will not appear on the screen (see
Figure 2 above). So when you turn a page, you typically don’t want the top of
the next page to appear at the top of the screen. Instead, the screen scrolls
up a certain amount dictated by this value. The value is the number of pixels
(dots on the screen) it will move. You should set this value to one which is
comfortable for you to use. Too large a value and you will lose music that you
are currently looking at. Too small a
value and you will have to scroll too often.
It is possible to have Virtual Page Turner automatically
turn pages using a built-in timer. This
is useful especially when in Fit Width viewing
mode. The combination of the Scroll
Amount and the Timer Speed can be set so the music travels up the screen at the
same pace as the performance. The timer
is turned on and off by pressing the ‘t’ key on the keyboard. This is a toggle switch so pressing it once
turns on the timer, pressing it again will turn off the timer. The value of the timer speed is in seconds.
Fractions of a second can be specified (0.001 for 1 millisecond).
While the timer is running, you can change the speed by
pressing the ‘s’ and the ‘q’ keys on the keyboard. ‘s’ will slow down the speed
by 10% and ‘q’ will make it quicker by 10%.
If you use this mode of operation often, you may find it useful to
program your foot switch accordingly. One possibility is to make the left button
‘s’, the middle button ‘t’, and the right button ‘q’. This way you can adjust the speed and stop
and start the timer as you please while you are playing.
Creating a piece of music for Virtual Page Turner is done
by selecting CreatePiece…
from the File
menu. A piece in Virtual Page Turner is a directory of files. Each of the
files in this directory is a page of your piece of music. Typically you will
scan your music from a scanner. It is also possible however to use an existing
PDF file as a source rather than the scanner. This choice is presented to you
by the panel which appears after selecting Create Piece… which is shown below in
Figure 4.
Figure 9. Selecting the Source for a
New Piece
Creating a Piece from
the Scanner
|
If you are using a scanner to scan your music to create a
piece, select Scanner
from the New Piece
panel and click on OK.
Virtual Page Turner will then ask you to select the scanner from a list using
the panel shown below in Figure 5.
Figure 10. Selecting the Scanner
If you have more than one scanner available (or more then
one TWAIN source) you will see multiple choices. Select the one you want to use and then click
Select.
Virtual Page Turner will then ask you to select a
directory in which to put the pages for your piece. You can either create a new
directory, or select a pre-existing directory for the destination. The name of
the directory will be the name of your piece.
Figure 11. Selecting a Directory to
Store Pages
Select the directory and click on OK.
At this point, Virtual Page Turner will interface with the
scanner and scan your first page.
Depending on the type of scanner you use, the interface will vary.
Usually a panel will appear allowing you to adjust the scanning margins similar
to the panel shown below.
Figure 12. Scanner Interface Panel
After adjusting the margins to your music and accepting
the scan, Virtual Page Turner will store the page in the directory you
previously chose. The first page will be
named Page01.gif. (By default, Virtual Page Turner stores images in GIF file
format)
Then Virtual Page Turner will ask you if there are more
pages to scan. If there are you indicate so and continue until you are finished
scanning your music.
Figure 13. Continue Scanning Panel
Once you indicate you are finished by selecting No on the
Continue Scanning panel, your pages will be saved in the directory you
previously chose and you can load the piece into Virtual Page Turner.
Creating a New Piece
from a PDF File
|
If you have a PDF file of your music, which is sometimes
the preferred format from some on-line sheet music vendors, you can create a
piece for Virtual Page Turner from that PDF file. On Windows, Virtual Page
Turner can directly read PDF Files but on Apple and Linux you need to convert
the PDF file to another format. You can think of a PDF file as another source
similar to the scanner.
Selecting PDF File in the New Piece panel will cause
Virtual Page Turner to ask you to select the PDF file using the panel shown
below.
Figure 14. Choosing the PDF File to
Convert
Select the PDF file you want to convert and click on Open. Virtual Page Turner will then ask you to
select a directory to store the converted file.
Figure 15. Choosing a Directory for PDF
Conversion
Once you choose this directory (or make a new one),
Virtual Page Turner will convert the PDF file and store the pages in that
directory.
The process is completed when you see the following panel.
Figure 16. PDF File Converted Panel
If you want to load the piece into Virtual Page Turner,
select Yes.
Otherwise select No.
Typically a PDF file will contain many pages
of music. In the Windows version of Virtual Page Turner, a special PDF reader
is used. The thing to remember about
this method of using PDF files is that due to the format, enhancements and
annotations are not possible. If you
want to add annotations, you will need to convert the PDF file to another
format like GIF as described earlier in the previous section. In the Apple
version of Virtual Page Turner, you will need to convert the file as there is
no built-in PDF viewer available.
Loading
a Piece into Virtual Page Turner
To load a piece you have created into Virtual Page Turner,
select Load Piece…
from the File
menu.
You will see a panel which asks you to select the
directory for that piece.
Figure 17. Selecting a Piece to Load
Navigate to the directory of your piece and click OK. Your music will then be displayed in the
canvas area.
Programs are collections of pieces. A program is a text
file which consists of a list of directories. Each directory is a piece and the
order of the pieces in the program is the same as the order of the directories
in the file. Using programs, it is possible to move from one piece to the next
without specifically loading each piece. (To move to the next piece, you press
the ‘F’ key (shift-f) and to move back one piece you press the ‘B’ key
(shift-b)).
You can manually create program files, but it is also
possible and usually easier to use Virtual Page Turner to create a program file
for you. To do this you select Create/Edit Program… in the File menu. To load a program file, select Load Program… in
the File
menu.
Select Create/Edit Program… in the File menu and you will
see the program edit panel shown below.
Figure 18. Create/Edit Program Panel
Adding Pieces to your
Program
|
To add a piece to your program select the Add Piece button.
After navigating to the directory which is the piece you want to add, click OK and the
directory will be added to the list area in the Create/Edit Program panel. Adding
more pieces to the program is done by just repeating that step as many times as
necessary.
Removing Pieces from
your Program
|
To remove a piece from your program, select the directory
in the list area of the Create/Edit Program panel and click on Remove Piece. The
piece will be removed from the list.
Changing the Order of
the Program
|
If you have added pieces in an order that is different
from the one you want, select a directory in the list area of the Create/Edit
Program panel and then click on Move Up or Move Down buttons depending on where you want that piece to
be in the program.
Once you have the program you want, you can save it by
selecting OK
in the Create/Edit Program panel. You
will be asked to choose a file name for the program. It should be a file ending
with the .txt
suffix. You can choose an existing file if you want or create a new file name.
If you choose an existing file, you will be asked to confirm if you want to
overwrite the file.
After you are done creating a program, Virtual Page Turner
will ask you if you want to load the program. Select Yes if you do,
and No
if you don’t.
If you have already created a program file, you can simply
load it by selecting Load
Program File… from the File menu.
Sometimes the quality
of the scanned image you get is not easy to read. This happens when scanning a copy, or if
there was some other problem with the scan.
To help deal with this I have also added a feature called “Enhance
Mode”. This is not a substitute for an
image editing tool such as Photoshop or Gimp, but it might come in handy when
some simple transformations are needed.
The way to get
into Enhance Mode, is to select “Toggle Enhance Mode” from the Edit menu after
you have loaded a piece of music.
Figure 19.
Toggle Enhance Mode Selection
After doing that,
you will see the tool bar with the enhance options to select.
Figure 20.
Enhance Tool Bar
The icons are
small. This may change and the pictures
may get better but if you hover the mouse over the buttons you will see what
their function is.
What Enhance Mode
is doing is using the capability of the ImageMagick command line function Convert.
Convert has several options and selecting a button adds that option
to the command. When you click on
Revert, you start over. So if you
selected Blur three times in a row, the command options would become “-blur 2
–blur 2 –blur 2”. (Blur always uses 2 as
a value currently) Also if you select Rotate Clockwise followed by Rotate
Counter Clockwise, they would cancel each other out.
When you start
enhance mode for a piece of music, all the original files are first saved in a
directory under that piece directory called ‘original’. This way you can always get back whatever you
started with. If you are short on disk
space, you might want to delete these directories when you are satisfied with the
result.
The Functions
are:
1. Revert
– Undos all your changes and clears the list of options for convert.
2. Blur
– peforms a blur on the page. I have
found when staffs are choppy and light, blur often makes it easier to read.
3. Rotate
Clockwise – rotate the image a fixed amount.
This will later change to allow you to add your specific value of
rotation.
4. Rotate
Counter Clockwise – same as above
5. Adjust
Black Threshold – This helps make some light images darker. Usually values
between 40000 and 60000 work well.
6. Sharpen
– sharpen the edges
7. Apply
to All Pages – does the conversion for all the pages in the piece. This can take a while.
8. Revert
All Pages – Undo all the changes you ever made to all the pages.
9. Save
– save the changes to the current page
Annotations
One of the nice features of Virtual Page Turner is the
ability to add annotations to your music. Often when working with other
musicians, it is desirable to make notes in the music. Fingerings and
accidentals are frequent annotations that are helpful. Also text to indicate
anything relating to the performance is often useful.
A quick way to remove all annotations is simply delete the
annotation file for that page. Annotation files are located in the piece
directory and have a suffix ‘.ann’.
Adding annotations is simply a matter of pressing the ‘A’
key (shift-a) or selecting Add Annotation… from the Edit menu. When you do either of these
actions, Virtual Page Turner will present you with the Add Annotations
panel shown below.
Figure 21. Add Annotations Panel
From this panel, you can either select the accidental you
want to add, or type in the text you want to add and select OK. Your annotation will appear in red on the
screen and you need to move the mouse to where you want the annotation to
appear and then click the left mouse button to place it. While you are adding an annotation, you can
change the size of the font by pressing the ‘>’ or ‘<’ key. (It also
works with ‘.’ or ‘,’ so you don’t need two hands to adjust the size. ‘.’ Will
make the font bigger and ‘,’ will make the font smaller.)
To remove an annotation, press the ‘R’ key or select Remove Annotation
from the Edit
menu. The status bar will indicate that you are removing annotations. Click the
left mouse button on any of the annotations you added and they will be removed.
Hit the escape key to stop this process.
Note:
Since there are two viewing modes, annotations are specific to each mode. That
is, if you add an annotation to your piece in Fit Width mode, it will not appear if you change the mode to Two Page. Also, keep in mind when you
add annotations, the size of the Virtual Page Turner window and the annotation
are independent. That is, if you place an annotation on the page, and then
change the size of your window, the annotation will no longer be where you want
it. Typically you will not want to often change the size of your window however
so this is not seen as a major problem. If you do need to change your window
size, you will have to remove all annotations and add new ones.
Bookmarks are a feature in Virtual Page Turner that you
can use to jump to a specific location in the piece you are playing. When you
are at a place in the music that you want to jump to from some other place,
press <shift> 1 through <shift> 9.
There are 9 programmable bookmarks available. When you want to jump to a
bookmark that you set, just push that number without the shift key. So for
instance, to set bookmark number 1, you press the ‘!’ key (shift-1) and the
status bar will notify you that bookmark 1 is set. Then later when you press
the ‘1’ key, you will return to that point in the music.
Bookmark ‘0’ is always set to take you to the beginning of
the piece. You can not change this bookmark.
Pressing the minus sign (‘-‘) will remove all bookmarks
that you have set.
The following are keyboard shortcuts to the commands in
Virtual Page Turner
|
Lower case f
|
Forward One Page (or scroll up in Fit Width mode)
|
|
Lower case b
|
Back One Page (or scroll down in Fit Width mode)
|
|
Upper case F
|
Forward One Piece
|
|
Upper case B
|
Back One Piece
|
|
Upper case A
|
Add Annotation
|
|
Upper Case G
|
Go To Piece
|
|
Upper case R
|
Remove Annotation
|
|
Lower case t
|
Toggle Timer on/off
|
|
Upper case O
|
Set Options
|
|
Lower case s
|
Slow timer by 10%
|
|
Lower case q
|
Quicken timer by 10%
|
|
Upper case L
|
Load Program
|
|
Lower case l
|
Load Piece
|
|
Upper case C
|
Create/Edit Program
|
|
Period (.) or ‘>’
|
While adding annotations this will increase the font
size
|
|
Comma (,) or ‘<’
|
While adding annotations this will decrease the font
size
|
|
Shift 1,2,3,4,5,6,7,8,9
|
Set a bookmark (up to 9 possible bookmarks)
|
|
1,2,3,4,5,6,7,8,9
|
Go to bookmark (must be previously set with
Shift-1,2,3,4,5,6,7,8,9)
|
|
0
|
Go to beginning of the piece
|
|
- (minus sign)
|
Remove all bookmarks
|
You can turn pages easily with Virtual Page Turner simply
by tapping on the space bar but there are some pieces which can keep your hands
too busy even for that! This is why I
recommend using the X-Keys footswitch which is available at the
virtualpianist.com web site as well as at the P. I. Engineering web site, www.xkeys.com.
Tips and Recommendations
Below are a few
recommendations found from personal experience.
1.
If you are performing. always have as a
back-up a printed copy of your music. As reliable as computers are, to totally
rely on them is a mistake. Without a printed copy of the music, you are dead in
the water if something goes wrong.
2.
There are several image manipulation commands
available to you through ImageMagick. To enhance your images once they are
scanned, you can use these commands from a command shell. For instance, to add contrast to a page
called Page01.gif, you would type convert Page01.gif –contrast Page01c.gif. For a complete list of commands
available to you, check http://www.imagemagick.org/script/command-line-options.php.
3.
For two page viewing a 17 inch monitor or larger
is needed. Also a resolution of
1680x1050 or greater is best. I find that an LCD monitor with the base removed
works very well. There are some relatively inexpensive monitors available
online. I use a 20 inch 1680x1050
monitor and it works very well. Of course for an upright piano, the laptop
won’t sit on the music desk so a converted monitor is necessary in that case. One good source is www.tigerdirect.com.
4.
If you have music that jumps back pages, it
works well to just copy the pages and insert them in the proper place. You do this by making sure the copied pages
follow alphabetically. For instance, if there are four pages; Page01.gif
Page02.gif, Page03.gif and Page04.gif where Page01.gif and Page02.gif are
repeated after Page03.gif, you might copy them and rename them Page03a.gif
Page03b.gif.
5.
Scanning from copies sometimes produces poor
quality images. It’s best to scan from
the original printed music.
6.
If your image doesn’t look good, try using some
of the convert commands built-in to your computer since you installed Virtual
Page Turner. I have found that convert image.gif –blur 2 image.gif
works well when the staff lines look choppy.
Rotation is also possible. Look
at http://www.imagemagick.org/script/command-line-options.php
for information about the new image capability you have with Virtual Page
Turner installed.
7.
Be careful about how you program the foot
switch. I used to have the right button
programmed to ‘F’ which means go to next piece.
Unfortunately I accidentally pressed it and I was jumped to the next
piece instead of the next page! Deadly in a performance.
8.
Do what you can to minimize your file size. Virtual Page Turner loads images when pages
change so the time to load should be considered. Although most files sizes are small enough
for load times to be small, there’s no use in loading color information from a
scan. convert image.gif
–monochrome image.gif
will get rid of the color information in your scan if you have any.
How to install and run from the source code
Why do this?
There are several
reasons to download and use the source code to run Virtual Page Turner. Computers are our tools and using the source
code allows you to understand what the program is telling your computer to do. It also allows you to make changes if you want
so you can make Virtual Page Turner do what you want it to do. There are some things you need to know to be
able to do this. Things like setting environment variables and installing
python modules and such are not going to be taught here. Anything like that I am going to assume you
know or know how to find help on the web.
All of this software is also on the Virtual Page Turner disk available
at http://www.virtualpianist.com/software/vpt. There are a number of steps:
1.
Create a directory for your code. Example: C:\vpt or "C:\Program
Files\Virtual Page Turner" (how)
2.
Download the source code file winsrcalpha.zip
3.
Using Winzip, extract the files into your new directory.
4.
Download the ImageMagick installer from
http://www.imagemagick.org/script/binary-releases.php#windows
5.
Run the ImageMagick installer.
6.
Download the ghostscript installer from http://ghostscript.com/releases
(Select ghostscript-8.63.tar.gz)
7.
Run the ghostscript installer
8.
Download the Accidentals Font from
http://www.hindson.com.au/wordpress/free-fonts-available-for-download
9.
Install the Font (how)
10.
Download Python version 2.5.2 from http://www.python.org/download (Not
everything is comatible with 2.6 yet)
11.
Install Python
12.
Download wxPython toolkit from
http://www.wxpython.org/download.php#binaries (Select Unicode version 2.5)
13.
Install wxPython
14.
Create the environment variable VPT_HOME and set it to your directory you
created in step 1 (how)
15.
You can now double click on the vpt.bat file or run from a command shell
python vpt.py
Software Needed
Python
There are many programs
that Virtual Page Turner relies on. This
gives it the power to do many things.
First and foremost, Virtual Page Turner is a python program. This means
you need the python interpreter. This is available at http://www.python.org. Get version 2.5. While the twain module is only supporting
version 2.5, I will need to stay with that until I test it all out with version
2.6
wxPython
To be able to have a
graphical user interface (GUI) I use a python toolkit called wxPython. You can get this at http://www.wxpython.org. It allows the panels and windows to work
across platforms like Windows, OS X, and Linux.
Twain
To be able to use your
scanner from Virtual Page Turner, I use
a python module called twain.
Unfortunately it only works on Windows.
Someday perhaps it will also support other operating systems. You get this at http://twainmodule.sourceforge.net. Of course if you are using an Apple or Linux
OS, just skip this.
Accidentals Font
To allow sharps, flats, and naturals to be annotated to
your music, I am using a font created by Matthew Hindson called
Accidentals. It is available at http://www.hindson.com.au/wordpress/free-fonts-available-for-download
and you will need to install this font on your computer for the annotations to
work properly.
Virtual Page Turner Source Code
The source code for
Virtual Page Turner is located at http://www.virtualpianist.com/software/src/vpt.
All of the files should be put in one directory.
ImageMagick
To make conversions
from PDF files to GIF image files, I use a software suite called
ImageMagick. This will be an integral
part of many of the future image manipulation capability built-in to Virtual
Page Turner. You get ImageMagick from http://www.imagemagick.org/script/index.php.
GhostScript
To do conversions from
PDF to GIF, ImageMagick uses GhostScript, an interpreter for the postscript language and PDF. You get GhostScript from http://www.ghostscript.com/awki.
Once you have
downloaded and installed all of the above code, set the environment variable,
VPT_HOME, to the directory you placed the Virtual Page Turner source code. Then you are ready to go.
Just type python vpt.py
from the VPT_HOME directory in a command shell.
Alternatively you can
use the mouse to execute vpt.bat on windows.
If all this seems like
too much work, you can get the disk with an installer from me at www.virtualpianist.com/software/vpt. The program is an executable but all the
source code is on the disk as well.
GNU Free Document License
Version 1.2,
November 2002
Copyright (C)
2000,2001,2002 Free Software Foundation,
Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim
copies of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook,
or other functional and useful document "free" in the sense of
freedom: to assure everyone the effective freedom to copy and redistribute it, with
or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and
publisher a way to get credit for their work, while not being considered
responsible for modifications made by others.
This License is a kind of "copyleft", which
means that derivative works of the document must themselves be free in the same
sense. It complements the GNU General
Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for
manuals for free software, because free software needs free documentation: a
free program should come with manuals providing the same freedoms that the software
does. But this License is not limited to
software manuals; it can be used for any textual work, regardless of subject
matter or whether it is published as a printed book. We recommend this License principally for
works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any
medium, that contains a notice placed by the copyright holder saying it can be distributed
under the terms of this License. Such a
notice grants a world-wide, royalty-free license, unlimited in duration, to use
that work under the conditions stated herein.
The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and
is addressed as "you". You
accept the license if you copy, modify or distribute the work in a way
requiring permission under copyright law.
A "Modified Version" of the Document means any
work containing the Document or a portion of it, either copied verbatim, or
with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a
front-matter section of the Document that deals exclusively with the
relationship of the publishers or authors of the Document to the Document's
overall subject (or to related matters) and contains nothing that could fall
directly within that overall subject.
(Thus, if the Document is in part a textbook of mathematics, a Secondary
Section may not explain any mathematics.)
The relationship could be a matter of historical connection with the
subject or with related matters, or of legal, commercial, philosophical,
ethical or political position regarding them.
The "Invariant Sections" are certain Secondary
Sections whose titles are designated, as being those of Invariant Sections, in
the notice that says that the Document is released under this License. If a section does not fit the above
definition of Secondary then it is not allowed to be designated as
Invariant. The Document may contain zero
Invariant Sections. If the Document does
not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of
text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice
that says that the Document is released under this License. A Front-Cover Text may be at most 5 words,
and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a
machine-readable copy, represented in a format whose specification is available
to the general public, that is suitable for revising the document straightforwardly
with generic text editors or (for images composed of pixels) generic paint
programs or (for drawings) some widely available drawing editor, and that is
suitable for input to text formatters or for automatic translation to a variety
of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format
whose markup, or absence of markup, has been arranged to thwart or discourage
subsequent modification by readers is not Transparent. An image format is not
Transparent if used for any substantial amount of text. A copy that is not "Transparent" is
called "Opaque".
Examples of suitable formats for Transparent copies
include plain ASCII without markup, Texinfo input format, LaTeX input format,
SGML or XML using a publicly available DTD, and standard-conforming simple HTML,
PostScript or PDF designed for human modification. Examples of transparent image formats include
PNG, XCF and JPG. Opaque formats include
proprietary formats that can be read and edited only by proprietary word
processors, SGML or XML for which the DTD and/or processing tools are not
generally available, and the machine-generated HTML, PostScript or PDF produced
by some word processors for output purposes only.
The "Title Page" means, for a printed book, the
title page itself, plus such following pages as are needed to hold, legibly,
the material this License requires to appear in the title page. For works in formats which do not have any
title page as such, "Title Page" means the text near the most
prominent appearance of the work's title, preceding the beginning of the body
of the text.
A section "Entitled XYZ" means a named subunit
of the Document whose title either is precisely XYZ or contains XYZ in
parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name
mentioned below, such as "Acknowledgements", "Dedications",
"Endorsements", or "History".) To "Preserve the Title" of such a
section when you modify the Document means that it remains a section
"Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the
notice which states that this License applies to the Document. These Warranty Disclaimers are considered to
be included by reference in this License, but only as regards disclaiming
warranties: any other implication that these Warranty Disclaimers may have is
void and has no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium,
either commercially or noncommercially, provided that this License, the copyright
notices, and the license notice saying this License applies to the Document are
reproduced in all copies, and that you add no other conditions whatsoever to
those of this License. You may not use technical
measures to obstruct or control the reading or further copying of the copies
you make or distribute. However, you may
accept compensation in exchange for copies.
If you distribute a large enough number of copies you must also follow
the conditions in section 3.
You may also lend copies, under the same conditions stated
above, and you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that
commonly have printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the copies in
covers that carry, clearly and legibly, all these Cover Texts: Front-Cover
Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly
identify you as the publisher of these copies.
The front cover must present the full title with all words of the title
equally prominent and visible. You may
add other material on the covers in addition. Copying with changes limited to
the covers, as long as they preserve the title of the Document and satisfy these
conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous
to fit legibly, you should put the first ones listed (as many as fit reasonably)
on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy a
computer-network location from which the general network-using public has
access to download using public-standard network protocols a complete
Transparent copy of the Document, free of added material. If you use the latter
option, you must take reasonably prudent steps, when you begin distribution of
Opaque copies in quantity, to ensure that this Transparent copy will remain
thus accessible at the stated location until at least one year after the last
time you distribute an Opaque copy (directly or through your agents or
retailers) of that edition to the public.
It is requested, but not required, that you contact the
authors of the Document well before redistributing any large number of copies,
to give them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the
Document under the conditions of sections 2 and 3 above, provided that you
release the Modified Version under precisely this License, with the Modified Version
filling the role of the Document, thus licensing distribution and modification
of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the
Modified Version:
A. Use in the Title Page (and on the covers, if any) a
title distinct from that of the Document, and from those of previous versions (which
should, if there were any, be listed in the History section of the
Document). You may use the same title as
a previous version if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons
or entities responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the Document
(all of its principal authors, if it has fewer than five), unless they release
you from this requirement.
C. State on the Title page the name of the publisher of
the Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a
license notice giving the public permission to use the Modified Version under
the terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of
Invariant Sections and required Cover Texts given in the Document's license
notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History",
Preserve its Title, and add to it an item stating at least the title, year, new
authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled
"History" in the Document, create one stating the title, year,
authors, and publisher of the Document as given on its Title Page, then add an
item describing the Modified Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the
Document for public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions it was based
on. These may be placed in the
"History" section. You may
omit a network location for a work that was published at least four years before the Document itself,
or if the original publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements"
or "Dedications", Preserve the Title of the section, and preserve in
the section all the substance and tone of each of the contributor
acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles.
Section numbers or the equivalent are not considered part of the section
titles.
M. Delete any section Entitled "Endorsements". Such a section may not be included in the
Modified Version.
N. Do not retitle any existing section to be Entitled
"Endorsements" or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers. If the Modified
Version includes new front-matter sections or appendices that qualify as
Secondary Sections and contain no material copied from the Document, you may at
your option designate some or all of these sections as invariant. To do this, add their titles to the list of
Invariant Sections in the Modified Version's license notice. These titles must
be distinct from any other section titles.
You may add a section Entitled "Endorsements",
provided it contains nothing but endorsements of your Modified Version by
various parties--for example, statements of peer review or that the text has been
approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover
Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the
list of Cover Texts in the Modified Version.
Only one passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the Document already includes a cover text
for the same cover, previously added by you or by arrangement made by the same
entity you are acting on behalf of, you may not add another; but you may
replace the old one, on explicit permission from the previous publisher that
added the old one.
The author(s) and publisher(s) of the Document do not by
this License give permission to use their names for publicity for or to assert
or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released
under this License, under the terms defined in section 4 above for modified versions,
provided that you include in the combination all of the Invariant Sections of
all of the original documents, unmodified, and list them all as Invariant
Sections of your combined work in its license notice, and that you preserve all
their Warranty Disclaimers.
The combined work need only contain one copy of this
License, and multiple identical Invariant Sections may be replaced with a
single copy. If there are multiple
Invariant Sections with the same name but different contents, make the title of
each such section unique by adding at the end of it, in parentheses, the name
of the original author or publisher of that section if known, or else a unique
number. Make the same adjustment to the section titles in the list of Invariant
Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled
"History" in the various original documents, forming one section
Entitled "History"; likewise combine any sections Entitled
"Acknowledgements", and any sections Entitled
"Dedications". You must delete
all sections Entitled "Endorsements".
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and
other documents released under this License, and replace the individual copies
of this License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for verbatim
copying of each of the documents in all other respects.
You may extract a single document from such a collection,
and distribute it individually under this License, provided you insert a copy
of this License into the extracted document, and follow this License in all other
respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with
other separate and independent documents or works, in or on a volume of a
storage or distribution medium, is called an "aggregate" if the copyright
resulting from the compilation is not used to limit the legal rights of the
compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this
License does not apply to the other works in the aggregate which are not
themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable
to these copies of the Document, then if the Document is less than one half of the
entire aggregate, the Document's Cover Texts may be placed on covers that
bracket the Document within the aggregate, or the electronic equivalent of
covers if the Document is in electronic form. Otherwise they must appear on
printed covers that bracket the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you
may distribute translations of the Document under the terms of section 4. Replacing
Invariant Sections with translations requires special permission from their
copyright holders, but you may include translations of some or all Invariant
Sections in addition to the original versions of these Invariant Sections. You may include a translation of this
License, and all the license notices in the Document, and any Warranty
Disclaimers, provided that you also include the original English version of
this License and the original versions of those notices and disclaimers. In case of a disagreement between the
translation and the original version of this License or a notice or disclaimer,
the original version will prevail.
If a section in the Document is Entitled
"Acknowledgements", "Dedications", or "History",
the requirement (section 4) to Preserve its Title (section 1) will typically
require changing the actual title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the
Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense
or distribute the Document is void, and will automatically terminate your
rights under this License. However, parties
who have received copies, or rights, from you under this
License will not have their licenses terminated so long as
such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised
versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit
to the present version, but may differ in detail to address new problems or
concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered version of this License
"or any later version" applies to it, you have the option of following
the terms and conditions either of that specified version or of any later
version that has been published (not as a draft) by the
Free Software Foundation.
If the Document does not specify a version number of this License, you
may choose any version ever published (not as a draft) by the Free Software
Foundation.
