Parent Directory
| 
Revision Log
| Links to HEAD: | (view) (download) (annotate) |
| Sticky Revision: |
Remove PS format. PS files are broken: fop is unable to embed fonts. PS is, nowadays, replaced with PDF. If PS is still needed, pdf2ps(1) can be simply used on PDF files. Approved by: doceng
pdb format isn't supported since a while. Let's remove its remains.
Update maxdepth from 6000 to 12000 [1]. This should fix the doc related ports build on FreeBSD 11.X. PR: 225287 Submitted by: Keren Sky <keren_sky@live.com> Obtained from: Kenji Rikitake <kenji@k2r.org> [1]
refactor translation to a new make file "doc.translate.mk" PR: 222939
switch to HTTPS PR: 222676
Fix `make -n' and `make -j1' PR: 222186
Remove the temporary assembled document after generating a PO file to make sure it does not hide changes in the English parent from translators. Sponsored by: iXsystems
Trim obsolete translations from PO files. These are translations for text which does not exist in the original English document any more.
Use Subversion metadata for version information rather than grepping for $FreeBSD$ version strings.
Improve latest revision detection based on mat's work. This clarifies the code, reduces dependencies, and removes a lot of quotes by using --stringparam. Differential Revision: https://reviews.freebsd.org/D6902
Fix using LATESTREVISION when not using svn (or svn is broken) Kinda ok'ed by: wblock Sponsored by: Absolight
Replace revision and publication date in generated documentation with the actual date of last update. This fixes the problems with misleading "last update" dates that only reflect the change in a single rarely-changed file. Note that hrs had reservations about doing this in the Makefile rather than with a stylesheet. However, not all our source files are XML. For now, this change works, and can be replaced by a more elegant solution later. We should also consider checking dates on other files that affect the content or appearance of documents, like images. Submitted by: grembo
Generate the correct paths to images in epub documents.
Stop putting PDF contents in .ps and .rtf files.
Run 'make SRCS' in the English document directory. Some SRCS files are generated, like the list of mirrors used in the Handbook, and this will make certain they exist when the PO extraction process needs them.
Put a plain $FreeBSD$ in the generated PO, rather than an ID string that has been expanded by Subversion. Thanks to bjk!
Improve the formatting of dblatex-produced PDF documents.
Remove extraneous whitespace.
Use the English catalog files to avoid problems with pre-translated entities. Tested by rene@ and RayCherng Yu <raycherng@gmail.com>. Well, and me, obviously. Reviewed by: rene
Make the normalized translation file depend on all the SRCS of the English original document. Reviewed by: rene
Use the en_US xmllint catalog variables so translated entities do not make their way into PO translations. Reviewed by: rene
Remove a duplicated {PO_LANG}.mo from CLEANFILES.
Modify the PO_SET script to add a #$FreeBSD$ line to new PO files.
Add PO translation support. Reviewed by: hrs (earlier version), blackend Approved by: doceng (implicit) Differential Revision: https://reviews.freebsd.org/D2947
Set FOP_OPTS, the variable passed by the fop shell script to the Java interpreter, to use the same minimum values for stack and heap space on all architectures. The built-in i386 defaults are smaller than those on amd64, so i386 fop PDF builds ran out of space and failed. Working values were copied from the amd64 defaults. Reviewed by: gabor, blackend, hrs Approved by: hrs
- Move the PGP keyring generation to the language-independent share directory Discussed with: hrs, wblock
- Enable docformatnav only when $docformatnav is set to 1.
- Set $docformatnav to 1 when $FORMATS contains "html" and "html-split" at the
same time.
- Fix localization of docformatnav using &docnavi.{split,single};.
- Do not create <a> element which points to the document itself.
- Remove share/xml/l10n.ent.
- Fix URI of freebsd-fo-cjk.xsl.
- Use /usr/bin/svnlite as SVN if available.
- Replace /XML/{doc,www}/ with /XML/ in SysId.
- Remove empty stylesheets in share/xsl and point share/xml/empty.xsl via
XML catalog instead.
- Change the L10N layer in freebsd-*.xsl not to use localized XSLT
stylesheets directly.
- Move share/xsl/* to share/xml and remove share/xsl.
- Remove obsolete share/web2c/pdftex.def.
Simplify localization layer for XSLT stylesheets. lang/share/xsl/*.xsl are now picked up via share/xsl/*.xsl and they are empty when there is no localized content in it. This prevents inconsistency between share/xsl/*.xsl and the localized ones.
Use XML catalog resolution wherever possible instead of absolute pathnames for external entities.
- Fix build of release notes Approved by: doceng (self)
Merge back improvements from the db5 branch: - Convert to DocBook 5.0 - Use XSL-FO and FOP for PDF rendering instead of DSSSL and Jade - Drop SGML catalogs since the tree is purely XML now - Drop DSSSL stylesheets - Drop other legacy constructs - Add support for Schematron validation - Add Schematron constraints - Add support for RELAX NG validation - Add experimental support for dblatex Sponsored by: The FreeBSD Foundation Approved by: doceng (self)
Fix install-html-split target: With the current code running "make install" will build the files but will install only 2 files (docbook.css and tramemark.html). Another "make install" is required to get the missing files. This is not the expected behavior. A quick workaround is to run "make && make install", but let's fix the code to get a working "make install". Discussed with: gabor
- Port PGP keyring generation to XSLT
Merge the XML toolchain upgrade, which contains the following changes: - Upgrade to DocBook 4.5 - Use XSLT instead of DSSSL to render XHTML-based output - Generate PDF from PS and simplify image processing - Fix make lint and validate the whole documentation set - Fix rendering of TOC elements - Fix misused link elements that resulted in a corrupt rendering - Use more human-friendly publication data and release info rendering - Add support for XInclude in DocBook documents - Add support for profiling with attributes [1] - Add support for Schematron constraints - Add experimental epub support - Add experimental support for XSL-FO-based printed output - Clean up obsolete SGML constructs - Clean up catalogs - Drop HTML Tidy since it is not needed any more [1] http://www.sagehill.net/docbookxsl/Profiling.html The dependencies of the build will change as follows: - textproc/opensp - www/tidy-lib - textproc/html - textproc/linuxdoc - textproc/docbook-410 - textproc/docbook-xml + textproc/docbook-xml-450 + textproc/iso-schematron-xslt Approved by: doceng (implicit)
Replace 'SGML' with 'XML' in Makefile code and comments. A consequence of this was that 'SGMLFLAGS' had to be changed to 'XMLFLAGS' in share/mk/doc.docbook.mk so that everything continued to build OK. Approved by: gabor (mentor)
- Rename the share/sgml directories to share/xml - Fix build errors from the next change Approved by: doceng (implicit)
- Rename .sgml files to .xml - Reflect the rename in referencing files Approved by: doceng (implicit)
- The trademarks.html file is now generated with a lower-case filename, reflact that Submitted by: ebrandi (via private mail)
Suppress HTML Tidy's version string output.
Merge the projects/sgml2xml branch:
- Documentation is updated from DocBook 4.1/SGML to DocBook 4.2/XML
- Webpages are updated from HTML 4.01 Transitional to XHTML 1.0 Transitional
- Static webpages are now processed by XSLT behind the scenes
- Webpages are now built with less cycles; tidy has been removed and the
date processing is now done by XSLT
- Generated webpages are now actually valid (they did not use to be)
- All XSLT stylesheets now pull in a main XSLT, which reduces
duplicated markup
- Site map and index are converted to an XML format with an
XSLT transformation that generates the output
- For docs, there is now only one entity set for both articles and books
- Some trademark/legalnotice entities have been merged to a cohesive
single entity file
- Untranslated entity sets are now always pulled in from the English tree
instead of redundant copies
- The base and enbase entities are already automatically generated so
remove inline definitions from individual files
- Fetch the LEGAL file via http instead of depending on CVS
- Convert id names to lowercase to avoid mixing different styles and
for better readability
- All PSGML comments are removed since they are mostly useless
- Convert character entities to normal characters
- Do not copy CSS files but override only necessary part
- Fix build with newest tidy
- Partly update the fdp-primer to reflect changes
Approved by: doceng (implicit)
- Set svn:ketwords and svn:mime-type. Note that application/octet-stream is set on some files as a workaround for binary check. - Fix pathname for svn co in the webupdate script. Approved by: doceng (implicit)
- Fix ($user-html-header$) to support <script src="foo">. While the rendered result of <script> end tag by the DSSSL stylesheet was </script\n> to avoid unnecessary spaces after the tag, most of the www browsers and HTML processors cannot recognize it as the end of <script>. To workaround this, ($user-html-headers$) now outputs the start and the end tag independently in each single line. - Add %html-header-script% to control if <script> is included in <head>. - Add html.header.script.google knob for SGML and XML documents in non-DocBook DTD. %html.header.script.google; and $html.header.script.google. - Add WWWFREEBSDORG make(1) knob to control the <script> inclusion. Note that <script> is disabled temporarily. Discussed with: gjb and core Tested by: gjb
Add a workaround to prevent Tidy from converting tabs to spaces by converting them to 	 before Tidy gets them. Then Tidy converts them back to real tabs, not spaces. Reviewed by: hrs, gjb
Typo and spelling fixes.
Make Traditional Chinese PDF/PostScript of FreeBSD Documents PR: docs/99260 Submitted by: Intron <intron@intron.at.ac>
Since we can now generate txt files with html2text, remove zh_CN.GB2312 from the NO_PLAINTEXT_LANG list. Spotted by: intron at intron dot ac
- Move build targets for book.{ps,pdf} of the handbook to the LI part.
- Add NO_{TEX,PLAINTEXT,RTF} and NO_{TEX,PLAINTEXT,RTF}_LANG knobs not to
build or install broken files[*].
Suggested by: alex.istra at rambler dot ru[*]
Add JADETEX_PREPROCESS and PDFTEX_PREPROCESS for pre-processing TeX file.
Apply RTF fixups which improves our .rtf generation: - Tell the location where Jade/OpenJade will look for the PNG images. - Use rtf-nopng as extension name for Jade/OpenJade generated RTF files. - Use fixrtf(1) from textproc/fixrtf to make necessary fixups on generated RTFs, embedding PNGs into the intermediate RTF and save them into the new *.rtf files. - Retire rtf.tar target which is no longer necessary. Please note that you have to upgrade the docproj toolset or this commit would break the build. PR: docs/93965 Submitted by: intron <intron intron ac> Approved by: doceng
Improve the docbook build infrastructure's index.sgml build process:
- Consider index.sgml as intermediate file, not dependency that ${DOC}.*
require. Instead, generate it on-the-fly when building ${DOC}.*.
This solves the problem that index.sgml is generated for the first
built target, but needs to be different from target to target.
The affected targets are:
index.html HTML.manifest
${DOC}.html
${DOC}.html-text
${DOC}.rtf
${DOC}.tex
${DOC}.tex-pdf
${INDEX_SGML} target removed in favor of the on-the-fly build.
- When building ${DOC}.rtf, add ${PRINT_INDEX} and ${LOCAL_IMAGES_PNG}
as dependencies, eliminating the need of building ${DOC}.rtf without
having to build ${DOC}.html beforehand.
- Modifications against ${HTML_INDEX} and ${HTML_SPLIT_INDEX}:
+ Add dependency to ${SRCS} and ${LOCAL_IMAGES_TXT} to force
index updates when necessary.
+ Every build now causes index.sgml to be reinitialized.
+ Depend on ${DOC}.* to generate index.sgml.
Submitted by: "intron" <intron at intron ac>
PR: docs/90255 (slightly changed version)
Merge some improvements of build infrastructure from the Simplified Chinese
project:
- For "dvi" and "ps", add "${DOC}.out" to CLEANFILES
- Allow overriding of the following targets:
${DOC}.txt, ${DOC}.dvi, ${DOC}.pdf, ${PRINT_INDEX}
Submitted by: "intron" <intron intron ac>
PR: docs/90171
Disable .ps and .pdf build of some languages---ja_JP.eucJP, ru_RU.KOI8-R, and zh_TW.Big5---because they are broken. This behavior can be controlled by using $NO_TEX_LANG. This is a temporary measure, and we need to use localized TeX variants to build the printable formats. Tested by: simon
- Rework jade/openjade handling. Before: use jade on i386, openjade on !386, provide OPENJADE var for override Now: detect what's available, when both systems are present, use jade, provide OPENJADE var for override This change follows same logic as recent similar change in web.mk Approved by: keramida (mentor)
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>
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.
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/.
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.
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 :)
Backout last change. It was already included in doc.common.mk. Found by: hrs
Always use absolute URLs for print output.
Honor DVIPSFLAGS even if PAPERSIZE is not defined.
- 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
Parse ISO* encodings, convert it to ISO-* before SP_ENCODINGS assignment Add ISO-8859-2 to SP_ENCODING_LIST
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
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.
Fix the lint target to use ${NSGMLSFLAGS}.
Use URLS_ABSOLUTE=yes for non-html formats and during "make package". Suggested by: den
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
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.
We never used .docb suffix in the project tree, so do not mention it in comments.
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.
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
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.
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
Install TRADEMARKS.html and LEGALNOTICE.html missing in HTML.manifest.
Add $JADETEX and $JADEPDFTEX.
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.
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
Add LEGALNOTICE.html and TRADEMARKS.html to CLEANFILES when appropriate.
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
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.
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.
Quick fix to produce correct html.tar and html.split.tar tarballs PR: docs/52419
Add ${PREFIX}/share/sgml/catalog.ports into ${CATALOGS} explicitly.
Collect catalogs only if avaiable.
In xmlcatmgr world, only ${PREFIX}/share/{sgml,xml}/catalog is
required from under ${PREFIX}.
Quiet a few make warnings by adding a few .if statements. 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
Slightly beef up the spellcheck target so that it works for the html-split and txt formats as well as the html format. Reviewed by: murray
Add a simple script to locate areas of a DocBook file where <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.
Add an ispell-based "spellcheck" target to the doc build infrastructure. Sponsored by: FreeBSD Mall, Inc.
Back out WITH_DOCFORMAT_NAVI_LINK?=YES in Makefile. The navi-link
is generated when ${WITH_DOCFORMAT_NAVI_LINK} is defined or
${FORMATS} includes "html" and "html-split."
- Add WITH_DOCFORMAT_NAVI_LINK to mk/doc.docbook.mk and 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$.
Commit images separation from en_US.ISO8859-1/ directory to 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
Now that the docproj port is updated accordingly, use version 4.2 of the docbook-xml DTD when building with the xsl stylesheet.
Clean up properly when STYLESHEET_TYPE is set to "xsl". Reviewed by: trhodes
Add the following knobs for the DocBook DSSSL stylesheets:
- 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.
Add ${DOC}.ps in pdf target CLEANFILES, this is needed to correctly clean
the Handbook build in pdf format.
Add ${DOC}.tex to CLEANFILES list of ps and pdf formats.
Create XHTML documents in place of HTML4 documents with a small alteration to the *.mk files.
Add some ${LOCAL_IMAGES_TXT} where needed to allow the build of various
formats: rtf and pdf.
Problem found by: ceri
s/seperate/separate/
This form allows you to request diffs between any two revisions of this file. For each of the two "sides" of the diff, enter a numeric revision.
| ViewVC Help | |
| Powered by ViewVC 1.1.27 |