Skip to content

Commit 4d24247

Browse files
committed
Updated README with new features
1 parent 6d543a6 commit 4d24247

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Xcri4j
22

3-
A Java library for parsing XCRI documents
3+
A Java library for parsing and generating XCRI documents
44

55
http://www.xcri.org/wiki/index.php/XCRI_CAP_1.2
66

7-
Note that this ISN'T FINISHED! Please fork it and add missing parts :-)
7+
## Features
8+
9+
* Handles incorrect namespaces
10+
* Handles element names in the WRONG CaSe
11+
* Handles HTML in CDATA sections in descriptions, tries to convert to valid XHTML
12+
* Logs errors and tries to fix them rather than fail
813

914
## Basic Usage
1015

@@ -13,4 +18,14 @@ To parse an XML document and create a new Catalog object:
1318
Catalog catalog = new Catalog();
1419
SAXBuilder builder = new SAXBuilder();
1520
Document document = builder.build(new File("src-test/test.xml"));
16-
catalog.fromXml(document);
21+
catalog.fromXml(document);
22+
23+
You can also output XCRI using JDOM:
24+
25+
new XMLOutputter().output(catalog.toXml(), out);
26+
27+
(For example, you can use XCRI4J as a preprocessor to attempt to clean up a feed)
28+
29+
## NOTE
30+
31+
Note that this ISN'T FINISHED! Please fork it and add missing parts :-)

0 commit comments

Comments
 (0)