Currently we have articles.ent and books.ent, and
for example, articles.ent can be used by putting the
following lines in the doctype declaration:
<!ENTITY % articles.ent PUBLIC
"-//FreeBSD//ENTITIES DocBook FreeBSD Articles Entity Set//EN">
%articles.ent;
This pulls all of the necessary entities via share/sgml/articles.ent.
The translation teams can customize these entities by redefining
the articles.ent file in <langcode>/share/sgml. See
ja_JP.eucJP/share/sgml for example.
- 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.
- Don't join trademarks with other words, e.g. using hyphens.
trademark.ent:
- Commonly used trademarks are defined as entities for ease of use.
- All trademark attributions are defined as entities for ease of use.
Approved by: ceri (mentor)
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
Markup is nice for visually showing the type of an element, but
it's nice to have all the relevant information in the running text
too for those cases where visual hints are impossible (i.e. when
someone is reading the text only version of the article).