Added convenience script for generating online docs for winehq.com.

This commit is contained in:
John R. Sheets 2001-01-19 20:58:37 +00:00 committed by Alexandre Julliard
parent d661dbdd6c
commit 8c63fb6a50
4 changed files with 215 additions and 0 deletions

95
documentation/make_winehq Executable file
View File

@ -0,0 +1,95 @@
#!/bin/sh
## John R. Sheets <jsheets@codeweavers.com>
## This is a convenience script for building the website docs for
## www.winehq.com. It creates tarballs of the HTML with special
## server-side includes and CSS settings that aren't appropriate for
## the mainline Wine tree. For this reason, and to make it easier to
## set up an automated website update system, I'm putting this in
## a standalone shell script.
##
## There's no need to invoke the Wine make system just for web
## updates. For example, we can just grab the documentation
## subdirectory, without having to pull the entire wine tree:
##
## $ cvs co wine/documentation
## $ cd wine/documentation
## $ ./make_winehq
## $ rsync ...
WWWDIR=www.winehq.com
## Want to put this into a sub-directory for easier maintenance
if [ -a $WWWDIR ]; then
rm -rf $WWWDIR.old
mv $WWWDIR $WWWDIR.old
mkdir $WWWDIR
fi
## Create four-book HTML tarball
echo "./db2html-winehq wine-user.sgml"
./db2html-winehq wine-user.sgml
echo "./db2html-winehq wine-devel.sgml"
./db2html-winehq wine-devel.sgml
echo "./db2html-winehq winelib-user.sgml"
./db2html-winehq winelib-user.sgml
echo "./db2html-winehq wine-pkg.sgml"
./db2html-winehq wine-pkg.sgml
tar czf winedoc-html.tgz wine-user wine-devel winelib-user wine-pkg
cp winedoc-html.tgz $WWWDIR
## Create one-book HTML tarball
echo "./db2html-winehq wine-doc.sgml"
./db2html-winehq wine-doc.sgml
tar czf wine-set-html.tgz wine-doc
cp wine-set-html.tgz $WWWDIR
## Create PostScript tarball
echo "db2ps wine-user.sgml"
db2ps wine-user.sgml > /dev/null 2>&1
echo "db2ps wine-devel.sgml"
db2ps wine-devel.sgml > /dev/null 2>&1
echo "db2ps winelib-user.sgml"
db2ps winelib-user.sgml > /dev/null 2>&1
echo "db2ps wine-pkg.sgml"
db2ps wine-pkg.sgml > /dev/null 2>&1
tar czf winedoc-ps.tgz wine-user.ps wine-devel.ps winelib-user.ps wine-pkg.ps
cp winedoc-ps.tgz $WWWDIR
## Create PDF tarball
echo "db2pdf wine-user.sgml"
db2pdf wine-user.sgml > /dev/null 2>&1
echo "db2pdf wine-devel.sgml"
db2pdf wine-devel.sgml > /dev/null 2>&1
echo "db2pdf winelib-user.sgml"
db2pdf winelib-user.sgml > /dev/null 2>&1
echo "db2pdf wine-pkg.sgml"
db2pdf wine-pkg.sgml > /dev/null 2>&1
tar czf winedoc-pdf.tgz wine-user.pdf wine-devel.pdf winelib-user.pdf wine-pkg.pdf
cp winedoc-pdf.tgz $WWWDIR
## Create SGML tarball
echo "Creating SGML package..."
tar czf winedoc-sgml.tgz *.sgml *.dsl *.ent db2html-winehq
cp winedoc-sgml.tgz $WWWDIR
## Done creating downloadable tarballs for users. Now we want to
## create a tarball of SHTML in a slightly different form, for the
## website. These versions use special server-side includes which
## aren't appropriate outside of winehq.com.
##
## Use the special website stylesheet
export WINEDOC_STYLESHEET=../winehq.dsl
## Create four-book SHTML tarball
echo "./db2html-winehq wine-user.sgml"
./db2html-winehq wine-user.sgml
echo "./db2html-winehq wine-devel.sgml"
./db2html-winehq wine-devel.sgml
echo "./db2html-winehq winelib-user.sgml"
./db2html-winehq winelib-user.sgml
echo "./db2html-winehq wine-pkg.sgml"
./db2html-winehq wine-pkg.sgml
tar czf winehq-shtml.tgz wine-user wine-devel winelib-user wine-pkg
cp winehq-shtml.tgz $WWWDIR

View File

@ -0,0 +1,65 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!-- *** Include list of authors *** -->
<!entity % authors SYSTEM "authors.ent">
%authors;
<!entity compiling SYSTEM "compiling.sgml">
<!entity debugging SYSTEM "debugging.sgml">
<!entity documentation SYSTEM "documentation.sgml">
<!entity patches SYSTEM "patches.sgml">
<!entity i18n SYSTEM "i18n.sgml">
<!entity porting SYSTEM "porting.sgml">
<!entity architecture SYSTEM "architecture.sgml">
<!entity ole SYSTEM "ole.sgml">
<!entity debugger SYSTEM "debugger.sgml">
<!entity consoles SYSTEM "consoles.sgml">
<!entity implementation SYSTEM "implementation.sgml">
<!entity opengl SYSTEM "opengl.sgml">
<!entity build SYSTEM "build.sgml">
<!entity tools SYSTEM "tools.sgml">
<!entity dlls SYSTEM "dlls.sgml">
<!entity cvs-regression SYSTEM "cvs-regression.sgml">
<!--
<!entity status SYSTEM "status.sgml">
-->
]>
<book id="index">
<bookinfo>
<title>Wine Developer's Guide</title>
</bookinfo>
<part id="part-one">
<title>Developing Wine</title>
&compiling;
&debugger;
&documentation;
&patches;
&i18n;
&tools;
</part>
<part id="part-two">
<title>Wine Architecture</title>
&architecture;
&debugging;
&ole;
&opengl;
&build;
&dlls;
</part>
<part id="part-three">
<title>Advanced Topics</title>
&implementation;
&porting;
&consoles;
&cvs-regression;
</part>
</book>

View File

@ -0,0 +1,17 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!-- *** Include list of authors *** -->
<!entity % authors SYSTEM "authors.ent">
%authors;
<!entity packaging SYSTEM "packaging.sgml">
]>
<book id="index">
<bookinfo>
<title>Wine Packagers Guide</title>
</bookinfo>
&packaging;
</book>

View File

@ -0,0 +1,38 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!-- *** Include list of authors *** -->
<!entity % authors SYSTEM "authors.ent">
%authors;
<!entity introduction SYSTEM "introduction.sgml">
<!entity getting SYSTEM "getting.sgml">
<!entity installing SYSTEM "installing.sgml">
<!entity configuring SYSTEM "configuring.sgml">
<!entity running SYSTEM "running.sgml">
<!entity bugs SYSTEM "bugs.sgml">
<!-- *** Not currently used *** -->
<!entity registry SYSTEM "registry.sgml">
<!entity fonts SYSTEM "fonts.sgml">
<!entity printing SYSTEM "printing.sgml">
]>
<book id="index">
<bookinfo>
<title>Wine User Guide</title>
</bookinfo>
&introduction;
&getting;
&installing;
&configuring;
&running;
&bugs;
<!--
&registry;
&fonts;
&printing;
-->
</book>