From 31fccbd58d3f91979d1f44e83fc2d109b403928a Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 8 May 2011 17:33:08 +0200 Subject: improved README.rst --- README.rst | 37 +++++++++++++++++++--------- mod/tex/context/third/rst/rst_directives.lua | 5 ++-- 2 files changed, 27 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index d22b305..7bb1190 100644 --- a/README.rst +++ b/README.rst @@ -15,14 +15,29 @@ Usage As rstConTeXt was developed on *texlua*, you may expect it to run best with this interpreter. For now the script accepts two command line arguments: the input -file and the output file: :: +file and the output file. The following will demonstrate the main usage in a +separate directory: :: - $texlua rst_parser.lua doc/documentation.rst man.tex + mkdir tmp; cd tmp + ln -s ../mod/tex/context/third/rst/*.lua . + texlua rst_parser.lua ../mod/doc/context/third/rst/documentation.rst doc.tex + context ../mod/doc/context/third/rst/manual.tex -This should get you the manual converted to a file ``man.tex`` which you can run -through |CONTEXT| now. You will find extended instructions on how to build the -manual with some cosmetic improvements in the section *Usage* of the manual -itself. +This should have gotten you the manual converted to a file ``doc.tex`` which was +subsequently run through |CONTEXT| to generate the final ``manual.pdf``. You +will find extended instructions on how to build the manual with some cosmetic +improvements in the section *Usage* of the manual itself. + +There is also a small module ``t-rst.mkiv`` which permits direct typesetting of +reST markup with |CONTEXT| MkIV. To install the module, simply copy anything +under the ``mod`` directory to your local |CONTEXT| tree. For instance, if +|CONTEXT| happens to be installed at ``~/context``, the installation would be +achieved this way: :: + + cp -r mod/* ~/context/tex/texmf-local/ + +For usage examples see the files ``hybridtest.tex`` and ``moduletest.tex`` in +the ``doc`` subdirectory. ======= License @@ -40,11 +55,9 @@ Contact |rstcontext| was written by Philipp Gesang, ``megas.kapaneus`` at ``gmail`` dot ``com`` (find me on BitBucket_). -.. |rstcontext| ctx:: {\em rst}\kern.5pt\CONTEXT - -.. |CONTEXT| ctx:: \CONTEXT - -.. _BitBucket: http://bitbucket.org/phg +.. |rstcontext| ctx:: {{\em rst}\kern.5pt\CONTEXT} +.. |CONTEXT| ctx:: {\CONTEXT} +.. _Contact: megas.kapaneus@gmail.com +.. _BitBucket: http://bitbucket.org/phg .. _maintainer: Contact_ - diff --git a/mod/tex/context/third/rst/rst_directives.lua b/mod/tex/context/third/rst/rst_directives.lua index 6af0ce4..bb1534a 100644 --- a/mod/tex/context/third/rst/rst_directives.lua +++ b/mod/tex/context/third/rst/rst_directives.lua @@ -227,10 +227,9 @@ rst_directives.ctx = function(name, data) local ctx = string.format([[ \startbuffer[%s] -%s -\stopbuffer +%s\stopbuffer \def\RSTsubstitution%s{%% - \getbuffer[%s] + \getbuffer[%s]%% } ]], name, data, name, name) return ctx -- cgit v1.2.3