1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY asciidoc-download-http "https://files.pythonhosted.org/packages/source/a/asciidoc/asciidoc-&asciidoc-version;.tar.gz">
|
---|
8 | <!ENTITY asciidoc-download-ftp " ">
|
---|
9 | <!ENTITY asciidoc-md5sum "&asciidoc-md5sum;">
|
---|
10 | <!ENTITY asciidoc-size "228 KB">
|
---|
11 | <!ENTITY asciidoc-buildsize "2.6 MB">
|
---|
12 | <!ENTITY asciidoc-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect2 id="asciidoc" xreflabel="asciidoc-&asciidoc-version;">
|
---|
16 |
|
---|
17 | <title>Asciidoc-&asciidoc-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="asciidoc">
|
---|
20 | <primary sortas="a-asciidoc">asciidoc</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect3 role="package">
|
---|
24 | <title>Introduction to Asciidoc Module</title>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | The <application>Asciidoc</application> package is a text document
|
---|
28 | format for writing notes, documentation, articles, books, ebooks,
|
---|
29 | slideshows, web pages, man pages and blogs. AsciiDoc files can be
|
---|
30 | translated to many formats including HTML, PDF, EPUB, and man page.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&asciidoc-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&asciidoc-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &asciidoc-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &asciidoc-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &asciidoc-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &asciidoc-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect4">Asciidoc Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect5">Optional (runtime)</bridgehead>
|
---|
72 | <para role="optional">
|
---|
73 | <xref linkend="docbook-xsl"/>,
|
---|
74 | <xref linkend="fop"/>,
|
---|
75 | <xref linkend="libxslt"/>,
|
---|
76 | <xref linkend="lynx"/>,
|
---|
77 | <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink>, and
|
---|
78 | <ulink url="&w3m-url;">W3m</ulink>
|
---|
79 | </para>
|
---|
80 |
|
---|
81 | </sect3>
|
---|
82 |
|
---|
83 | <sect3 role="installation">
|
---|
84 | <title>Installation of Asciidoc</title>
|
---|
85 |
|
---|
86 | <!-- https://github.com/asciidoc-py/asciidoc-py/pull/267 -->
|
---|
87 | <!-- Fixed in version 10.2.1
|
---|
88 | <para>
|
---|
89 | Fix an issue causing thousands of lines of
|
---|
90 | <quote><computeroutput>invalid escape sequence</computeroutput></quote>
|
---|
91 | warnings outputted when generating the documentation of some
|
---|
92 | packages with Asciidoc and Python 3.12 or later:
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | <screen><userinput>sed '/self.separator =/s/"/r"/' -i asciidoc/asciidoc.py</userinput></screen>
|
---|
96 | -->
|
---|
97 | <para>
|
---|
98 | Build the module:
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | &build-wheel;
|
---|
102 |
|
---|
103 | <para>
|
---|
104 | This package does not come with a test suite.
|
---|
105 | </para>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
109 | </para>
|
---|
110 |
|
---|
111 | <screen role="root"><userinput>&install-wheel; asciidoc</userinput></screen>
|
---|
112 |
|
---|
113 | </sect3>
|
---|
114 |
|
---|
115 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
116 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
117 |
|
---|
118 | <sect3 role="content">
|
---|
119 | <title>Contents</title>
|
---|
120 |
|
---|
121 | <segmentedlist>
|
---|
122 | <segtitle>Installed Programs</segtitle>
|
---|
123 | <segtitle>Installed Libraries</segtitle>
|
---|
124 | <segtitle>Installed Directories</segtitle>
|
---|
125 |
|
---|
126 | <seglistitem>
|
---|
127 | <seg>
|
---|
128 | a2x and
|
---|
129 | asciidoc
|
---|
130 | </seg>
|
---|
131 | <seg>None</seg>
|
---|
132 | <seg>
|
---|
133 | /usr/lib/python&python3-majorver;/site-packages/asciidoc and
|
---|
134 | /usr/lib/python&python3-majorver;/site-packages/asciidoc-&asciidoc-version;.dist-info
|
---|
135 | </seg>
|
---|
136 | </seglistitem>
|
---|
137 | </segmentedlist>
|
---|
138 |
|
---|
139 | <variablelist>
|
---|
140 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
141 | <?dbfo list-presentation="list"?>
|
---|
142 | <?dbhtml list-presentation="table"?>
|
---|
143 |
|
---|
144 | <varlistentry id="a2x">
|
---|
145 | <term><command>a2x</command></term>
|
---|
146 | <listitem>
|
---|
147 | <para>
|
---|
148 | is a toolchain manager for AsciiDoc
|
---|
149 | (converts Asciidoc text files to other file formats)
|
---|
150 | </para>
|
---|
151 | <indexterm zone="asciidoc a2x">
|
---|
152 | <primary sortas="b-a2x">a2x</primary>
|
---|
153 | </indexterm>
|
---|
154 | </listitem>
|
---|
155 | </varlistentry>
|
---|
156 |
|
---|
157 | <varlistentry id="asciidoc-prog">
|
---|
158 | <term><command>asciidoc</command></term>
|
---|
159 | <listitem>
|
---|
160 | <para>
|
---|
161 | converts an AsciiDoc text file to HTML or DocBook
|
---|
162 | </para>
|
---|
163 | <indexterm zone="asciidoc asciidoc-prog">
|
---|
164 | <primary sortas="b-asciidoc-prog">asciidoc</primary>
|
---|
165 | </indexterm>
|
---|
166 | </listitem>
|
---|
167 | </varlistentry>
|
---|
168 |
|
---|
169 | </variablelist>
|
---|
170 |
|
---|
171 | </sect3>
|
---|
172 |
|
---|
173 | </sect2>
|
---|