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