[ndoc-devel] RE: [Ndoc-users] Ndoc for 2005

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

I will help get you the VSHIK:

I had to download the VS2005 SDK and install it. Go here:
http://msdn.microsoft.com/vstudio/extend/default.aspx

and look for the October 2005 SDK. I don't know if the new March CTP has =
the
VS Help Authoring/Integration stuff.

MS

-----Original Message-----
From: ndo...@li...
[mailto:ndo...@li...] On Behalf Of Ken Kohler
Sent: Friday, March 17, 2006 1:32 PM
To: Derrick, Sally; David Kean; Paul Selormey; Jeremiah Voris;
ndo...@li... Strickland,David; =
kd...@op...
Cc: ndo...@li...; ndo...@li...
Subject: RE: [Ndoc-users] Ndoc for 2005

Hi Everyone,

As has been mentioned before, I have a working copy of
NDoc 1.3.x that works with VS 2.0 and Generics.  I
started with ndoc-src-1.3.1-v13.zip, found at
http://jonas.lagerblad.com/blog/?p=3D4, so I take no
credit for getting NDoc to compile with VS 2005.

1.3.1-v13 is known to have 2 major issues:
1) Working links to system classes
2) Correct output of Generics for other languages than
C#

I worked only on the MSDN Documenter and ported my
changes to the MSDN2 Documenter.  I do not have the
VSHIK and cannot find in on Microsoft's website, so I
cannot compile the HtmlHelp documenter.  The JavaDoc
documenter gives a runtime error (stylesheet problem?)
if it is used, I have not touched this one.

The bulk of my changes are localized to additional
files I added, or additional code and methods called
by or surrounded by tests for user selection of .Net
Framework 2.0 as the target.  This limits the scope of
changes to existing code to help preserve
compatibility with 1.0 and 1.1 Framework help file
generation.  I changed only one XSLT file for MSDN
(and thus one file for MSDN2).

The big issues with fixing links to the MS-HELP urls
(i.e. the framework help) are:=20

1) The SDK root has changed.  The change is more than
from 1.0 to 1.1 of the framework, which was just a
version number update.  The root is partially mapped
based on the actual files that the help pages are
stored in, of which there are about 20 files.  To
solve this, I created the url  based on one of the
files then verified (navigated to) the MS-HELP page.=20
If the navigation failed, I tried the next file...and
so on.  This is the only way I could think of to
resolve the base portion of the URL.

2) Generation of URL for Generics is difficult.  For
classes, I updated the corresponding stylesheet to
call a utility method.  At this point when generating
the html page, there is enough information, if you
count the parameters, to form the appropriate URL,
though Enumerator, KeyCollection and ValueCollection
derived classes needed additional work due to issues
with reflection information not being correct.

3) MS-HELP links for members/properties/fields/etc.
can be problamatic.  The only effective way to get the
correct URL appears to be navigate the the Member page
for the corresponding class, then parse the page to
find the actual link for the member/property/etc.=20
This logic is so much easier than using reflection to
try to determine what type of information needs to be
used for the help link.

4) Some links for user generated code (generics?) do
not appear that they ever can be correct.  After all
HTML files are generated (prior to creating the CHM
file) the links are verified.  Bad links to developer
classes are removed.

I only use C#, so I have not verified correctness with
VB or any other language.  I now have a utility that
can scan the DOC directory created by NDoc to verify
all links in the generated HTML files.  With both the
GenericsTest project and the src\Test project, which I
updated for testing Generics, the generated documents
DO NOT have any bad links with my updated code.

If you want the updated Source Code, let me know and I
will e-mail it.

Ken

--- "Derrick, Sally" <Sal...@su...>
wrote:

> It might be too late to avoid that.  Kevin sent
> alpha code in Jan that
> worked fine for my purposes.
>=20
> Here's the email I received:=20
>=20
> >
> >Hi everyone,
> >
> >Make sure you look at the "read-me" file ! =20
> >
> >Current Build is
>
>http://members.optushome.com.au/kdowns/NDoc2-Alpha3k-20060120.zip
> >
> >
> >Let me know how you get on; bug reports, comments
> and suggestions are
> always welcome :-)
> >
> >
> >regards,
> >Kevin =20
> >
>=20
> Sally
>=20
> -----Original Message-----
> From: ndo...@li...
> [mailto:ndo...@li...] On
> Behalf Of David Kean
> Sent: Thursday, March 16, 2006 10:17 PM
> To: Paul Selormey; Jeremiah Voris
> Cc: ndo...@li...;
> ndo...@li...
> Subject: RE: [Ndoc-users] Ndoc for 2005
>=20
> You might want to ping Kevin Downs (kdowns AT
> optusnet DOT com DOT au),
> as he is currently working up an update for 2.0 and
> you probably don't
> want to be duplicating effort.
>=20
>=20
> -----Original Message-----
> From: ndo...@li...
> [mailto:ndo...@li...] On
> Behalf Of Paul
> Selormey
> Sent: Thursday, 16 March 2006 7:49 PM
> To: Jeremiah Voris
> Cc: ndo...@li...;
> ndo...@li...
> Subject: Re: [Ndoc-users] Ndoc for 2005
>=20
> Right, that is a very good idea. I am currently
> planning to start a
> project in VS.NET 2005 and will seriously need NDoc
> support.
>=20
> David Strickland, Ken Kohler also announced a
> similar update for the
> .NET 2 support. Please get together and merge these
> updates and upload
> it somewhere for us to test it, and start working
> with it. I believe the
> NDoc developers are currently busy, so for now a
> fork will not be bad.
>=20
> Best regards,
> Paul.
>=20
> Jeremiah Voris wrote:
> > On 3/16/06, Strickland,David
> <dst...@mn...> wrote:
> >> I have a buildable 2005 copy based off of 1.3v13.
> I spent the better
> part of
> >> the day today doing a simple port and reworking
> the Solution and
> project
> >> classes to support the new formats. Is there
> another project everyone
> has
> >> moved to already if not anyone got a suggestion
> where I can post this
> thing
> >> so we can start testing/hacking on it. Granted
> it's got more bugs
> then a new
> >> york slum and is probably about as Stable a
> democracy in Iraq but if
> no one
> >> else has anything it'll be a place to start. If
> needed we could
> always
> >> branch into a new SourceForge Project but that
> might be overkill and
> in the
> >> end do more harm to the community then good.
> >>
> >> Anyone care to comment?
> >=20
> > Sounds like you and Ken Kohler need to get
> together and figure out an=20
> > integration strategy. :) Has anyone contacted the
> project admins?
> >=20
> > --
> > 533777336444244
> >=20
> >=20
> >
>
-------------------------------------------------------
> > This SF.Net email is sponsored by xPML, a
> groundbreaking scripting
> language
> > that extends applications into web and mobile
> media. Attend the live
> webcast
> > and join the prime developer group breaking into
> this new coding
> territory!
> >
>
http://sel.as-us.falkag.net/sel?cmd=3Dk&kid=110944&bid$1720&dat=121642
> > _______________________________________________
> > Ndoc-users mailing list
> > Ndo...@li...
> >
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
>=20
>=20
>
-------------------------------------------------------
> This SF.Net email is sponsored by xPML, a
> groundbreaking scripting
> language that extends applications into web and
> mobile media. Attend the
> live webcast and join the prime developer group
> breaking into this new
> coding territory!
>
http://sel.as-us.falkag.net/sel?cmd=3Dlnk&kid=3D110944&bid=3D241720&dat=3D=
121642
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
>=20
>
########################################################################
> #############
> Attention:
> The information contained in this message and or
> attachments is intended
> only for the person or entity to which it is
> addressed and may contain
> confidential and/or privileged material. Any review,
> retransmission,
> dissemination or other use of, or taking of any
> action in reliance upon,
> this information by persons or entities other than
> the intended
> recipient is prohibited. Any views expressed in this
> message are those
> of the individual sender and may not necessarily
> reflect the views of
> AusSoft Solutions Pty Ltd.
> If you received this in error, please inform us by
> email at
> pos...@au... and delete the material from
> any system.
>
########################################################################
> #############
>=20
>=20
>
-------------------------------------------------------
> This SF.Net email is sponsored by xPML, a
> groundbreaking scripting
> language that extends applications into web and
> mobile media. Attend the
> live webcast and join the prime developer group
> breaking into this new
> coding territory!
>
http://sel.as-us.falkag.net/sel?cmd=3Dk&kid=110944&bid$1720&dat=121642
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
>=20
>=20
>=20
>
-------------------------------------------------------
> This SF.Net email is sponsored by xPML, a
> groundbreaking scripting language
> that extends applications into web and mobile media.
> Attend the live webcast
> and join the prime developer group breaking into
> this new coding territory!
>
http://sel.as-us.falkag.net/sel?cmd=3Dlnk&kid=110944&bid$1720&dat=121642
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
>=20

__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around=20
http://mail.yahoo.com=20

-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting =
language
that extends applications into web and mobile media. Attend the live =
webcast
and join the prime developer group breaking into this new coding =
territory!
http://sel.as-us.falkag.net/sel?cmd=3Dlnk&kid=3D110944&bid=3D241720&dat=3D=
121642
_______________________________________________
Ndoc-users mailing list
Ndo...@li...
https://lists.sourceforge.net/lists/listinfo/ndoc-users