× 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.


  1.  Home
  2. RPG400-L
  3. April 2007

RE: ILEDocs




Thanks,
Tommy Holden


-----Original Message-----
From: rpg400-l-bounces@xxxxxxxxxxxx
[mailto:rpg400-l-bounces@xxxxxxxxxxxx] On Behalf Of Kurt Anderson
Sent: Friday, April 27, 2007 7:38 AM
To: RPG programming on the AS400 / iSeries
Subject: RE: ILEDocs

That file didn't appear when I restored from the savf.


Kurt Anderson
Application Developer
Highsmith Inc

-----Original Message-----
From: rpg400-l-bounces@xxxxxxxxxxxx
[mailto:rpg400-l-bounces@xxxxxxxxxxxx] On Behalf Of Holden Tommy
Sent: Thursday, April 26, 2007 7:10 PM
To: RPG programming on the AS400 / iSeries
Subject: RE: ILEDocs

In QTXTSRC there is a readme file that should explain the tool more in
depth


Thanks,
Tommy Holden


-----Original Message-----
From: rpg400-l-bounces@xxxxxxxxxxxx
[mailto:rpg400-l-bounces@xxxxxxxxxxxx] On Behalf Of Kurt Anderson
Sent: Thursday, April 26, 2007 4:08 PM
To: RPG programming on the AS400 / iSeries
Subject: RE: ILEDocs

I downloaded this and restored it to my system... But is there a help
file or instructions somewhere that I'm not seeing?


Kurt Anderson
Application Developer
Highsmith Inc

-----Original Message-----
From: rpg400-l-bounces@xxxxxxxxxxxx
[mailto:rpg400-l-bounces@xxxxxxxxxxxx] On Behalf Of Holden Tommy
Sent: Thursday, April 26, 2007 3:40 PM
To: RPG programming on the AS400 / iSeries
Subject: RE: ILEDocs

Ok in a nutshell...sometime ago it was mentioned that RPG, etc should
have a function similar to Javadocs. From this we started an initiative
to build our own tool for extracting comments, etc from source members
on the iSeries. The save file includes all the source code and objects
(works for v5r1 and up). The parser will extract the data from the
source member and will create XML and HTML files on the IFS or load the
data extracted into a PF. The HTML files use XML data binding for the
data representation. There currently is no display method for the PF.
An example of the process:
This source file http://code.midrange.com/index.php?id=cc20d9a15a will
be parsed via ILEPARSE

The defined tags in the source to be extracted start with the @ symbol.
The resulting HTML/XML will look like this
http://tommyholden.com/downloads/iledocs/ILEDOCS-QRPGLESRC-KR0058CMP-SQL
RPGLE.html

This does support extracting copybook tags (even nested copybooks)
you'll see them in the example output. The entire program and /copy are
generated at the same time. There is also a BLDINDEX command that will
build an index.html in the IFS file for all the source member pages in
the directory.


Thanks,
Tommy Holden


-----Original Message-----
From: rpg400-l-bounces@xxxxxxxxxxxx
[mailto:rpg400-l-bounces@xxxxxxxxxxxx] On Behalf Of Scott Klement
Sent: Thursday, April 26, 2007 3:02 PM
To: RPG programming on the AS400 / iSeries
Subject: Re: ILEDocs

What is the ILEDocs initiative about? If I download the ZIP file, what
will be in it? You say you're looking for volunteers -- volunteers to
do what?

Holden Tommy wrote:
I'm looking for volunteers to help with testing the ILEDocs initiative

that started from these mailing lists (thanks David for supporting
the
community!!) anyway if you want to try out what we have so far you
can
check it out by downloading from
http://www.tommyholden.com/downloads/iledocs/ILEDOCS.zip

Just unzip the savf and upload...RSTLIB ILEDOCS there is a readme
file
in QTXTSRC.

Should you find any bugs, etc feel free to contact me off list at
tommy@tommyholden dot com...


Thanks,
Tommy Holden



--
This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing
list To post a message email: RPG400-L@xxxxxxxxxxxx To subscribe,
unsubscribe, or change list options,
visit: http://lists.midrange.com/mailman/listinfo/rpg400-l
or email: RPG400-L-request@xxxxxxxxxxxx
Before posting, please take a moment to review the archives at
http://archive.midrange.com/rpg400-l.


--
This is the RPG programming on the AS400 / iSeries (RPG400-L) mailing
list To post a message email: RPG400-L@xxxxxxxxxxxx To subscribe,
unsubscribe, or change list options,
visit: http://lists.midrange.com/mailman/listinfo/rpg400-l
or email: RPG400-L-request@xxxxxxxxxxxx
Before posting, please take a moment to review the archives at
http://archive.midrange.com/rpg400-l.


? Instructions For Setting Up ILEDOCS ?*

 Setting Up Record Types ?*
Add ILEDOCS library to your library list (ADDLIBLE ILEDOCS)
Run the RCDTYPMNT command to enter your Keywords for
Documentation. There should be a record for the KEYWORD record
type that you can use. (The RCDTYPMNT & CTLMAINT commands are
part of a separate open source package that is used by ILEDOCS)

 Adding Keywords To Control File ?*
After you have the record type defined run the CTLMAINT command.
Some sample KEYWORD records already exist that you can modify or
you can add additional keyword records that pertain to your
internal program documentation.

 Examples Of Using ILEPARSE ?*
To document the source you can use the ILEPARSE command which is
the main process behind the tool. As with any other command you
can prompt the command and enter your criteria. Below is an
example of the command:

? ILEPARSE SRCFILE(mylib/mysrcfile) SRCMBR(mymbr) SRCTYPE(RPGLE) ?*
? OUTPUT(*XML) PATH('/myifsfolder') ?*

the output for *XML will be in
? /myifsfolder/mylib-mysrcfile-mymbr-mbrtype.xml ?*
to see the data represented by the output open the
? /myifsfolder/mylib-mysrcfile-mymbr-mbrtype.html ?*
in your web browser (IE or Firefox)

With output to *XML an HTML document will be created for the XML
file that will display the XML data via data binding. You can
also create an index.html for the IFS folder by using the BLDINDEX
command (i.e. BLDINDEX IFSPATH('/myifsfolder') ) (more detail
later )

For output of the documentation to a PF:
? ILEPARSE SRCFILE(mylib/mysrcfile) SRCMBR(mymbr) SRCTYPE(RPGLE) ?*
? OUTPUT(*FILE) ?*
? Output to file data will be in the ILEBASE file. No Search function ?*
? exists currently for presenting the data retrieved. ?*

 BLDINDEX Command ?*
The BLDINDEX command reads through the IFS directory and creates
an index.html web page with links to the documented programs in the
directory. For searching through the programs this is the best place
to start.

 RCDTYPMNT Command ?*
The record type maintenance command allows you to define "generic"
record layouts for control data. There are a couple of example
record types defined in the record type files. One of the examples
is LIVEDBS. This record type contains the iSeries partition, Clock
Polling Flag, TCP/IP Port, FTP File Name, FTP User ID, FTP Password,
and FTP DNS Name. All record types have a 100 byte maximum length.
To put this to use you'll enter your record data via the CTLMAINT
command.

 CTLMAINT Command ?*
This command will allow you to maintain the control file using the
record types you have defined. Some entries already exist for some
common source member types that you can use and modify to your needs.

As an Amazon Associate we earn from qualifying purchases.

This thread ...
Follow-Ups:
Replies:
Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2024 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.