Menu
▾
▴
[ndoc-commits] CVS: ndoc/src/Documenter/Msdn MsdnDocumenter.cs,1.62,1.63 MsdnDocumenterConfig.cs,1.28,1.29 MsdnXsltUtilities.cs,1.3,1.4
|
From: Jean-Claude M. <jc...@us...> - 2003-06-25 16:18:08
|
Update of /cvsroot/ndoc/ndoc/src/Documenter/Msdn
In directory sc8-pr-cvs1:/tmp/cvs-serv27942/src/Documenter/Msdn
Modified Files:
MsdnDocumenter.cs MsdnDocumenterConfig.cs MsdnXsltUtilities.cs
Log Message:
Implemented option to choose the target SDK documentation version (v1.0, v1.1 and MsdnOnline), and replaced all the hard coded base urls.
Index: MsdnDocumenter.cs
===================================================================
RCS file: /cvsroot/ndoc/ndoc/src/Documenter/Msdn/MsdnDocumenter.cs,v
retrieving revision 1.62
retrieving revision 1.63
diff -C2 -d -r1.62 -r1.63
*** MsdnDocumenter.cs 22 Mar 2003 19:59:28 -0000 1.62
--- MsdnDocumenter.cs 25 Jun 2003 16:18:02 -0000 1.63
***************
*** 1414,1418 ****
#endif
- MsdnXsltUtilities utilities = new MsdnXsltUtilities(fileNames, elemNames);
ExternalHtmlProvider htmlProvider = new ExternalHtmlProvider(MyConfig, filename);
StreamWriter streamWriter = null;
--- 1414,1417 ----
***************
*** 1429,1432 ****
--- 1428,1436 ----
arguments.AddParam("ndoc-document-attributes", String.Empty, MyConfig.DocumentAttributes);
arguments.AddParam("ndoc-documented-attributes", String.Empty, MyConfig.DocumentedAttributes);
+
+ MsdnXsltUtilities utilities = new MsdnXsltUtilities(fileNames, elemNames, MyConfig.LinkToSdkDocVersion);
+
+ arguments.AddParam("ndoc-sdk-doc-base-url", String.Empty, utilities.SdkDocBaseUrl);
+ arguments.AddParam("ndoc-sdk-doc-file-ext", String.Empty, utilities.SdkDocExt);
arguments.AddExtensionObject("urn:NDocUtil", utilities);
Index: MsdnDocumenterConfig.cs
===================================================================
RCS file: /cvsroot/ndoc/ndoc/src/Documenter/Msdn/MsdnDocumenterConfig.cs,v
retrieving revision 1.28
retrieving revision 1.29
diff -C2 -d -r1.28 -r1.29
*** MsdnDocumenterConfig.cs 10 Jun 2003 05:05:52 -0000 1.28
--- MsdnDocumenterConfig.cs 25 Jun 2003 16:18:02 -0000 1.29
***************
*** 65,68 ****
--- 65,70 ----
_FilesToInclude = string.Empty;
+ _LinkToSdkDocVersion = SdkDocVersion.SDK_v1_1;
+
}
***************
*** 443,446 ****
--- 445,480 ----
}
+ SdkDocVersion _LinkToSdkDocVersion;
+
+ /// <summary>Gets or sets the LinkToSdkDocVersion property.</summary>
+ [
+ Category("HTML Help Options"),
+ Description("Specifies to which version of the .NET Framework SDK documentation the links to system types will be pointing.")
+ ]
+ public SdkDocVersion LinkToSdkDocVersion
+ {
+ get { return _LinkToSdkDocVersion; }
+ set
+ {
+ _LinkToSdkDocVersion = value;
+ SetDirty();
+ }
+ }
+
+ }
+
+ /// <summary>
+ /// Specifies a version of the .NET Framework documentation.
+ /// </summary>
+ public enum SdkDocVersion
+ {
+ /// <summary>The SDK version 1.0.</summary>
+ SDK_v1_0,
+
+ /// <summary>The SDK version 1.1.</summary>
+ SDK_v1_1,
+
+ /// <summary>The online version of the SDK documentation.</summary>
+ MsdnOnline
}
Index: MsdnXsltUtilities.cs
===================================================================
RCS file: /cvsroot/ndoc/ndoc/src/Documenter/Msdn/MsdnXsltUtilities.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** MsdnXsltUtilities.cs 27 May 2003 04:39:51 -0000 1.3
--- MsdnXsltUtilities.cs 25 Jun 2003 16:18:02 -0000 1.4
***************
*** 4,14 ****
namespace NDoc.Documenter.Msdn
{
- /// <summary>
- /// Summary description for MsdnXsltUtilities.
- /// </summary>
public class MsdnXsltUtilities
{
! const string baseURL = "ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrf";
! const string systemPrefix = "System.";
/// <summary>
--- 4,20 ----
namespace NDoc.Documenter.Msdn
{
public class MsdnXsltUtilities
{
! private const string sdkDoc10BaseUrl = "ms-help://MS.NETFrameworkSDK/cpref/html/frlrf";
! private const string sdkDoc11BaseUrl = "ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrf";
! private const string sdkDocPageExt = ".htm";
! private const string msdnOnlineSdkBaseUrl = "http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrf";
! private const string msdnOnlineSdkPageExt = ".asp";
! private const string systemPrefix = "System.";
! private string sdkDocBaseUrl;
! private string sdkDocExt;
! private StringDictionary fileNames;
! private StringDictionary elemNames;
! private StringCollection descriptions = new StringCollection();
/// <summary>
***************
*** 17,24 ****
/// <param name="fileNames">A StringDictionary holding id to file name mappings.</param>
/// <param name="elemNames">A StringDictionary holding id to element name mappings</param>
! public MsdnXsltUtilities(StringDictionary fileNames, StringDictionary elemNames)
{
! _fileNames = fileNames;
! _elemNames = elemNames;
}
--- 23,69 ----
/// <param name="fileNames">A StringDictionary holding id to file name mappings.</param>
/// <param name="elemNames">A StringDictionary holding id to element name mappings</param>
! /// <param name="linkToSdkDocVersion">Specifies the version of the SDK documentation.</param>
! public MsdnXsltUtilities(
! StringDictionary fileNames,
! StringDictionary elemNames,
! SdkDocVersion linkToSdkDocVersion)
{
! descriptions = new StringCollection();
!
! this.fileNames = fileNames;
! this.elemNames = elemNames;
!
! switch (linkToSdkDocVersion)
! {
! case SdkDocVersion.SDK_v1_0:
! sdkDocBaseUrl = sdkDoc10BaseUrl;
! sdkDocExt = sdkDocPageExt;
! break;
! case SdkDocVersion.SDK_v1_1:
! sdkDocBaseUrl = sdkDoc11BaseUrl;
! sdkDocExt = sdkDocPageExt;
! break;
! case SdkDocVersion.MsdnOnline:
! sdkDocBaseUrl = msdnOnlineSdkBaseUrl;
! sdkDocExt = msdnOnlineSdkPageExt;
! break;
! }
!
! }
!
! /// <summary>
! /// Gets the base Url for system types links.
! /// </summary>
! public string SdkDocBaseUrl
! {
! get { return sdkDocBaseUrl; }
! }
!
! /// <summary>
! /// Gets the page file extension for system types links.
! /// </summary>
! public string SdkDocExt
! {
! get { return sdkDocExt; }
}
***************
*** 32,38 ****
if (cref.Substring(2, 7) != systemPrefix)
{
! string fileName = _fileNames[cref];
if ((fileName == null) && cref.StartsWith("F:"))
! fileName = _fileNames["E:" + cref.Substring(2)];
if (fileName == null)
--- 77,83 ----
if (cref.Substring(2, 7) != systemPrefix)
{
! string fileName = fileNames[cref];
if ((fileName == null) && cref.StartsWith("F:"))
! fileName = fileNames["E:" + cref.Substring(2)];
if (fileName == null)
***************
*** 46,52 ****
{
case "N:": // Namespace
! return baseURL + cref.Substring(2).Replace(".", "") + ".htm";
case "T:": // Type: class, interface, struct, enum, delegate
! return baseURL + cref.Substring(2).Replace(".", "") + "ClassTopic.htm";
case "F:": // Field
case "P:": // Property
--- 91,97 ----
{
case "N:": // Namespace
! return sdkDocBaseUrl + cref.Substring(2).Replace(".", "") + sdkDocExt;
case "T:": // Type: class, interface, struct, enum, delegate
! return sdkDocBaseUrl + cref.Substring(2).Replace(".", "") + "ClassTopic" + sdkDocExt;
case "F:": // Field
case "P:": // Property
***************
*** 68,72 ****
if (cref.Substring(2, 7) != systemPrefix)
{
! string name = _elemNames[cref];
if (name != null)
return name;
--- 113,117 ----
if (cref.Substring(2, 7) != systemPrefix)
{
! string name = elemNames[cref];
if (name != null)
return name;
***************
*** 97,115 ****
string crefType = crefName.Substring(0, index);
string crefMember = crefName.Substring(index + 1);
! return baseURL + crefType.Replace(".", "") + "Class" + crefMember + "Topic.htm";
}
- private StringDictionary _fileNames;
- private StringDictionary _elemNames;
-
public bool HasSimilarOverloads(string description)
{
! if (_descriptions.Contains(description))
return true;
! _descriptions.Add(description);
return false;
}
-
- private StringCollection _descriptions = new StringCollection();
}
}
--- 142,155 ----
string crefType = crefName.Substring(0, index);
string crefMember = crefName.Substring(index + 1);
! return sdkDocBaseUrl + crefType.Replace(".", "") + "Class" + crefMember + "Topic" + sdkDocExt;
}
public bool HasSimilarOverloads(string description)
{
! if (descriptions.Contains(description))
return true;
! descriptions.Add(description);
return false;
}
}
}
|