xml2rfc Plugin

$Date: 2005/10/21 21:20:53 $

Abstract

xml2rfc/rfc2629 support for the XMLMind XML Editor.

Great thanks are due to Hussein Shafie, who answered many inexperienced questions about xxe's css/xml/java support.


Table of Contents

Overview
Usage
Toolbar
Keyboard Shortcuts
XML2RFC menu
Convert sub-menu
Table Rendering
Processing Instructions
Including External References
Known Limitations
Support
Change Log

Overview

This xxe plugin attempts to support most of the rfc2629bis DTD, as of xml2rfc release 1.29, April 5, 2005. This documentation for plugin version 0.7.1. The plugin requires at least xxe 2.10 (released June 2, 2005) and has been tested up to 3.0 (released October 6, 2005).

This plugin can create text or HTML output using xml2rfc, if installed; it can also use xmlmind's native XSL support to generate HTML. It can also convert to txt, HTML, nroff or canonical XML using the xml.resource.org web form. Use the menu items Convert to HTML using XSL, HTML Preview using XSL, Text Preview using xml.resource.org, and the ...using xml.resource.org Convert submenu if you don't have xml2rfc installed.

The following items are not yet (and may never be) supported:

  • texttable. This requires some extra help (probably a custom java widget) to style the table for xmlmind. However, newer versions of xxe are expected to have a feature to help support this.

  • <?rfc ?> processing instructions in the document, <?rfc include= in particular. (Wish: to be able to handle this like external entity references) (Partial <?rfc include= support is described in the section called “Including External References”). The <?rfc ?> processing instructions before the root element are supported by a custom editor

  • The RFC's description of <list> specifies that style is inherited from nearest parent; DTD says that it defaults to empty. The editor currently uses the DTD definition; java might be able to help implement the other way.

Planned features:

  • Make toolbar helpers more useful

    • Increase/decrease list item level (tab?)

    • Fix section manager, including a version of >> which attaches to previous-sibling's last section descendant

  • Improve <list counter> support

  • <?rfc ?> PI editor inside the document