source: general/prog/python-modules/asciidoc.xml@ 6b3ecbb4

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../../general.ent">
  %general-entities;

  <!ENTITY asciidoc-download-http "https://files.pythonhosted.org/packages/source/a/asciidoc/asciidoc-&asciidoc-version;.tar.gz">
  <!ENTITY asciidoc-download-ftp  " ">
  <!ENTITY asciidoc-md5sum        "&asciidoc-md5sum;">
  <!ENTITY asciidoc-size          "228 KB">
  <!ENTITY asciidoc-buildsize     "2.6 MB">
  <!ENTITY asciidoc-time          "less than 0.1 SBU">
]>

  <sect2 id="asciidoc" xreflabel="asciidoc-&asciidoc-version;">

    <title>Asciidoc-&asciidoc-version;</title>

    <indexterm zone="asciidoc">
      <primary sortas="a-asciidoc">asciidoc</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Asciidoc Module</title>

      <para>
        The <application>Asciidoc</application> package is a text document
        format for writing notes, documentation, articles, books, ebooks,
        slideshows, web pages, man pages and blogs. AsciiDoc files can be
        translated to many formats including HTML, PDF, EPUB, and man page.
      </para>

      &lfs121_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&asciidoc-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download (FTP): <ulink url="&asciidoc-download-ftp;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &asciidoc-md5sum;
          </para>
        </listitem>
        <listitem>
          <para>
            Download size: &asciidoc-size;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated disk space required: &asciidoc-buildsize;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated build time: &asciidoc-time;
          </para>
        </listitem>
      </itemizedlist>

      <bridgehead renderas="sect4">Asciidoc Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional (runtime)</bridgehead>
      <para role="optional">
        <xref linkend="docbook-xsl"/>,
        <xref linkend="fop"/>,
        <xref linkend="libxslt"/>,
        <xref linkend="lynx"/>,
        <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink>, and
        <ulink url="&w3m-url;">W3m</ulink>
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Asciidoc</title>

      <!-- https://github.com/asciidoc-py/asciidoc-py/pull/267 -->
<!-- Fixed in version 10.2.1
      <para>
        Fix an issue causing thousands of lines of
        <quote><computeroutput>invalid escape sequence</computeroutput></quote>
        warnings outputted when generating the documentation of some
        packages with Asciidoc and Python 3.12 or later:
      </para>

<screen><userinput>sed '/self.separator =/s/"/r"/' -i asciidoc/asciidoc.py</userinput></screen>
-->
      <para>
        Build the module:
      </para>

&build-wheel;

      <para>
        This package does not come with a test suite.
      </para>

      <para>
        Now, as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>&install-wheel; asciidoc</userinput></screen>

    </sect3>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/pip3-cmd-explain.xml"/>

    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>
            a2x and
            asciidoc
          </seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/asciidoc and
            /usr/lib/python&python3-majorver;/site-packages/asciidoc-&asciidoc-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect5">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>

        <varlistentry id="a2x">
          <term><command>a2x</command></term>
          <listitem>
            <para>
              is a toolchain manager for AsciiDoc
              (converts Asciidoc text files to other file formats)
            </para>
            <indexterm zone="asciidoc a2x">
              <primary sortas="b-a2x">a2x</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="asciidoc-prog">
          <term><command>asciidoc</command></term>
          <listitem>
            <para>
              converts an AsciiDoc text file to HTML or DocBook
            </para>
            <indexterm zone="asciidoc asciidoc-prog">
              <primary sortas="b-asciidoc-prog">asciidoc</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>