Minor formatting enhancement
[extfs.d.git] / xml-ANNOUNCE
1 XML Virtual FileSystem for Midnight Commander
2
3
4 WHAT IS IT
5    View an XML file in Midnight Commander as a filesystem.
6
7
8 WHAT'S NEW in version 1.1.0 (2013-11-26)
9    Show comment(s) before the root element.
10
11 WHAT'S NEW in version 1.0.0 (2013-11-23)
12    With lxml.etree-based implementation show only child namespaces
13    (calculated as combined namespaces minus parent's namespaces).
14
15 WHAT'S NEW in version 0.6.0 (2013-11-22)
16    Refactored _list() and attrs2text() to be completely generic.
17
18 WHAT'S NEW in version 0.5.0 (2013-11-19)
19    Added lxml.etree-based implementation.
20
21 WHAT'S NEW in version 0.4.0 (2013-11-19)
22    Added ElementTree-based implementation.
23
24 WHAT'S NEW in version 0.3.0 (2013-11-16)
25    Initial release. Implementation based on minidom.
26
27
28 WHERE TO GET
29    Home page: http://phdru.name/Software/mc/xml.html
30    Download:  http://phdru.name/Software/mc/xml
31     git clone http://git.phdru.name/extfs.d.git
32     git clone  git://git.phdru.name/extfs.d.git
33
34    Installation instructions: http://phdru.name/Software/mc/INSTALL.html
35
36
37 The VFS represents tags as directories; the directories are numbered to
38 distinguish tags with the same name; numbering also helps to sort tags by their
39 order in XML instead of sorting them by name. Attributes, text nodes and
40 comments are represented as text files; attributes are shown in a file named
41 "attributes", attributes are listed in the file as name=value lines (I
42 deliberately ignore a small chance of newline characters in values); names and
43 values are reencoded to the console encoding. Text nodes and comments are
44 collected in a file named "text", stripped and reencoded. The filesystem is
45 read-only.
46
47 Implementation based on minidom doesn't understand namespaces, it just shows
48 them among other attributes. ElementTree-based implementation doesn't show
49 namespaces at all. Implementation based on lxml.etree shows namespaces in a
50 separate file "namespaces".
51
52 It is useful to have a top-down view on an XML structure but it's especially
53 convenient to extract text values from tags. One can get, for example, a
54 base64-encoded image - just walk down the VFS to the tag's directory and copy
55 its text file to a real file.
56
57 The VFS was inspired by a FUSE xmlfs: https://github.com/halhen/xmlfs
58
59
60 AUTHOR
61    Oleg Broytman <phd@phdru.name>
62
63 COPYRIGHT
64    Copyright (C) 2013 PhiloSoft Design
65
66 LICENSE
67    GPL