Commit graph

187 commits

Author SHA1 Message Date
Martin Heinen
f1510cc0c0 Fix sorting of mirrors. Newer versions of xsltproc
add a newline after comments which breaks the pattern
used by awk.  Directly search for @sortkey@ now.

Discussed with:	hrs
2005-01-15 15:02:12 +00:00
Giorgos Keramidas
17ee19c2b8 Set the default line width for FORMATS="txt" to 72 columns. This fixes,
after a very long time, the problem described in:

PR:		docs/41791
Submitted by:	Jerry Dunham <jdunham@m3designinc.com>
2005-01-10 22:00:58 +00:00
Simon L. B. Nielsen
7cfdcf77eb Tell collateindex to set the id tag (to "doc-index" in lack of better
idea for a name) so we will not get dynamic filenames for html-split
output.
2005-01-06 12:40:46 +00:00
Murray Stokely
e94633c940 Fix HTML output with multiple XML SRCs case. 2004-09-07 12:06:22 +00:00
Murray Stokely
c290cc6eff Add definitions required for using SAXON instead of libxslt when
USE_SAXON is set.  This doesn't quite work yet.

Also fix a bug in the .fo target that was uncovered when slides for a
presentation are split across multiple XML files.
2004-09-07 11:56:03 +00:00
Murray Stokely
30830727e5 Add support for using FOP or XEP as an XSL-FO backend via USE_* make
variables.  PassiveTeX is pretty limited and so the other formatters
give the stylesheets more functionality to create nice slides.
2004-09-04 19:17:35 +00:00
Murray Stokely
54ab45e845 Add support for building documents in our doc/ tree marked up in
Norman Walsh's DocBook Slides DTD.

This DTD offers the vocabulary of simplified DocBook for
presentations.  Initially, the supported output formats are PDF and
HTML.

XSL stylesheets are used so libxslt is required.

PassiveTeX is used for the PDF generation to convert the XSL-FO
directly to PDF.

This commit moves various TeX definitions out of doc.docbook.mk and
into doc.project.mk, since docbook is no longer the only back-end to
utilize TeX.

An example Makefile would look like :

----
DOCFORMAT=	slides
DOC=		slides

SRCS=	slides.xml

DOC_PREFIX?=	${.CURDIR}/../../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"
---

And an example slides file (slides.xml) looks like :

---
<!DOCTYPE slides PUBLIC "-//Norman Walsh//DTD Slides XML V3.3.1//EN"
  "http://docbook.sourceforge.net/releases/slides/3.3.1/slides.dtd">
<slides>
<slidesinfo>
  <title>What's new in FreeBSD 5.3</title>
  <titleabbrev>FreeBSD 5.3</titleabbrev>
</slidesinfo>

<foil><title>Introduction Slide</title>
  <para>Content</para>
</foil>
</slides>
---

You could then build the HTML and PDF versions of the slides by typing
"make FORMATS='pdf html'".  Enjoy.

Please coordinate with doceng@ before importing any presentations to
doc/.
2004-09-02 17:12:14 +00:00
Murray Stokely
25e6eedd23 XSLTPROC and TIDY are not specific to either DocBook or HTML formats,
so move the associated variables to doc.project.mk instead of
duplicating the definitions for each doc type.
2004-09-02 16:42:01 +00:00
Marc Fonvieille
b15b7b88e6 Fix the RTF build:
Jade is not able to embed images but links them instead, so images have
to be installed with the .rtf document (it's similar to the HTML case).

I added a new format: rtf.tar which is a better solution than using rtf
since the images are not embedded.
make FORMATS=rtf.tar is your friend :)
2004-08-12 15:09:05 +00:00
Murray Stokely
4a479db46d Backout last change. It was already included in doc.common.mk.
Found by:	hrs
2004-08-12 05:28:42 +00:00
Murray Stokely
863ccaf4aa Always use absolute URLs for print output. 2004-08-12 03:45:39 +00:00
Murray Stokely
415cd96b9d Honor DVIPSFLAGS even if PAPERSIZE is not defined. 2004-08-11 10:51:13 +00:00
Hiroki Sato
7462d30d2f - When <langcode>/share/mk/doc.local.mk exists, it will be included
just after doc.common.mk included.  This can be used for various
  language specific customizations.

- Remove SP_ENCODING_LIST.  Translators should define the SP_ENCODING
  variable directly in their doc.local.mk when it is needed.

Discussed with:	den
2004-08-09 16:22:55 +00:00
Denis Peplin
78b44725a4 Parse ISO* encodings, convert it to ISO-* before SP_ENCODINGS assignment
Add ISO-8859-2 to SP_ENCODING_LIST
2004-08-06 09:33:17 +00:00
Denis Peplin
ee53d80ba8 Set SP_ENCODING from SP_ENCODING_LIST
Add KOI8-R to this list
Other encodings can be added after some testing

Note: KOI8-R supported by jade-1.2.1_8 and above

Reviewed by:		Dmitry Morozovsky <marck@rinet.ru>, ru
With cleanups from:	ru
No objections from:	freebsd-doc
2004-08-06 05:22:17 +00:00
Hiroki Sato
ca944c36ab Remove trailing whitespaces. 2004-07-23 18:58:56 +00:00
Hiroki Sato
c8277d756c Fix a build problem when print/ghostscript-afpl is used:
- epsgeom+gs now converts EPS files.  graphics/peps is no longer used.
 - Add $PERL, $REALPATH, and $SETENV into doc.project.mk.

Tested by:	simon
2004-07-23 18:53:34 +00:00
Murray Stokely
551eaf5b40 Add a DSSSL stylsheet to enable more efficient spellchecking. This
stylesheet omits the contents of <filename>, <devicename>,
<programlisting>, and other tags that are likely to not contain real
English words.  The output of this stylesheet can then be checked with
'make spellcheck' with far fewer false positives.
2004-07-14 05:28:11 +00:00
Hiroki Sato
eb69b4c15d Fix the lint target to use ${NSGMLSFLAGS}. 2004-07-07 13:30:49 +00:00
Hiroki Sato
a13b50e98b Unbreak the build.
Pointy hat to:	hrs
2004-07-07 11:23:16 +00:00
Hiroki Sato
84f8ee0a15 Use relative URLs when URL_RELPREFIX is defined and URLS_ABSOLUTE
is not defined.

- URL_RELPREFIX must always point the top page's URL
  (http://www.FreeBSD.org) in relative form, defined in Makefile.

- &url.base; can be used in doc/<langcode>/*.  It will be
  replaced with the real URL which points the top page.

For translators: Please make sure to define URL_RELPREFIX to
point the top page.  The localized docs have different directory
hierarchy in its URL from the English version.

Tested by:	den
2004-07-06 15:09:55 +00:00
Hiroki Sato
afc3a245b3 Use URLS_ABSOLUTE=yes for non-html formats and during
"make package".

Suggested by:	den
2004-05-12 12:58:12 +00:00
Hiroki Sato
413af34cb6 Reimplement absolute/relative URL knob. Urls.ent now statically
includes the both of relative and absolute URLs, and when
the URLS_ABSOLUTE make variable is defined, absolute URLs in
share/sgml/urls.ent are used.
2004-05-11 10:59:48 +00:00
Hiroki Sato
5350ccb9b2 Unbreak the build. The current URLS_ENT cannot support .OBJDIR
when .CURDIR is not under DOC_PREFIX.  This is a band-aid measure
but I will fix this soon.

Pointy hat to:	hrs
2004-05-11 10:35:19 +00:00
Denis Peplin
d25767864b Move
SRCS+= ${URLS_ENT}
from English Handbook Makefile to doc.common.mk

Reviewed by:	hrs
2004-05-11 05:52:39 +00:00
Denis Peplin
2b0f6c0e65 Use &url.main; entity in place of ../../../..
Replace &url.main; -> http://www.FreeBSD.org
when URLS_ABSOLUTE is set (for release building),
and -> ../../../.. by default (for mirror sites).

Patch was slightly modified by:	hrs
Discussed with:	des, ceri, hrs, trhodes, simon
2004-05-05 12:52:48 +00:00
Simon L. B. Nielsen
c0dc63ac06 Really unbreak creation of PDF documents which use "shared" PNG images:
The previous fix only worked in some cases, so back it out and add a
more clean fix.  This fix also makes "make clean" work as expected again
for the shared PNG images.

The real problem is the assumption in doc.images.mk that the
${IMAGES_PDF} variable only need to contain images converted to PDF
format and not images which are already in PNG format.  We need to list
the PNG images in ${IMAGES_PDF} since they might be in a shared image
directory, and if we don't list them in ${IMAGES_PDF} they will not be
copied to the working directory and will therefor not be found during
build.

Prompted by:	phantom
2004-04-05 22:53:43 +00:00
Simon L. B. Nielsen
c187df3fbf Unbreak creation of PDF documents which use PNG images (e.g.
articles/console-server), by also copying PNG images to the working
directory during PDF build.
2004-03-24 22:57:56 +00:00
Alexey Zelkin
a4ef4bf328 We never used .docb suffix in the project tree, so do not mention it
in comments.
2004-03-24 09:52:57 +00:00
Alexey Zelkin
713a6ebd26 Introduce BZIP2_PACKAGE user defined variable which used to control
output format of 'make package'.  If BZIP2_PACKAGE is set, then .tbz
archive will be generated instead of .tgz.
2004-03-24 09:50:03 +00:00
Alexey Zelkin
7f574a3bf2 Fix 'make package' to generate valid packages
After introduction of shared images concept it was not possible to realize
how images should be put into packages, so built images references were
used.  It result up tgz file with lots filename which contained of '..'.

In order to workaround this issue I used temporary directory to install
complete packaging document, then generate PLIST based on content of
temporary directory and create actual package then.

Prodded by:	The FreeBSD Russian Documentation Project
2004-03-24 09:45:31 +00:00
Alexey Zelkin
79d9b31fc9 Unconditionally set 'NO_SUBDIR' define.
doc.docbook.mk includes bsd.subdir.mk via bsd.obj.mk which is responsible
for processing of 'SUBDIR' make variable.  But since we are handling
'SUBDIR' here explicitly, doing same thing (second time!) via
bsd.subdir.mk's rules makes no sense and only adds disk IO overhead.

It reduces install recursive calls by factor 4.
2004-03-23 23:53:27 +00:00
Hiroki Sato
ed2b02d9be Use FOO_CMD instead of FOO to avoid a conflict with a variable used
in the docproj port.  TEX, LATEX, PDFTEX, JADETEX, and PDFJADETEX
has been renamed to TEX_CMD, LATEX_CMD, PDFTEX_CMD, JADETEX_CMD, and
PDFJADETEX_CMD for consistency.  And TEXCMDS has been renamed
TEX_CMDSEQ because TEXCMDS and TEX_CMD are misleading names.

Discussed on:	-doc
2004-02-16 14:13:24 +00:00
Hiroki Sato
6b2564e38e Install TRADEMARKS.html and LEGALNOTICE.html missing in HTML.manifest. 2004-02-08 12:34:16 +00:00
Hiroki Sato
1afd84c68b Add $JADETEX and $JADEPDFTEX. 2004-02-04 16:47:22 +00:00
Hiroki Sato
2e2010fbb7 Improve transtable.{xml,xsl}, including:
- The structure of transtable.xml is revised.  <word> should be
   bracketed with <group>.

 - A sorting order of the FreeBSD mirror sites rendered using
   mirrors.xml has been determined by sort(1).

 - A template "transtable-lookup" has been added for localization on
   word-by-word basis.

 - Replace English month names in news.xml, press.xml, and
   advisories.xml with numbers that correspond to the names.
   The number->name translation is performed on the fly.

 - Since information in mirrors.xml is used in www/ tree, it depends on
   doc/ tree now.  When WITHOUT_DOC is defined it can be built without
   doc/ tree, but some information becomes unavailable.  For example,
   a list of the mirror sites generated in index.html becomes a dummy
   one, and calling "transtable-lookup" with a word returns the word
   itself.

Neither www/ nor doc/ build should be broken due to this commit, but
until the necessary changes are applied in the localized directories,
the transtable does not work; it simply generates non-localized contents
even if transtable.xsl is used.
2004-01-12 21:27:01 +00:00
Hiroki Sato
2194b439bc Disable a guess of ${LANGCODE} from ${.CURDIR} when it is already defined.
Pointed out by:	ue
2004-01-06 23:57:46 +00:00
Hiroki Sato
354d1cc7e5 Fix problems when ghostscript with A4=yes is used. 2003-12-30 21:41:17 +00:00
Murray Stokely
1d5eac4d80 Add a 'GREYSCALE_IMAGES' option to the print infrastructure to convert
screenshots to greyscale before embedding them in the PostScript
output.

Sponsored by:	FreeBSD Mall, Inc.
2003-12-08 02:37:02 +00:00
Hiroki Sato
944a63f930 - Fix ${LANGCODE} problem when the working directory's absolute pathname
includes "doc" and "www" simultaneously.

Spotted by:	ceri

- Use www/share/sgml/advisories.xml instead of
  www/en/security/advisories.xml.
2003-11-26 01:47:00 +00:00
Hiroki Sato
05c16e954c Trim useless commands. 2003-11-24 19:59:11 +00:00
Hiroki Sato
252ac09ed2 Add a workaround to unbreak the build when ghostscript built
with A4=yes is used.

Discussed on:	-doc
2003-11-24 18:34:01 +00:00
Hiroki Sato
20bedcfcf2 Add refinements on mirrors.xml:
- add doc.common.mk, which defines variables, targets, and
   dependencies commonly used in www/ and doc/.

 - move www/<lang>/includes.xsl to the language independent
   directory and split into several files.

 - add transtable*.xsl and transtable.xml to support localized
   mirror names.

 - make doc/{en_US.ISO8859-1,ja_JP.eucJP}/books/handbook/ use
   mirrors.xml (mirrors and eresources).

 - make www/{en,ja}/index.xsl use mirrors.xml.

For details, please see doc/share/sgml/README.mirrors for the moment.

Reviewed by:	simon and Alex Dupre <sysadmin@alexdupre.com>
2003-11-24 18:26:35 +00:00
Hiroki Sato
8aeea9b2b6 Move lists of FreeBSD mirror sites to doc/share/sgml/mirrors.xml
(currently en_US.ISO8859-1/books/handbook/mirrors and
www/en/index.xsl use it).

Reviewed by:	simon
Discussed on:	-doc
2003-11-16 18:56:24 +00:00
Ceri Davies
636e72e5a6 Add LEGALNOTICE.html and TRADEMARKS.html to CLEANFILES when appropriate. 2003-10-02 19:46:49 +00:00
Simon L. B. Nielsen
4c6ebf3b41 Change the default Tidy options so it doesn't indent, and so it wraps
the lines at column 90, instead of the default 68.  This makes the
resulting HTML considerably smaller.

The change also band-aid a problem where Tidy wrap lines which shouldn't
have been wrapped.  This can cause extra spaces in the resulting HTML,
e.g. resulting in "( audio/lame)" instead of "(audio/lame)".

Discussed on:	-doc
2003-09-18 21:39:37 +00:00
Simon L. B. Nielsen
16d9a01672 Add support for optionally showing all trademark symbols, not just the
required symbols, by setting the make variable
WITH_ALL_TRADEMARK_SYMBOLS, to any non empty value.

This feature is mainly useful for document writers, to make sure all
trademarks are marked up correctly.
2003-09-14 13:11:43 +00:00
Marc Fonvieille
21aca1de1c Add more warnings to make lint. It should be possible now to find
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.
2003-08-27 07:10:36 +00:00
Marc Fonvieille
f8cfbd21b0 Remove -p option from ${MKDIR} definition to avoid redundancy (options
should be specified out from the variable definition).

PR:		docs/54422
Submitted by:	Lukas Ertl <l.ertl@univie.ac.at>
2003-08-01 20:28:55 +00:00
Marc Fonvieille
efd8e60b6d Quick fix to produce correct html.tar and html.split.tar tarballs
PR:	docs/52419
2003-07-05 10:09:50 +00:00