documentation - better PDF results
Susan Farley
susan at codeweavers.com
Mon Sep 24 15:55:34 CDT 2001
These changes provide better formatting for the PDF versions of the wine
documentation (PDF, mainly), by avoiding tags that allow text to run out
into the right margin. I have also added a style sheet (print.dsl) that
lets us change the top/bottom margins, limit the depth of the
table-of-contents, and the like.
log:
better formatting for PDF output
Susan Farley
<susan at codeweavers.com>
-------------- next part --------------
Index: Makefile.in
===================================================================
RCS file: /home/wine/wine/documentation/Makefile.in,v
retrieving revision 1.16
diff -u -u -r1.16 Makefile.in
--- Makefile.in 2001/05/03 18:33:32 1.16
+++ Makefile.in 2001/09/24 19:35:54
@@ -57,10 +57,10 @@
$(DB2HTML) $(BOOKNAME).sgml
$(BOOKNAME).pdf: $(BOOK_SRCS)
- db2pdf $(BOOKNAME).sgml > /dev/null
+ db2pdf -d ./print.dsl $(BOOKNAME).sgml > /dev/null 2>&1
$(BOOKNAME).ps: $(BOOK_SRCS)
- db2ps $(BOOKNAME).sgml > /dev/null
+ db2ps -d ./print.dsl $(BOOKNAME).sgml > /dev/null 2>&1
install::
$(INSTALL) -d $(mandir)/man$(prog_manext)
Index: configuring.sgml
===================================================================
RCS file: /home/wine/wine/documentation/configuring.sgml,v
retrieving revision 1.8
diff -u -u -r1.8 configuring.sgml
--- configuring.sgml 2001/09/19 22:34:38 1.8
+++ configuring.sgml 2001/09/24 19:35:55
@@ -171,15 +171,12 @@
to leave off the trailing slash!
</para>
<para>
- <programlisting>
-"Type" = "floppy|hd|cdrom|network" <--- the |'s mean "Type = '<one of the options>'"
- </programlisting>
- </para>
- <para>
+ <programlisting>"Type" = "floppy|hd|cdrom|network"</programlisting>
Sets up the type of drive Wine will see it as. Type must
equal one of the four <literal>floppy</literal>,
<literal>hd</literal>, <literal>cdrom</literal>, or
<literal>network</literal>. They are self-explanatory.
+ (The |'s mean "Type = '<one of the options>'".)
</para>
<para>
<programlisting>"Label" = "blah"</programlisting> Defines the
Index: fonts.sgml
===================================================================
RCS file: /home/wine/wine/documentation/fonts.sgml,v
retrieving revision 1.5
diff -u -u -r1.5 fonts.sgml
--- fonts.sgml 2001/04/02 19:14:41 1.5
+++ fonts.sgml 2001/09/24 19:35:56
@@ -435,8 +435,10 @@
my Windows fonts on my Win95 <medialabel>C:</medialabel>
drive live; could be e.g.
<filename>/mnt/dosC/windows/system</filename> for Win31.
+ </para>
+ <para>
In <filename>/c/windows/fonts/fonts.scale</filename> I
- have
+ have:
</para>
<programlisting>
14
Index: getting.sgml
===================================================================
RCS file: /home/wine/wine/documentation/getting.sgml,v
retrieving revision 1.1
diff -u -u -r1.1 getting.sgml
--- getting.sgml 2000/12/13 21:52:37 1.1
+++ getting.sgml 2001/09/24 19:35:56
@@ -78,9 +78,7 @@
this may be a little risky, depending on how far the unstable
distribution has diverged from the stable one. You can find a
list of Wine binary packages for the various Debian releases
- using the
- <ulink url="http://cgi.debian.org/cgi-bin/search_packages.pl?keywords=wine&searchon=names&version=all&release=all">
- package search engine</ulink> at <ulink url="http://www.debian.org">
+ using the package search engine at <ulink url="http://www.debian.org">
www.debian.org</ulink>.
</para>
Index: installing.sgml
===================================================================
RCS file: /home/wine/wine/documentation/installing.sgml,v
retrieving revision 1.3
diff -u -u -r1.3 installing.sgml
--- installing.sgml 2001/01/18 23:03:47 1.3
+++ installing.sgml 2001/09/24 19:35:56
@@ -55,8 +55,8 @@
themselves, the Wine team will make the automated Wine
installation script, <filename>tools/wineinstall</filename>,
do everything we find necessary to do; running the
- conventional <command>configure && make depend && make && make
- install</command> cycle is thus not recommended, unless
+ conventional <userinput>configure && make depend && make && make
+ install</userinput> cycle is thus not recommended, unless
you know what you're doing. At the moment,
<filename>tools/wineinstall</filename> is able to create a
configuration file, install the registry, and create the
@@ -84,53 +84,17 @@
correctly.
</para>
- <informaltable frame="none">
- <tgroup cols="5">
- <tbody>
- <row>
- <entry>C:\</entry>
- <entry></entry><entry></entry><entry></entry>
- <entry>Root directory of primary disk drive</entry>
- </row>
- <row>
- <entry></entry>
- <entry>Windows\</entry>
- <entry></entry><entry></entry>
- <entry>Windows directory, containing .INI files, accessories, etc</entry>
- </row>
- <row>
- <entry></entry><entry></entry>
- <entry valign="middle">System\</entry>
- <entry></entry>
- <entry><literallayout>Win3.x/95/98/ME directory for common DLLs
-WinNT/2000 directory for common 16-bit DLLs</literallayout></entry>
- </row>
- <row>
- <entry></entry><entry></entry>
- <entry>System32\</entry>
- <entry></entry>
- <entry>WinNT/2000 directory for common 32-bit DLLs</entry>
- </row>
- <row>
- <entry></entry><entry></entry>
- <entry>Start Menu\</entry>
- <entry></entry>
- <entry>Program launcher directory structure</entry>
- </row>
- <row>
- <entry></entry><entry></entry><entry></entry>
- <entry>Programs\</entry>
- <entry>Program launcher links (.LNK files) to applications</entry>
- </row>
- <row>
- <entry></entry>
- <entry>Program Files\</entry>
- <entry></entry><entry></entry>
- <entry>Application binaries (.EXE and .DLL files)</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+<programlisting>
+C:\ Root directory of primary disk drive
+ Windows\ Windows directory, containing .INI files,
+ accessories, etc.
+ System\ Win3.x/95/98/ME directory for common DLLs
+ WinNT/2000 directory for common 16-bit DLLs
+ System32\ WinNT/2000 directory for common 32-bit DLLs
+ Start Menu\ Program launcher directory structure
+ Programs\ Program launcher links (.LNK files) to applications
+ Program Files\ Application binaries (.EXE and .DLL files)
+</programlisting>
<para>
Wine emulates drives by placing their virtual drive roots to
@@ -246,9 +210,11 @@
Use <filename>tools/wineinstall</filename> to compile Wine
and install the default registry. Or if you prefer to do
it yourself, compile <filename>programs/regapi</filename>,
- and run: <command>programs/regapi/regapi setValue <
- winedefault.reg</command>
+ and run:
</para>
+ <screen>
+ <userinput>programs/regapi/regapi setValue < winedefault.reg</userinput>
+ </screen>
</listitem>
<listitem>
<para>
@@ -569,13 +535,9 @@
</para>
<para>
- <warning>
- <title>Warning/Warning/Warning!!!!!!</title>
- <para>
- <screen>
-THIS MAY TRASH YOUR SYSTEM IF USED INCORRECTLY
-THIS MAY TRASH YOUR SYSTEM IF USED CORRECTLY
- </screen>
+ <warning><title>Warning/Warning/Warning!!!!!!</title>
+ <para>This may trash your system if used incorrectly. It may
+ even trash your system when used <emphasis>correctly</>!
</para>
</warning>
</para>
@@ -629,7 +591,7 @@
<orderedlist>
<listitem>
<para>
- Your SCSI card must be supported under linux. This will
+ Your SCSI card must be supported under Linux. This will
not work with an unknown SCSI card. Even for cheap'n
crappy "scanner only" controllers some special Linux
drivers exist on the net.
@@ -710,7 +672,7 @@
</para>
<para>
<programlisting>
-ipplus.exe <---> (TWAIN INTERFACE) <---> (TWAIN DATA SOURCE . ASPI) -> WINASPI
+ipplus.exe <-> (TWAIN INTERFACE) <-> (TWAIN DATA SOURCE.ASPI) -> WINASPI
</programlisting>
</para>
</sect2>
@@ -718,7 +680,7 @@
<sect2>
<title>NOTES/BUGS</title>
<para>
- The biggest is that it only works under linux at the moment.
+ The biggest is that it only works under Linux at the moment.
</para>
<para>
The ASPI code has only been tested with:
Index: introduction.sgml
===================================================================
RCS file: /home/wine/wine/documentation/introduction.sgml,v
retrieving revision 1.1
diff -u -u -r1.1 introduction.sgml
--- introduction.sgml 2000/12/13 21:52:37 1.1
+++ introduction.sgml 2001/09/24 19:35:56
@@ -90,8 +90,7 @@
<para>
The Wine Users Guide will focus on running precompiled
Windows applications using the Wine emulator.
- <ulink url="http://wine.codeweavers.com/docs/winelib-user/">
- The Winelib Users Guide</ulink> will cover Winelib
+ The Winelib Users Guide will cover Winelib
applications.
</para>
Index: make_winehq
===================================================================
RCS file: /home/wine/wine/documentation/make_winehq,v
retrieving revision 1.2
diff -u -u -r1.2 make_winehq
--- make_winehq 2001/05/03 18:33:12 1.2
+++ make_winehq 2001/09/24 19:35:56
@@ -45,26 +45,26 @@
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
+echo "db2ps -d ./print.dsl wine-user.sgml"
+db2ps -d ./print.dsl wine-user.sgml > /dev/null 2>&1
+echo "db2ps -d ./print.dsl wine-devel.sgml"
+db2ps -d ./print.dsl wine-devel.sgml > /dev/null 2>&1
+echo "db2ps -d ./print.dsl winelib-user.sgml"
+db2ps -d ./print.dsl winelib-user.sgml > /dev/null 2>&1
+echo "db2ps -d ./print.dsl wine-pkg.sgml"
+db2ps -d ./print.dsl 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
+echo "db2pdf -d ./print.dsl wine-user.sgml"
+db2pdf -d ./print.dsl wine-user.sgml > /dev/null 2>&1
+echo "db2pdf -d ./print.dsl wine-devel.sgml"
+db2pdf -d ./print.dsl wine-devel.sgml > /dev/null 2>&1
+echo "db2pdf -d ./print.dsl winelib-user.sgml"
+db2pdf -d ./print.dsl winelib-user.sgml > /dev/null 2>&1
+echo "db2pdf -d ./print.dsl wine-pkg.sgml"
+db2pdf -d ./print.dsl 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
Index: running.sgml
===================================================================
RCS file: /home/wine/wine/documentation/running.sgml,v
retrieving revision 1.5
diff -u -u -r1.5 running.sgml
--- running.sgml 2001/05/11 20:02:07 1.5
+++ running.sgml 2001/09/24 19:35:56
@@ -33,7 +33,8 @@
--help,-h Show this help message
--managed Allow the window manager to manage created windows
--version,-v Display the Wine version
- --winver Version to imitate (win95,nt40,win31,nt2k,win98,nt351,win30,win20)
+ --winver Version to imitate
+ (win95,nt40,win31,nt2k,win98,nt351,win30,win20)
</screen>
</para>
@@ -170,29 +171,83 @@
in Wine. More channels might be added to (or subtracted
from) later versions.
</para>
- <screen>
-all accel advapi animate aspi atom avifile bitblt
-bitmap caret cdrom class clipboard clipping combo comboex
-comm commctrl commdlg console crtdll cursor datetime dc
-ddeml ddraw debug debugstr delayhlp dialog dinput dll
-dosfs dosmem dplay driver dsound edit elfdll enhmetafile
-event exec file fixup font gdi global graphics
-header heap hook hotkey icmp icon imagehlp imagelist
-imm int int10 int16 int17 int19 int21 int31
-io ipaddress joystick key keyboard ldt listbox listview
-local mci mcianim mciavi mcicda mcimidi mciwave mdi
-menu message metafile midi mmaux mmio mmsys mmtime
-module monthcal mpr msacm msg msvideo nativefont nonclient
-ntdll odbc ole opengl pager palette pidl print
-process profile progress prop propsheet psapi psdrv ras
-rebar reg region relay resource richedit scroll segment
-seh selector sendmsg server setupapi setupx shell snoop
-sound static statusbar storage stress string syscolor system
-tab tape tapi task text thread thunk timer
-toolbar toolhelp tooltips trackbar treeview ttydrv tweak typelib
-updown ver virtual vxd wave win win16drv win32
-wing wininet winsock winspool wnet x11 x11drv
- </screen>
+
+ <table frame="none"><title>Debug Channels</title>
+ <tgroup cols=5 align="left">
+ <tbody>
+<row><entry>
+all</><>accel</><>advapi</><>animate</><>aspi</>
+</row><row><entry>
+atom</><>avifile</><> bitblt</><> bitmap</><> caret</>
+</row><row><entry>
+cdrom</><>class</><> clipboard</><> clipping</><>combo</>
+</row><row><entry>
+comboex</><> comm</><>commctrl</><>commdlg</><> console</>
+</row><row><entry>
+crtdll</><>cursor</><>datetime</><>dc</><> ddeml</>
+</row><row><entry>
+ddraw</><> debug</><> debugstr</><>delayhlp</><>dialog</>
+</row><row><entry>
+dinput</><>dll</><> dosfs</><>dosmem</><>dplay</>
+</row><row><entry>
+driver</><>dsound</><>edit</><>elfdll</><>enhmetafile</>
+</row><row><entry>
+event</><>exec</><>file</><>fixup</><>font</>
+</row><row><entry>
+gdi</><> global</><>graphics</><> header</><>heap</>
+</row><row><entry>
+hook</><>hotkey</><>icmp</><>icon</><>imagehlp</>
+</row><row><entry>
+imagelist</><> imm</><>int</><>int10</><>int16</>
+</row><row><entry>
+int17</><>int19</><>int21</><>int31</><> io</>
+</row><row><entry>
+ipaddress</><>joystick</><>key</><>keyboard</><>ldt</>
+</row><row><entry>
+listbox</><> listview</><> local</><>mci</><>mcianim</>
+</row><row><entry>
+mciavi</><>mcicda</><> mcimidi</><> mciwave</><> mdi</>
+</row><row><entry>
+menu</><> message</><> metafile</><>midi</><> mmaux</>
+</row><row><entry>
+mmio</><> mmsys</><> mmtime</><> module</><>monthcal</>
+</row><row><entry>
+mpr</><> msacm</><> msg</><> msvideo</><> nativefont</>
+</row><row><entry>
+nonclient</><> ntdll</><> odbc</><> ole</><> opengl</>
+</row><row><entry>
+pager</><> palette</><> pidl</><> print</><> process</>
+</row><row><entry>
+profile</><> progress</><>prop</><> propsheet</><>psapi</>
+</row><row><entry>
+psdrv</><> ras</><> rebar</><> reg</><> region</>
+</row><row><entry>
+relay</><> resource</><>richedit</><>scroll</><>segment</>
+</row><row><entry>
+seh</><>selector</><>sendmsg</><> server</><>setupapi</>
+</row><row><entry>
+setupx</><>shell</><> snoop</><> sound</><>static</>
+</row><row><entry>
+statusbar</><>storage</><> stress</><> string</><>syscolor</>
+</row><row><entry>
+system</><> tab</><>tape</><>tapi</><>task</>
+</row><row><entry>
+text</><>thread</><>thunk</><>timer</><> toolbar</>
+</row><row><entry>
+toolhelp</><>tooltips</><>trackbar</><>treeview</><>ttydrv</>
+</row><row><entry>
+tweak</><>typelib</><> updown</><>ver</><>virtual</>
+</row><row><entry>
+vxd</><>wave</><>win</><>win16drv</><>win32</>
+</row><row><entry>
+wing</><>wininet</><> winsock</><> winspool</><>wnet</>
+</row><row><entry>
+x11</><> x11drv</>
+</row>
+ </tbody>
+ </tgroup>
+ </table>
+
<para>
For more details about debug channels, check out the
<ulink url="http://wine.codeweavers.com/docs/wine-devel/">
Index: winehq.dsl
===================================================================
RCS file: /home/wine/wine/documentation/winehq.dsl,v
retrieving revision 1.1
diff -u -u -r1.1 winehq.dsl
--- winehq.dsl 2000/12/13 21:52:37 1.1
+++ winehq.dsl 2001/09/24 19:35:57
@@ -30,13 +30,13 @@
(make formatting-instruction data: "-->")))
;; Customize the body tag attributes
-(define %body-attr%
- (list
- (list "BGCOLOR" "#555555")
- (list "TEXT" "#000000")
- (list "LINK" "#0000FF")
- (list "VLINK" "#840084")
- (list "ALINK" "#0000FF")))
+;;(define %body-attr%
+;; (list
+ ;; (list "BGCOLOR" "#555555")
+;; (list "TEXT" "#000000")
+;; (list "LINK" "#0000FF")
+;; (list "VLINK" "#840084")
+;; (list "ALINK" "#0000FF")))
</style-specification-body>
</style-specification>
-------------- next part --------------
<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
<!ENTITY print-ss PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA DSSSL>
]>
<style-sheet>
<style-specification id="print" use="print-stylesheet">
<style-specification-body>
;; I was hoping that this would take out the many blank pages in the
;; PDF file, but it doesn't, it just slides the page numbers over.
(define %two-side% #f)
(define %generate-book-titlepage% #t)
;;Titlepage Not Separate
(define (chunk-skip-first-element-list)
(list (normalize "sect1")
(normalize "section")))
;;Titlepage Separate?
;(define (chunk-skip-first-element-list)
; '())
(define (list-element-list)
;; fixes bug in Table of Contents generation
'())
(define (toc-depth nd)
2)
;; This seems to have no affect
(define %generate-book-titlepage-on-separate-page% #f)
(define %body-start-indent%
;; Default indent of body text
2pi)
(define %para-indent-firstpara%
;; First line start-indent for the first paragraph
0pt)
(define %para-indent%
;; First line start-indent for paragraphs (other than the first)
0pt)
(define %block-start-indent%
;; Extra start-indent for block-elements
2pt)
;;Define distance between paragraphs
(define %para-sep%
(/ %bf-size% 2.0))
;;Define distance between block elements (figures, tables, etc.).
(define %block-sep%
(* %para-sep% 1.0))
;; (* %para-sep% 2.0))
(define %hyphenation%
;; Allow automatic hyphenation?
#t)
(define %left-margin% 5pi)
(define %right-margin% 5pi)
(define %top-margin% 5pi)
(define %bottom-margin% 5pi)
(define %footer-margin% 2pi)
(define %header-margin% 2pi)
(define %line-spacing-factor% 1.3)
;; Factor used to calculate leading
;; The leading is calculated by multiplying the current font size by the
;; '%line-spacing-factor%'. For example, if the font size is 10pt and
;; the '%line-spacing-factor%' is 1.1, then the text will be
;; printed "10-on-11".
(define %head-before-factor%
;; Factor used to calculate space above a title
;; The space before a title is calculated by multiplying the font size
;; used in the title by the '%head-before-factor%'.
;; 0.75)
0.5)
(define %head-after-factor%
;; Factor used to calculate space below a title
;; The space after a title is calculated by multiplying the font size used
;; in the title by the '%head-after-factor%'.
0.5)
(define %input-whitespace-treatment% 'collapse)
(define ($generate-book-lot-list$)
;; Which Lists of Titles should be produced for Books?
(list ))
(define tex-backend
;; Are we using the TeX backend?
;; This parameter exists so that '-V tex-backend' can be used on the
;; command line to explicitly select the TeX backend.
#t)
</style-specification-body>
</style-specification>
<external-specification id="print-stylesheet" document="print-ss">
</style-sheet>
More information about the wine-patches
mailing list