This is great! I can't wait to start using it in my applications.

On most of my databases, I get an error of "DXL Exporter Operation Failed." Do you know the cause of this?

Very cool!
A few quick suggestions:
- Save the path and filename of the last file the user exported to. Its annoying having to navigate back to the same folder every time
- This tool should definitely be able to run in "headless" mode. For instance, it should be able to run as a scheduled agent every night to update the database documentation. Currently, I assume the file dialog would not allow you to run this on the server? It would also require a way to specify the filename through a config document or something similar
- A frames format similar to Javadoc would be easier to navigate around. Perhaps show all the forms and views down the left hand side and the actual info on the right? Not sure. Something to think about
Excellent work!.

I'm getting an error in the status bar:
SAXStartElement List item does not exist on line 28
and then the operation fails.

Do you know why this is? I've followed the same format for commenting fields as I used in form fields which work.

"subform" was accidentally left out of the SAXCharacters method. I added the following to line 14 of the method:
Or listElements("subform")

There is another application which may be of interest, LotusScript.doc
* Without special comments in the code, you get basic information (classes, subs, functions with parameters etc) and you can see where the LS code is.
* Supports special comments in the LS code, similar to the JavaDoc comments (@param etc)
* Documentation is put in a Notes database and can be generated by hand or by using a scheduled agent
* Read documentation using a browser. JavaDoc frameset is used.
For more information and download see http://www.lsdoc.org

Hi Patrick,
I don't have any words to appreciate this splendid work you did. You have saved Notes world spending lots of time to generate this type of reports.
Keep the good work going...
with rgds,
Madheeswar

If I run the agent on the NotesDoc db, I get a nice HTML doc.
If I run it against other dbs, I'm getting a 'Sax Parser Operation Failed' error in some dbs and 'DXL Exporter Failed' in others Nothing in the status bar.
I took one db with the parser operation failure and pulled all but one view and one form. The form has one field, no buttons. No db script, no agents, no form events, no nothing and I still get the same error.
I can't figure out how to debug the agent - I've stepped through it but don't see any kind of output or temp variables that point me to the error.
The failures occur in the initialize agent code
'Process SAX events
Call exporter.Process <<- 'DXL Exporter Failed' fails here
Call saxParser.Process <<- 'Sax Parser Operation Failed' fails here
I'm sure I'm doing something stupid but can't see the problem. Any pointers are appreciated.

OK, I'm working this out a bit.
First, I put in an 'on error resume next' statement so the code just runs and generates the html file.
I think the problem is tied up with REM statements in function code.
Something that wasn't obvious to me - You get one and only one REM statement in Function code and LS.
In Function code some interesting things happen if you don't close out the rem with a */:
REM {/** Comment 1*/};
REM {/** Comment 2*/};
Yields 'Comment 1' in the html output
REM {/** Comment 1};
...plus any other code
Yields all of the code (in my case, a view action button).
REM {/** Comment 1
Comment 2*/};
Yields
Comment 1
Comment 2
I'm guessing that the parse errors happen as a function of unclosed */ tags.
& acts like a CRLF. You get the CRLF then the & on the next line. Could be useful for formatting very long comments
> and < also generate CRLFs
text <br> more text generates
text
> more text.
Looks like one could play with this all day long...
I was hoping to be able to put comments in the code where it made sense (easy for someone else to understand what I was doing) and have NotesDoc extract all of those bits. The as is code won't do that. I think this means I need to put all the comments in one place for ease of use with NotesDoc, duplicate the comments in the body of the code (works for NotesDoc and someone reading the code) or hack NotesDoc to read the entire code string and extract all possible comments (not an xml parser so this one could be a challenge).
If I learn more, I'll post more.

OK, I was back into it yesterday and found the following:
Don't comment actions. They show up when you generate a NotesDoc, but not necessarily with the form/view they belong to and they show up as field comments.
Don't copy/paste text in from Word. I built a small table of data in Word that I wanted to bring into a NotesDoc comment. It pasted in without the borders - no problem at all, but caused a parse failure. Turns out that something I entered in Word as a dash character really wasn't a dash in the LS routine. Whatever it was, it was longer than a dash and was positioned in the upper half of the character space rather than in the middle like a dash would be. Once I pulled this 'thing that looks like a dash but is not a dash' from the comment, the NotesDoc routine worked fine.
If I find other 'things not to do' , I'll post them as well.

Login to add your comment