Filer med mera
The working language of Projekt Runeberg is English. The following
text should be translated to English.
Arbetet inom Projekt Runeberg bedrivs ideellt och ganska oorganiserat.
Det är dock ingen ursäkt för att inte försöka hålla så god ordning som
möjligt på det vi gör. Den här WWW-sidan är ett första försök att
på ett centralt ställe sammanställa hur det går till när man ska göra
något i Projekt Runeberg.
Om du inte har ett konto på Lysators datorer har du inte mycket nytta
av att läsa vidare. Då är du i stället beroende av att vi som har det
hjälper dig att ta emot din text och katalogisera den. Ha överseende
med oss om vi inte svarar så snabbt som vi borde! Vi vill hjälpa dig
snabbt, men ibland har vi ont om tid. Du får gärna läsa vidare; hur
vi bedriver projektet är ingen hemlighet.
Files
This is intended to be a complete list of all files in Project
Runeberg. Please help keep it up to date!
- /usr/local/runeberg
- The top of the source tree. Everything outside this tree shoule
be generated from this source. Warning! There is still
some material which resides in other places.
- /usr/local/runeberg/bin
- Various programs and scripts that are used to maintain, manipulate and
install the editions. Source code to the programs are maintained in
the same directory, and there is a Makefile that compiles everything
that needs compilation.
- /usr/local/runeberg/bilder
- Images used throgout the project. This is somewhat arcane and may
be considered obsolete.
- /usr/local/runeberg/brev
- Not actively used.
- /usr/local/runeberg/gopher
- We hope to phase out this directory in the near future. Some
parts of are still used, however.
- /usr/local/runeberg/gopher/katalog.tab
- Source to our List of Nordic
Authors.
- /usr/local/runeberg/ordlistor
- Obsolete experiments with automatically generated word lists.
- /usr/local/runeberg/postlista
- Archive of everything sent to runeberg-list@lysator.liu.se.
- /usr/local/runeberg/texter
- Actually, almost all source to the project (except the very few
program sources found in ../bin are kept here. Each edition
have its own source directory here. Apart from the editions there are
a few extra files (and special editions); they are enumerated below.
- /usr/local/runeberg/texter/Makedefaults
- This file is included by every Makefile in the normal
editions. See makefile.html for more
information about the Makefiles.
- /usr/local/runeberg/texter/Makefile
- A makefile that installs all editions.
NYIThis is automatically ran once per week to ensure that we
don't forget to install something.
- /usr/local/runeberg/texter/WWW
- A symbolic link to /usr/www/html/runeberg. Is this link used by
anything? If not, it should probably be removed.
- /usr/local/runeberg/texter/admin/
- A special edition, which contains information used internally in
the project.
- /usr/local/runeberg/texter/authors/
- A special edition, large parts of which are automatically
generated. The automatically generated book and author indexes use
files in this directory while they are being constructed.
- /usr/local/runeberg/texter/authors/a.lst
- A list of all authors which we publish, and several other
persons as well.
- /usr/local/runeberg/texter/authors/author-code.txt
- A short description, written in HTML, of each author which we
have published anything by. Look at a few of them before you write a
new one, to get a feel for what is expected. This should not inlcude
a list of the texts we have published; that will automatically be
incorporated together with this text into
author-code.html.
Each author has a unique author
code.
- /usr/local/runeberg/texter/authors/author-code.html
- Automatically generated. Internal use only. Use with caution.
- /usr/local/runeberg/texter/authors/author-code.tit/
- Automatically generated.
- /usr/local/runeberg/texter/authors/author-code.tit/index-code
- Automatically generated. One file per author and edition. The
file format is designed to be computer-readable.
- /usr/local/runeberg/texter/index-code/
- One directory per edition we publish. Each edition has a
unique index code.
- /usr/local/runeberg/texter/index-code/Makefile
- A makefile that generates and installs the HTML and ftp versions
of this edition.
- /usr/local/runeberg/texter/index-code/RCS
- All source files are version-controlled by RCS in this
subdirectory.
- /usr/local/runeberg/texter/index-code/assignments
- FIXME: Needs documentation.
- /usr/local/runeberg/texter/index-code/index.html
- Cover page for the edition.
- /usr/local/runeberg/texter/index-code/*
- Each edition has full liberty to organize the rest of the files
any way it wants to. A few files have special meaning.
RCS
Alla våra "källkodsfiler" ligger under RCS. Om filen du tänker
ändra inte ligger under RCS så är den antagligen automatgenererad.
Tänk efter en gång till innan du gör något. Din ändring kanske
försvinner nästa gång filen automatgenereras!
Om du inte kan RCS ska du se till att någon lär dig det. Tips: VC i
Emacs gör livet mycket enklare.
Katalogen
Leif Stensson har gjort experiment med en ny katalog, men tills vidare
är det vår enkla katalog som gäller. Den
automatgenereras från filen
/usr/local/runeberg/gopher/katalog.tab. Det finns en kommentar i
början av filen som beskriver formatet. När du gjort en ändring
skriver du make install
så installeras en uppdaterad
katalog i WWW-filträdet.
Så fort du påbörjar ett nytt verk ska du göra en anteckning i
katalogen, så att ingen annan börjar på samma verk. Skriv det som en
kommentar tills du har något att presentera, så att det inte dyker upp
i katalogen på Webben.
Author list
Our author lists are generated from the
data found in /usr/www/runeberg/texter/authors/a.lst. Each author occupies one
line, and each field on each line is separated by a bar. Example:
1858|1941|Lagerlöf|SELMA Ottiliana Lovisa|se|writer|lagerlof
Note that the entire entry must fit on one line. There is currently
no way to write comments in the file. The fields have the following
meaning (from left to right)
- 1858
- Year of birth.
- 1941
- Year of death.
- Lagerlöf
- Name used for sorting. Normally this is the surname, but in some
cases (such as Olavus Petri) the entire name should be included in
this field.
- SELMA Ottiliana Lovisa
- Given names. The name normally used is written in all caps.
- se
- Country code. This is *not* the langauge code! Some authors
write in more than one language.
- writer
- Profession
- lagerlof
- Code name for this author. This is the same code that appears in
the AUTHOR = code entry in our makefiles.
Text till verken
Text till verk ska ligga i ett subdir till
/usr/local/runeberg/texter.
Varje verk har ett eget directory. Namnet finns i katalogens första
fält.
I varje directory ska följande filer finnas:
Makefile
: genom att skriva make
ska
verket installeras i WWW-trädet. Våra makefiler skriver vi så långt
möjligt i ett hårt specat subset av make
som tillsammans med
/usr/local/runeberg/texter/Makedefaults.
assignments
: här står i ett standardiserat (men för
tillfället odokumenterat) format vem som har gjort/ska göra/gör vad.
RCS
: i detta directory lagras RCS-filer med vars
hjälp man kan plocka fram äldre versioner av alla filer.
- Själva texten. Det har ännu inte utkristalliserats någon standard
för hur det ska lagras, men det är ganska vanligt att den ligger i
filer med namn 01.html, 02.html och så vidare, ett kapitel per fil.
Det är dock inte alltid så.
WWW-trädet
WWW-trädet finns under /usr/www/html/runeberg. En del filer editeras
på plats i trädet; samtliga dessa är RCS-kontrollerade. Alla andra
filer kopieras dit automatiskt från /usr/local/runeberg någonstans.
Så är i alla fall tanken. Hjälp till att se till att det alltid är
så! (Alternativt: dokumentera undantagen!)
Se upp
Det är inte säkert att allt som står här stämmer. När verkligheten
och detta dokument inte stämmer överens, ska endera eller båda ändras
snarast i mån av tid. Det kan dock vara lämpligt att låta sömn,
arbete, mat, social samvaro och andra aktiviteter få högre prioritet
ibland. Kom ihåg att det här är ett ideellt arbete! Ta en paus om
det känns tråkigt.