Re: Reviving the project

Perhaps you can contribute to the XML output module as this wasn't need so far at our site. But it would be nice to get an XML output so one could use an XSLT document to create a static HTML documentation from it (which also would be possible from the database but the XML + XSLT = HTML approach would be more direct and flexible IMO).

Tommy.Holden@xxxxxxxxxxxxxxxxxxxxx schrieb:

due to the under-whelming response to the beta version we had, and the additional workload i've just inherited it would be a long time before i can contribute anything to the project. i'll be happy to stay updated and possibly offer some ideas/opinions but other than that i feel that i've run as far as i can with this. hopefully others will be able to assist in this endeavor.

Thanks,
Tommy Holden



From:
Mihael Schmidt <mihael@xxxxxxxxxxxxxx>
To:
iledocs@xxxxxxxxxxxx
Date:
03/17/2009 02:57 PM
Subject:
[IleDocs] Reviving the project
Sent by:
iledocs-bounces@xxxxxxxxxxxx



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)