Following is the list of products
 RML System (Version 1.1)

RML System is an interactive code reference tool kit. It could help software developers or computer programming language learners to create the RML documents relevant to source code. By browsing with RML document, we could understand the source code more quickly and thoroughly.

RML System provides two peer browsers, CodeBrowser and Reference Markup Language (RML) Browser. Software developers could use this system navigating the source code and RML document. Code and RML document are cross-referenced, and could be accessed from one to other by a single mouse click. In this way, the users could quickly find out the information they are concerning about.

RML System also provides two peer builders, CodeBuilder and RmlBuilder. These builders are used for creating and modifying the RML document.

 What Can RML System Be Used For

  • Comment Stable Workhorse System Many people spend lots of time to read the code in such systems. With RML document and RML Browser, the source code could become more understandable.
  • Remark the obsolete code The old systems may still have some valuable code, but it is difficult to find it out since no one read them often, If we have RML document and RML Browser with these code, we could easily locate the useful information when we need it.
  • Refer the sample code Most programming textbook has some sample code. The process of reading through the sample code by referring the textbook is some kind of tedious. RML Browser could lead the readers to the code explanation simply by a mouse click.
  • Create personal source code reference If you are a seasoned software developer, you must have lots of valuable experience and know-how. RML document is a convenient tool for you to record such knowledge and create index to the relevant source code.
 RML System Diagram

Following is the RML System Diagram.



This diagram shows all the applications (except RmlSetup) and files in the RML system. They are:

Applications in RML System

  • CodeConfig:      setting the configurations and project file for code applications.
  • CodeBuilder:     working with RmlBuilder and maintaining code sticker file.
  • CodeBrowser:   working with RmlBrowser and navigating the source code file.
  • RmlConfig:       setting the configurations and project file for RML applications.
  • RmlBuilder:      working with CodeBuilder and building the RML document.
  • RmlBrowser:    working with CodeBrowser and navigating the RML document.

Files in RML System

  • Cfg File:     application configuration file.
  • Cpf File:     code project file.
  • Csf File:     code sticker file.
  • Code File:  source code file.
  • Rpf File:     RML project file.
  • Rml File:    Reference Markup File.

The diagram also shows the relationship among the files and applications. The arrow from a file to an application means that the application takes the file as an input; the arrow from an application to a file indicates that the application may change the content of the file. In RML System, code file will never be changed and the two browsers don't change any files.

 The Feature of RML System

  • Platform Independent: The RML System is developed in Java. It could run on every machine if the Java Platform exists.
  • Deployment Flexibility: RML Builder/Browser and Code Builder/Browser are linked through UDP protocol. The two peer applications could be deployed on same or different machines. If there are two machines connected by UDP on our desk, we could install the RML system on each of the machines, and start Code application and RML application from different computers. In this way, we could get larger display area on the screen.
  • Easy to Learn: Most operations are the same as those in HTML browsers and file editors.
  • Low Hardware Requirement: The RML system could run very well on Pentium II with 64M RAM. It would be much better if we have 128M memory.
  • Safe to Source Code: RML system just reads and displays the source code files. It never writes to the source code files.

 RML Builder (Version 0.1)

RML Builder (Version 0.1) is a little older trial version, which was released in October 2002.

RML Builder (Version 0.1) includes RML Builder and Code Builder. These two builder applications work together to create and update the RML documents for RML Browsers.

In this package, a tutor is provided so that users could learn how to use this system. We don't have tutor in RML System (Version 1.1). Since the most operations are the same in both RML System (Version 1.1) and RML Builder (Version 0.1), you could download RML Builder (Version 0.1), and follow the tutor to learn the operations quickly.

Some notices for this package:

  1. The license files in RML Builder (Version 0.1) and RML System (Version 1.1) are incompatible. Please don't install the two packages in the same folder.
  2. The project file in RML Builder (Version 0.1) and RML System (Version 1.1) are incompatible. I will provide the service to convert the project files in RML Builder (Version 0.1) format to RML System (Version 1.1) format.
  3. The expiration date of trial system is the end of February 2003. If some one is still interested it after that date, please send me an email, and I will generate a set of new trial license files. I will support this package until the end of June, 2003 and will provide an updated tutorial before that date.