enable it in en_US.ISO8859-1/ and ja_JP.eucJP/.
- Add PUBLIC "-//FreeBSD//ENTITIES DocBook Language Specific Entities//EN"
and l10n.ent for entity localization.
- Use share/misc/docbook.css for indentiation of <programlisting>
and <screen>.
- Add some missing $FreeBSD$.
share/images. To link "generic" images (share/images ones) from
Makefiles use IMAGES_EN and to link localized images use IMAGES.
For an example look at en_US.ISO8859-1/books/handbook/Makefile
of doc/en_US.ISO8859-1/books/faq/book.sgml rev 1.509 by moving
the entity definitions to the place where we define all the other
version number entities. This makes it far more likely that they'll
be updated correctly during version number bumps.
- WITH_INLINE_LEGALNOTICE (for HTML only):
do not render <legalnotice> as a separate file if defined.
- WITH_ARTICLE_TOC:
generate TOC for documents whose root element is <article> if defined.
- WITH_BIBLIOXREF_TITLE:
for cross references to bibliography entries, use the title of
the entry as the cross reference text, if defined.
textproc/scr2txt must also be on the system.
The .txt files are created on the fly with .png ones. This is not
perfect, but it allows mirrors to build docs.
'text-only' case.
Do this by explicitly setting preferred-mediaobject-notations to the
empty list.
This has only worked for so long because the source format for images in
all the documents with plain text equivalents for images has been EPS,
which isn't used in the HTML output format. If PNG images were used
then the <textobject> element wasn't chosen.
make the difference between -STABLE and -CURRENT manual pages. We need
this for devfs, device.hints etc. manual pages in our Handbook.
Manual pages entities for -CURRENT should have the form &man.current.foo.1;
Note, this does not concern release notes but only docs.
An "old" man.devfs.5 entity is kept to allow the build of localized docs
till their upgrade.
localized docs.
For example in the Handbook Makefile, an image entry will be similar to:
IMAGES = ../../../en_US.ISO8859-1/books/handbook/install/userconfig.scr
the image will be built in that directory and then installed in the right
localized place at installation time.
Some versions of ghostscript (7.04) have problems with the use of
relative path when the arguments are passed by peps; a fix was
added.
Reviewed and discussed with: murray
well as the lack of necessity of duplicates) in revision 1.142 (adding
PAM manual pages).
Found by: ../examples/check-manref.sh
Submitted by: sed, xargs, ../examples/add-manref.sh
Someone on the RE team will reinstate this change when the release is
imminent.
This (hopefully) will prevent people reading our doc files from getting
confused as to what the latest release is.
Approved by: murray
repo-copy from sound). This is based on the old sound chapter, but
includes video and other multimedia related bits. More will be added to
it shortly and various parts will be cleaned up, but I wanted to get
this in the tree before I do anything else to it.
The sound chapter has been removed from the build, but I haven't cvs
rm'd it yet (though I will in about 24 hrs time).
Mostly submitted by: Ross Lippert <ripper@eskimo.com>
Add support for using the XSL stylesheets to generate HTML output using
XSLT transforms, rather than using JadeTeX. So (assuming you have
installed xsltproc from ports/textproc/libxslt, and the docbook-xsl
stylesheets), you can now do
make STYLESHEET_TYPE=xsl FORMATS=html
and get HTML output that way.
'xsl' a different set of rules are invoked to use an XSL toolchain
(processors, stylesheets, and so forth) to convert the DocBook to the
various different output formats.
I haven't actually written the rules that are invoked when this knob is
set to 'xsl'. But how hard can it be. . .
If defined, EPS files are run length encoded before being integrated
into the PostScript output.
"make book.ps" currently generates a 96 megabyte file.
"make RLE=1 book.ps" generates a 16 megabyte file.
If we added a tool to use better (LZW) compression for the eps
screenshots and such, then we could reduce this number further.
Don't make the assumption that source files are writable.
The FDP infrastructure has a few constructs of the form
"cp foo bar; cat baz >> bar". This breaks if foo isn't
writable (as is frequently the case in P4 work directory).
<filename role="package">. The <port> tag as it was had two major
defects: (a) the name is ambiguous (does "port" mean "architecture"?
how about "TCP/UDP port"?), and (b) it introduces a non-standard (to
DocBook) tag, which is generally assumed to be evil.
Moral support by: bmah, keramida, mwlucas, roam
stylesheets. To get around this, append the filename specified in the
'CSS_SHEET_ADDITIONS' variable (if defined) to the end of the default
CSS stylesheet. This allows us to add document-specific stylesheet
rules while still supporting braindead browsers and reusing the
default CSS code.
CURDIR. This causes problems when one wants to have multiple doc/
trees checked out at once because it requires every tree to be in a
directory called "doc"; i.e., one must have <name-of-tree>/doc/
instead of just <name-of-tree>/ like one can do with src/. Mitigate
the pain by making it possible to tell the build infrastructure what
the doc prefix is called; this still isn't perfect since it requires
to fix a bug that would cause footnote numbering to be messed up if
using %footnote-ulinks% and we had any empty <ulink></ulink> elements
in a document. (This happens a lot in the release documentation.)
This change has been submitted to the DocBook bug database on
SourceForge as bug #502066. When it gets included into the
DocBook DSSSL distribution and the corrected version gets incorporated
into the FreeBSD Ports Collection, I'll back out the change in our
(FreeBSD's) stylesheet.
combination of %footnote-ulink% and bop-footnotes not generating any
URL footnotes (although other footnotes in documents were
correct). freebsd.dsl contains a modified definition of the
ulink element as defined in dblink.dsl from the DSSSL print stylesheet;
unfortunately it was missing some lines of code, which we restore.
As of this commit, no document in the FDP uses %footnote-ulink%,
although the release documentation will enable it shortly.
that optional features such as two-sided output and justification work
for PDF files, not just PostScript.
PR: docs/32849
Submitted by: Peter Johnson <freebsd@bilogic.org>
possible generated files (make clean is called for all known formats).
It can be useful when default FORMATS for document has different value
than was used in build.
Reviewed by: nik
to process generated HTML. This not cause any side effects except
leaving some character entities in their numeric form instead
converting them into alphabetical notation (< instead of <),
but since all browsers understand such cases it is not a problem.
This commit should make all translations tidy clean, since
tidy should not arise entities conversion problem as it did
for long time before. Therefore all occurences of manual settings
of TIDYFLAGS and NO_TIDY declarations for translations are removed.
No objections from: -doc
Requested by: Russian and Japanese translation teams
in the FAQ to use these. (Presumably there'll be others.)
While I'm here, add an entity for the current release's errata file.
Heavily based on the last patch in the PR, modified to be consistent
with the way that the Website build defines similar entities.
PR: 30202
Submitted by: Michael Lucas <mwlucas@blackhelicopters.org>
* Add a new document-specific variable, HAS_INDEX, to specify if a
given document is marked up with <indexterm> entries.
* Rework the index support so that both HAS_INDEX and GEN_INDEX are
checked before trying to generate an index for a document.
* Only create index.sgml if both HAS_INDEX and GEN_INDEX are set.
This allows us to recursively build the documentation tree with
GEN_INDEX=1 and have it only try to create an index (very time
consuming) for the few documents that are ready for this. Previously,
running "make GEN_INDEX=1" from the top of the doc tree would look for
index terms in every single document.
With this, I hope we can start building our docs with GEN_INDEX set on
freefall so that users browsing the HTML docs will get the benefit of
the index we've been hiding in CVS for 6 months.
Also fix several minor bugs here, such as leftover files not being
deleted after 'make clean'.
PR: docs/31131
Submitted by: Cyrille Lefevre <clefevre@citeweb.net>
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.
