[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[141ee0a5] | 2 | <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[5fe69261] | 4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
[141ee0a5] | 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 " ">
|
---|
[569925c7] | 9 | <!ENTITY asciidoc-md5sum "&asciidoc-md5sum;">
|
---|
[9d43379c] | 10 | <!ENTITY asciidoc-size "212 KB">
|
---|
[72c62e4] | 11 | <!ENTITY asciidoc-buildsize "4.3 MB">
|
---|
[141ee0a5] | 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">
|
---|
[939f4ae4] | 24 | <title>Introduction to Asciidoc Module</title>
|
---|
[141ee0a5] | 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 |
|
---|
[282a0eb] | 33 | &lfs120_checked;
|
---|
[141ee0a5] | 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 |
|
---|
[939f4ae4] | 71 | <bridgehead renderas="sect5">Optional (runtime)</bridgehead>
|
---|
[141ee0a5] | 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>
|
---|
[72c62e4] | 85 |
|
---|
[9ef2bd4] | 86 | <!-- https://github.com/asciidoc-py/asciidoc-py/pull/267 -->
|
---|
| 87 | <para>
|
---|
[3525199c] | 88 | Fix an issue causing thousands of lines of
|
---|
[9ef2bd4] | 89 | <quote><computeroutput>invalid escape sequence</computeroutput></quote>
|
---|
| 90 | warnings outputted when generating the documentation of some
|
---|
| 91 | packages with Asciidoc and Python 3.12 or later:
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
[8ef3f05] | 94 | <screen><userinput>sed '/self.separator =/s/"/r"/' -i asciidoc/asciidoc.py</userinput></screen>
|
---|
[9ef2bd4] | 95 |
|
---|
[141ee0a5] | 96 | <para>
|
---|
[72c62e4] | 97 | Build the module:
|
---|
[141ee0a5] | 98 | </para>
|
---|
| 99 |
|
---|
[db244ae2] | 100 | &build-wheel;
|
---|
[141ee0a5] | 101 |
|
---|
[72c62e4] | 102 | <para>
|
---|
| 103 | This package does not come with a test suite.
|
---|
| 104 | </para>
|
---|
[141ee0a5] | 105 |
|
---|
[72c62e4] | 106 | <para>
|
---|
| 107 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 108 | </para>
|
---|
[141ee0a5] | 109 |
|
---|
[db244ae2] | 110 | <screen role="root"><userinput>&install-wheel; asciidoc</userinput></screen>
|
---|
[141ee0a5] | 111 |
|
---|
| 112 | </sect3>
|
---|
| 113 |
|
---|
[939f4ae4] | 114 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[5fe69261] | 115 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
[939f4ae4] | 116 |
|
---|
[141ee0a5] | 117 | <sect3 role="content">
|
---|
| 118 | <title>Contents</title>
|
---|
| 119 |
|
---|
| 120 | <segmentedlist>
|
---|
| 121 | <segtitle>Installed Programs</segtitle>
|
---|
| 122 | <segtitle>Installed Libraries</segtitle>
|
---|
| 123 | <segtitle>Installed Directories</segtitle>
|
---|
| 124 |
|
---|
| 125 | <seglistitem>
|
---|
| 126 | <seg>
|
---|
| 127 | a2x and
|
---|
| 128 | asciidoc
|
---|
| 129 | </seg>
|
---|
| 130 | <seg>None</seg>
|
---|
| 131 | <seg>
|
---|
[939f4ae4] | 132 | /usr/lib/python&python3-majorver;/site-packages/asciidoc and
|
---|
[7b459c22] | 133 | /usr/lib/python&python3-majorver;/site-packages/asciidoc-&asciidoc-version;.dist-info
|
---|
[141ee0a5] | 134 | </seg>
|
---|
| 135 | </seglistitem>
|
---|
| 136 | </segmentedlist>
|
---|
| 137 |
|
---|
| 138 | <variablelist>
|
---|
| 139 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 140 | <?dbfo list-presentation="list"?>
|
---|
| 141 | <?dbhtml list-presentation="table"?>
|
---|
| 142 |
|
---|
| 143 | <varlistentry id="a2x">
|
---|
| 144 | <term><command>a2x</command></term>
|
---|
| 145 | <listitem>
|
---|
| 146 | <para>
|
---|
| 147 | is a toolchain manager for AsciiDoc
|
---|
| 148 | (converts Asciidoc text files to other file formats)
|
---|
| 149 | </para>
|
---|
| 150 | <indexterm zone="asciidoc a2x">
|
---|
| 151 | <primary sortas="b-a2x">a2x</primary>
|
---|
| 152 | </indexterm>
|
---|
| 153 | </listitem>
|
---|
| 154 | </varlistentry>
|
---|
| 155 |
|
---|
| 156 | <varlistentry id="asciidoc-prog">
|
---|
| 157 | <term><command>asciidoc</command></term>
|
---|
| 158 | <listitem>
|
---|
| 159 | <para>
|
---|
| 160 | converts an AsciiDoc text file to HTML or DocBook
|
---|
| 161 | </para>
|
---|
| 162 | <indexterm zone="asciidoc asciidoc-prog">
|
---|
| 163 | <primary sortas="b-asciidoc-prog">asciidoc</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 | </listitem>
|
---|
| 166 | </varlistentry>
|
---|
| 167 |
|
---|
| 168 | </variablelist>
|
---|
| 169 |
|
---|
| 170 | </sect3>
|
---|
| 171 |
|
---|
| 172 | </sect2>
|
---|