UlrichG
Member
Erläutert wird das Erstellen einer lokalen Kopie der FreeBSD-Dokumentation
aus den aktualisierten Quellen für die Sprachen Deutsch und Englisch.
Mögliche Formate sind: txt, html-split, html, pdf, ps.
Stand: Juli 2015
A) Verschiedene Ports installieren:
Metaport textproc/docproj
% make config
FOP=>on (benötigt java),
dblatex=>off(benötigt texlive, Fehlermeldung, siehe unten),
svn=>off /usr/bin/svnlite zum checkout (co) und update (up) ist ausreichend,
Rest=>off.
% make install clean
security/ca_root_nss installieren
für Zertifikate (Meldung beim co oder up)
print/papersize-default-a4 installieren
Setzt das default Papierformat auf DIN A4
Die Fonts befinden sich in /usr/local/share/fonts.
Um Fehlermeldungen zu vermeiden, habe ich folgenden Symlink gesetzt:
cd /usr/local/lib/X11/
ln -s /usr/local/share/fonts ./fonts
B) Umgebungsvariablen setzen:
DOC_LANG="en_US.ISO8859-1 de_DE.ISO8859-1"
Für diese Sprachen wird die Dokumentation formatiert.
ENGLISH_ONLY="yes"
Es wird nur die englische Dokumentation erstellt und installiert.
DOC_LANG wird ignoriert wenn diese Variable gesetzt ist!
FORMATS="txt html-split html pdf ps"
In diese Formate wird formatiert.
DOCDIR="/usr/share/doc"
Das Defaultverzeichnis für die formatierten Dokumente.
SVN_UPDATE=yes
Ermöglicht ein update der Doc-Sourcen mittels 'make update'
Hier mein Eintrag in der .zshrc:
# docproj
export DOC_LANG="en_US.ISO8859-1 de_DE.ISO8859-1"
#export ENGLISH_ONLY=yes # Entweder DOC_LANG oder ENGLISH_ONLY
export SVN_UPDATE=yes
export FORMATS="txt html-split html pdf ps"
export DOCDIR="/usr/home/testdoc"
C) Dokumentation-Sourcen mit svnlite auschecken.
Mirror für Europa:
checkout:
% svnlite co https://svn0.eu.FreeBSD.org/doc/head ~/doc (oder: /usr/doc)
oder:
% svnlite co https://svn.freebsd.org/doc/head ~/doc
Vor dem co muß das Zielverzeichnis für die Sourcen ~/doc leer sein
(es sei denn, es wurde mit svn oder svnlite erstellt, dann ist ein update mit svn/svnlite möglich).
Beim update werden nur die jeweiligen Änderungen heruntergeladen und eingepflegt.
update:
% svnlite up ~/doc
oder
% cd ~/doc && make update
oder
% cd ~/doc && svnlite up
D) Silbentrennung ermöglichen (PDF-Format)
Das Archiv offo-hyphenation-binary.zip von
http://sourceforge.net/projects/offo/files/offo-hyphenation/
herunterladen.
Daraus das Archiv fop-hyph.jar nach
/usr/local/share/java/fop/lib kopieren.
(Zur Erläuterung siehe:
http://offo.sourceforge.net/hyphenation/binary/installation.html
https://xmlgraphics.apache.org/fop/0.95/hyphenation.html).
E) Dokumentation formatieren
Bei gesetzter DOC_LANG/ENGLISH_ONLY Umgebungsvariable,
im Wurzelverzeichnis für die Doc-Sourcen: ~/doc
% cd ~/doc && make install
ausführen. Es werden nur die durch die Variablen definierten Sprachen bearbeitet.
Alternativ in ein bestimmtes Sprachverzeichnis wechseln, z.B.
% cd de_DE.ISO8859-1 && make install
oder in das Verzeichnis eines bestimmten Dokumentes wechseln, z.B.
% cd en_US.ISO8859-1/books/fdp-primer make install
Der Aufruf von make ist auch in der Form (z.B.):
% make FORMATS=pdf install
möglich.
F) Zu klären:
Mittels der Umgebungsvariablen RENDERENGINE kann zwischen FOP und DBLATEX
gewählt werden. Ich konnte DBLATEX nicht ausführen. Die Datei freebsd-dblatex.xsl
wird benötigt aber nicht gefunden:
xsl:include : unable to load http://www.FreeBSD.org/XML/lang/share/xml/freebsd-dblatex.xsl
G) Wem das alles zu aufwendig ist, der kann folgende Ports verwenden:
misc/freebsd-doc-de
misc/freebsd-doc-en
misc/freebsd-doc-all Für alle vorhandenen Übersetzungen.
Diese Ports werden monatlich aktualisiert.
-----
Projekt zur Erstellung der deutschen FreeBSD-Dokumentation:
https://people.freebsd.org/~jkois/FreeBSDde/de/
FreeBSD Documentation Project:
https://www.freebsd.org/docproj/
FreeBSD Documentation Project Primer (fdp-primer):
https://www.freebsd.org/doc/en/books/fdp-primer/
https://www.freebsd.org/doc/de_DE.ISO8859-1/books/fdp-primer/index.html
Handbuch:
https://www.freebsd.org/doc/handbook/updating-upgrading-documentation.html
PS:
htdocs, flyer und slides wurden nicht berücksichtigt.
aus den aktualisierten Quellen für die Sprachen Deutsch und Englisch.
Mögliche Formate sind: txt, html-split, html, pdf, ps.
Stand: Juli 2015
A) Verschiedene Ports installieren:
Metaport textproc/docproj
% make config
FOP=>on (benötigt java),
dblatex=>off(benötigt texlive, Fehlermeldung, siehe unten),
svn=>off /usr/bin/svnlite zum checkout (co) und update (up) ist ausreichend,
Rest=>off.
% make install clean
security/ca_root_nss installieren
für Zertifikate (Meldung beim co oder up)
print/papersize-default-a4 installieren
Setzt das default Papierformat auf DIN A4
Die Fonts befinden sich in /usr/local/share/fonts.
Um Fehlermeldungen zu vermeiden, habe ich folgenden Symlink gesetzt:
cd /usr/local/lib/X11/
ln -s /usr/local/share/fonts ./fonts
B) Umgebungsvariablen setzen:
DOC_LANG="en_US.ISO8859-1 de_DE.ISO8859-1"
Für diese Sprachen wird die Dokumentation formatiert.
ENGLISH_ONLY="yes"
Es wird nur die englische Dokumentation erstellt und installiert.
DOC_LANG wird ignoriert wenn diese Variable gesetzt ist!
FORMATS="txt html-split html pdf ps"
In diese Formate wird formatiert.
DOCDIR="/usr/share/doc"
Das Defaultverzeichnis für die formatierten Dokumente.
SVN_UPDATE=yes
Ermöglicht ein update der Doc-Sourcen mittels 'make update'
Hier mein Eintrag in der .zshrc:
# docproj
export DOC_LANG="en_US.ISO8859-1 de_DE.ISO8859-1"
#export ENGLISH_ONLY=yes # Entweder DOC_LANG oder ENGLISH_ONLY
export SVN_UPDATE=yes
export FORMATS="txt html-split html pdf ps"
export DOCDIR="/usr/home/testdoc"
C) Dokumentation-Sourcen mit svnlite auschecken.
Mirror für Europa:
checkout:
% svnlite co https://svn0.eu.FreeBSD.org/doc/head ~/doc (oder: /usr/doc)
oder:
% svnlite co https://svn.freebsd.org/doc/head ~/doc
Vor dem co muß das Zielverzeichnis für die Sourcen ~/doc leer sein
(es sei denn, es wurde mit svn oder svnlite erstellt, dann ist ein update mit svn/svnlite möglich).
Beim update werden nur die jeweiligen Änderungen heruntergeladen und eingepflegt.
update:
% svnlite up ~/doc
oder
% cd ~/doc && make update
oder
% cd ~/doc && svnlite up
D) Silbentrennung ermöglichen (PDF-Format)
Das Archiv offo-hyphenation-binary.zip von
http://sourceforge.net/projects/offo/files/offo-hyphenation/
herunterladen.
Daraus das Archiv fop-hyph.jar nach
/usr/local/share/java/fop/lib kopieren.
(Zur Erläuterung siehe:
http://offo.sourceforge.net/hyphenation/binary/installation.html
https://xmlgraphics.apache.org/fop/0.95/hyphenation.html).
E) Dokumentation formatieren
Bei gesetzter DOC_LANG/ENGLISH_ONLY Umgebungsvariable,
im Wurzelverzeichnis für die Doc-Sourcen: ~/doc
% cd ~/doc && make install
ausführen. Es werden nur die durch die Variablen definierten Sprachen bearbeitet.
Alternativ in ein bestimmtes Sprachverzeichnis wechseln, z.B.
% cd de_DE.ISO8859-1 && make install
oder in das Verzeichnis eines bestimmten Dokumentes wechseln, z.B.
% cd en_US.ISO8859-1/books/fdp-primer make install
Der Aufruf von make ist auch in der Form (z.B.):
% make FORMATS=pdf install
möglich.
F) Zu klären:
Mittels der Umgebungsvariablen RENDERENGINE kann zwischen FOP und DBLATEX
gewählt werden. Ich konnte DBLATEX nicht ausführen. Die Datei freebsd-dblatex.xsl
wird benötigt aber nicht gefunden:
xsl:include : unable to load http://www.FreeBSD.org/XML/lang/share/xml/freebsd-dblatex.xsl
G) Wem das alles zu aufwendig ist, der kann folgende Ports verwenden:
misc/freebsd-doc-de
misc/freebsd-doc-en
misc/freebsd-doc-all Für alle vorhandenen Übersetzungen.
Diese Ports werden monatlich aktualisiert.
-----
Projekt zur Erstellung der deutschen FreeBSD-Dokumentation:
https://people.freebsd.org/~jkois/FreeBSDde/de/
FreeBSD Documentation Project:
https://www.freebsd.org/docproj/
FreeBSD Documentation Project Primer (fdp-primer):
https://www.freebsd.org/doc/en/books/fdp-primer/
https://www.freebsd.org/doc/de_DE.ISO8859-1/books/fdp-primer/index.html
Handbuch:
https://www.freebsd.org/doc/handbook/updating-upgrading-documentation.html
PS:
htdocs, flyer und slides wurden nicht berücksichtigt.
