updweb
[ --rc
RC
]
[ --verbose
... | --no_verbose
] [ --overwrite
| --no_overwrite
]
[ --webbase
WEBBASE
] [ --srcbase
SRCBASE
] [ --src
SRC
]
[ --webdir
WEBDIR
] [ --xsltpool
XSLTPOOL
]
[ --tempdir
TEMPDIR
] [ --keeptmp
| --no_keeptmp
]
--mkhelp
[ --story
STORY
] --hlpmont
--comp
[ --compdir
COMPDIR
] [ --complang
COMPLANG
]
[ --compimgsz
W
xH
] [ --compfldth
COMPFLDTH
]
[ --replcompix
| --no_replcompix
] [ --upload
| --no_upload
]
[ --localize
| --no_localize
]
--index
[ --ixsrc
IXSRC
]--xslt
--local
--js
--css
--htaccess
[ --websrv
| --no_websrv
]--audio
[ --audio_maxkbps
KBPS
]--images
--no_mkhelp
--no_hlpmont
--no_comp
--no_index
--no_xslt
--no_local
--no_js
--no_css
--no_htaccess
--no_audio
--no_images
Alle Optionen haben Vorgabewerte. Der Befehl updweb --help zeigt die Vorgabewerte an.
--rc
RC
Liest die Einstellungen aus der Datei $HOME/etc/kleider_herbaer_de/sitestyle_conf.d/
. Die Datei RC
.rcupdweb.rc
zeigt den den Aufbau und mögliche Einstellungen.
--help
Gibt eine kurze Hilfe und die Vorgabe-Werte zu allen Optionen aus.
--version
Gibt kurze Hinweise zum Programm und die Version aus.
--verbose
Erstellte und gelöschte Dateien und Verzeichnisse sowie Meldungen über den Programmablauf werden nach STDOUT ausgegeben.
--no_verbose
Diese Option hebt die Wirkung der Option --verbose
auf.
--overwrite
Existierende Dateien werden überschrieben.
--no_overwrite
Existierende Dateien werden weder gelöscht noch ersetzt.
--webbase
WEBBASE
WEBBASE
ist der Pfad des Basisverzeichnis für alle Dateien im Zusammenhang mit der Website.
--srcbase
SRCBASE
SRCBASE
ist der Pfad des Basisverzeichnis für die Skripte und Vorlagen zur Website. Darin wird das Unterverzeichnis localization
mit den Programmen localization/localize
und localization/ftp.pl
zur Übersetzung und zum Updoad der Lesebeiträge (--comp
) erwartet.
--src
SRC
SRC
ist der Pfad des Quell-Verzeichnisses zum Stil und zu den Lesetexten der Website.
--webdir
WEBDIR
WEBDIR
ist der Pfad des Verzeichnisses, das die Vorlage für die Website ist.
In diesem Verzeichnis werden die Startseite index.xhtml
und das Stil-Unterverzeichnis style
erzeugt. Unterverzeichnisse enthalten die Bildergeschichten.
--xsltpool
XSLTPOOL
XSLTPOOL
ist der Pfad des Verzeichnisses der XSLT-Dateien, die von mehreren Anwendung gemeinsam genutzt werden. Vorgabe ist /pool
.
--tempdir
TEMPDIR
Im Verzeichnis TEMPDIR
werden temporäre "kompakte" Javascript- und CSS-Dateien gespeichert, die direkt in die Hilfedatei oder in XSLT-Dateien eingebunden werden.
--keeptmp
Temporäre Dateien werden nicht gelöscht, sondern bleiben erhalten.
--no_keeptmp
Temporäre Dateien werden gelöscht.
--mkhelp
Hilfe-Dateien
erzeugen.WEBDIR
/style/*_help.xhtml.de
Die Hauptquelle für eine Hilfedatei ist die Datei
. Diese Datei kann Text-Platzhalter enthalten, die sich zum Beispiel Bezeichnungen beziehen, die durch Stylesheet aus der richtigen Lokalisierungsdatei eingefügt werden. Die Transformation SRC
/PRESENTATION
_help.xhtml.delocalization_repltext.xslt
(Text) ersetzt diese Platzhalter durch den Text aus der Lokalisierungsdatei.
Falls die Transformation
existiert, wird sie angewandt, um die Hilfedatei zu erzeugen.SRC
/PRESENTATION
_mkhlp.xslt
Andernfalls ersetzt die Transformation
Verweise auf CSS-Dateien (SRC
/help_step_1.xslt
link
-Elemente mit dem Attribut rel
= "stylesheet
") und Verweise auf Javascript-Dateien (script
-Elemente mit dem Attribut src
) durch xi:include
-Elemente. Sie fügt auch einen Verweis auf ein Icon (link
-Element mit dem Attribut rel
= "shortcut icon
") ein, falls er noch fehlt.
Die zweite Transformation
sieht die Dateiinhalte statt der SRC
/help_step_2.xsltxi:include
-Elemente. In die eingebundenen CSS-Regeln (desktop.css
(Quelltext)) setzt sie den Basis-Pfad der Bilder im Stil-Verzeichnis ein und entfernt unnötige Leerzeichen.
Das Programm rmxmlns.pl
(Quelltext) entfernt nicht benutzte Namensraum-Knoten.
Die Hilfe-Datei wird nur erzeugt, wenn die Dateien SRC
/PRESENTATION
_help.xhtml.de
und SRC
/help_step_1.xslt
existieren.SRC
/help_step_2.xslt
--story
STORY
Das Unterverzeichnis STORY
von WEBDIR
enthält die Bilder, die den Bildverweisen in der Stil-abhängigen Hilfe zugeordnet werden.
--hlpmont
Montagen von Vorschaubilder für die Hilfe-Datei erzeugen. Die Hilfe-Datei
muss existieren. Diese Aktion erstellt im Verzeichnis WEBDIR
/help.xhtml
zu jedem Abschnitt der Hilfe eine Bildmontage von Vorschaubildern zu allen Bildern, auf die im Abschnitt verwiesen wird.WEBDIR
/helpmontage
Die Transformation desktop_montage.xslt
(Text) erstellt die Befehle zur Bildmontage.
--comp
Aus den Docbook-Quelltexten im Verzeichnis COMPDIR
und dessen Unterverzeichnissen werden XHTML-Komponenten im Verzeichnis
erstellt (Lesebeiträge). Diese werden in der Startseite eingebettet angezeigt. Auf das Docbook-Dokument werden vier aufeinander folgende XSLT-Transformationen angewandt:WEBDIR
/comp
comp_dbk_ht.xslt
(Text) erzeugt ein XHTML-Dokument,xhtml_add_linkthumbs.xslt
fügt zu Verweisen auf Bildergeschichten zusätzlich Vorschaubilder als Verweise ein.ht_abs2rel.xslt
(Text) ersetzt in Verweisen absolute URL-Pfade dieser Website als Verweisziel durch relative Pfade.xhtml_minimize_index.xslt
(Text) enfernt unnötige Leerzeichen, Elemente und Attribute.In jedem direkten Unterverzeichnis von COMPDIR
wird eine Index-Datei index.xml
(s. components.rng
) erzeugt.
Die Transformation
liest die Kennung der Sprache aus der Quelldatei. Der Default-Wert der Sprachkennung ist SRC
/language.xslt
COMPLANG
.
Wenn die Option --upload
wirksam ist, werden die Lesebeiträge durch das Skript
übersetzt und durch das Skript SRCBASE
/localization/localize
hochgeladen.SRCBASE
/localization/pdf.pl
--compdir
COMPDIR
In Unterverzeichnissen von COMPDIR
liegen die DocBook-Quelltexte der Komponenten, die in die Startseite eingebettet werden.
--complang
COMPLANG
COMPLANG
ist die Kennung der Sprache der Komponenten, deren Sprache nicht explizit angegeben ist.
--compimgsz
W
xH
W
und H
sind die Breite und die Höhe, auf die Bilder zu den Lesetexten eingepasst (meist verkleinert) werden, in Pixel.
--compfldth
COMPFLDTH
Abschnitte eines Lesetexte können eingefaltet werden, wenn die Anzahl der Abschnitte eines Lesetextes wenigstens COMPFLDTH
ist. Wenn COMPFLDTH
0 ist, kann ein Text nicht gefaltet werden.
--replcompix
Diese Option wirkt zusammen mit der Aktions-Option --comp
. Existierende Dateien index.xml
in Unterverzeichnissen von COMPDIR
werden ersetzt.
--no_replcompix
Diese Option wirkt zusammen mit der Aktions-Option --comp
und hebt die Wirkung der Option --replcompix
auf. Wenn ein Unterverzeichnis
eine Datei mit dem Namen COMPDIR
/SUBDIR
index.xml
enthält, bleiben diese Datei und das entsprechende Unterverzeichnis
unverändert. In WEBDIR
/comp/SUBDIR
wird keine Datei eingefügt oder ersetzt.WEBDIR
/comp/SUBDIR
--upload
Diese Option bewirkt, dass die Lesebeiträge (--comp
) nach Maßgabe der Option --localize
übersetzt und hochgeladen werden.
--no_upload
Hebt die Wirkung der Option --upload
auf.
--localize
Diese Option wirkt zusammen mit der Aktions-Option --comp
und der Option --upload
. Lesebeiträge (--comp
) werden übersetzt, bevor sie hochgeladen werden.
--no_localize
Diese Option wirkt zusammen mit der Aktions-Option --comp
und hebt die Wirkung der Option --localize
auf. Lesebeiträge werden nicht übersetzt.
--index
Startseite
erzeugen. Die Startseite wird aus dem Quelltext WEBDIR
/index.xhtml.LANG
IXSRC
erzeugt. Die Transformation index_comp.xslt
(Text) bindet die „Lesebeiträge” in den Baum ein, die Transformation index_treeinc.xslt
(Text) die Kalender. Die Transformation index_dbk_ht.xslt
(Text) erzeugt das HTML-Dokument.
LANG
wird mittels
aus SRC
/language.xsltIXSRC
gelesen. Der Default-Wert ist COMPLANG
.
--ixsrc
IXSRC
IXSRC
ist der Pfad der Quelldatei der Startseite im DocBook-Format.
--xslt
Erzeugt die Dateien
: umformatierte ("minimierte") Versionen der gleichnamigen Dateien im Verzeichnis WEBDIR
/style/*.xslt
ohne Kommentare und Dokumentation.SRC
Anstelle von Verweisen auf Javascript-Dateien und CSS-Dateien werden die Javascript- und CSS-Dateien direkt eingebunden. Dazu werden zunächst "verdichtete" Versionen der Javascript- und CSS-Dateien (ohne unnötige Leerzeichen und ohne Kommentare) in einem Unterverzeichnis von
erzeugt und am Ende wieder gelöscht. Ausgenommen ist die Datei TEMPDIR
common.js
(Quelltext), auf die immer verwiesen wird.
Das Programm rmxmlns.pl
(Quelltext) entfernt nicht benutzte Namensraum-Knoten.
--local
Kopiert die Lokalisierungsdateien
nach SRC
/local.xml.LANG
WEBDIR
/local/local.xml.LANG
--js
Erzeugt die Datei
: eine "verdichtete" Version der Datei WEBDIR
/style/common.js
(Quelltext)
ohne Kommentare und unnötige Leerzeichen. Dazu wird das Perl-Programm SRC
/common.js
(Quelltext)clean_js.pl
(Quelltext) aufgerufen.
--css
Erzeugt die Datei
: eine "verdichtete" Version der Datei WEBDIR
/style/embedded.css
ohne Kommentare und unnötige Leerzeichen. Dazu wird das Perl-Programm SRC
/embedded.css
clean_css.pl
(Quelltext) aufgerufen.
--htaccess
Erzeugt aus
die Datei SRC
/htaccess
. Das Perl-Programm WEBDIR
/style/.htaccessclean_config.pl
(Quelltext) entfernt Leerzeilen und Kommentarzeilen.
--websrv
htaccess-Dateien können Platzhalter für Werte (z.B. Dateipfade) enthalten, die für den lokalen Server und den Webserver unterschiedlich sind. Die Werte werden aus der Geheimnisdatei (
) gelesen. Diese Option bewirkt, dass die Werte für den Webserver eingesetzt werden.WEBBASE
/secrets
--no_websrv
Diese Option hebt die Wirkung der Option --websrv
auf. Platzhalter in den htaccess-Dateien werden durch die Werte für den lokalen Server ersetzt.
--audio
Erzeugt aus WAV-Dateien
Ogg-Vorbis-Audio - Dateien SRC
/*.wav
. Die maximale Bitrate ist WEBDIR
/style/*.oggKBPS
.
Die Dateien
werden nach SRC
/*.ogg
kopiert.WEBDIR
/style/
--audio_maxkbps
KBPS
KBPS
ist die maximale Bitrate für Ogg-Vorbis-Audio-Dateien, die dieses Skript aus WAV-Dateien erzeugt.
--images
--no_*
Wenn keine der "Aktionsoptionen" --mkhelp
, --hlpmont
, --index
, --xslt
, --js
, --css
, --htaccess
, --audio
oder --images
genutzt wird, können auch die Optionen mit dem Präfix "no_
" (--no_mkhelp
, --no_hlpmont
, --no_index
, --no_xslt
, --no_js
, --no_css
, --no_htaccess
, --no_audio
und --no_images
) genutzt werden. Diese schließen die zugehörige Aktion aus. Alle nicht ausgeschlossenen Aktionen werden ausgeführt.
Das Skript updweb
hilft bei der Aktualisierung der Vorlage der Website. Wenn der Quelltext der Startseite (IXSRC
) geändert ist, aktualisiert es die Startseite in der Vorlage. Wenn ein "Stil" geändert oder neu ist, übernimmt es die Änderungen.
Die Einzelheiten sind zu den Optionen beschrieben.
Wenn keine der "Aktionen" --mkhelp
, --hlpmont
, --index
, --xslt
, --js
, --css
, --htaccess
, --audio
oder --images
in der Befehlszeile erscheint, führt das Skript alle Aktionen aus, sonst nur die genannten und nicht ausgeschlossenen.
HOME
Beeinflusst den Dateipfad, unter dem eine Konfigurationsdatei (s. --rc
) gesucht wird.
Wendet XSLT-Transformationen an.
Erzeugt aus WAV-Dateien Ogg-Vorbis-Audio-Dateien.
Komprimiert Dateien.
Erstellt die Montagen der Vorschaubilder zur Hilfe.