1
General Board / Re: Using Both EA and NDoc documentation in .NET
« on: December 15, 2003, 12:10:53 pm »
Thanks Matthias,
In my tests I discovered that I could use (xmlified) img tags. Your extra tips are most useful.
I did decide to use EA in my projects.
I'm currently using three forms of documentation. In time I would like to merge these into one.
1) Pure NDoc documentation.
2) My own documentation which is produced as compiled help (CHM) files. This is dead easy to do. (I use Homesite to create content and the HTML Help Workshop to turn that into a CHM.)
3) HTML format EA documentation.
This will head toward deeper integration but works as is. Integration is likely to follow a track like:
A) Check the ability to import other CHM's into a new build within Help Workshop. That gives me a way to integrate the automatically created content into the manually controlled CHM.
B) Build a CHM from EA HTML content. The structure is a very regular with subdirectories etc. I envisage a mixed automatic / manual approach initially. In this a tool creates the basic HTML Help files by recursing the subdirectories and building the file list and navigation structure. I haven't yet investigated putting names into the "site map" file. I'd like to automate but expect to do it manually at first.
C) Merge all three into one CHM.
The material won't initially be interlinked, but that may come later...
This is a fill in project and has no time line.
In my tests I discovered that I could use (xmlified) img tags. Your extra tips are most useful.
I did decide to use EA in my projects.
I'm currently using three forms of documentation. In time I would like to merge these into one.
1) Pure NDoc documentation.
2) My own documentation which is produced as compiled help (CHM) files. This is dead easy to do. (I use Homesite to create content and the HTML Help Workshop to turn that into a CHM.)
3) HTML format EA documentation.
This will head toward deeper integration but works as is. Integration is likely to follow a track like:
A) Check the ability to import other CHM's into a new build within Help Workshop. That gives me a way to integrate the automatically created content into the manually controlled CHM.
B) Build a CHM from EA HTML content. The structure is a very regular with subdirectories etc. I envisage a mixed automatic / manual approach initially. In this a tool creates the basic HTML Help files by recursing the subdirectories and building the file list and navigation structure. I haven't yet investigated putting names into the "site map" file. I'd like to automate but expect to do it manually at first.
C) Merge all three into one CHM.
The material won't initially be interlinked, but that may come later...
This is a fill in project and has no time line.