Initial commit of XsdDoc, an XML schema documentation plug-in for SHFB

Build/Build.bat

@@ -0,0 +1,5 @@
+@echo off
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" Build.proj /t:Build
+
+PAUSE

Build/Build.proj

@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="3.5">
+
+	<!-- Build Settings -->
+
+	<PropertyGroup>
+		<BuildDir>$(MSBuildProjectDirectory)\</BuildDir>
+		<ProjectDir>$(BuildDir)..\</ProjectDir>
+		<SourceDir>$(ProjectDir)Source\</SourceDir>
+		<SetupDir>$(ProjectDir)Setup\</SetupDir>
+		<LibDir>$(ProjectDir)Lib\</LibDir>
+		<HelpDir>$(ProjectDir)Help\</HelpDir>
+		<SamplesDir>$(ProjectDir)Samples\</SamplesDir>
+		<OutputDir>$(ProjectDir)Output\</OutputDir>
+		<GeneratedBinaries>$(OutputDir)Bin\</GeneratedBinaries>
+		<GeneratedHelp>$(OutputDir)Help\</GeneratedHelp>
+		<GeneratedSetup>$(OutputDir)Setup\</GeneratedSetup>
+		<GeneratedSourceCode>$(OutputDir)Source\</GeneratedSourceCode>
+		<GeneratedSamples>$(OutputDir)Samples\</GeneratedSamples>
+		<GeneratedRelease>$(OutputDir)Release\</GeneratedRelease>
+		<Configuration>Release</Configuration>
+	</PropertyGroup>
+
+	<!-- External projects -->
+
+	<Import Project="$(MSBuildExtensionsPath)\MSBuildCommunityTasks\MSBuild.Community.Tasks.Targets"/>
+
+	<!-- Build -->
+
+	<Target Name="Build">
+		<CallTarget Targets="Clean" />
+		<CallTarget Targets="Compile" />
+		<CallTarget Targets="GenerateHelp" />
+		<CallTarget Targets="GenerateSetup" />
+		<CallTarget Targets="GenerateSourceCode" />
+		<CallTarget Targets="GenerateSamples" />
+		<CallTarget Targets="GenerateRelease" />
+	</Target>
+
+	<!-- Clean -->
+
+	<Target Name="Clean">
+		<ItemGroup>
+			<AllSolutionFiles Include="$(SourceDir)**\*.sln" />
+			<AllSolutionFiles Include="$(SetupDir)**\*.sln" />
+			<CompilationFiles Include="$(ProjectDir)**\bin\**\*.*" />
+			<CompilationFiles Include="$(ProjectDir)**\obj\**\*.*" />
+		</ItemGroup>
+		<MSBuild Projects="@(AllSolutionFiles)" Targets="Clean" />
+		<Delete Files="@(CompilationFiles)" />
+		<RemoveDir Directories="$(CustomTasksDir)" />
+		<RemoveDir Directories="$(OutputDir)" />
+	</Target>
+
+	<!-- Compile -->
+
+	<Target Name="Compile">
+		<MSBuild Projects="$(SourceDir)XsdDocumentation.sln"
+				 Properties="Configuration=$(Configuration);OutDir=$(GeneratedBinaries);PostBuildEvent=" />
+	</Target>
+
+	<Target Name="GenerateHelp">
+		<MSBuild Projects="$(HelpDir)Help.shfbproj" />
+	</Target>
+
+	<!-- Generate Setup -->
+
+	<Target Name="GenerateSetup">
+		<MSBuild Projects="$(SetupDir)Setup.sln" Targets="Rebuild"
+				 Properties="Configuration=$(Configuration);OutDir=$(GeneratedSetup);" />
+	</Target>
+
+	<!-- Generate Source Code -->
+
+	<Target Name="GenerateSourceCode">
+		<ItemGroup>
+			<SourceCodeFiles Include="$(ProjectDir)**\*.*"
+							 Exclude="$(ProjectDir)**\.svn\**\*.*;$(OutputDir)**\*.*;$(LibDir)**\*.*;$(CustomTasksDir)**\*.*;$(ProjectDir)**\bin\**\*.*;$(ProjectDir)**\obj\**\*.*;$(ProjectDir)**\*.scc;$(ProjectDir)**\*.vssscc;$(ProjectDir)**\*.vspscc;$(ProjectDir)**\*.suo;$(ProjectDir)**\*.cache;$(ProjectDir)**\*.user;$(ProjectDir)**\*.resharper" />
+		</ItemGroup>
+
+		<Copy SourceFiles="@(SourceCodeFiles)" DestinationFolder="$(GeneratedSourceCode)%(RecursiveDir)" />
+		<Exec Command="attrib -r -h /s" WorkingDirectory="$(GeneratedSourceCode)" />
+	</Target>
+
+	<!-- Generate Samples -->
+
+	<Target Name="GenerateSamples">
+		<ItemGroup>
+			<Sample Include="$(SamplesDir)**\*.shfbproj" />
+		</ItemGroup>
+
+		<MSBuild Projects="@(Sample)" />
+
+		<ItemGroup>
+			<GeneratedSample Include="$(GeneratedSamples)**\*.chm" />
+		</ItemGroup>
+
+		<Copy SourceFiles="@(GeneratedSample)" DestinationFolder="$(GeneratedSamples)" />
+		<RemoveDir Directories="%(GeneratedSample.RootDir)%(GeneratedSample.Directory)" />
+	</Target>
+
+	<!-- Generate Release -->
+
+	<Target Name="GenerateRelease">
+		<ItemGroup>
+			<GeneratedSourceCodeFiles Include="$(GeneratedSourceCode)\**\*.*" />
+			<GeneratedSetupFiles Include="$(GeneratedSetup)\**\*.*" />
+			<GeneratedSampleFiles Include="$(GeneratedSamples)\**\*.*" />
+		</ItemGroup>
+
+		<RemoveDir Directories="$(GeneratedRelease)" />
+		<MakeDir Directories="$(GeneratedRelease)" />
+		<Zip WorkingDirectory="$(GeneratedSourceCode)" Files="@(GeneratedSourceCodeFiles)" ZipFileName="$(GeneratedRelease)Source.zip" />
+		<Zip WorkingDirectory="$(GeneratedSetup)" Files="@(GeneratedSetupFiles)" ZipFileName="$(GeneratedRelease)Setup.zip" />
+		<Zip WorkingDirectory="$(GeneratedSamples)" Files="@(GeneratedSampleFiles)" ZipFileName="$(GeneratedRelease)Samples.zip" />
+	</Target>
+</Project>

Build/Clean.bat

@@ -0,0 +1,5 @@
+@echo off
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" Build.proj /t:Clean
+
+PAUSE

Build/Compile Debug Build.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:Compile /p:Configuration=Debug
+
+PAUSE

Build/Compile Release Build.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:Compile /p:Configuration=Release
+
+PAUSE

Build/Generate Help.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:GenerateHelp
+
+PAUSE

Build/Generate Release.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:GenerateRelease
+
+PAUSE

Build/Generate Samples.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:GenerateSamples
+
+PAUSE

Build/Generate Setup.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:GenerateSetup
+
+PAUSE

Build/Generate Source Code.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+
+"%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe" /nologo /t:GenerateSourceCode
+
+PAUSE

Etc/Samples/AnnotationTransform/MySchema.xsd

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema targetNamespace="http://schemas.example.com/MySchema"
+		   elementFormDefault="qualified"
+		   xmlns="http://schemas.example.com/MySchema"
+		   xmlns:xs="http://www.w3.org/2001/XMLSchema"
+		   xmlns:doc="http://schemas.example.com/MyDocSchema">
+	<xs:element name="root" type="xs:string">
+		<xs:annotation>
+			<xs:documentation>
+				This is my standard summary.
+			</xs:documentation>
+			<xs:appinfo>
+				<doc:seeAlso namespace="http://schemas.example.com/MySchema" element="otherRoot1" />
+				<doc:seeAlso namespace="http://schemas.example.com/MySchema" element="otherRoot2" />
+				<doc:remarks>
+					These are my custom remarks.
+				</doc:remarks>
+			</xs:appinfo>
+		</xs:annotation>
+	</xs:element>
+
+	<xs:element name="otherRoot1" type="xs:string" />
+	<xs:element name="otherRoot2" type="xs:string" />
+</xs:schema>

Etc/Samples/AnnotationTransform/MyTransform.xslt

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsl:stylesheet version="1.0"
+				xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+				xmlns:xsd="http://tempuri.org/XMLSchema.xsd"
+				xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5"
+				xmlns:xs="http://www.w3.org/2001/XMLSchema"
+				xmlns:doc="http://schemas.example.com/MyDocSchema">
+	<xsl:output method="xml" indent="yes"/>
+
+	<xsl:template match="*">
+		<xsl:variable name="summary" select="xs:annotation/xs:documentation" />
+		<xsl:variable name="remarks" select="xs:annotation/xs:appinfo/doc:remarks" />
+		<xsl:variable name="seeAlsos" select="xs:annotation/xs:appinfo/doc:seeAlso" />
+
+		<xsd:schemaDoc>
+			<ddue:summary>
+				<ddue:para>
+					<xsl:apply-templates select="$summary/@*|$summary/node()" mode="copy"/>
+				</ddue:para>
+			</ddue:summary>
+			<xsl:if test="$remarks">
+				<ddue:remarks>
+					<ddue:content>
+						<ddue:para>
+							<xsl:apply-templates select="$remarks/@*|$remarks/node()" mode="copy"/>
+						</ddue:para>
+					</ddue:content>
+				</ddue:remarks>
+			</xsl:if>
+			<xsl:if test="$seeAlsos">
+				<ddue:relatedTopics>
+					<xsl:for-each select="$seeAlsos">
+						<xsd:xmlEntityReference xml:space="preserve"><xsl:value-of select="@namespace"/>#E/<xsl:value-of select="@element"/></xsd:xmlEntityReference>
+					</xsl:for-each>
+				</ddue:relatedTopics>
+			</xsl:if>
+		</xsd:schemaDoc>
+	</xsl:template>
+
+	<xsl:template match="@*|node()" mode="copy">
+		<xsl:copy>
+			<xsl:apply-templates select="@*|node()" mode="copy"/>
+		</xsl:copy>
+	</xsl:template>
+
+</xsl:stylesheet>

Etc/Samples/Chameleon/Chameleon.xsd

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema id="Chameleon"
+    elementFormDefault="qualified"
+    xmlns:xs="http://www.w3.org/2001/XMLSchema"
+>
+	<xs:element name="chameleonElement" type="xs:string" />
+</xs:schema>

Etc/Samples/Chameleon/User1.xsd

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema id="User1"
+    targetNamespace="http://tempuri.org/User1.xsd"
+    elementFormDefault="qualified"
+    xmlns="http://tempuri.org/User1.xsd"
+    xmlns:mstns="http://tempuri.org/User1.xsd"
+    xmlns:xs="http://www.w3.org/2001/XMLSchema"
+>
+	<xs:include schemaLocation="Chameleon.xsd" />
+
+	<xs:element name="user1">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element ref="chameleonElement" />
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

Etc/Samples/Chameleon/User2.xsd

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema id="User2"
+    targetNamespace="http://tempuri.org/User2.xsd"
+    elementFormDefault="qualified"
+    xmlns="http://tempuri.org/User2.xsd"
+    xmlns:mstns="http://tempuri.org/User2.xsd"
+    xmlns:xs="http://www.w3.org/2001/XMLSchema"
+>
+	<xs:include schemaLocation="Chameleon.xsd" />
+
+	<xs:element name="User2">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element ref="chameleonElement" />
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

Etc/Samples/ExclusionDifferentNamespace/Schema.xsd

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema targetNamespace="http://tempuri.org/Schema.xsd"
+		   elementFormDefault="qualified"
+		   xmlns="http://tempuri.org/Schema.xsd"
+		   xmlns:xs="http://www.w3.org/2001/XMLSchema"
+		   xmlns:sd="http://tempuri.org/SchemaDependency.xsd">
+	<xs:import namespace="http://tempuri.org/SchemaDependency.xsd" schemaLocation="SchemaDependency.xsd" />
+
+	<xs:element name="root">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element ref="sd:ElementDependency" />
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

Etc/Samples/ExclusionDifferentNamespace/SchemaDependency.xsd

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema targetNamespace="http://tempuri.org/SchemaDependency.xsd"
+		   elementFormDefault="qualified"
+		   xmlns="http://tempuri.org/SchemaDependency.xsd"
+		   xmlns:xs="http://www.w3.org/2001/XMLSchema">
+	<xs:element name="ElementDependency">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element ref="ElementDependency" minOccurs="0" maxOccurs="unbounded" />
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

Etc/Samples/ExclusionSameNamespace/Schema.xsd

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema targetNamespace="http://tempuri.org/Exclusion"
+		   elementFormDefault="qualified"
+		   xmlns="http://tempuri.org/Exclusion"
+		   xmlns:xs="http://www.w3.org/2001/XMLSchema">
+	<xs:include schemaLocation="SchemaDependency.xsd" />
+
+	<xs:element name="root">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element ref="ElementDependency" />
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

Etc/Samples/ExclusionSameNamespace/SchemaDependency.xsd

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema targetNamespace="http://tempuri.org/Exclusion"
+		   elementFormDefault="qualified"
+		   xmlns="http://tempuri.org/Exclusion"
+		   xmlns:xs="http://www.w3.org/2001/XMLSchema">
+	<xs:element name="ElementDependency">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element ref="ElementDependency" minOccurs="0" maxOccurs="unbounded" />
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

Etc/Samples/Test/EmptyNamespace.xsd

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema id="EmptyNamespace"
+    elementFormDefault="qualified"
+    xmlns:xs="http://www.w3.org/2001/XMLSchema"
+>
+	<xs:element name="root" type="enum" />
+
+	<xs:simpleType name="enum">
+		<xs:restriction base="xs:NMTOKEN">
+			<xs:enumeration value="Auto" />
+			<xs:enumeration value="Value1" />
+			<xs:enumeration value="Value2" />
+			<xs:enumeration value="Value3" />
+		</xs:restriction>
+	</xs:simpleType>
+</xs:schema>