You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!DOCTYPE html><htmlxmlns="http://www.w3.org/1999/xhtml" class="no-js"><head><metahttp-equiv="Content-Type" content="text/html; charset=utf-8"/><script>(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement)</script><title>Chapter 1. Overview</title><linkhref="./css/pygments.css" rel="stylesheet"/><metaname="viewport" content="width=device-width, initial-scale=1.0"/><linkhref="https://purl.org/dc/elements/1.1/" rel="schema.dc"/><metaname="dc.modified" content="2024-10-21T05:32:50Z"/><metaname="dc.created" content="2024-10-21T05:32:50Z"/><metaname="generator" content="DocBook xslTNG version 2.3.0-SNAPSHOT / 275bab4e / SAXON HE 12.5"/><linkhref="./css/guide-toc.css" rel="stylesheet"/><linkhref="./css/docbook.css" rel="stylesheet" media="screen"/><metaname="viewport" content="width=device-width, initial-scale=1.0"/><linkhref="css/guide.css" rel="stylesheet"/><linkhref="css/guide-online.css" rel="stylesheet"/><linkhref="media/xsltng-icon.png" rel="shortcut icon"/><scriptsrc="https://kit.fontawesome.com/c94d537c36.js" type="text/javascript" crossorigin="anonymous"></script><linkrel="prev" href="ch-preface.html"/><linkrel="next" href="ch-using.html"/><linkrel="up" href="parti.html"/><linkrel="home" href="index.html"/><scriptsrc="./js/xlink.js" defer="defer"></script><scriptsrc="./js/persistent-toc.js" defer="defer"></script><scriptsrc="./js/pagetoc.js" data-dynamic-pagetoc="true" defer="defer"></script><scriptsrc="./js/chunk-nav.js" defer="defer"></script></head><bodyclass="chapter component"><navclass="top"><spanclass="nav"><atitle="DocBook xslTNG Reference" href="index.html"><iclass="fas fa-home"></i></a><ahref="ch-preface.html" title="Preface"><iclass="fas fa-arrow-left"></i></a><atitle="Part I . Introduction" href="parti.html"><iclass="fas fa-arrow-up"></i></a><atitle="Chapter 2 . Using the stylesheets" href="ch-using.html"><iclass="fas fa-arrow-right"></i></a></span><spanclass="title"><iclass="title">DocBook xslTNG Reference</i></span><spanclass="logo"><imgsrc="media/xsltng-inverted.png"/></span></nav><divclass="pagebody"><main><sectionid="whatfor" db-chunk="ch-overview.html" db-id="d150e82" class="chapter component"><header><h1>Chapter <spanclass="label">1</span><spanclass="sep">. </span>Overview</h1></header><divclass="db-bfs"><p>Before we get started, let’s look at what the stylesheets do and
2
+
where you can get them!</p></div><sectionid="whatdo" class="section"><header><h2><spanclass="label">1<spanclass="sep">.</span>1</span><spanclass="sep">. </span>What do the stylesheets do?</h2></header><p>The <citeclass="citetitle">DocBook xslTNG</cite> stylesheets transform
3
+
DocBook V5.x into HTML. The intent is that they support all of DocBook
4
+
V5.2, including the DocBook Publishers elements. (The
5
+
<ahref="https://xsltng.docbook.org/report/" class="link">test suite report</a>
6
+
gives a precise summary of the current state of coverage.) They will also
7
+
process DocBook V4.x documents by first converting them (tranforming
8
+
source elements that have changed, adding the namespace, etc.) into
9
+
5.x documents.</p><p>Some parts of DocBook, especially the modeling parts, are very
10
+
open-ended. One could, in principle, write a function synopsis for any
11
+
programming language. The stylesheets are naturally going to support
12
+
only a subset of languages out of the box. Every attempt has been made
13
+
to make customizations easy where it’s anticipated that they may be
14
+
necessary.</p><p>The stylesheets can also be used to produce paged media such as
15
+
PDF files. This works by having a slightly different HTML
16
+
transformation initially, and then by further transforming the HTML so
17
+
that it can be formatted with an appropriate CSS formatter to produce
18
+
paged output. This is similar, but not the same as producing XSL
19
+
Formatting Objects and then transforming those.</p><p>Producing other output formats, EPUB files, for example, is
20
+
planned for the future but no specific schedule is promised. There are no
21
+
plans at the moment to produce XSL FO stylesheets.</p></section><sectionid="getting" class="section"><header><h2><spanclass="label">1<spanclass="sep">.</span>2</span><spanclass="sep">. </span>Getting the stylesheets</h2></header><p>There are three ways to get the stylesheets: you can
22
+
<ahref="#get-github" class="link">download the latest release</a> from
23
+
GitHub, you can <ahref="#get-maven" class="link">get them from Maven</a>,
and <ahref="ch-building.html" class="link">build them yourself</a>. We’ll cover
27
+
the first two options in this chapter; <ahref="ch-building.html" class="xref xref-chapter">Chapter <spanclass="label">6</span>, Building the stylesheets</a> covers
28
+
the last option in detail.</p><sectionid="get-github" class="section"><header><h3><spanclass="label">1<spanclass="sep">.</span>2<spanclass="sep">.</span>1</span><spanclass="sep">. </span>Download the latest release</h3></header><p>The latest release is always available from the
releases page</a>. At the time of publication, the latest release was
31
+
version 2.3.0-SNAPSHOT.</p><p>Distributed this way, you’ll get a ZIP file that contains the stylesheets
32
+
plus a number of ancillary files and tools. These are mostly covered in
33
+
the next chapter <ahref="ch-using.html" class="xref xref-chapter">Chapter <spanclass="label">2</span>, Using the stylesheets</a>.</p><p>You can unzip the file anywhere that’s convenient: in your home
34
+
directory or in a system-wide location.</p></section><sectionid="get-maven" class="section"><header><h3><spanclass="label">1<spanclass="sep">.</span>2<spanclass="sep">.</span>2</span><spanclass="sep">. </span>Getting the release from Maven</h3></header><p>The latest release is always available
</p><p>The group, artifact, and version ID for the latest release at
38
+
the time of publication is:</p><pclass="center"><code>org.docbook:docbook-xslTNG:2.3.0-SNAPSHOT</code></p><p>If you’re comfortable using Maven, I’m going to assume that’s all you
39
+
need to know.</p><p>The Maven distribution differs from the zip file in a couple of ways:</p><olclass="orderedlist" type="1"><li><p>It doesn’t bundle any of the dependencies. The
40
+
<ahref="#get-github" class="link">ZIP file</a> is more akin
“uber” or “fat” jar</a>; it includes (some of) the core dependencies so
44
+
that it works out-of-the-box. Maven is designed to resolve dependencies,
45
+
so that shouldn’t be necessary here.</p></li><li><p>The Maven jar doesn’t include the Python script or the extra resources
46
+
(CSS and JavaScript files) because it doesn’t seem like it would be convenient
47
+
to extract them from the Maven jar (which will probably be installed deep in
48
+
some repository hierarchy well out of sight). Consequently, you may want to
49
+
<ahref="#get-github" class="link">download the distribution</a> periodically as well.
50
+
</p></li></ol></section></section></section><footer><divclass="footnotes"><hr/><divclass="footnote" id="get-maven_para1_footnote1-fnote"><divclass="footnote-number"><supclass="footnote-number"><ahref="#get-maven_para1_footnote1-fref">*</a></sup></div><divclass="footnote-body"><p>With the caveat that it sometimes takes a few
51
+
hours for the releases to make their way from the registry onto the website.
52
+
If you’re chasing the very latest release and it’s just been published, it
0 commit comments