The XHTML WYSIWYG Editor For Desktop & Web Applications

Library Specifications

Image and Attachment (link) libraries are exposed as XML documents that XStandard reads from the CMS. Implementation of these libraries is provided below:

For testing, you may use the following URLs:

Should you need to build your own implementation, below you will find the technical specifications.

Request

XStandard makes calls to the library via HTTP GET. The library can be a server-side script or a static XML document. With each request, XStandard sends the relative path to sub-folders in the query string which can be read from PHP like this: $_GET['x-cms-library-path'].


Response

The library response is an XML document as show in the screen shot below.

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <library>
  3. <containers>
  4. <container>
  5. <objectName>folder1</objectName>
  6. <path>path1/path2</path>
  7. <label>Folder 1</label>
  8. <baseURL>http://localhost/path1/path2/folder1/</baseURL>
  9. <empty>false</empty>
  10. <icon>folder</icon>
  11. <metadata />
  12. <options>0</options>
  13. </container>
  14. </containers>
  15. <objects>
  16. <object>
  17. <objectName>image1.gif</objectName>
  18. <path>path1/path2</path>
  19. <label>Image 1</label>
  20. <icon>image</icon>
  21. <metadata />
  22. <options>0</options>
  23. <attrs>
  24. <attr>
  25. <name>src</name>
  26. <value>http://localhost/path1/path2/image1.gif</value>
  27. </attr>
  28. <attr>
  29. <name>width</name>
  30. <value>100</value>
  31. </attr>
  32. <attr>
  33. <name>height</name>
  34. <value>200</value>
  35. </attr>
  36. </attrs>
  37. <props>
  38. <prop>
  39. <name>decorative</name>
  40. <value>false</value>
  41. </prop>
  42. <prop>
  43. <name>size</name>
  44. <value>2099</value>
  45. </prop>
  46. <prop>
  47. <name>date</name>
  48. <value>2005-05-15 10:15:01</value>
  49. </prop>
  50. </props>
  51. </object>
  52. </objects>
  53. </library>

Download library.xml

Library Response XML Description
ElementDescription
containers / container / objectNameFolder name.
containers / container / pathPath to parent folder in the library.
containers / container / labelFriendly name.
containers / container / baseURLURL to this folder.
containers / container / emptyFlag indicating if the container is empty. Possible values are true and false. This value is not currently used.
containers / container / iconID of an icon defined in XStandard's icons.xml file.
containers / container / metadataReserved for future use.
containers / container / optionsReserved for future use. Set value to 0 in the meantime.
objects / object / objectNameFile name.
objects / object / pathPath to parent folder in the library.
objects / object / labelFriendly name.
objects / object / iconID of an icon defined in XStandard's icons.xml file.
objects / object / metadataReserved for future use.
objects / object / optionsReserved for future use. Set value to 0 in the meantime.
objects / object / attrsA collection of attributes for this object. XStandard will create markup from these attributes.
objects / object / attrs / attr / nameAttribute name. This value must conform to the naming conventions of XML attributes.
objects / object / attrs / attr / valueAttribute value.
objects / object / propsA collection of properties for this object. XStandard will use this metadata to provide additional information about the object.
objects / object / props / prop / nameProperty name. Possible values are: size, date, newWindow, decorative
objects / object / props / prop / valueProperty value.