Commit graph

59 commits

Author SHA1 Message Date
Murray Stokely
0b61dde25e Correctly use the \url{} macro for ulinks without any content.
So <ulink url="bla"></ulink> will be displayed properly.
2001-10-13 01:07:24 +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
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
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
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
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
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
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
Murray Stokely
d79e4c4fad Turn on justification and hyphenation by default for print output. 2001-08-02 03:24:04 +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
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
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
Murray Stokely
2a6d5f6c26 Add handlers for <chapterinfo>.
Also add a handler for <contrib> inside of <author> tags.

This should allow us to more formally define contributors to the
Handbook.
2001-07-17 02:22:29 +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
Murray Stokely
5c47dd8654 Introduce a new handbook-specific knob ``WITH_PGPKEYS'' and add the
relevant functions to the DSSSL stylesheet.

The default behavior is for print output formats to just display PGP
fingerprints unless you use `make WITH_PGPKEYS=1 FORMATS=ps'.  This new
default behavior reduces the size of Appendix E from 52 pages to 9
pages, and that could be trimmed down more with a more efficient
layout for the fingerprints (does each entry really warrant a new
section header?)

Knob requested by: Chris Costello
Discussed on: -doc
2001-07-12 01:40:31 +00:00
Murray Stokely
78c6c53ba0 Image support has been mangled since the move to docbook.css. This
adds a new mediaobject handler to simplify the output HTML so that
images no longer overlap the text and other nearby images.

The output HTML used to look like this :

      <div class="MEDIAOBJECT">
        <p><img src="fig2.png"></p>
      </div>

The problem was that the image would be displayed on top of nearby
text or image elements completely obscuring the previous contents
rather than doing proper page layout.  With this change, the above now
simply looks like this :

      <img src="fig2.png">

An alternative solution would be to fix docbook.css, but I think that
the problem stems from the way that different browsers implement CSS.
It is easier to just fix it here at the DSSSL level.
2001-06-24 02:46:40 +00:00
Nik Clayton
e705f83469 Turn on the use of the stylesheet. Remove the code that caries out
special formatting for questions, as the stylesheets now do this.

Interested parties can look at http://people.freebsd.org/~nik/faq-css/
for an idea of how the new stylesheets render.
2001-06-18 14:29:16 +00:00
Nik Clayton
53c24748d7 Select the right .index file depending on whether the output is being
chunked or not.
2001-06-16 21:30:11 +00:00
Dima Dorfman
c99472149c The problem is with nested links; quite frankly, they don't work.
This isn't normally an issue because no one in their right mind will
stick a <link> inside another <link>.  However, we have entities which
create links, such as &man.*;, &a.*;, etc.  It's nice to be able to
use these inside links.  To deal with this..

Introduce a create-link procedure which will be used to replace (make
element gi: "A" ...) constructs.  This procedure creates a link as
specified only if the can-link-here procecure (described below)
returns #t.  If the latter returns #f, it will print the link text
without the link.

The (also new) can-link-here procedure returns #t if it determines
that it's okay to make a link in the current context, and #f
otherwise.  Currently, it does its check by figuring out whether the
current context is within a <title> or <question> tag.  This is not
ideal because it doesn't catch all cases, but it's a lot better than
nothing.  As the other cases are discovered, this procedure can be
modified.
2001-06-02 23:02:13 +00:00
Dima Dorfman
94eb26771b Introduce a <groupname> tag similar to <username>. I don't forsee it
being rendered any differently than <username>, but it's very
confusing to write markup with both user and group names in close
proximity, and both marked up with <username>.
2001-05-22 03:32:17 +00:00
Udo Erdelhoff
f777871dce Add the framework for using <bibliography>. Use the title of the Book
in the text and let it be a link to the bibliography entry.
Note: The functionality needs JADEFLAGS=-Vbiblio-xref-title in the Makefile

Reviewed by:	nik, freebsd-doc (original version)
Original by:	nik
2001-05-20 17:30:44 +00:00
Nik Clayton
6b9ded6e4c Fix a typo, and make sure that ISBN numbers in the front matter are
included.
2001-04-09 20:35:47 +00:00
Nik Clayton
82d52622d4 Add a default $create-refentry-xref-link$ function. 2001-04-05 13:19:59 +00:00
Nik Clayton
8e5b858d5b Add a new variable, %refentry-xref-link% which determines whether or not
man page references (&man.ls.1;, etc) are converted in to links to the
man->HTML CGI on freebsd.org.  Defaults to off.

Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 09:40:24 +00:00
Nik Clayton
59595c172d In the print stylesheet, keep the ToC to 3 levels of depth or less, and
don't indent body text.  This reduces the size of the Handbook's PS file
by about 1MB, and has similar (although less dramatic) effects on the
other documents.
2001-03-04 18:05:19 +00:00
Nik Clayton
2aa8b87288 Oops. That last commit bought in some more stuff from my development
tree that I wasn't quite ready for.  It may as well stay in now though.

In order.

 1.  Pull out the code that deals with <segmentedlist>, the regular
     stylesheets handle that now.

 2.  Change how $email-footer$ is handled.  This requires changes to the
     <lang>/share/sgml/freebsd.dsl files, to come very shortly.

 3.  Redo warning and caution label support.  This is no-op, as Norm's
     sheets don't support this the way I want yet.

 4.  Remove a useless comment.

 5.  Pull out the experimental docinfo stuff, it doesn't work.

 6.  Pull out the special handling of <literallayout>, the regular
     stylesheets handle that now too.
2001-02-20 19:38:25 +00:00
Nik Clayton
ebb3148dbd Turn off the 'heading level characteristic' option. It breaks the Handbook
PDF build.
2001-02-20 19:17:26 +00:00
Nik Clayton
18f94d697b Hack to select the right image scaling based on the 'format' attribute
of the 'imagedata' element.
2001-02-20 19:09:50 +00:00
Nik Clayton
4e9b64c5f7 Turn on %generate-legalnotice-link%. This makes the word "Copyright" in
generated HTML link to the legalnotice, if the document has one.

Requested by several people on -doc (all of whom probably thought this
would be quite a lot of effort, heh heh heh).
2001-02-13 19:21:31 +00:00
Nik Clayton
5a65a99ceb Set the heading-level characteristic to '2' if we're generating PDF output.
This has the useful side effect of generating bookmarks in the PDF file,
which programs like Adobe Acrobat Reader can use to provide a navigable
table of contents in a side window.  This only seems to work with OpenJade,
but the option doesn't cause Jade any problems.
2001-01-08 12:40:52 +00:00
Nik Clayton
6c424d3554 Put down the crack pipe long enough to revert back to labelling questions
with a number, and not just a big "Q".  No idea what the hell I was
thinking when I did that.

Override generate-anchor in the master stylesheets, so that the names
(i.e., the <a name="...">) in the HTML output for questions is Qx.y.,
where x.y is the question number.  This is much less likely to change
than the AENxxxx format, which changes with every addition or deletion
to the FAQ, so it's much easier for people to link to specific questions
within the FAQ now.

A few whitespace/indentation changes with existing code.
2000-10-28 21:14:44 +00:00
Nik Clayton
b5fbe0e00e Remove a gratuitous output.print.pdf section, a hang over from some of my
earlier testing.

Redefine the literallayout element handling, so that 'class=monospaced' is
handled properly.
2000-10-23 14:41:46 +00:00
Nik Clayton
895a6d904c Reorganise things a little bit.
Redefine two functions in <[ %output.print; [ ... ]]> to support image
handling.
2000-10-08 19:15:06 +00:00
Ben Smithurst
846c848b3d Add some magic which puts double quotes around <errorname> text.
Submitted by:	nik
2000-07-25 18:23:45 +00:00
Nik Clayton
c0ca318851 Turn on callout graphics. Forgot this from about a week ago. 2000-07-25 10:31:35 +00:00
Nik Clayton
a595525171 Give each language and encoding it's own freebsd.dsl, to contain style
sheet definitions for that language only.  Each file reads in the defaults
from the master share/sgml/freebsd.dsl file, and adds overrides, or new
definitions, as necessary.

Move the per-language hacks from share/sgml/freebsd.dsl in to
<lang>/share/sgml/freebsd.dsl as necessary.

Add links to the -questions and -doc mailing lists to the bottom of the
generated HTML output for some languages.  The -questions link will
become a link to Greg's "Getting the most from questions" document when
I bring that in, but I haven't done that yet, and I didn't want these
patches hanging around my local tree.

This was the real reason for making freebsd.dsl language local, as it
makes it much easier to translate generated text, such as the text of
the links, without polluting share/sgml/freebsd.dsl.

Update doc.docbook.mk to use the new, per-language freebsd.dsl file when
building the docs.  While I'm here, update .pdb generation so that it
creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates
"book.pdb" and "handbook.pdb").  This makes it easier to install more than
one document on a Palm, because two docs called "book.pdb" or "article.pdb"
can not co-exist.
2000-03-23 09:00:17 +00:00
Nik Clayton
67c7006408 Back out part of the previous commit; remove the code that generates HTML
expecting to find a docbook.css stylesheet file, which I committed a bit
too soon.

Pointed out by:	jim
2000-02-15 01:57:17 +00:00
Nik Clayton
0aa5ee0c69 Add "legalnotice" to the list of elements that are included on the title
page of articles.  This necessitates duplicating the entire list in the
customisation layer, which will need to be kept up to date as the master
stylesheets change.
2000-02-14 01:29:17 +00:00
Nik Clayton
9b0a980469 Add $FreeBSD$ comment.
Submitted by:   billf
1999-11-15 19:44:15 +00:00
Nik Clayton
212679edca Fix a typo in the French localisation of the stylesheets. 1999-11-10 20:32:58 +00:00