private static void TestOthers(BuildDocumenter documenter,
                                       TestOptions options)
        {
            string helpRegisterDir = Path.Combine(sampleDir, @"SampleRegisterTopics\");

            // Prepare the documents and project file paths
            //string projectFile  = Path.Combine(helpRegisterDir, "Topics.xml");
            string projectFile  = Path.Combine(helpRegisterDir, "Topics.sandtopics");
            string documentsDir = Path.Combine(helpRegisterDir, "Documents");

            // First add the conceptual contents for the topics...
            ConceptualGroup registerGroup = new ConceptualGroup(
                "HelpRegister User Manual", TestGroupIds.RegisterTopicsGroupId);

            registerGroup.RunningHeaderText = "Sandcastle HelpRegister: User Manual";
            registerGroup.CreateContent(documentsDir, projectFile);
            string       mediaLinks   = Path.Combine(helpRegisterDir, "MediaContent.media");
            MediaContent mediaContent = new MediaContent(mediaLinks,
                                                         Path.Combine(helpRegisterDir, "Media"));

            //mediaContent.Load();
            registerGroup.AddMedia(mediaContent);

            ConceptualContent content = registerGroup.Content;

            registerGroup.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                       "OtherConceptual" + BuildFileExts.ConceptualGroupExt));

            content.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                 "OtherConceptual" + BuildFileExts.ConceptualContentExt));

            documenter.AddGroup(registerGroup);
        }
Example #2
0
        private static void TestMain(BuildDocumenter documenter,
                                     TestOptions options)
        {
            string helpTestDir = Path.Combine(sampleDir, @"SampleTopics\");

            // Prepare the documents and project file paths
            //string projectFile = Path.Combine(helpTestDir, "Topics.xml");
            string projectFile  = Path.Combine(helpTestDir, "Topics.sandtopics");
            string documentsDir = Path.Combine(helpTestDir, "Documents");

            // First add the conceptual contents for the topics...
            ConceptualGroup testsGroup = new ConceptualGroup(
                "Test Topics", TestGroupIds.SampleTopicsGroupId);

            testsGroup.ChangeHistory     = ConceptualChangeHistory.ShowFreshnessDate;
            testsGroup.RunningHeaderText = "Sandcastle Helpers: Test Topics";
            testsGroup.CreateContent(documentsDir, projectFile);
            string mediaLinks = Path.Combine(helpTestDir, "MediaContent.media");

            testsGroup.AddMedia(new MediaContent(mediaLinks,
                                                 Path.Combine(helpTestDir, "Media")));

            testsGroup.AddSnippet(new CodeSnippetContent(Path.Combine(
                                                             helpTestDir, "CodeSnippetSample.snippets")));

            documenter.AddGroup(testsGroup);
        }
        private static void TestSharpScript(BuildDocumenter documenter,
                                            TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            //string libraryDir = Path.Combine(sampleDir, @"SampleTestLibraryCLR\");
            //string outputDir = Path.Combine(libraryDir, @"Output\");
            //string projectDoc = Path.Combine(outputDir, "Project.xml");

            string sourceFile =
                @"F:\SandcastleAssist\Development\Source\Tests\ScriptSample\samples\PhotoDemo\PhotoDemo.sln";
            ReferenceVsNetSource vsSource = new ReferenceVsNetSource();
            ReferenceVsNetItem   vsItem   = new ReferenceVsNetItem(
                new BuildFilePath(sourceFile));

            vsItem.XamlSyntax = false;
            vsItem.AddInclude("{5F2605F7-5F00-4756-AC61-1D83B0E541E4}");
            vsItem.AddInclude("{16B291CB-4AC1-41B9-943C-341FB528D7A1}");
            vsItem.AddInclude("{4D8373CD-6685-4288-A1FF-1E37319D60D4}");
            vsSource.Add(vsItem);

            //CommentContent comments = vsSource.Comments;
            //CommentItem projItem = new CommentItem("R:Project",
            //    CommentItemType.Project);
            //projItem.Value.Add(new CommentPart("Summary of the project",
            //    CommentPartType.Summary));
            //comments.Add(projItem);
            //CommentItem nsItem = new CommentItem("N:TestLibraryCLR",
            //    CommentItemType.Namespace);
            //nsItem.Value.Add(new CommentPart("Summary of the namespace",
            //    CommentPartType.Summary));
            //comments.Add(nsItem);

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test ScriptSharp Library", Guid.NewGuid().ToString(), vsSource);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: ScriptSharp Library";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;
            apiGroup.SyntaxType  = BuildSyntaxType.CSharp | BuildSyntaxType.JavaScript;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing ScriptSharp Library";
            }

            //ReferenceContent apiContent = apiGroup.Content;
            //apiContent.FrameworkType = BuildFrameworkType.Framework20;

            //apiGroup.AddItem(projectDoc, null);
            //apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
            //    Path.Combine(outputDir, "SampleLibraryCLR.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, ""));

            documenter.AddGroup(apiGroup);
        }
Example #4
0
        private static void TestOthers(BuildDocumenter documenter,
                                       TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            //string libraryDir = Path.Combine(sampleDir, @"SampleTestLibraryCLR\");
            //string outputDir = Path.Combine(libraryDir, @"Output\");
            //string projectDoc = Path.Combine(outputDir, "Project.xml");

            string sourceFile =
                @"F:\SandcastleAssist\Main\Samples\HelpersSamples.sln";
            ReferenceVsNetSource vsSource = new ReferenceVsNetSource();
            ReferenceVsNetItem   vsItem   = new ReferenceVsNetItem(
                new BuildFilePath(sourceFile));

            //vsItem.XamlSyntax = false;
            vsItem.AddInclude("{41A48F1C-3E52-4995-B181-363EDBC02CA0}");
            vsSource.Add(vsItem);

            CommentContent comments = vsSource.Comments;
            CommentItem    projItem = new CommentItem("R:Project",
                                                      CommentItemType.Project);

            projItem.Value.Add(new CommentPart("Summary of the project",
                                               CommentPartType.Summary));
            comments.Add(projItem);
            CommentItem nsItem = new CommentItem("N:TestLibraryCLR",
                                                 CommentItemType.Namespace);

            nsItem.Value.Add(new CommentPart("Summary of the namespace",
                                             CommentPartType.Summary));
            comments.Add(nsItem);

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test CPP-CLR Library", Guid.NewGuid().ToString(), vsSource);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: C++/CLR Library";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing C++/CLR Library";
            }

            //ReferenceContent apiContent = apiGroup.Content;
            //apiContent.FrameworkType = BuildFrameworkType.Framework20;

            //apiGroup.AddItem(projectDoc, null);
            //apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
            //    Path.Combine(outputDir, "SampleLibraryCLR.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, ""));

            documenter.AddGroup(apiGroup);
        }
Example #5
0
        private static void TestSilverlight(BuildDocumenter documenter,
                                            TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            //string libraryDir = Path.Combine(sampleDir, @"SampleTestLibraryCLR\");
            //string outputDir = Path.Combine(libraryDir, @"Output\");
            //string projectDoc = Path.Combine(outputDir, "Project.xml");

            string sourceFile =
                @"F:\SandcastleAssist\Development\Source\Tests\SilverlightClassLibrary3\SilverlightClassLibrary3.sln";
            ReferenceVsNetSource vsSource = new ReferenceVsNetSource();
            ReferenceVsNetItem   vsItem   = new ReferenceVsNetItem(
                new BuildFilePath(sourceFile));

            vsItem.XamlSyntax = false;
            vsSource.Add(vsItem);

            //CommentContent comments = vsSource.Comments;
            //CommentItem projItem = new CommentItem("R:Project",
            //    CommentItemType.Project);
            //projItem.Value.Add(new CommentPart("Summary of the project",
            //    CommentPartType.Summary));
            //comments.Add(projItem);
            //CommentItem nsItem = new CommentItem("N:TestLibraryCLR",
            //    CommentItemType.Namespace);
            //nsItem.Value.Add(new CommentPart("Summary of the namespace",
            //    CommentPartType.Summary));
            //comments.Add(nsItem);

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test Silverlight 5 Library", Guid.NewGuid().ToString(), vsSource);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: Silverlight 5";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing Silverlight 5";
            }

            //ReferenceContent apiContent = apiGroup.Content;
            //apiContent.FrameworkType = BuildFrameworkType.Framework20;

            //apiGroup.AddItem(projectDoc, null);
            //apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
            //    Path.Combine(outputDir, "SampleLibraryCLR.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, ""));

            apiGroup.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                  "Silverlight.Group" + BuildFileExts.ReferenceGroupExt));

            documenter.AddGroup(apiGroup);
        }
        private static void TestSolution(BuildDocumenter documenter,
                                         TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            string sourceFile =
                @"F:\SandcastleAssist\Main\Tests\SmartDeviceProjectCE\SmartDeviceProjectCE.csproj";
            ReferenceVsNetSource vsSource = new ReferenceVsNetSource();
            ReferenceVsNetItem   vsItem   = new ReferenceVsNetItem(
                new BuildFilePath(sourceFile));

            vsItem.XamlSyntax = false;
            vsSource.Add(vsItem);

            //CommentContent comments = vsSource.Comments;
            //CommentItem projItem = new CommentItem("R:Project",
            //    CommentItemType.Project);
            //projItem.Value.Add(new CommentPart("Summary of the project",
            //    CommentPartType.Summary));
            //comments.Add(projItem);
            //CommentItem nsItem = new CommentItem("N:TestLibraryCLR",
            //    CommentItemType.Namespace);
            //nsItem.Value.Add(new CommentPart("Summary of the namespace",
            //    CommentPartType.Summary));
            //comments.Add(nsItem);

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test Compact Framework Library", Guid.NewGuid().ToString(), vsSource);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: Compact Framework";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing Compact Framework";
            }

            //ReferenceContent apiContent = apiGroup.Content;
            //apiContent.FrameworkType = BuildFrameworkType.Framework20;

            //apiGroup.AddItem(projectDoc, null);
            //apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
            //    Path.Combine(outputDir, "SampleLibraryCLR.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, ""));

            documenter.AddGroup(apiGroup);
        }
Example #7
0
        private static void TestHierarchicalToc(BuildDocumenter documenter,
                                                TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            string libraryDir = Path.Combine(sampleDir, @"SampleHierarchicalToc\");

            string outputDir = Path.Combine(libraryDir, @"Output\");
            //string projectDoc = Path.Combine(outputDir, "Project.xml");

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test Hierarchical Toc References", TestGroupIds.TestTocLibGroupId);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: Test Hierarchical Toc";
            apiGroup.RootTopicId       = "d36e744f-c053-4e94-9ac9-b1ee054d8de1";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "HierarchicalToc Test References";
            }

            ReferenceContent apiContent = apiGroup.Content;

            apiGroup.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                  "HierarchicalToc" + BuildFileExts.ReferenceGroupExt));

            apiContent.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                    "HierarchicalToc" + BuildFileExts.ReferenceContentExt));

            apiContent.FrameworkType = BuildFrameworkType.Framework35;

            //apiGroup.AddItem(projectDoc, null);
            apiContent.AddItem(Path.Combine(outputDir, "SampleHierarchicalToc.xml"),
                               Path.Combine(outputDir, "SampleHierarchicalToc.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, "TestLibrary.dll"));

            documenter.AddGroup(apiGroup);
        }
Example #8
0
        private static void TestOthers0(BuildDocumenter documenter,
                                        TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            string libraryDir = Path.Combine(sampleDir, @"SampleTestLibraryCLR\");

            string outputDir = Path.Combine(libraryDir, @"Output\");
            //string projectDoc = Path.Combine(outputDir, "Project.xml");

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test CPP-CLR Library", Guid.NewGuid().ToString());

            apiGroup.RunningHeaderText = "Sandcastle Helpers: C++/CLR Library";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing C++/CLR Library";
            }

            ReferenceContent apiContent = apiGroup.Content;

            apiGroup.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                  "OtherReference" + BuildFileExts.ReferenceGroupExt));

            apiContent.ContentFile = new BuildFilePath(Path.Combine(workingDir,
                                                                    "OtherReference" + BuildFileExts.ReferenceContentExt));

            apiContent.FrameworkType = BuildFrameworkType.Framework20;

            //apiGroup.AddItem(projectDoc, null);
            apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
                               Path.Combine(outputDir, "SampleLibraryCLR.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, ""));

            documenter.AddGroup(apiGroup);
        }
Example #9
0
        private static void TestMain(BuildDocumenter documenter,
                                     TestOptions options, ReferenceEngineSettings engineSettings)
        {
            // Decide which version information to use...
            ReferenceVersionType versionType = ReferenceVersionType.Advanced;

            string libraryDir = Path.Combine(sampleDir, @"SampleLibrary\");

            string outputDir  = Path.Combine(libraryDir, @"Output\");
            string projectDoc = Path.Combine(outputDir, "Project.xml");

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test API References", TestGroupIds.TestLibGroupId);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: Test API Reference";

            if (engineSettings != null && engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "SampleLibrary Test References";
            }

            ReferenceContent apiContent = apiGroup.Content;

            apiContent.FrameworkType = BuildFrameworkType.Framework35;
            apiContent.AddItem(projectDoc, null);
            apiContent.AddItem(Path.Combine(outputDir, "TestLibrary.xml"),
                               Path.Combine(outputDir, "TestLibrary.dll"));

            apiGroup.AddSnippet(new CodeSnippetContent(Path.Combine(
                                                           libraryDir, "CodeSnippetSample.snippets")));

            string helpTestDir = Path.Combine(sampleDir, @"SampleTopics\");
            string mediaLinks  = Path.Combine(helpTestDir, "MediaContent.media");

            apiGroup.AddMedia(new MediaContent(mediaLinks,
                                               Path.Combine(helpTestDir, "Media")));

            // Create and add an API filter...
            ReferenceNamespaceFilter namespaceFilter =
                new ReferenceNamespaceFilter("TestLibrary", true);

            namespaceFilter.Add(new ReferenceTypeFilter("Point3D", false, false));

            apiContent.TypeFilters.Add(namespaceFilter);

            documenter.AddGroup(apiGroup);

            ReferenceVersionInfo versionInfo = null;

            if (versionType == ReferenceVersionType.Advanced)
            {
                libraryDir = Path.Combine(sampleDir, @"SampleLibraryVersion\");
                outputDir  = Path.Combine(libraryDir, @"Output\");

                apiContent = new ReferenceContent();
                apiContent.FrameworkType = BuildFrameworkType.Framework20;
                apiContent.AddItem(Path.Combine(outputDir, "TestLibrary.xml"),
                                   Path.Combine(outputDir, "TestLibrary.dll"));

                versionInfo = new ReferenceVersionInfo();
                versionInfo.PlatformFilters = true;
                //versionInfo.PlatformId = "netfw";
                versionInfo.PlatformTitle = ".NET Framework";
                //versionInfo.VersionId = "netfw20";
                versionInfo.VersionLabel = "2.0";

                ReferenceVersionSource source = new ReferenceVersionSource();
                //source.VersionId    = "netfw10";
                source.VersionLabel = "1.0";
                source.Content      = apiContent;

                versionInfo.AddSource(source);

                apiGroup.VersionType = versionType;
                apiGroup.VersionInfo = versionInfo;
            }

            if (versionType == ReferenceVersionType.Advanced &&
                versionInfo != null)
            {
                libraryDir = Path.Combine(sampleDir, @"SampleLibrarySilverlight\");
                outputDir  = Path.Combine(libraryDir, @"Output\");

                apiContent = new ReferenceContent();
                apiContent.FrameworkType = BuildFrameworkType.Silverlight40;
                apiContent.AddItem(Path.Combine(outputDir, "TestLibrary.xml"),
                                   Path.Combine(outputDir, "TestLibrary.dll"));

                ReferenceVersionRelated relatedVersion = new ReferenceVersionRelated();
                relatedVersion.PlatformId = "silverlight_mobile";
                //relatedVersion.PlatformTitle = "Silverlight for Windows Phone";

                ReferenceVersionSource source = new ReferenceVersionSource();
                source.VersionId = "silverlight_mobile_v1";
                //source.VersionLabel = "Windows Phone OS 7.0";
                source.Content = apiContent;

                relatedVersion.Add(source);

                versionInfo.AddRelated(relatedVersion);
            }
        }
Example #10
0
        private static void TestSilverlightWPF(BuildDocumenter documenter,
                                               TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            // Decide which Caliburn Micro library to include: Silverlight or WPF
            bool useSilverlight = true;

            string libraryDir = Path.Combine(sampleDir, @"SampleLibrary\");

            if (useSilverlight)
            {
                string outputDir = Path.Combine(libraryDir, @"Libraries\Caliburn.Micro\Silverlight\");
                //string projectDoc = Path.Combine(outputDir, "Project.xml");

                ReferenceGroup apiGroup = new ReferenceGroup(
                    "Test Silverlight 4", Guid.NewGuid().ToString());
                apiGroup.RunningHeaderText = "Sandcastle Helpers: Test Silverlight 4.0";
                //apiGroup.RootTopicId = "d36e744f-c053-4e94-9ac9-b1ee054d8de1";
                apiGroup.SyntaxType        |= BuildSyntaxType.Xaml;
                apiGroup.EnableXmlnsForXaml = true;

                if (engineSettings.RootNamespaceContainer)
                {
                    apiGroup.RootNamespaceTitle = "Caliburn Micro for Silverlight 4.0 v1.0 RTW";
                }

                ReferenceContent apiContent = apiGroup.Content;
                apiContent.FrameworkType = BuildFrameworkType.Silverlight40;

                //apiGroup.AddItem(projectDoc, null);
                //apiContent.AddItem(Path.Combine(outputDir, "Caliburn.Micro.xml"),
                //    Path.Combine(outputDir, "Caliburn.Micro.dll"));
                ReferenceItem refItem = new ReferenceItem(
                    Path.Combine(outputDir, "Caliburn.Micro.xml"),
                    Path.Combine(outputDir, "Caliburn.Micro.dll"));
                //refItem.XamlSyntax = true;
                apiContent.Add(refItem);

                //apiContent.AddDependency(Path.Combine(outputDir, "System.Windows.Interactivity.dll"));

                documenter.AddGroup(apiGroup);
            }
            else
            {
                string outputDir = Path.Combine(libraryDir, @"Libraries\Caliburn.Micro\WPF\");
                //string projectDoc = Path.Combine(outputDir, "Project.xml");

                ReferenceGroup apiGroup = new ReferenceGroup(
                    "Test WPF .NET 4", Guid.NewGuid().ToString());
                apiGroup.RunningHeaderText = "Sandcastle Helpers: Test .NET Framework 4.0";
                //apiGroup.RootTopicId = "d36e744f-c053-4e94-9ac9-b1ee054d8de1";
                apiGroup.SyntaxType        |= BuildSyntaxType.Xaml;
                apiGroup.EnableXmlnsForXaml = true;

                if (engineSettings.RootNamespaceContainer)
                {
                    apiGroup.RootNamespaceTitle = "Caliburn Micro for WPF 4.0 v1.0 RTW";
                }

                ReferenceContent apiContent = apiGroup.Content;
                apiContent.FrameworkType = BuildFrameworkType.Framework40;

                //apiGroup.AddItem(projectDoc, null);
                //apiContent.AddItem(Path.Combine(outputDir, "Caliburn.Micro.xml"),
                //    Path.Combine(outputDir, "Caliburn.Micro.dll"));
                ReferenceItem refItem = new ReferenceItem(
                    Path.Combine(outputDir, "Caliburn.Micro.xml"),
                    Path.Combine(outputDir, "Caliburn.Micro.dll"));
                //refItem.XamlSyntax = true;
                apiContent.Add(refItem);

                //apiContent.AddDependency(Path.Combine(outputDir, "System.Windows.Interactivity.dll"));

                documenter.AddGroup(apiGroup);
            }
        }
Example #11
0
        private static void TestRedirection(BuildDocumenter documenter,
                                            TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            string libraryDir = Path.Combine(sampleDir, @"SampleLibrary\Libraries\");

            string outputDir  = Path.Combine(libraryDir, @"Redirects\");
            string projectDoc = Path.Combine(outputDir, "Project.xml");

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Testing Redirection", Guid.NewGuid().ToString());

            apiGroup.RunningHeaderText = "Sandcastle Helpers: Testing Assembly Redirection";

            apiGroup.SyntaxType        |= BuildSyntaxType.Xaml;
            apiGroup.EnableXmlnsForXaml = true;
            apiGroup.VersionType        = ReferenceVersionType.Assembly;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing Assembly Redirection";
            }

            ReferenceContent apiContent = apiGroup.Content;

            apiContent.FrameworkType = BuildFrameworkType.Framework40;

            apiContent.AddItem(projectDoc, null);
            ReferenceItem refItem = new ReferenceItem(
                Path.Combine(outputDir, "Tests.Drawings.xml"),
                Path.Combine(outputDir, "Tests.Drawings.dll"));

            //refItem.XamlSyntax = true;
            apiContent.Add(refItem);

            //apiContent.AddDependency(Path.Combine(outputDir, "Tests.Shapes.dll"));
            //apiContent.AddDependency(Path.Combine(outputDir, "Tests.Geometries.dll"));

            documenter.AddGroup(apiGroup);

            // Testing embedded documents...
            //apiGroup = new ReferenceGroup(
            //    "Testing Embeddeding", Guid.NewGuid().ToString());
            //apiGroup.ExcludeToc = true; //NOTE!!!
            //apiGroup.RunningHeaderText = "Sandcastle Helpers: Testing Assembly Redirection";

            //apiGroup.SyntaxType |= BuildSyntaxType.Xaml;
            //apiGroup.EnableXmlnsForXaml = true;
            //apiGroup.VersionType = ReferenceVersionType.Assembly;

            //if (engineSettings.RootNamespaceContainer)
            //{
            //    apiGroup.RootNamespaceTitle = "Testing Assembly Redirection";
            //}

            //apiContent = apiGroup.Content;
            //apiContent.FrameworkType = BuildFrameworkType.Framework40;
            //apiContent.AddItem(projectDoc, null);

            //apiContent.AddItem(projectDoc, null);
            //refItem = new ReferenceItem(
            //    Path.Combine(outputDir, "Tests.Shapes.xml"),
            //    Path.Combine(outputDir, "Tests.Shapes.dll"));
            //refItem.XamlSyntax = true;
            //apiContent.Add(refItem);

            //refItem = new ReferenceItem(
            //    Path.Combine(outputDir, "Tests.Geometries.xml"),
            //    Path.Combine(outputDir, "Tests.Geometries.dll"));
            //refItem.XamlSyntax = true;
            //apiContent.Add(refItem);

            //documenter.AddGroup(apiGroup);

            ReferenceLinkSource linkSource = new ReferenceLinkSource();

            refItem = new ReferenceItem(projectDoc, null);
            //refItem.XamlSyntax = true;
            linkSource.Add(refItem);

            refItem = new ReferenceItem(
                Path.Combine(outputDir, "Tests.Shapes.xml"),
                Path.Combine(outputDir, "Tests.Shapes.dll"));
            //refItem.XamlSyntax = true;
            linkSource.Add(refItem);

            refItem = new ReferenceItem(
                Path.Combine(outputDir, "Tests.Geometries.xml"),
                Path.Combine(outputDir, "Tests.Geometries.dll"));
            //refItem.XamlSyntax = true;
            linkSource.Add(refItem);

            engineSettings.AddLinkSource(linkSource);
        }
Example #12
0
        private static void TestXsdDocsWiX(BuildDocumenter documenter,
                                           TestOptions options)
        {
            string baseDir = Path.Combine(sampleDir, @"SampleXsdDocs\WiX\");

            if (!Directory.Exists(baseDir))
            {
                throw new InvalidOperationException(String.Format(
                                                        "The directory '{0}' does not exists.", baseDir));
            }

            // First add the conceptual contents for the topics...
            ConceptualGroup xsdGroup = new ConceptualGroup(
                "XsdDocs - WiX Schema", TestGroupIds.XsdDocsWizGroupId);

            xsdGroup.SyntaxType        = BuildSyntaxType.None;
            xsdGroup.RunningHeaderText = "Sandcastle XsdDocs: WiX Schema";

            ConceptualXsdDocSource xsdSource = new ConceptualXsdDocSource();

            // Use the default properties with the following changes...
            xsdSource.SchemaSetContainer = true;
            xsdSource.SchemaSetTitle     = "WiX Installer Schema References";
            xsdSource.TransformFileName  = new BuildFilePath(Path.Combine(baseDir,
                                                                          "AnnotationTranform.xslt"));

            IList <BuildFilePath> documentFiles = xsdSource.ExternalDocumentFileNames;

            if (documentFiles == null)
            {
                documentFiles = new BuildList <BuildFilePath>();
                xsdSource.ExternalDocumentFileNames = documentFiles;
            }
            documentFiles.Add(new BuildFilePath(Path.Combine(baseDir,
                                                             "SchemaSetDoc.xml")));

            IList <BuildFilePath> schemaFiles = xsdSource.SchemaFileNames;

            if (schemaFiles == null)
            {
                schemaFiles = new BuildList <BuildFilePath>();
                xsdSource.SchemaFileNames = schemaFiles;
            }
            string[] files = Directory.GetFiles(Path.Combine(baseDir, "Schemas"));
            if (files == null || files.Length == 0)
            {
                return;
            }
            for (int i = 0; i < files.Length; i++)
            {
                schemaFiles.Add(new BuildFilePath(files[i]));
            }
            IDictionary <string, string> nsRenaming = xsdSource.NamespaceRenaming;

            if (nsRenaming == null)
            {
                nsRenaming = new BuildProperties();
                xsdSource.NamespaceRenaming = nsRenaming;
            }
            nsRenaming["http://schemas.microsoft.com/wix/2006/localization"]
                = "Localization Schema";
            nsRenaming["http://schemas.microsoft.com/wix/2006/wi"]
                = "Database Schema";
            nsRenaming["http://schemas.microsoft.com/wix/ComPlusExtension"]
                = "COM+ Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/DifxAppExtension"]
                = "Driver Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/FirewallExtension"]
                = "Firewall Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/GamingExtension"]
                = "Gaming Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/IIsExtension"]
                = "IIS Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/MsmqExtension"]
                = "MSMQ Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/NetFxExtension"]
                = ".NET Framework Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/PSExtension"]
                = "PowerShell Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/SqlExtension"]
                = "SQL Server Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/UtilExtension"]
                = "Utility Extension Schema";
            nsRenaming["http://schemas.microsoft.com/wix/VSExtension"]
                = "Visual Studio Extension Schema";

            xsdGroup.Source = xsdSource;

            documenter.AddGroup(xsdGroup);
        }
        private static void TestOther2(BuildDocumenter documenter,
                                       TestOptions options, ReferenceEngineSettings engineSettings)
        {
            if (tocType == CustomTocType.ReferenceRoot)
            {
                return;
            }

            //string libraryDir = Path.Combine(sampleDir, @"SampleTestLibraryCLR\");
            //string outputDir = Path.Combine(libraryDir, @"Output\");
            //string projectDoc = Path.Combine(outputDir, "Project.xml");

            //string sourceFile =
            //    @"F:\SandcastleAssist\Development\Source\Tests\MvcApplication1\MvcApplication1.sln";
            string sourceFile =
                @"F:\SandcastleAssist\Development\Source\Tests\MvcApplication2\MvcApplication2.csproj";
            ReferenceVsNetSource vsSource = new ReferenceVsNetSource();
            ReferenceVsNetItem   vsItem   = new ReferenceVsNetItem(
                new BuildFilePath(sourceFile));

            vsItem.XamlSyntax = false;
            vsSource.Add(vsItem);

            //CommentContent comments = vsSource.Comments;
            //CommentItem projItem = new CommentItem("R:Project",
            //    CommentItemType.Project);
            //projItem.Value.Add(new CommentPart("Summary of the project",
            //    CommentPartType.Summary));
            //comments.Add(projItem);
            //CommentItem nsItem = new CommentItem("N:TestLibraryCLR",
            //    CommentItemType.Namespace);
            //nsItem.Value.Add(new CommentPart("Summary of the namespace",
            //    CommentPartType.Summary));
            //comments.Add(nsItem);

            ReferenceGroup apiGroup = new ReferenceGroup(
                "Test ASP.NET MVC Library", Guid.NewGuid().ToString(), vsSource);

            apiGroup.RunningHeaderText = "Sandcastle Helpers: ASP.NET MVC";

            apiGroup.VersionType = ReferenceVersionType.AssemblyAndFile;

            if (engineSettings.RootNamespaceContainer)
            {
                apiGroup.RootNamespaceTitle = "Testing ASP.NET MVC";
            }

            //ReferenceContent apiContent = apiGroup.Content;
            //apiContent.FrameworkType = BuildFrameworkType.Framework20;

            //apiGroup.AddItem(projectDoc, null);
            //apiContent.AddItem(Path.Combine(outputDir, "SampleLibraryCLR.xml"),
            //    Path.Combine(outputDir, "SampleLibraryCLR.dll"));

            //apiContent.AddDependency(Path.Combine(outputDir, ""));

            documenter.AddGroup(apiGroup);

            //ReferenceLinkSource linkSource = new ReferenceLinkSource();
            //linkSource.LinkType = BuildLinkType.Msdn;
            //linkSource.Title = "ASP.NET MVC 3 Framework";
            //linkSource.FrameworkType = BuildFrameworkType.Framework40;

            //string aspMVCDir =
            //    @"E:\Program Files\Microsoft ASP.NET\ASP.NET MVC 3\Assemblies";

            //ReferenceItem refItem = new ReferenceItem(
            //    Path.Combine(aspMVCDir, "System.Web.Mvc.xml"),
            //    Path.Combine(aspMVCDir, "System.Web.Mvc.dll"));
            ////refItem.XamlSyntax = true;
            //linkSource.Add(refItem);

            //engineSettings.AddLinkSource(linkSource);

            engineSettings.WebMvcSdkType = BuildSpecialSdkType.WebMvc04;
        }