entities throughout the install chapter. These need to be defined
with so that these buttons don't wrap across lines.
This prevents :
"Press the [
OK ] button"
from showing up in the print or HTML output.
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.
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.
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.
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.
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}
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
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.
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
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.
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
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.
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.
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.
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.
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.
don't have to keep this number updated at N different places
throughout the doc tree.
Update 3 instances of "4,000" in the Handbook to use this new entity.
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.
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
on -doc who don't share my sense of the aesthetic
Try a better fix at the 'stair stepping' in lists -- the previous fix only
worked for lists that were children of the BODY element, so it didn't have
any effect on those that were (for example) enclosed inside a
<DIV CLASS="PROCEDURE">.
list items, but not to the bullets/marks. Where it used to appear as
1.
This is item one.
2.
This is item two.
and so on, it should now appear as
1. This is item one.
2. This is item two.
Based on a suggestion from Haikal Saadh <wyldephyre2@yahoo.com>.
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.
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.
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.
should speak for themselves. Using these will significantly improve
consistency through the doc tree. Right now--before most of the
documents use these--there are five or six different spellings of
"FreeBSD-STABLE", even in the same document! &os; was added for
completeness.
Approved by: -doc
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.
