The commercial processors are assumed to provide their own documentation and support, so installation instructions for commercial processors are not provided in this book. For a long time, version 0. Now the refactored version has been released, with the first stable version 0. It is highly recommended that you not use version 0.
|Published (Last):||8 August 2014|
|PDF File Size:||12.71 Mb|
|ePub File Size:||6.52 Mb|
|Price:||Free* [*Free Regsitration Required]|
The commercial processors are assumed to provide their own documentation and support, so installation instructions for commercial processors are not provided in this book. For a long time, version 0. Now the refactored version has been released, with the first stable version 0. It is highly recommended that you not use version 0. FOP is also a Java program, so it is easy to install, especially if you already are using Java programs such as Saxon or Xalan.
You probably want the binary version rather than the source version. The distribution comes as a compressed zip file with everything you need. That site will also provide you with detailed instructions for getting started with FOP. FOP is distributed as a zip file, which can be opened on almost all systems. Linux users can also download a gzipped tar file.
Although most people will run FOP using its included convenience scripts, it is useful to know where the files are.
The lib directory has other. The version numbers shown here may differ from the ones in your distribution. A software framework that allows software components to work together. It is used internally by FOP. Provides the support library for SVG graphics. You will most likely want to process bitmap graphics in your document. FOP has built-in support for some graphics formats, but some popular formats such as PNG are not supported natively. If you are processing languages other than English, then you need to download an additional file named fop-hyph.
Copy it to the lib subdirectory of the FOP installation. FOP will convert a. Use the stylesheet parameter fop1. The old fop. That message comes from a template named root. You can change what the message says in a customization layer , or you could define it as an empty template there to turn off the message entirely.
Which script you use depends on the operating system: fop is a shell scripts for Linux or Unix, or fop. The following are some examples of using the scripts:. All of the arguments to the command are in the form of options, and they can be presented in any order. One option you will not find is the ability to set DocBook stylesheet parameters on the command line when you use the -xsl option that processes the stylesheet.
The following example assumes the FOP. Replace any version strings in the example below with the actual version numbers on the files in your FOP distribution. Depending on the memory configuration of your machine, your FOP process may fail on large documents with a java. It may be that your system is not allocating enough memory to the Java Virtual Machine. You can increase the memory allocation by adding a -Xmx option to any Java command. You can make the change permanent by adding it in the FOP convenience script, such as fop.
In this example, the memory allocation is MB. The value you use should be less than the installed memory on the system, and should leave enough memory for other processes that may be running. Most of them are commercial products, but they are in serious competition on price and features, which benefits the user community.
They also differ in the features they offer. Here is a quick description of some of the features:. Some products provide a command line interface or convenience script. These are useful for automated batch processing of many documents, so you do not have to open them one at a time in a graphical interface. Some provide extension elements and processing instructions to enable features that are not covered in the XSL-FO 1.
Because these products are undergoing rapid development, and because they provide their own documentation and support, this book will not provide general instructions on how to use them. But the DocBook XSL stylesheets include support for some of the extensions provided by a few of the processors, and those will be described in this book. When the extensions for one of these processors is turned on, extra code is written by the stylesheet into the XSL-FO file.
That extra code is understood only by a specific processor, so this feature is controlled by stylesheet parameters. If you are using XEP, then set the xep. If you are using Antenna House's product, then set the axf. If you are using the Arbortext processor, then set the arbortext. You should never turn on the extensions for a processor you are not using, or you will likely get a lot of error messages from the XSL-FO processor that does not understand the extra code.
Not all extension functions in each product are used by the DocBook stylesheets. If you find in their documentation an extension you want to use, you can write a customization layer that implements an extension. PDF bookmarks. In XEP, the extension element is rx:bookmark.
In Antenna House, an extension attribute named axf:outline-level is used. In Arbortext, the element is fo:bookmark , which is part of the XSL 1. PDF document information. When you view a PDF file's document properties in the reader, it may show title, author, subject, and keywords information. In XEP, the extension element is rx:meta-info. In Antenna House, the extension element is axf:document-info.
Index cleanup. The cleanup process entails removing duplicate page numbers on an entry, and converting a sequence of consecutive numbers to a page range. This produces a more usable index.
In XEP, the extension element is rx:page-index. In Antenna House, the extension is an attribute named axf:suppress-duplicate-page-number. Getting the tools working. Note For a long time, version 0. Installing FOP. Unpack the archive FOP is distributed as a zip file, which can be opened on almost all systems.
Locate the FOP. Using FOP. Note Use the stylesheet parameter fop1. Fop convenience scripts. FOP Java command. FOP java. Processor extensions. PDF version available.
Getting started with Docbook
Contents Purpose What is DocBook? What are the Advantages of DocBook? Purpose The purpose of this page is to give an overview of the DocBook format. It offers an explanation of the advantages of this format, links further reading on this subject and contains a short tutorial. What is DocBook? DocBook is an XML based standard, which is used in many of today's documentation tasks. When you want to create a DocBook document source, you write XML files which describe the document layout, paragraph division and other attributes.
Subscribe to RSS
Creating user manuals for the software you are building is an important task. Sometimes it is a project requirement but more often than that it is just more efficient having a document to which you can refer users to and stop waisting you precious time explaining the fundamentals of content management systems to novice users instead of actually doing what you are payed for. Since I do not like to repeat myself I wanted a system that is capable of generating documentation in variety of formats, PDF being the most important one. DocBook is the first thing that came to mind, but as it is usually the case the things are not so simple as they should be. After playing fore the most part of the day with DocBook and various utilities I decided to write it down for future reference.
From DocBook to PDF using Apache FOP
Jump to navigation. Computers were first invented to do math, and they do it really well. But it didn't take long for users to repurpose their futuristic calculators into fancy, dynamic typewriters. Now human-readable text drives computing, so it's important to choose the right format for the text you write. DocBook is an XML schema. In fact, it's safe to say that if you own a computer or mobile device, there's XML on it. DocBook itself is easy to learn and easy to write, and it's also one of the most flexible formats available.
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together. If nothing happens, download GitHub Desktop and try again. Go back. If nothing happens, download Xcode and try again.