Commit graph

272 commits

Author SHA1 Message Date
Murray Stokely
6cfb4c7134 Add entity for amdpm(4). 2001-09-18 04:50:22 +00:00
Murray Stokely
2a18b45f52 Move the newsgroup entities out of the Handbook directory and create a
catalog entry for them.  These entities are not specific to the
Handbook.
2001-09-18 04:14:44 +00:00
Murray Stokely
8577fa90a4 Add a knob to trace TeX's memory usage. This is useful when you're
using tons of different macro packages (like we do) and something is
misbehaving. ``make TRACE=1 book.ps''
2001-09-17 09:45:01 +00:00
Murray Stokely
24818905cc Silence a warning for HTML output, and add some more special handling
for the justified print output case.
2001-09-13 07:34:57 +00:00
Murray Stokely
f7fcffd6d4 Add support for cascading stylesheets and images for documents with
HTML as a source format.
2001-09-13 07:26:48 +00:00
Dima Dorfman
2fbe82ba36 Add klxref(8). 2001-09-11 12:46:57 +00:00
Murray Stokely
f0a4faa9b7 Whitespace change only. 2001-09-11 08:56:52 +00:00
Murray Stokely
2f6155eed2 Use a formatting-instruction to work around the problem where Jade
thinks that it must never output something like "_" to the TeX
backend, and should instead use \char{95}.  The package we are using
to hyphenate URLs, url.sty, is designed to allow URLs without worrying
about such things, and will literally display the \char{95} without
this patch.
2001-09-11 08:47:53 +00:00
Murray Stokely
486bf4abfd Turn on -ioutput.print.twoside in the TWO_SIDE=1 case (which is also
the BOOK_OUTPUT=1 case).
2001-09-11 02:32:32 +00:00
Murray Stokely
621456e13d Add a new parameter entity output.print.twoside, which redefines some
of the functions to get correct page numbering for two sided output.
This code will also have to insert some blank pages to make sure part
and chapter headers always start on a verso page.  This is an
improvement, but it is also a work in progress that should be in the
tree so others can experiment with it.

The most visible impact is that the Chapter 1 now starts on page 2
instead of page 1.  Part I now starts on page 1 instead of xviii.
When this is done properly, Chapter 1 will start on page 3.
2001-09-11 02:31:50 +00:00
Murray Stokely
45c7fe1389 Wrap <filename> in \url{...} if justification is turned on. This
prevents the majority of the remaining margin overflows.  However,
this solution isn't very elegant in that it completely ignores
<replaceable>s inside of a <filename> element.  The normal TeX that
gets output inside of \url{..} confuses TeX, so we must simply process
the children of replaceable without doing any additional formatting
inside of the \url{..} (such as putting the text into italics).

More work needs to be done on this.
2001-09-11 02:06:03 +00:00
Murray Stokely
2bd7f72656 Add justification to the list of features that
'make BOOK_OUTPUT=1 book.ps' gives you.
2001-09-11 00:38:32 +00:00
Murray Stokely
872e454400 Add a formatting instruction to wrap URLs in \url{} for the print
backend.  This allows JUSTIFY=1 to look much nicer.  Filenames still
aren't handled, but there is another TeX package for that that I will
use shortly.
2001-09-08 02:21:19 +00:00
Murray Stokely
eca1d05330 Add a new option 'JUSTIFY' which can be used to tell the TeX backend
to make the paragraphs right justified using TeX's default hyphenation
rules.  We still must add some hooks to certain elements (URLs) to
deal with special cases that TeX can't hyphenate well.
2001-09-08 01:59:22 +00:00
Murray Stokely
7f68ef77e2 We don't want to label the preface sections, if present. 2001-09-07 22:26:45 +00:00
Murray Stokely
a36b0de6c7 Add two new options to our documentation infrastructure.
TWO_SIDE    - If defined, two sided output will be created.  This
                  means that new chapters will only start on odd
                  numbered (aka right side, aka recto) pages and the
                  headers and footers will be aligned appropriately
                  for double sided paper.  Blank pages may be added as
                  needed.

    BOOK_OUTPUT - If defined, this will set all of the other
                  print-output options that can significantly increase
                  the build time, but make for much nicer looking
                  output.

To implement the two sided output, we need to override a TeX variable
to control the behavior of the JadeTeX macro package.  So this also
introduces a TEXCMDS variable that can be set with additional TeX
commands that should be run before processing the input TeX document.
In the TWO_SIDE case, we simply set it to \def\PageTwoSide{1}
2001-09-07 10:21:41 +00:00
Bruce A. Mah
b80538a56f Update os.numports to reflect the INDEX file for 4.4-RELEASE,
with 5,813 (rounded down to 5,800) ports.
2001-09-04 04:03:45 +00:00
Bruce A. Mah
ecbfbb99d0 Add entity for pcic(4). 2001-09-03 05:19:52 +00:00
Dima Dorfman
f0e2e70507 Add entries for ntp-genkeys(8) and daemon(8). 2001-08-30 05:25:44 +00:00
Bruce A. Mah
cd4ba70ca7 Back out 1.43->1.44 delta, which turned on hyphenation and justification
by default for printed output.  It turns out that this combination results
in URLs running of the right margin of the printed page.

This back-out is a temporary work-around to fix the PS/PDF
documentation for the impending 4.4-RELEASE.

Approved by:	murray
2001-08-27 04:01:40 +00:00
Dima Dorfman
ff522925e3 authors.ent has been moved to en_US.ISO8859-1/share/sgml/authors.ent.
The file is hardly Handbook-specific.

Repo-copy by:	jdp
2001-08-25 22:02:08 +00:00
Murray Stokely
e90bee4e01 Add a new target to the Handbook makefile: 'pgpkeyring'.
This target finds all <programlisting role="pgpkey"> elements in the
Handbook and writes out a flat text file suitable for importing into
PGP or GPG.

This can be used in the web build to automatically update the public
keyring of FreeBSD developers.
2001-08-23 07:59:07 +00:00
Nik Clayton
8a0bc3bfb8 Discover the -s parameter to pkg_create, and remove the dependency on
installing the files before packaging them up.
2001-08-22 22:30:26 +00:00
Bruce A. Mah
3752f1a2de Add manpage entity for digictl(8). 2001-08-20 17:34:10 +00:00
Bruce A. Mah
095f51ac9f Add entry for ispppcontrol(8). 2001-08-17 15:47:07 +00:00
Dima Dorfman
b72265ea42 An increasing amount of documents use the -V flag to Jade via
JADEFLAGS to set variables such as %generate-article-toc%.  However,
JADEFLAGS is also passed to nsgmls, which doesn't, and shouldn't,
understand -V.  The Makefiles which do this are correct, because the
name--JADEFLAGS--implies that it will only be passed to Jade, not to
nsgmls, too.  Furthermore, simply not passing JADEFLAGS to nsgmls is
not okay, since nsgmls *does* need the -i flags used to
include/exclude certain parts of the document.

Remedy this by breaking up JADEFLAGS into itself and SGMLFLAGS.  The
latter will be passed to all SGML processors such as nsgmls and Jade.
The former will only be passed to Jade.  The -V flags should stay in
JADEFLAGS, and the -i flags should be moved to SGMLFLAGS.

This fixes `make lint` for documents which use -V via JADEFLAGS.

Reviewed by:	bmah
2001-08-16 05:19:51 +00:00
Murray Stokely
388ddee70e Add scr -> png -> eps support, so that we can build Randy's new
Installation chapter with spiffy color screenshots of sysinstall.
2001-08-14 21:51:25 +00:00
Dima Dorfman
4cc873c196 Match beginning and ending tag names.
PR:		29655
Submitted by:	Peter Johnson <freebsd@bilogic.org>
2001-08-14 05:22:57 +00:00
Dima Dorfman
5b273a9676 Move the sgmltag comment to where it belongs (i.e., above the sgmltag
code, not in the middle of no man's land).

PR:		29655
Submitted by:	Peter Johnson <freebsd@bilogic.org>
2001-08-14 05:18:06 +00:00
Jun Kuriyama
f8a4b74cae Add &man.X.1; entry to unbreak handbook/x11/chapter.sgml. 2001-08-11 04:36:32 +00:00
Bruce A. Mah
d0303b94c1 Add entry for nmdm(4). 2001-08-11 02:01:53 +00:00
Murray Stokely
2f6147a6ac Another update to the <authorgroup> / <*info> handling. See the
comment for details.

Hashed out with: chern
2001-08-09 23:18:34 +00:00
Murray Stokely
0128e1ed79 Make author attributions show up in italics at the front of each
chapter/section to match our old way of doing things.  Each <author> in
an <authorgroup> will be attributed with :

   "<contrib> by <author>.  "
2001-08-09 00:28:10 +00:00
Chern Lee
1121738517 port tag links:
http://www.FreeBSD.org/cgi/url.cgi?ports/category/port changed to:
http://www.FreeBSD.org/cgi/url.cgi?ports/category/port/pkg-descr

The CGI returns "port does not exist" for the old instance.

Reviewed by:	murray
2001-08-09 00:14:42 +00:00
Valentino Vaschetto
3b78237508 Materialized Nik's meta bibliography concept.
This adds a seperate book for the bibliography of the docproject. Individual
books can then create dynamic bibliographies containing only the books that
they reference from this master bibliography.

http://www.FreeBSD.org/cgi/getmsg.cgi?fetch=88939+0+/usr/local/www/db/text/2001/freebsd-doc/20010715.freebsd-doc

Approved by:	murray
Kickstarted by: nik
2001-08-08 02:23:43 +00:00
Jesus Rodriguez Cuesta
90a98f9d06 Create BookInfo and stylesheets spanish specific entities 2001-08-05 19:40:38 +00:00
Murray Stokely
d79e4c4fad Turn on justification and hyphenation by default for print output. 2001-08-02 03:24:04 +00:00
Dima Dorfman
33423e8ca2 mp(3) doesn't exist. 2001-08-01 15:00:37 +00:00
Dima Dorfman
a8d7e2bc08 Add libmp man pages. 2001-07-29 13:34:52 +00:00
Murray Stokely
a428d684dd Two sections in the backups chapter were wrapped in a %not.published
entity that is never defined.  Define this entity in freebsd.ent so
that the behavior is as intended.
2001-07-28 04:06:29 +00:00
Murray Stokely
f9ccc49092 Add a new tunable knob 'MIN_SECT_LABELS' and the necessary stylesheet
support.

This option prevents section labels from being numbered after the third
level.

make FORMATS=ps :

  "N.N.N Section Title"
  "N.N.N.N really specific topic"
  "N.N.N.N.N really-really specific topic"

make MIN_SECT_LABELS=1 FORMATS=ps :

  "N.N.N Section Title"
  "really specific topic"
  "really-really specific topic"

The section titles are still bold, spaced away from the text, and
sized according to their nesting level.
2001-07-28 03:00:03 +00:00
Murray Stokely
a7fe7f4563 Use DSSSL's (next-match) function to fall through to next most
specific construction rule instead of duplicating code when we want to
conditionally alter the stylsheets.

Suggested by: Norman Walsh
Referenced in: ISO/IEC 10179:1996(E) p180-181
2001-07-27 21:16:55 +00:00
Chern Lee
2da5194780 Make <envar> show up as monospaced font in printed version.
Reviewed by:	murray
2001-07-24 23:09:25 +00:00
Dima Dorfman
59292e255d Introduce a <port> element that answers the question of how to mark up
a port name.  Right now, it renders as monospace, and with a hyperlink
to the port's pkg-descr file if possible.
2001-07-24 11:07:59 +00:00
Dima Dorfman
de4dca94cc Add two scripts that manipulate man-refs.ent. add-manref.sh inserts a
new man page entity with the right format into the right place.
Revs. 1.82-1.84 of man-refs.ent are a good, although perhaps extreme,
example of what this is trying to prevent.  check-manref.sh makes sure
that the entities in man-refs.ent are in the right order, which is
necessary for add-manref.sh to work properly.
2001-07-24 10:56:11 +00:00
Bruce A. Mah
5a4e6c5809 Add txp(4). 2001-07-24 00:12:20 +00:00
Murray Stokely
bd3a3ce150 Last commit prevented <ulinks> in the index from showing up properly for
printed output.  This fixes indexterms so that page numbers are
displayed following the indexed word/phrase.
2001-07-21 09:09:59 +00:00
Murray Stokely
abaf57a792 Allow NICE_HEADERS to be used in the GEN_INDEX case.
NICE_HEADERS is a set of print-only enhancements, however the HTML
backend is invoked whenever an index is generated, so we should not
touch JADEOPTS directly and should instead modify the .tex-ps target
directly.
2001-07-21 03:44:27 +00:00
Murray Stokely
383c86289e Wrap author attributions in <sect1info> and <sect2info> as
appropriate.

I've specifically left JKH's attribution for the "FreeBSD History"
section in tact, since this is a first person account of the history
of FreeBSD and as such the author needs to be identified in place.
This could probably be marked up differently, but its clear that this
section is different from all of the other "contributed by XXX" in the
Handbook.

Also add support for <sect1info> and <sect2info> to the stylsheet so
that these attributions get displayed as they have been.
2001-07-21 02:29:59 +00:00
Murray Stokely
a6695a0034 Correctly display local file links in the print stylesheet.
Local-file URLs are encoded as file://localhost/path/file which is
fine for HTML but this looks ugly when printed.

Add a function to chop off the "file://localhost" so that the above
URL would be printed as "/path/file" but still link to
"file://localhost/path/file" for HTML output.
2001-07-20 04:59:28 +00:00