Software Archive
Read-only legacy content
17061 Discussions

Online documentation

Intel_C_Intel
Employee
603 Views
I am wondering if there is any product out there
(preferrably, but not necessarily, from Microsoft) that
can do the following task for me.

I am developing codes in Fortran 95 and C++ using the
integrated developer studio environment by Microsoft and
Compaq. The code is used for scientific/engineering
simulation and hence a good chunck of it is based on hand
written notes and published papers, ... I have all these
documents scanned. I just want to create an easy way to
access these documents. So, if I am reviewing a routine, I
can click on some function keys (similar to F1) or
hyperlink item, ... that automatically opens up the
relevant scanned document.

Do you know any product that can do that? Please send a
copy of your reply by e-mail to "asi@enginia.com"

Ali Asi
Enginia Research Inc.
asi@enginia.com
0 Kudos
5 Replies
Intel_C_Intel
Employee
603 Views
Create help files that show some scanned documents? Lots of ways to go. For example,

The free, MS's own HTML Help Workshop.

The full featured, but expensive like RoboHelp

and everything in between. (see your favorite search engine or download site)
0 Kudos
Jugoslav_Dujic
Valued Contributor II
603 Views
I think that OP didn't ask for a help authoring tool, but more something like VS plug-in which would enable him to have documentation for the source file in the editor at hand. Don't know if there's something like that readily available, but a carefully written macro (which would examine the value of ActiveDocument.Title -- something like that -- and then run the application which displays appropriate help document) might suit his needs.

Jugoslav
0 Kudos
Intel_C_Intel
Employee
603 Views
I have to agree with Jugoslav Dujic. My question is not about online help for the final developed code. I am looking for a way to document my code beside putting just simple comment lines.

Ali Asi
0 Kudos
Intel_C_Intel
Employee
603 Views
Oh, sorry. I guess I mis-read that.

JT
0 Kudos
Intel_C_Intel
Employee
603 Views
I'd recommend "CodeWright" by Premia. It will do what you're asking.

It is a code editor that allows you to put in "Links" to documents/ To Do lists/ files etc. You use "Edit->Insert Link" and the editor puts a dialog button into your source code (you specify the comment delimiter "!" so that the compiler ignores it). When you click on the button it brings up the specified file or whatever and opens the file with whatever application you've specified - brilliant.

It integrates with Visual Studio so that code changes in one are reflected in the other, you can debug/compile etc from either the editor or from VS. On the down side it doesn't natively support Fortran syntax but you use an Add-in DLL that makes the editor recognise Fortran.

I'm sure some of the other editors also have features like this, but I've only used Codewright.

Guy
0 Kudos
Reply