Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 4 Sep 2003 01:00:37 +0200
From:      "Simon L. Nielsen" <simon@FreeBSD.org>
To:        freebsd-doc@freebsd.org
Subject:   Tidy options
Message-ID:  <20030903230035.GB386@FreeBSD.org>

Next in thread | Raw E-Mail | Index | Archive | Help

--ctP54qlpMx3WjD+/
Content-Type: multipart/mixed; boundary="kORqDWCi7qDJ0mEj"
Content-Disposition: inline


--kORqDWCi7qDJ0mEj
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

Hello

In the DocBook documentation with HTML output when using a package
reference preceded by a character (with no space in between) there are
often inserted spaces which looks odd.  E.g from
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/video-playback.ht=
ml

	... codec with MPEG3 audio encoding (  audio/lame is required):

The HTML that gives this problem is:

            the MPEG4 codec with MPEG3 audio encoding (<a
            href=3D"http://www.FreeBSD.org/cgi/url.cgi?ports/audio/lame/pkg=
-descr">
            <tt class=3D"FILENAME">audio/lame</tt></a> is

The problem is that Tidy is a bit too agressive when trying to make the
HTML look nice, so it inserts newline where it really shouldn't, since
it tries to keep the lines at max 68 characters (the Tidy default
default).

To fix this I propose to remove the -i flag (which indents the HTML)
=66rom the default Tidy arguments and add '-wrap 90'.  This makes the HTML
more "ugly", but I don't really think this matters, since it's still
correct and of course the browsers doesn't care.  If anybody for some
reason still like to generate more readable HTML, they can just use the
TIDYFLAG make variable to override the defaults.

I should also mention that these options make book.html (the complete
handbook in one HTML file) go from 3 986 799 to 3 002 354 bytes.

Any objection to changing this?

--=20
Simon L. Nielsen
FreeBSD Documentation Team

--kORqDWCi7qDJ0mEj
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="docmake-tidy.patch"

==== //depot/user/simon/doc/share/mk/doc.docbook.mk#2 - /home/simon/freebsd/p4/simon/doc/share/mk/doc.docbook.mk ====
@@ -226,7 +226,7 @@
 PDFTEX?=	${PREFIX}/bin/pdftex
 GROFF?=		groff
 TIDY?=		${PREFIX}/bin/tidy
-TIDYOPTS?=	-i -m -raw -preserve -f /dev/null -asxml ${TIDYFLAGS}
+TIDYOPTS?=	-wrap 90 -m -raw -preserve -f /dev/null -asxml ${TIDYFLAGS}
 HTML2TXT?=	${PREFIX}/bin/links
 HTML2TXTOPTS?=	-dump ${HTML2TXTFLAGS}
 HTML2PDB?=	${PREFIX}/bin/iSiloBSD

--kORqDWCi7qDJ0mEj--

--ctP54qlpMx3WjD+/
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (FreeBSD)

iD8DBQE/VnKTh9pcDSc1mlERAm8CAKCf9+8sSqaa8LerN5xZGF5SZyPavQCfY1XB
96hXU4PU9+6rsZvFP+O6/2s=
=5rHc
-----END PGP SIGNATURE-----

--ctP54qlpMx3WjD+/--



Want to link to this message? Use this URL: <http://docs.FreeBSD.org/cgi/mid.cgi?20030903230035.GB386>