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