1 Note: this is the initial release, it should contain some bugs ;-)
6 This project contains a skyrix-xml/SaxObjC SAX driver bundle which can process
7 so called "structured text" files, or in short "STX". The parsing events are
8 reported as XHTML tags.
16 will be reported as SAX events similiar to such an HTML file:
24 The basis for this driver bundle, the StructuredText framework, was initially
25 written by Mirko Viviani and Giulio Cesare Solaroli and sponsored by eXtrapola
27 Note that the "original" StructuredText framework is much more capable and
28 generic than what this SAX driver provides. On the pro side, your applications
29 do not need to care about the actual tag format if you use SaxObjC. Your
30 applications can use either, XHTML, HTML, PYX or STX files using the available
31 SaxObjC drivers without any additional work.
36 Not sure what the correct MIME type for structured text is supposed to be, for
37 now we register this driver for the
46 Just use the saxxml or domxml tools which are part of skyrix-xml, eg:
48 saxxml -XMLReader STXSaxDriver data/hhtest1.stx
50 This will print the XHTML representation of the STX file on stdout.
52 STX Functionality which is implemented
53 ======================================
57 Anyway, we used this document as "reference":
59 http://plone.org/documentation/howto/FrontPage/UsingStructuredText
61 of the construct defined there, we have skipped just the table construct.
63 But we have added a few thinks:
64 - it is possible to use quotes in link url (es: if you have
65 "Link":http://www.url.com, the comma will end up into the link; to avoid
66 this, we can parse a string like that: "Link":'http://www.url.com', and the
67 comma will be left out of the link).
68 - link target: they are not a first class citizen (specially in XHTML), but
69 sometime they are very usefull. To define a target, you can add it after a
70 link: "Link":'http://www.url.com'::'target'. Also the target can be quoted
71 in order to avoid problems with punctuation.
72 - Image link: in order to create a link around an image, we have defined the
74 ["Alt text":http://www.url.com/image.gif]:'http://www.url.com'.
75 Here too, quoting and target are supported.
81 STXDebugEnabled YES|NO
82 STXSaxDriverDebugEnabled YES|NO
87 http://www.zope.org/Members/millejoh/structuredText
88 http://plone.org/documentation/howto/FrontPage/UsingStructuredText
94 STXSaxDriver < SaxXMLReader >
100 StructuredTextRenderingDelegate
101 StructuredTextRenderingDelegate_XHTML