Makefile
Please help keep this file up to date!
Every edition has a Makefile. It specifies
- which files that make up the edition
- the copyright status of the edition
- the author (actually, all copyright holders)
Since we have a large number of editions, and expect the number of
editions to grove in the future, it is important that all our
Makefiles are as similar as possible. We may have to change all
Makefiles in the future to meet new demands; that will be a lot
simpler if they all look the same.
- INDEX = index code
- The index code is the same as the name of the directory
that the Makefile resides in. The index name consists of lower case
letters of the English alphabet (a - z) and digits. There cannot be
more than eight (8) characters in an index name.
- TITLE = "full title of the edition"
- The full printable and readable title of the edition. If the
original material was a book, this is the title of the book.
- AUTHOR = author-code-list
- This is a whitespace-separated list of author codes. Each author
code consists of up to eight (8) lower case letters of the English
alphabet (a - z) and digits. Both authors, translators, illustrators,
and any other copyright holders are mentioned in this list, so
strictly speaking the name is wrong.
Author codes are defined in /usr/local/runeberg/texter/authors/; see editions.html for some information on this (more documentation is
needed).
As a special case, if there is no author or if
the author is anonymous, the line AUTHOR=anon should be
present. That way, the installation software can report missing
AUTHOR lines as errors.
- LICENSE = filename
- NYI:.
This optional line is included in those editions that we publish
even though they are protected by copyright. The specified file
should include a short text (one or at most two lines) describing the
copyright status. It is recommended that it contains an HTML link to
a longer document giving the complete information.
The following file names are currently allowed:
- license.txt
- We have obtained a special license to publish the text. This will
cause a copyright symbol to appear on each HTML page in the edition
together with the contents of license.txt.
- pd.txt
- The edition has been placed in the Public Domain by the copyright
holders. A "no-copyright" icon will appear on each page.
- trans.txt
- The edition can be published legally thanks to the transition
rules of the new Swedish copyright law.
- DEATH = year
- NYI. This optional line is normally not needed. The
information is fetched from the author catalog.FIXME-link-here.
NYI. This is the year of the death of the last copyright
holder. This tag is mandatory if AUTHOR=anon, and in that case it is
the year the work was first published. Under current Swedish law the
work is protected until the year year + 71.
- OFFLINE = reason
- NYIEditions which we don't publish for some reason should
have this line. In the future, it will prevent installation by
mistake.
Two valid reasons are defined:
- wip
- Work in progress.
- license
- The text is covered by copyright and we don't have a license to
publish it. (Sooner or later the copyright will expire and we will be
allowed to publish it).
- LANGUAGE = language-code
- This is a list of all the languages used in the edition. The
langauge codes are defined by ISO. We use a subset:
- daDanish
- fiFinnish
- noNorwegian
- svSwedish
For reference, a long list of langauge
codes compiled from various sources is available. It may contain
errors.
- FILES = list-of-files
- Normally, this is a list of all files that make up the edition.
File names consists of a base name and an extension. The base name
should be at most eight lower case letters from the English alphabet,
or digits, and it should not start with a digit. We use the following
extensions:
- .html
- HTML files. The files are written in an
extended subset of HTML.
- .gif
- GIF files. Used for inline images.
- .jpg
- JPEG files. Used for inline images.
Actually, using FILES is just a shorthand for using both SRC_FILES
and WEB_FILES.
- SRC_FILES = list-of-files
- This should list all files that are used to create the HTML
edition. Defaults to FILES. Any file names and extensions are
allowed. All files on this list are included in the tar distribution
of the edition. A few files are automatically included even if they
are not mentioned here, currently:
- ../Makedefaults
- Makefile
- assignments
- NYI:any file mentioned in a LICENSE line
- WEB_FILES = list-of-files
- List of files to include on the Web server. Defaults to
FILES. Should only include files with the exensions documented
under FILES.
- include ../Makedefaults
- The defaults file contains rules and variables that make
everything work smoothly. Just type "make" and the text will be
installed both on the WWW and ftp server. Then type "make" in the
authors directory, and all catalogs and similar things will be
updated.