Metadata-Version: 1.1
Name: rst2textile
Version: 0.1.1
Summary: rst2textile is docutils textile writer convert reStructuredText(rst) to Textile format.
Home-page: https://bitbucket.org/shimizukawa/rst2textile
Author: Takayuki SHIMIZUKAWA
Author-email: shimizukawa@gmail.com
License: UNKNOWN
Description: `rst2textile` is docutils textile writer convert reStructuredText(rst) to Textile format.

        

        Features

        ==========

        

        * Docutils writer for textile.

        

          * supported syntaxes are:

        

            * headings: h1/h2..

            * docinfo: field-list (like `:Date: today`) at top of rst file.

            * paragraph

            * emphasis: `*em*`

            * strong: `**strong**`

            * list-item: `* egg`

            * enum-item: `#. ham`

            * blockquote

            * link: `\`foo <http://example.com/>\`_`

            * image: `.. image:: http://example.com/image.png`

            * literal: `\`\`some code\`\`` and `::`

        

        * Sphinx textile builder (experimental).

        

          #. write conf.py `extensions = ['docutils_textile']`

          #. build by `sphinx-build -b textile source _build/textile`

        

        Install

        ========

        

        ::

        

           $ pip install rst2textile

        

        or::

        

           $ pysetup install docutils

           $ pysetup install rst2textile

        

        

        If you wanto to use unrelease version, you can install from repository::

        

           $ pysetup install https://bitbucket.org/shimizukawa/rst2textile/get/tip.zip

        

        

        Run

        ======

        

        ::

        

           $ rst2textile.py input.rst output.txt

        

        or::

        

           $ python -m rst2textile input.rst output.txt

        

        

        Test

        =====

        

        ::

        

           $ python setup.py test

        

        or::

        

           $ python test.py

        

        *currently, 'pysetup run test' not working.*

        

        Depends

        ========

        * Python 2.4 - 2.7, 3.1 - 3.3

        * Docutils 0.5 - 0.8.1

        

        

        Limitation

        ============

        * Not supported: some textile syntax at http://redcloth.org/textile

        * pysetup: Not support auto install dependency libraries(docutils).

        

        

        ToDo

        =====

        * Documentation

        * Implement some textile format.

        

        History

        ========

        

        0.1.0 (2012/4/22)

        ------------------

        * first release

        * supported syntax: h1/h2.., docinfo, paragraph, *em*, **strong**, list-item, enum-item, blockquote, link, image, literal

        

        

        Convert Samples

        ==================

        

        Heading1

        ---------

        .. container:: test, rst, textile

        

           rst::

        

              ==========

              Heading1

              ==========

        

           textile::

        

              h1. Heading1

        

        Headings

        ---------

        .. container:: test, rst, textile

        

           rst::

        

              ==========

              Heading1

              ==========

        

              Heading2

              ==========

        

              Heading3

              ----------

        

              Heading4

              ^^^^^^^^^^

        

           textile::

        

              h1. Heading1

        

        

              h2. Heading2

        

        

              h3. Heading3

        

        

              h4. Heading4

        

        

        Document Information

        -----------------------

        .. container:: test, rst, textile

        

           rst::

        

              HelloWorld

              ===========

        

              :Date: Today

              :Author: SpamEgg

              :Location: Here

        

           textile::

        

              h1. HelloWorld

        

              Date:

                 Today

        

              Author:

                 SpamEgg

        

              Location:

                 Here

        

        Paragraph

        ----------

        

        .. container:: test, rst, textile

        

           rst::

        

              Normal Text

        

           textile::

        

              Normal Text

        

        Emphasized

        -----------

        

        .. container:: test, rst, textile

        

           rst::

        

              *emphasized* (e.g., italics)

        

           textile::

        

              _emphasized_ (e.g., italics)

        

        Strongly emphasized

        --------------------

        .. container:: test, rst, textile

        

           rst::

        

              **strongly emphasized** (e.g., boldface)

        

           textile::

        

              *strongly emphasized* (e.g., boldface)

        

        List items

        -----------

        .. container:: test, rst, textile

        

           rst::

        

              - An item in a bulleted (unordered) list

        

              - Another item in a bulleted list

        

                - Second Level

        

                * Second Level Items

        

                  * Third level

        

           textile::

        

              * An item in a bulleted (unordered) list

              * Another item in a bulleted list

              ** Second Level

              ** Second Level Items

              *** Third level

        

        Enumerated list items

        ----------------------

        .. container:: test, rst, textile

        

           rst::

        

              #. An item in an enumerated (ordered) list xxxxxxx

              #. Another item in an enumerated list yyyyyy

        

                 #. Another level in an enumerated list vvvvvvvv

                 #. Another level in an enumerated list vvvvvvvv

        

              #. 3rd element at indent level1

        

           textile::

        

              # An item in an enumerated (ordered) list xxxxxxx

              # Another item in an enumerated list yyyyyy

              ## Another level in an enumerated list vvvvvvvv

              ## Another level in an enumerated list vvvvvvvv

              # 3rd element at indent level1

        

        Blockquotes

        ------------

        .. container:: test, rst, textile

        

           rst::

        

              Blockquotes

        

                 This text will be enclosed in an HTML blockquote element.

        

                 Second Paragraph.

        

           textile::

        

              Blockquotes

        

              bq. This text will be enclosed in an HTML blockquote element.

              bq. Second Paragraph.

        

        Links

        -------

        .. container:: test, rst, textile

        

           rst::

        

              `link text and link target url <http://www.example.com/link/target/address>`_

        

           textile::

        

              "link text and link target url":http://www.example.com/link/target/address

        

        Images

        -------

        .. container:: test, rst, textile

        

           rst::

        

               .. image:: http://example.com/image.jpg

        

               .. figure:: local/image/path.png

        

           textile::

        

              !http://example.com/image.jpg!

        

              !local/image/path.png!

        

        

        Inner Reference

        ----------------

        .. container:: test, rst, textile

        

           rst::

        

              HelloWorld

              ===========

        

              reference to HelloWorld_ !

        

           textile::

        

              h1. HelloWorld

        

              reference to "HelloWorld" !

        

        

        Literal (code)

        ----------------

        .. container:: test, rst, textile

        

           rst::

        

              ::

        

                 class Foo(object):

        

                     def __init__(self, value):

                         print "value = %d" % value

                         raise NotImplementedError(u'EmptyClass')

        

           textile::

        

              <pre>

              class Foo(object):

        

                  def __init__(self, value):

                      print "value = %d" % value

                      raise NotImplementedError(u'EmptyClass')

              </pre>

        

        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: Environment :: Other Environment
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: General
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.4
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Requires: docutils
