Changeset 4423:30bac4a06a01 in livinglogic.python.xist

Show
Ignore:
Timestamp:
03/17/11 14:10:55 (9 years ago)
Author:
Walter Doerwald <walter@…>
Branch:
default
Message:

Start documentation for the XIST scripts.

Location:
src/ll/xist/scripts
Files:
3 modified

Legend:

Unmodified
Added
Removed
  • src/ll/xist/scripts/__init__.py

    r4422 r4423  
    77## 
    88## See ll/__init__.py for the license 
     9 
     10""" 
     11This package contains the following scripts: 
     12 
     13    ``dtd2xsc`` 
     14        ``dtd2xsc`` creates a skeleton XIST namespace module from a DTD. 
     15 
     16    ``xml2xsc`` 
     17        ``xml2xsc`` is a script that generates a skeleton XIST namespace module 
     18        from one or more XML files. 
     19 
     20    ``tld2xsc`` 
     21        ``tld2xsc`` converts a Java tag library description XML file to a skeleton 
     22        XIST namespace 
     23 
     24    ``doc2txt`` 
     25        ``doc2txt`` creates a plain text file from a XML file using XISTs doc 
     26        XML vocabulary. 
     27 
     28These scripts can either be called via Pythons :option:`-m` option:: 
     29 
     30    python -mll.xist.scripts.xml2xsc --help 
     31 
     32or as a simple script installed in the search path:: 
     33 
     34    xml2xsc --help 
     35""" 
     36 
     37 
     38__docformat__ = "reStructuredText" 
  • src/ll/xist/scripts/dtd2xsc.py

    r4422 r4423  
    1111 
    1212""" 
    13 Module that helps to create XIST namespace modules from DTDs. Needs xmlproc__ 
     13``dtd2xsc`` is a script that helps to create XIST namespace modules from DTDs. 
     14It reads one or more DTDs and outputs a skeleton namespace module. 
    1415 
    15 __http://www.garshol.priv.no/download/software/xmlproc/ 
     16 
     17``dtd2xsc`` requires xmlproc__. 
     18 
     19__ http://www.garshol.priv.no/download/software/xmlproc/ 
    1620 
    1721For usage information type:: 
    1822 
    1923    $ dtd2xsc --help 
    20  
    2124""" 
    2225 
  • src/ll/xist/scripts/xml2xsc.py

    r4422 r4423  
    88## 
    99## See ll/__init__.py for the license 
     10 
     11 
     12""" 
     13``xml2xsc`` is a script that generates an XIST namespace module from one or more 
     14XML files. 
     15""" 
    1016 
    1117