× The internal search function is temporarily non-functional. The current search engine is no longer viable and we are researching alternatives.
As a stop gap measure, we are using Google's custom search engine service.
If you know of an easy to use, open source, search engine ... please contact support@midrange.com.



Hi,

this project has been very quiet for some time now. But I think it is a very important project and I would like to see a working solution to the documentation problem RPG suffers from.

I have already written a documentation tool at work and am now allowed to share it with the community. Though I need to refactor it a little bit. Because of that you'll have to wait a little bit for the source/program (but I'm working on it).

The program is seperated into several modules. The default output goes to a database table on the i5 which acts kind of like a xref table. We have a java web application which accesses the table and displays the documentation.

The program can easily be extended to make the output go to an xml file.

Another idea is to have the output generate a wiki document which can be submitted to a wiki which supports xml-rpc. The wiki system would be the frontend to the user with the whole search possiblilites of the wiki available to the user. Possible wikis are PHPWiki and Confluence (which are the ones I know which support XML-RPC). The whole wiki /XML-RPC idea is just that ... an idea. I haven't tested any of this. But with the help of the HTTPAPI service program from Scott Klement it should be easy to access the wiki via the http protocol.

AFAIK Sourceforge.net does support a wiki as a hosted app. Perhaps that wiki can be access via XML-RPC. If it is available the wiki on iledocs.sf.net could act as a documenation site for free RPG program and service programs where the documentation could be uploaded and easily access by the RPG community.

Another nice feature would be the linking from one program/procedure to another (like the @see tag from javadoc).

I hope to get some comments from you.

The current level of documentation can be seen on a document which is based on the automatically generated documention:
http://www.rpgnextgen.com/downloads/llist-docs.html

Regards

Mihael (aka fist)

As an Amazon Associate we earn from qualifying purchases.

This thread ...

Follow-Ups:

Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2026 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].

Operating expenses for this site are earned using the Amazon Associate program and Google Adsense.