snow/asternet
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Added sandcadstle documentation project

Browse source
This commit is contained in:
Skrusty 2015-01-05 19:30:54 +00:00
parent 3c34e430d0
commit 59f7d9a4e9
8 changed files with 230 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
Asterisk.2013/Asterisk.2013.sln
View file

@ -6,6 +6,7 @@ MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{80ADC18F-2BFC-4B79-B264-5244E4F2FEED}" Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{80ADC18F-2BFC-4B79-B264-5244E4F2FEED}"
ProjectSection(SolutionItems) = preProject ProjectSection(SolutionItems) = preProject
ChangeLog.txt = ChangeLog.txt ChangeLog.txt = ChangeLog.txt
..\README.md = ..\README.md
EndProjectSection EndProjectSection
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsterNET", "Asterisk.NET\AsterNET.csproj", "{BC6E7DBA-C05A-45FE-A2A3-B1637CE16274}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsterNET", "Asterisk.NET\AsterNET.csproj", "{BC6E7DBA-C05A-45FE-A2A3-B1637CE16274}"
@ -14,6 +15,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsterNET.WinForm", "Asteris
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsterNET.Test", "Asterisk.NET.Test\Asterisk.NET.Test\AsterNET.Test.csproj", "{B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsterNET.Test", "Asterisk.NET.Test\Asterisk.NET.Test\AsterNET.Test.csproj", "{B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}"
EndProject EndProject
Project("{7CF6DF6D-3B04-46F8-A40B-537D21BCA0B4}") = "Documentation", "Documentation\Documentation.shfbproj", "{186124F7-82FA-4562-8B87-33D53A84E8BA}"
EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU Debug|Any CPU = Debug|Any CPU
@ -32,6 +35,10 @@ Global
{B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}.Debug|Any CPU.Build.0 = Debug|Any CPU {B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}.Release|Any CPU.ActiveCfg = Release|Any CPU {B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}.Release|Any CPU.Build.0 = Release|Any CPU {B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}.Release|Any CPU.Build.0 = Release|Any CPU
{186124F7-82FA-4562-8B87-33D53A84E8BA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{186124F7-82FA-4562-8B87-33D53A84E8BA}.Debug|Any CPU.Build.0 = Debug|Any CPU
{186124F7-82FA-4562-8B87-33D53A84E8BA}.Release|Any CPU.ActiveCfg = Release|Any CPU
{186124F7-82FA-4562-8B87-33D53A84E8BA}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection EndGlobalSection
GlobalSection(SolutionProperties) = preSolution GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE HideSolutionNode = FALSE

3
Asterisk.2013/ChangeLog.txt
View file

@ -1,3 +1,6 @@
05.01.2015 (Skrusty)
Added a sandcastle documentation project to AsterNET. Initial draft includes CHM and HTML output based on AsterNET 1.0.0.
03.01.2015 (Skrusty) 03.01.2015 (Skrusty)
Code tidy, comments cleaned up,moved to auto properties, using's cleaned up Code tidy, comments cleaned up,moved to auto properties, using's cleaned up

33
Asterisk.2013/Documentation/Content/VersionHistory/VersionHistory.aml Normal file
View file

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="100303f2-3dd8-401b-a594-579aae2a939c" revisionNumber="1">
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<introduction>
<para>The topics in this section describe the various changes made to the [TODO: Project Title] over the
life of the project.</para>
</introduction>
<section>
<title>Version History</title>
<content>
<para>Select a version below to see a description of its changes.</para>
<list class="bullet">
<listItem>
<para><link xlink:href="d9cb48f8-c21b-4dbb-96d8-c726593f257e" /></para>
</listItem>
<listItem>
<para>[TODO: Add links to each specific version page]</para>
</listItem>
</list>
</content>
</section>
<relatedTopics>
<link xlink:href="79b6241e-05a3-441c-b6a1-51f2b5b7f265" />
</relatedTopics>
</developerConceptualDocument>
</topic>

28
Asterisk.2013/Documentation/Content/VersionHistory/v1.0.0.0.aml Normal file
View file

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="d9cb48f8-c21b-4dbb-96d8-c726593f257e" revisionNumber="1">
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<introduction>
<para>Version [TODO: Version] was released on [TODO: Date].
</para>
</introduction>
<section>
<title>Changes in This Release</title>
<content>
<list class="bullet">
<listItem>
<para>[TODO: Add change items here]</para>
</listItem>
</list>
</content>
</section>
<relatedTopics>
<link xlink:href="100303f2-3dd8-401b-a594-579aae2a939c" />
</relatedTopics>
</developerConceptualDocument>
</topic>

55
Asterisk.2013/Documentation/Content/Welcome.aml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="79b6241e-05a3-441c-b6a1-51f2b5b7f265" revisionNumber="1">
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<introduction>
<para>This is a sample conceptual topic. You can use this as a starting point for adding more conceptual
content to your help project.</para>
</introduction>
<section>
<title>Getting Started</title>
<content>
<para>To get started, add a documentation source to the project (a Visual Studio solution, project, or
assembly and XML comments file). See the <legacyBold>Getting Started</legacyBold> topics in the Sandcastle Help
File Builder's help file for more information. The following default items are included in this project:</para>
<list class="bullet">
<listItem>
<para><localUri>ContentLayout.content</localUri> - Use the content layout file to manage the
conceptual content in the project and define its layout in the table of contents.</para>
</listItem>
<listItem>
<para>The <localUri>.\Media</localUri> folder - Place images in this folder that you will reference
from conceptual content using <codeInline>medialLink</codeInline> or <codeInline>mediaLinkInline</codeInline>
elements. If you will not have any images in the file, you may remove this folder.</para>
</listItem>
<listItem>
<para>The <localUri>.\icons</localUri> folder - This contains a default logo for the help file. You
may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update
the <ui>Transform Args</ui> project properties page by removing or changing the filename in the
<codeInline>logoFile</codeInline> transform argument. Note that unlike images referenced from conceptual topics,
the logo file should have its <legacyBold>BuildAction</legacyBold> property set to <codeInline>Content</codeInline>.</para>
</listItem>
<listItem>
<para>The <localUri>.\Content</localUri> folder - Use this to store your conceptual topics. You may
name the files and organize them however you like. One suggestion is to lay the files out on disk as you have
them in the content layout file as shown in this project but the choice is yours. Files can be added via the
Solution Explorer or from within the content layout file editor. Files must appear in the content layout file
in order to be compiled into the help file.</para>
</listItem>
</list>
<para>See the <legacyBold>Conceptual Content</legacyBold> topics in the Sandcastle Help File Builder's
help file for more information. See the <legacyBold> Sandcastle MAML Guide</legacyBold> for details on Microsoft
Assistance Markup Language (MAML) which is used to create these topics.</para>
</content>
</section>
<relatedTopics>
<link xlink:href="100303f2-3dd8-401b-a594-579aae2a939c" />
</relatedTopics>
</developerConceptualDocument>
</topic>

18
Asterisk.2013/Documentation/ContentLayout.content Normal file
View file

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<Topics>
<Topic id="79b6241e-05a3-441c-b6a1-51f2b5b7f265" visible="True" isDefault="true" isSelected="true" title="Welcome to the [TODO: Add project name]">
<HelpKeywords>
<HelpKeyword index="K" term="Welcome" />
</HelpKeywords>
</Topic>
<Topic id="100303f2-3dd8-401b-a594-579aae2a939c" visible="True" isExpanded="true" title="Version History">
<HelpKeywords>
<HelpKeyword index="K" term="version, history" />
</HelpKeywords>
<Topic id="d9cb48f8-c21b-4dbb-96d8-c726593f257e" visible="True" title="Version 1.0.0.0">
<HelpKeywords>
<HelpKeyword index="K" term="version, 1.0.0.0" />
</HelpKeywords>
</Topic>
</Topic>
</Topics>

86
Asterisk.2013/Documentation/Documentation.shfbproj Normal file
View file

@ -0,0 +1,86 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
<PropertyGroup>
<!-- The configuration and platform will be used to determine which assemblies to include from solution and
project documentation sources -->
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>186124f7-82fa-4562-8b87-33d53a84e8ba</ProjectGuid>
<SHFBSchemaVersion>1.9.9.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
<AssemblyName>Documentation</AssemblyName>
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
<FrameworkVersion>.NET Framework 4.0</FrameworkVersion>
<OutputPath>.\Help\</OutputPath>
<HtmlHelpName>Documentation</HtmlHelpName>
<Language>en-US</Language>
<TransformComponentArguments>
<Argument Key="logoFile" Value="Help.png" xmlns="" />
<Argument Key="logoHeight" Value="" xmlns="" />
<Argument Key="logoWidth" Value="" xmlns="" />
<Argument Key="logoAltText" Value="" xmlns="" />
<Argument Key="logoPlacement" Value="left" xmlns="" />
<Argument Key="logoAlignment" Value="left" xmlns="" />
<Argument Key="maxVersionParts" Value="" xmlns="" />
</TransformComponentArguments>
<DocumentationSources>
<DocumentationSource sourceFile="..\Asterisk.NET\bin\Debug\AsterNET.dll" xmlns="" />
<DocumentationSource sourceFile="..\Asterisk.NET\bin\Debug\AsterNET.xml" xmlns="" />
</DocumentationSources>
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
<HelpFileFormat>HtmlHelp1, Website</HelpFileFormat>
<IndentHtml>False</IndentHtml>
<KeepLogFile>True</KeepLogFile>
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
<CppCommentsFixup>False</CppCommentsFixup>
<CleanIntermediates>True</CleanIntermediates>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
</PropertyGroup>
<ItemGroup>
<Folder Include="Content" />
<Folder Include="Content\Examples" />
<Folder Include="Content\VersionHistory" />
<Folder Include="icons" />
<Folder Include="Media" />
</ItemGroup>
<ItemGroup>
<None Include="Content\VersionHistory\v1.0.0.0.aml" />
<None Include="Content\VersionHistory\VersionHistory.aml" />
<None Include="Content\Welcome.aml" />
</ItemGroup>
<ItemGroup>
<ContentLayout Include="ContentLayout.content" />
</ItemGroup>
<ItemGroup>
<Content Include="icons\Help.png" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\Asterisk.NET\AsterNET.csproj">
<Name>AsterNET</Name>
<Project>{bc6e7dba-c05a-45fe-a2a3-b1637ce16274}</Project>
<Private>True</Private>
</ProjectReference>
</ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>

BIN
Asterisk.2013/Documentation/icons/Help.png Normal file
View file

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB