Commit graph

76 commits

Author SHA1 Message Date
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
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
Nik Clayton
9524fc725a Add JADEFLAGS to the nsgmls command line, so that any special "-i" settings
get passed down properly.  This fixes "make lint" for the Handbook, now that
the chapters are individually buildable.
2001-07-16 15:11:54 +00:00
Murray Stokely
213a66a8d3 Introduce a 'NICE_HEADERS' tuneable knob that creates customized
chapter headers that you may find more aesthetically pleasing than the
rather spartan chapter headers in Norm's print stylesheets.  This
option only effects print output formats for English language books.

Also move the local-en-label-title-sep customization from share/sgml
to en_blah/share/sgml since the best values for this customization
depend on the locale.

This changes (make FORMATS=ps) :

    Chapter 7. Users and Basic Account Management

    7.1. Synopsis

into (make NICE_HEADERS=1 FORMATS=ps) :

    Chapter 7
    /Users and Basic Account Management/

    7.1  Synopsis

More work needs to be done for the NICE_HEADERS case to enhance the
output, but I think its an improvement.
2001-07-16 05:00:21 +00:00
Chris Costello
dde382c2b4 Add a dependancy on ${CSS_SHEET} for the docbook.css target. Without this,
one must run a `make clean' (or `rm docbook.css') or the stylesheet is not
updated, regardless of whether or not it's been updated since the last
build.
2001-07-14 18:04:06 +00:00
Nik Clayton
9e7e408f55 Use peps instead of eps2png. 2001-07-13 12:09:59 +00:00
Dima Dorfman
350f5b2b24 Add INDEX_SGML and docbook.css to CLEANFILES as appropriate.
PR:		28864
Submitted by:	Alex Kapranoff <kapr@acm.org>
2001-07-12 00:24:59 +00:00
Murray Stokely
088000e692 Slight modification to support the case where a document contains
indexterms, but we don't want to generate the index.

Specifically, touch the ${INDEX_SGML} file if ${GEN_INDEX} is not set.

Suggested by: Nik
2001-07-10 03:06:48 +00:00
Nik Clayton
6887d21569 Add a new variable, EPS2PNG_RES, to set the resolution eps2png uses to
convert graphics.  Change the default from 82 to 100, for clearer images.

PR:		docs/28237
Submitted by:	G. Adam Stanislav <adam@whizkidtech.net>

While I'm here, include some suffix rules to convert .scr files to .png
files.  Nothing uses these, yet, but should do shortly.
2001-06-22 10:12:23 +00:00
Chris Costello
1d6177220b Null commit:
Apparently either my editor or CVS appended a new-line at the end
  of this file, which was a part of the previous delta.
2001-06-21 03:03:51 +00:00
Chris Costello
a7db143730 Include ${LANGUAGECATALOG} in `make validate' nsgmls command line arguments. 2001-06-21 02:55:59 +00:00
Nik Clayton
e4bca6fe83 Pull in docbook.css as necessary. 2001-06-18 14:24:08 +00:00
Nik Clayton
5c75be36bd Rewrite the index generation support -- this seems to do the right thing,
and doesn't break the build in the non-GEN_INDEX case, so it's safe to
commit.  I need more people testing it though.
2001-06-16 14:11:52 +00:00
Andrey A. Chernov
f749b200c1 ISO_* -> ISO* rename 2001-06-11 01:20:40 +00:00
Dima Dorfman
8140e08d69 Bump the number of directories traversed to find LANGCODE to 10. This
isn't a problem yet, but I did run into it in my local builds a few
times, and I thought it'd be better to raise it now to make sure
nothing magically breaks later.

Silence by:	-doc
2001-05-22 03:18:38 +00:00
Nik Clayton
f3866f36b1 Make the eps2png and epstopdf commands OBJDIR safe.
Submitted by:	Christian Weisgerber <naddy@mips.inka.de>
2001-05-09 19:31:47 +00:00
Nik Clayton
d058817a01 Fix small error that meant that library images weren't being included in
any generated tarballs.
2001-03-27 16:15:07 +00:00
David E. O'Brien
3cdf03e3f3 If running on the Alpha, use OpenJade.
Forgotten by:	who ever did the doc.docbook.mk Alpha support
Silence by:	doc@freebsd.org
2001-03-22 22:49:01 +00:00
David E. O'Brien
e6e620e787 Separate the Alpha arch test and the OPENJADE test. This also gets
"OPENJADE" exported in the Alpha case so it matches the non-Alpha case.

Silence by:	doc@freebsd.org
2001-03-22 22:47:32 +00:00
Alexander Langer
b250ca7d11 Now really do use openjade on alpha.
PR:		25891
Submitted by:	Christian Weisgerber <naddy@mips.inka.de>
2001-03-18 15:48:10 +00:00
Nik Clayton
e64d4df877 Finish off the previous commit by removing the -S flag from the links
command line, which is not supported in links (but was in w3m).
2001-03-13 18:29:06 +00:00
Nik Clayton
ff2f53e45a Honour $LOCALBASE when setting $PREFIX.
PR:		docs/25496
Submitted by:	Mike Meyer <mwm@mired.org>
2001-03-13 09:54:34 +00:00
Jim Mock
c371a0a7a7 w3m -> links
Submitted by:	jkh, dd
2001-03-13 03:03:46 +00:00
Nik Clayton
66417ff8b0 Use openjade if we're on an Alpha. Use links instead of w3m. 2001-03-11 18:26:06 +00:00
Nik Clayton
3df699389c Use a different mechanism to specify the input file to TeX.
<aph>  running, for instance, "jadetex '\nonstopmode\input{$<}'" is much
       better since it won't crash out an automated build as badly
<nik_> Huh?
<aph>  it will fail rather than kick you into a TeX prompt and wait for output
<aph>  I guess in BSD make that would be:
<aph>  jadetex '\nonstopmode\input{${.ALLSRC}'

Submitted by:	Adam di Carlo <adam@onshore.com>
2001-02-26 22:56:59 +00:00
Nik Clayton
fc20bd6c53 1. Add a new knob, GEN_INDEX. If defined (nothing does yet), collateindex.pl
will be run to generate index.sgml, an automatically generated index for
the document.  This is also added to the list of dependencies.

2. Add a DOCBOOKSUFFIX variable, defaulting to "sgml", so we can write

   MASTERDOC?=  ${.CURDIR}/${DOC}.${DOCBOOKSUFFIX}

Requested by:   Michael Wiedmann <mw@miwie.in-berlin.de>
                Linux Documentation Project

3. Set the DSSSL 'openjade' variable to #t if we're processing with
   OpenJade.

4. Work around a bug in the stylesheets.  If we split the <legalnotice>
   out in to a separate file it isn't added to the HTML.manifest.  Check
   for it by hand, and include it if necessary.
2001-02-22 15:42:41 +00:00
Nik Clayton
88abf1e8bb Better image support. Use Ghostscript and NetPBM, rather than simply
relying on ImageMagick.
2001-02-20 19:08:58 +00:00
Nik Clayton
378340c7fe Use epstopdf (from teTeX) rather than ImageMagick to convert EPS to PDF
files.  The results seem to be nicer.
2001-02-12 17:03:54 +00:00
Jun Kuriyama
a2bdbe7902 Remove ${.TARGET} if jade failed. 2000-10-31 14:39:13 +00:00
Nik Clayton
7c4206c1aa Support installing images where the document and images are split up over
multiple directories, the way (for example) that the Handbook is.
2000-10-29 18:01:54 +00:00
Nik Clayton
324f84d204 LIB_IMAGES -> IMAGES_LIB, to be consistent with IMAGES_PNG and IMAGES_EPS
Extend the image support.  Now handles the "install" part for HTML, PS, and
PDF, as well as packaging.

Better support for images in the PDF output.  I'm still trying to figure out
how to get good quality PDF from EPS source though.
2000-10-29 02:39:10 +00:00
Jun Kuriyama
5daef3227b Temporary fix to make this buildable.
Submitted by:	crossd@cs.rpi.edu
2000-10-10 06:16:56 +00:00
Nik Clayton
3197343458 Support images in the documentation.
For producing text-only docs, we need to have a second HTML target.

The PS and PDF targets (which depended on a .tex file) have been split
out so that they each depend on their own .tex-${format} file, to get
the image formats correct.
2000-10-08 19:19:09 +00:00
Nik Clayton
107896244a Initial support for images within the documentation. Support EPS and PNG
format images.  Assume that ImageMagick has been installed -- this is a
big requirement, and will be refined before this gets much further.
2000-10-08 19:17:42 +00:00
Nik Clayton
4d20c32be9 Add a comment to sync this with my local repository. 2000-10-08 19:16:32 +00:00
Neil Blakey-Milner
a15fa475b5 Make 'make lint' work again. Obviously no-one uses it. (:
(I forgot to set NSGMLS)
2000-10-07 16:31:04 +00:00
Neil Blakey-Milner
c97832896f If OPENJADE is defined, use the openjade replacement tools like
'openjade', 'onsgmls', like 'osgmlnorm'.
2000-09-28 23:34:49 +00:00
Neil Blakey-Milner
1c78f1c07d a) "Fix" out-of-tree builds by not hard-coding locations of dsl files
with SYSTEM, and using instead PUBLIC entities gained from the catalog
in the directory of the language the document belongs to, or the
language-neutral entity.  Now we always use default.dsl as our dsl
master, and it grabs the necessary magic from the catalogs.

b) Fix the always-out-of-date imagelib problem with some make(1)-fu.

Approved by:	nik (ages ago)
2000-09-28 23:29:48 +00:00
Nik Clayton
a9b9a2fe08 Add ${DSSSLCATALOG} and ${JADECATALOG} to the list of catalogs the lint:
target uses -- this ensures that any options (such as "OMITTAG NO") that
are used when building the docs are also used when linting them, so that
errors don't slip through the cracks.

Prompted by r1.93 of the FAQ.
2000-09-25 08:17:03 +00:00
Nik Clayton
460016ce35 Fix the handling of unsupported formats (like "html-split") in doc.html.mk.
Output a non-fatal warning for these.  For unknown formats output a fatal
error.
2000-07-23 16:27:58 +00:00
John Baldwin
3ac389f2d4 Don't allow html-split to be treated as a format during install.
Admittedly, this is a hack, and the real solution is to sanitize FORMATS
by removing any words that aren't in KNOWN_FORMATS.  This fixes release
since releases uses 'html html-split txt' for FORMATS when it compiles and
installs the docs.
2000-07-19 01:46:48 +00:00
Nik Clayton
f631452350 doc.images.mk
LOCAL_LIB_IMAGES_DIR should be a path component, not a complete path, so
remove ${.CURDIR}.

doc.docbook.mk

Set the directory for image installation correctly, and ensure that the
directory exists before we try and do anything with it.

These should fix the installation problems people are having with the
primer.  There's still an outstanding bug -- make(1) thinks that the
local library images are out-of-date with respect to the ones in
share/images for some reason.  This forces a rebuild each time.  I'm
still looking at that.
2000-07-18 16:30:45 +00:00
Nik Clayton
693df4dc05 Fix the problem where <foo>.html.gz was being listed as a dependency, and
we don't need it anymore.

I'm fixing this from Kirk's tutorial at the O'Reilly Open Source conference.
He was no help at all. . .
2000-07-17 22:30:03 +00:00
Neil Blakey-Milner
279c23a44c LANGCODE, not LANG_CODE. Of course, it passed testing, because
doc//share/sgml/freebsd.dsl exists.
2000-07-17 08:51:38 +00:00
Nik Clayton
69a59546e0 Make sure the LOCAL_LIB_IMAGES_DIR directory is cleaned appropriately. 2000-07-16 16:34:08 +00:00
Nik Clayton
57f6bf9869 Support library images. Do this by
1.  Listing LIB_IMAGES as a dependency on certain targets, to ensure
    that library images are pulled in correctly.

2.  Create a new FORMAT, html.tar, to cater for the case where we might
    be producing a single .html file, but we need to tar that up for
    distribution and the tar file needs to include all the images.

3.  Update the various install-* targets to include the images.

4.  Update the package-* targets to include the images

While I'm here, pull out the .doc target.  For some reason I thought our
tool chain could produce Microsoft Word .doc files.  It can't.
2000-07-16 16:32:27 +00:00
Nik Clayton
03f0782120 Pull in doc.images.mk as necessary.
Also pull in doc.html.mk when DOCFORMAT==html, something I missed from
an earlier commit.
2000-07-16 16:29:18 +00:00
Nik Clayton
f24bb0a201 Image support in the documentation. For the time being, just support
library images (and in particular the callout bugs).
2000-07-16 16:27:30 +00:00
Neil Blakey-Milner
2d8415a9de 1) Use non-relative path to the DSL location, which makes external
document building work again.

2) Add support for building html documents, which is required for
ipsec-must document.
2000-07-14 08:42:49 +00:00
Nik Clayton
2ee393d1be Support infrastructure for HTML documents in the doc/ tree. 2000-06-26 09:04:24 +00:00