sandbox/rst2wiki/README.txt

   1 ========
   2 rst2wiki
   3 ========
   4
   5 .. contents::
   6
   7
   8 What is rst2wiki?
   9 =================
  10
  11 ``rst2wiki`` is a tool that transforms reStructuredText_ into various
  12 Wiki texts. To date ``rst2wiki`` supports two Wiki texts TWiki_ and
  13 Atlassian Confluence_.
  14
  15
  16 Usage
  17 =====
  18
  19 ``rst2wiki.py`` currently has one option ``--wiki`` beyond "General",
  20 "Parser", and "Standalone" options.
  21
  22 Example::
  23
  24   # TWiki text
  25   $ rst2wiki.py --wiki twiki test.rst test.twiki
  26
  27   # Confluence text
  28   $ rst2wiki.py --wiki confluence test.rst test.confluence
  29
  30 By default ``rst2wiki.py`` will generate TWiki text.
  31
  32
  33 Availability
  34 ============
  35
  36 ``rst2wiki`` is available through the `Docutils Subversion repository`_
  37 as part of the Docutils sandbox in ``sandbox/rst2wiki``.
  38
  39
  40 Contact
  41 =======
  42
  43 If you have questions, patches, etc ... feel free to contact me at: joshua.graff@ccrypt.org
  44
  45
  46 Installation
  47 ============
  48
  49 Currently, ``rst2wiki`` requires you copy the frontend tool ``rst2wiki.py``
  50 and writer ``wiki.py`` into the appropriate directories under your docutils
  51 install.
  52
  53 Example::
  54
  55   $ cd <rst2wiki sandbox>/tools
  56   $ dirname `which rst2html.py`
  57   <bin path>
  58   $ cp rst2wiki.py <bin path>
  59   $ cd <rst2wiki sandbox>/docutils/writers
  60   $ cp wiki.py <path to docutils install>/writers
  61
  62
  63 Copyright and license
  64 =====================
  65
  66 Copyright (C) 2012 by Joshua Graff
  67
  68 License is BSD_ 2-Clause
  69
  70
  71 TODO
  72 ====
  73
  74 * Add some actual automated tests
  75
  76 * Expand support for a few more Wiki dialects
  77
  78
  79 Links
  80 =====
  81
  82 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
  83
  84 .. _TWiki: http://twiki.org
  85
  86 .. _Confluence: http://www.atlassian.com/software/confluence/overview
  87
  88 .. _Docutils Subversion repository: http://docutils.sourceforge.net/docs/dev/repository.html
  89
  90 .. _BSD: http://www.opensource.org/licenses/BSD-2-Clause