- Use trademark entities, including XFree86 now that the XFree86 Core
Team has responded with their trademark policy.
- Add trademark attributions.
- Always use correct case for trademarks.
- Don't join trademarks with other words, e.g. using hyphens.
- Don't use trademarks as nouns (e.g. don't use "Windows NT's").
trademark.ent:
- Add entities for more trademarks / companies.
- Fix the Xiph.Org entry.
- Use trademark entities.
- Add trademark attributions.
- Always use correct case for trademarks.
- Don't join trademarks with other words, e.g. using hyphens.
- Don't use trademarks as nouns (e.g. don't use "Windows NT's").
diskless-x/article.sgml:
- While I'm here anyway add trademark tags for all trademarks, now
that the stylesheet handles it right.
trademark.ent:
- Add entities for more trademarks / companies.
Also rename the 3Com trademark entity from t3com to tm.3com. This
should make the entity naming convention a bit more consitent. This is
done now since the entity is not used too many places yet.
empty and unclosed tags. I used the word "should" because sometimes it
does not work, however most of malformed tags are found now.
That idea came after a talk with Denis Peplin.
- Use trademark entities.
- Add trademark attributions.
- Always use correct case for trademarks.
- Don't join trademarks with other words, e.g. using hyphens.
- Use 'UNIX like systems' instead of 'UNIX systems'.
trademark.ent:
- Add entities for more trademarks / companies.
Each trademark will only have a trademark symbol appended the first
time in a document for print / html, and the first time on each HTML
page for html-split.
It is possible to always append the trademark symbol for a trademark,
by setting the role attribute to "force" in the trademark tag.
The code differentiates between trademarks in normal text and titles,
so if there is a trademark in a title, the symbol will be displayed
the first time in the title, and the first time in the normal text.
Basically this means that all trademarks can / should be marked up in
the documents, and the stylesheet will do "the right thing".
Looked at by: murray
Approved by: mwlucas (temp mentor)
- I added various trademarks needed in trademarks.ent but I did not
used them in the section. They should be added when the trademarks
tagging will be definitively defined.
PR: docs/55652 [1]
Submitted by: Dan Pelleg <daniel+handbook@pelleg.org> [1]
Add trademark symbols and attributions:
- Add trademark tags as needed, generally on first use in each
article.
- Add an attribution to the legal section mentioning all trademarks
referenced.
- Always use correct case for trademarks.
trademark.ent:
Add Macromedia, Inc trademark attribution.
share/sgml, since a lot of the entities are language independent, and
it makes work simpler for translators to have them in share/sgml.
The trademark.ent file contain:
- Commonly used trademarks defined as entities for ease of use.
- All trademark attributions defined as entities for ease of use.
Suggested by: hrs
Approved by: ceri (mentor)
Update man-refs.ent and the docs accordingly, while retaining the man.X.1
entity to allow translators to catch up with this change.
Submitted by: Alexey Mahotkin <alexm@w-m.ru
and the localized sysids to <langcode>/share/sgml/catalog.
Since <langcode>/share/sgml/freebsd.dsl still include some
language-neutral parameters and procedures for printable formats,
I will work on assorting them similarly. I am sorry that
this (and probably the next) commit may break the translation
team's usual update procedure, but you can merge the language-specific
freebsd.dsl from the English version as before.
Discussed on: -doc
bsd.obj.mk already includes bsd.subdir.mk so there is no need
to include it twice.
PR: 52540
Submitted by: "Simon L.Nielsen" <simon@nitro.dk>
Tested with: cd doc/ && make
<indexterms> are sparse. Also add makefile glue so that this may be
invoked on the Handbook or any other document in the FDP tree by
typing "make indexcheck".
Sponsored by: FreeBSD Mall, Inc.
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>
