blob: 528fa782b95de0c4b5d032ee25437f6ff793007c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 4. AsciiDoc Backends</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ch03.html" title="Chapter 3. AsciiDoc Document Types" /><link rel="next" href="ch05.html" title="Chapter 5. DocBook" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ch03.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch05.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="X5"></a>Chapter 4. AsciiDoc Backends</h1></div></div></div><p>The asciidoc(1) command translates an AsciiDoc formatted file to the
backend format specified by the <code class="literal">-b</code> (<code class="literal">--backend</code>) command-line
option. asciidoc(1) itself has little intrinsic knowledge of backend
formats, all translation rules are contained in customizable cascading
configuration files. Backend specific attributes are listed in the
<a class="link" href="aph.html" title="Appendix H. Backend Attributes">Backend Attributes</a> section.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
docbook45
</span></dt><dd>
Outputs DocBook XML 4.5 markup.
</dd><dt><span class="term">
docbook5
</span></dt><dd>
Outputs DocBook XML 5.0 markup.
</dd><dt><span class="term">
html4
</span></dt><dd>
This backend generates plain HTML 4.01 Transitional markup.
</dd><dt><span class="term">
xhtml11
</span></dt><dd>
This backend generates XHTML 1.1 markup styled with CSS2. Output
files have an <code class="literal">.html</code> extension.
</dd><dt><span class="term">
html5
</span></dt><dd>
This backend generates HTML 5 markup, apart from the inclusion of
<a class="link" href="ch22.html" title="Chapter 22. HTML 5 audio and video block macros">audio and video block macros</a> it is functionally identical to
the <span class="emphasis"><em>xhtml11</em></span> backend.
</dd><dt><span class="term">
slidy
</span></dt><dd>
Use this backend to generate self-contained
<a class="ulink" href="http://www.w3.org/Talks/Tools/Slidy2/" target="_top">Slidy</a> HTML slideshows for
your web browser from AsciiDoc documents. The Slidy backend is
documented in the distribution <code class="literal">doc/slidy.txt</code> file and
<a class="ulink" href="https://asciidoc.org/slidy.html" target="_top">online</a>.
</dd><dt><span class="term">
wordpress
</span></dt><dd>
A minor variant of the <span class="emphasis"><em>html4</em></span> backend to support
<a class="ulink" href="http://srackham.wordpress.com/blogpost1/" target="_top">blogpost</a>.
</dd><dt><span class="term">
latex
</span></dt><dd>
Experimental LaTeX backend.
</dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_backend_aliases"></a>4.1. Backend Aliases</h2></div></div></div><p>Backend aliases are alternative names for AsciiDoc backends. AsciiDoc
comes with two backend aliases: <span class="emphasis"><em>html</em></span> (aliased to <span class="emphasis"><em>xhtml11</em></span>) and
<span class="emphasis"><em>docbook</em></span> (aliased to <span class="emphasis"><em>docbook45</em></span>).</p><p>You can assign (or reassign) backend aliases by setting an AsciiDoc
attribute named like <code class="literal">backend-alias-<alias></code> to an AsciiDoc backend
name. For example, the following backend alias attribute definitions
appear in the <code class="literal">[attributes]</code> section of the global <code class="literal">asciidoc.conf</code>
configuration file:</p><pre class="literallayout">backend-alias-html=xhtml11
backend-alias-docbook=docbook45</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X100"></a>4.2. Backend Plugins</h2></div></div></div><p>The asciidoc(1) <code class="literal">--backend</code> option is also used to install and manage
backend <a class="link" href="ch34.html" title="Chapter 34. Plugins">plugins</a>.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
A backend plugin is used just like the built-in backends.
</li><li class="listitem">
Backend plugins <a class="link" href="ch26.html#X27" title="26.11. Configuration file names, precedence and locations">take precedence</a> over built-in backends with
the same name.
</li><li class="listitem">
You can use the <code class="literal">{asciidoc-confdir}</code> <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attribute</a> to
refer to the built-in backend configuration file location from
backend plugin configuration files.
</li><li class="listitem">
You can use the <code class="literal">{backend-confdir}</code> <a class="link" href="ch31.html" title="Chapter 31. Intrinsic Attributes">intrinsic attribute</a> to
refer to the backend plugin configuration file location.
</li><li class="listitem">
By default backends plugins are installed in
<code class="literal">$HOME/.asciidoc/backends/<backend></code> where <code class="literal"><backend></code> is the
backend name.
</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch05.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|
