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.
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
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.
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.
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>.
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
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.
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.
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.
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).
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.
now-deprecated osf1(8). -CURRENT doesn't have these anymore, but the
-STABLE branches do; plus it's a little odd to try to write about the
scripts' removal without these entries.
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.
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)
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.
attributes. We don't use these yet, but they've been hanging around my
tree for ages, and it's time other people got to play with them.
Add (HTML) entity defs for lsquo and rsquo, ` and ' respectively.
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.
Default to labelling questions with "Q:" and answers with "A:" when
processing <qandaset>s. In the HTML output, render questions in a larger,
bolder font than the answers. Requested by several people on -doc.
Default to numbering sections. Requested by one person on -doc, who
seemed somewhat confused that I hadn't read his mind and done this three
months previously.
cvs: ----------------------------------------------------------------------
in the case of */FAQ/Makefile, because the FAQs are all in the wrong
place. Things still install properly, but some of the directory paths
are hardcoded. This will be going away ASAP.
by the recently committed "Serial Console" section. I had these in my
local tree, and they slipped off my "list of things to commit" somehow.
Prompted by: Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
Current version of dsssl-docbook-modular has Japanese option, but
this doesn't satisfy our needs.
Until I write a patch, Japanese stylesheet should be off.
sanctioned hack to indent verbatim environments :-)
Explicitly turn off formatting a <variablelist> as a table, it's still
buggy.
Rename "usen-*" to "en-*", as the usage changed in the underlying
stylesheets. The leader to a <warning> or <caution> should now have
the ":" in the correct position.
The construct:
<citerefentry>
<refentrytitle>foobar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
is a pain to type, and messes up the pretty-printing of the source code.
Replace every occurence of a entry like that with:
&man.foobar.1;
Adjusting the manual page name and section number appropriately.
The definitions for these entities are stored in man-refs.ent. This
file is in doc/share/sgml because it is not just specific to the Handbook.
I expect the DocBook'd FAQ and Tutorials (coming RSN) to use them as
well.
A new PUBLIC identifier has been created for these entities, and added to
the catalog file.
Doc. Proj. related ports under $PREFIX/share. Update en/handbook/Makefile
with the new paths.
Didn't seem worthwhile to do a repository copy for only three files moved.
