Skip to content

Commit

Permalink
Deploying to gh-pages from @ 71de04f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ndw committed Nov 10, 2024
1 parent bc6f6b1 commit a9789a6
Show file tree
Hide file tree
Showing 954 changed files with 81,004 additions and 21,483 deletions.
Binary file added epub/DocBook-xslTNG-2.5.0.epub
Binary file not shown.
1,624 changes: 774 additions & 850 deletions explorer/index.html

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions guide/2.4.1/index.html

This file was deleted.

15 changes: 15 additions & 0 deletions guide/2.5.0/ackno.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" class="no-js"><head><meta http-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>Acknowledgements</title><link href="./css/pygments.css" rel="stylesheet"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link href="https://purl.org/dc/elements/1.1/" rel="schema.dc"/><meta name="dc.modified" content="2024-11-10T17:45:24Z"/><meta name="dc.created" content="2024-11-10T17:45:24Z"/><meta name="generator" content="DocBook xslTNG version 2.5.0-SNAPSHOT / 71de04fc / SAXON HE 12.5"/><link href="./css/guide-toc.css" rel="stylesheet"/><link href="./css/docbook.css" rel="stylesheet" media="screen"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link href="css/guide.css" rel="stylesheet"/><link href="css/guide-online.css" rel="stylesheet"/><link href="media/xsltng-icon.png" rel="shortcut icon"/><script src="https://kit.fontawesome.com/c94d537c36.js" type="text/javascript" crossorigin="anonymous"></script><link rel="prev" href="references.html"/><link rel="next" href="gindex.html"/><link rel="up" href="parti.html"/><link rel="home" href="index.html"/><script src="./js/xlink.js" defer="defer"></script><script src="./js/persistent-toc.js" defer="defer"></script><script src="./js/chunk-nav.js" defer="defer"></script></head><body class="acknowledgements component"><nav class="top"><span class="nav"><a title="DocBook xslTNG Reference" href="index.html"><i class="fas fa-home"></i></a> <a href="references.html" title="References"><i class="fas fa-arrow-left"></i></a> <a title="Part  I .  Introduction" href="parti.html"><i class="fas fa-arrow-up"></i></a> <a title="Index" href="gindex.html"><i class="fas fa-arrow-right"></i></a></span><span class="title"><i class="title">DocBook xslTNG Reference</i></span><span class="logo"><img src="media/xsltng-inverted.png"/></span></nav><main><section id="acknowledgements" db-chunk="ackno.html" db-id="d151e6453" class="acknowledgements component"><header><h1>Acknowledgements</h1></header>


<p>I’d like to thank The Academy, the…no, wrong event.</p>

<p>DocBook has benefited immeasurably by the time and energy that
innumerable people have poured into it. I thank them all.</p>

<p>This project has benefited from the generous support of
Michael Kay and Saxonica for <cite class="citetitle">Saxon EE</cite> and
Micheal Miller and Antenna House for <cite class="citetitle">Antenna House Formatter</cite>.
</p>

<p>Bethan Tovey-Walsh designed the lovely xslTNG logo.</p>
</section></main><nav class="bottom"><div class="navrow"><div class="navleft"><a title="References" href="references.html"><i class="fas fa-arrow-left"></i></a></div><div class="navmiddle"><a title="" href="index.html"><i class="fas fa-home"></i></a></div><div class="navright"><a title="Index" href="gindex.html"><i class="fas fa-arrow-right"></i></a></div></div><div class="navrow"><div class="navleft navtitle">References</div><div class="navmiddle"><a title="Part  I .  Introduction" href="parti.html"><i class="fas fa-arrow-up"></i></a></div><div class="navright navtitle">Index</div></div><div class="infofooter"><span class="copyrightfooter"><a href="dbcpyright.html">Copyright</a> © 2020–2024 Norman Walsh.</span></div><nav class="tocopen"></nav><nav class="toc"></nav><!-- Hide ToC details from user agents that don’t support JS --><script type="text/html" class="tocopen"><i class="far fa-book"></i></script><script type="text/html" class="toc"><header><span>Table of Contents</span><span class="close"><i class="far fa-window-close"></i></span><p class="ptoc-search"><input class="ptoc-search" placeholder="Search" style="width: 80%"/></p></header><div db-persistent-toc="persistent-toc.html" db-prefix="">Loading…</div></script></nav></body></html>
144 changes: 144 additions & 0 deletions guide/2.5.0/ch-building.html

Large diffs are not rendered by default.

760 changes: 760 additions & 0 deletions guide/2.5.0/ch-customizing.html

Large diffs are not rendered by default.

256 changes: 256 additions & 0 deletions guide/2.5.0/ch-implementation.html

Large diffs are not rendered by default.

295 changes: 295 additions & 0 deletions guide/2.5.0/ch-localization.html

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions guide/2.5.0/ch-overview.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" class="no-js"><head><meta http-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><link href="./css/pygments.css" rel="stylesheet"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link href="https://purl.org/dc/elements/1.1/" rel="schema.dc"/><meta name="dc.modified" content="2024-11-10T17:45:24Z"/><meta name="dc.created" content="2024-11-10T17:45:24Z"/><meta name="generator" content="DocBook xslTNG version 2.5.0-SNAPSHOT / 71de04fc / SAXON HE 12.5"/><link href="./css/guide-toc.css" rel="stylesheet"/><link href="./css/docbook.css" rel="stylesheet" media="screen"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link href="css/guide.css" rel="stylesheet"/><link href="css/guide-online.css" rel="stylesheet"/><link href="media/xsltng-icon.png" rel="shortcut icon"/><script src="https://kit.fontawesome.com/c94d537c36.js" type="text/javascript" crossorigin="anonymous"></script><link rel="prev" href="ch-preface.html"/><link rel="next" href="ch-using.html"/><link rel="up" href="parti.html"/><link rel="home" href="index.html"/><script src="./js/xlink.js" defer="defer"></script><script src="./js/persistent-toc.js" defer="defer"></script><script src="./js/pagetoc.js" data-dynamic-pagetoc="true" defer="defer"></script><script src="./js/chunk-nav.js" defer="defer"></script></head><body class="chapter component"><nav class="top"><span class="nav"><a title="DocBook xslTNG Reference" href="index.html"><i class="fas fa-home"></i></a> <a href="ch-preface.html" title="Preface"><i class="fas fa-arrow-left"></i></a> <a title="Part  I .  Introduction" href="parti.html"><i class="fas fa-arrow-up"></i></a> <a title="Chapter  2 .  Using the stylesheets" href="ch-using.html"><i class="fas fa-arrow-right"></i></a></span><span class="title"><i class="title">DocBook xslTNG Reference</i></span><span class="logo"><img src="media/xsltng-inverted.png"/></span></nav><div class="pagebody"><main><section id="whatfor" db-chunk="ch-overview.html" db-id="d151e82" class="chapter component"><header><h1>Chapter <span class="label">1</span><span class="sep"></span>Overview</h1></header><div class="db-bfs"><p>Before we get started, let’s look at what the stylesheets do and
where you can get them!</p></div><section id="whatdo" class="section"><header><h2><span class="label">1<span class="sep">.</span>1</span><span class="sep"></span>What do the stylesheets do?</h2></header><p>The <cite class="citetitle">DocBook xslTNG</cite> stylesheets transform
DocBook V5.x into HTML. The intent is that they support all of DocBook
V5.2, including the DocBook Publishers elements. (The
<a href="https://xsltng.docbook.org/report/" class="link">test suite report</a>
gives a precise summary of the current state of coverage.) They will also
process DocBook V4.x documents by first converting them (tranforming
source elements that have changed, adding the namespace, etc.) into
5.x documents.</p><p>Some parts of DocBook, especially the modeling parts, are very
open-ended. One could, in principle, write a function synopsis for any
programming language. The stylesheets are naturally going to support
only a subset of languages out of the box. Every attempt has been made
to make customizations easy where it’s anticipated that they may be
necessary.</p><p>The stylesheets can also be used to produce paged media such as
PDF files. This works by having a slightly different HTML
transformation initially, and then by further transforming the HTML so
that it can be formatted with an appropriate CSS formatter to produce
paged output. This is similar, but not the same as producing XSL
Formatting Objects and then transforming those.</p><p>Producing other output formats, EPUB files, for example, is
planned for the future but no specific schedule is promised. There are no
plans at the moment to produce XSL FO stylesheets.</p></section><section id="getting" class="section"><header><h2><span class="label">1<span class="sep">.</span>2</span><span class="sep"></span>Getting the stylesheets</h2></header><p>There are three ways to get the stylesheets: you can
<a href="#get-github" class="link">download the latest release</a> from
GitHub, you can <a href="#get-maven" class="link">get them from Maven</a>,
or you can clone
<a href="https://github.com/docbook/xslTNG" class="link">the repository</a>
and <a href="ch-building.html" class="link">build them yourself</a>. We’ll cover
the first two options in this chapter; <a href="ch-building.html" class="xref xref-chapter">Chapter <span class="label">6</span>, Building the stylesheets</a> covers
the last option in detail.</p><section id="get-github" class="section"><header><h3><span class="label">1<span class="sep">.</span>2<span class="sep">.</span>1</span><span class="sep"></span>Download the latest release</h3></header><p>The latest release is always available from the
<a href="https://github.com/docbook/xslTNG/releases" class="link">GitHub
releases page</a>. At the time of publication, the latest release was
version 2.5.0-SNAPSHOT.</p><p>Distributed this way, you’ll get a ZIP file that contains the stylesheets
plus a number of ancillary files and tools. These are mostly covered in
the next chapter <a href="ch-using.html" class="xref xref-chapter">Chapter <span class="label">2</span>, Using the stylesheets</a>.</p><p>You can unzip the file anywhere that’s convenient: in your home
directory or in a system-wide location.</p></section><section id="get-maven" class="section"><header><h3><span class="label">1<span class="sep">.</span>2<span class="sep">.</span>2</span><span class="sep"></span>Getting the release from Maven</h3></header><p>The latest release is always available
<a href="https://search.maven.org/search?q=org.docbook.docbook-xslTNG" class="link">from
Maven</a><sup id="get-maven_para1_footnote1-fref" class="footnote-number"><a href="#get-maven_para1_footnote1-fnote">*</a></sup>.
</p><p>The group, artifact, and version ID for the latest release at
the time of publication is:</p><p class="center"><code>org.docbook:docbook-xslTNG:2.5.0-SNAPSHOT</code></p><p>If you’re comfortable using Maven, I’m going to assume that’s all you
need to know.</p><p>The Maven distribution differs from the zip file in a couple of ways:</p><ol class="orderedlist" type="1"><li><p>It doesn’t bundle any of the dependencies. The
<a href="#get-github" class="link">ZIP file</a> is more akin
to
<a href="https://stackoverflow.com/questions/11947037/what-is-an-uber-jar" class="link">an
“uber” or “fat” jar</a>; it includes (some of) the core dependencies so
that it works out-of-the-box. Maven is designed to resolve dependencies,
so that shouldn’t be necessary here.</p></li><li><p>The Maven jar doesn’t include the Python script or the extra resources
(CSS and JavaScript files) because it doesn’t seem like it would be convenient
to extract them from the Maven jar (which will probably be installed deep in
some repository hierarchy well out of sight). Consequently, you may want to
<a href="#get-github" class="link">download the distribution</a> periodically as well.
</p></li></ol></section></section></section><footer><div class="footnotes"><hr/><div class="footnote" id="get-maven_para1_footnote1-fnote"><div class="footnote-number"><sup class="footnote-number"><a href="#get-maven_para1_footnote1-fref">*</a></sup></div><div class="footnote-body"><p>With the caveat that it sometimes takes a few
hours for the releases to make their way from the registry onto the website.
If you’re chasing the very latest release and it’s just been published, it
may be available before it appears on the website.</p></div></div></div></footer></main><nav class="pagetoc"><div class="tocwrapper"></div></nav></div><nav class="bottom"><div class="navrow"><div class="navleft"><a title="Preface" href="ch-preface.html"><i class="fas fa-arrow-left"></i></a></div><div class="navmiddle"><a title="" href="index.html"><i class="fas fa-home"></i></a></div><div class="navright"><a title="Chapter  2 .  Using the stylesheets" href="ch-using.html"><i class="fas fa-arrow-right"></i></a></div></div><div class="navrow"><div class="navleft navtitle">Preface</div><div class="navmiddle"><a title="Part  I .  Introduction" href="parti.html"><i class="fas fa-arrow-up"></i></a></div><div class="navright navtitle">Chapter  2 .  Using the stylesheets</div></div><div class="infofooter"><span class="copyrightfooter"><a href="dbcpyright.html">Copyright</a> © 2020–2024 Norman Walsh.</span></div><nav class="tocopen"></nav><nav class="toc"></nav><!-- Hide ToC details from user agents that don’t support JS --><script type="text/html" class="tocopen"><i class="far fa-book"></i></script><script type="text/html" class="toc"><header><span>Table of Contents</span><span class="close"><i class="far fa-window-close"></i></span><p class="ptoc-search"><input class="ptoc-search" placeholder="Search" style="width: 80%"/></p></header><div db-persistent-toc="persistent-toc.html" db-prefix="">Loading…</div></script></nav></body></html>
Loading

0 comments on commit a9789a6

Please sign in to comment.