diff --git a/Asterisk.2013/Asterisk.2013.sln b/Asterisk.2013/Asterisk.2013.sln index d28109b..8e79ab9 100644 --- a/Asterisk.2013/Asterisk.2013.sln +++ b/Asterisk.2013/Asterisk.2013.sln @@ -6,6 +6,7 @@ MinimumVisualStudioVersion = 10.0.40219.1 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{80ADC18F-2BFC-4B79-B264-5244E4F2FEED}" ProjectSection(SolutionItems) = preProject ChangeLog.txt = ChangeLog.txt + ..\README.md = ..\README.md EndProjectSection EndProject 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 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsterNET.Test", "Asterisk.NET.Test\Asterisk.NET.Test\AsterNET.Test.csproj", "{B82B8EBF-8180-401D-8D3A-4BF7CFDB7A08}" EndProject +Project("{7CF6DF6D-3B04-46F8-A40B-537D21BCA0B4}") = "Documentation", "Documentation\Documentation.shfbproj", "{186124F7-82FA-4562-8B87-33D53A84E8BA}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution 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}.Release|Any CPU.ActiveCfg = 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 GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/Asterisk.2013/ChangeLog.txt b/Asterisk.2013/ChangeLog.txt index 5201c99..65924a6 100644 --- a/Asterisk.2013/ChangeLog.txt +++ b/Asterisk.2013/ChangeLog.txt @@ -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) Code tidy, comments cleaned up,moved to auto properties, using's cleaned up diff --git a/Asterisk.2013/Documentation/Content/VersionHistory/VersionHistory.aml b/Asterisk.2013/Documentation/Content/VersionHistory/VersionHistory.aml new file mode 100644 index 0000000..81cc1e3 --- /dev/null +++ b/Asterisk.2013/Documentation/Content/VersionHistory/VersionHistory.aml @@ -0,0 +1,33 @@ + + + + + The topics in this section describe the various changes made to the [TODO: Project Title] over the +life of the project. + + +
+ Version History + + Select a version below to see a description of its changes. + + + + + + + + [TODO: Add links to each specific version page] + + + + + +
+ + + + + +
+
diff --git a/Asterisk.2013/Documentation/Content/VersionHistory/v1.0.0.0.aml b/Asterisk.2013/Documentation/Content/VersionHistory/v1.0.0.0.aml new file mode 100644 index 0000000..bf9b584 --- /dev/null +++ b/Asterisk.2013/Documentation/Content/VersionHistory/v1.0.0.0.aml @@ -0,0 +1,28 @@ + + + + + Version [TODO: Version] was released on [TODO: Date]. + + + +
+ Changes in This Release + + + + + [TODO: Add change items here] + + + + + +
+ + + + + +
+
diff --git a/Asterisk.2013/Documentation/Content/Welcome.aml b/Asterisk.2013/Documentation/Content/Welcome.aml new file mode 100644 index 0000000..4bc179b --- /dev/null +++ b/Asterisk.2013/Documentation/Content/Welcome.aml @@ -0,0 +1,55 @@ + + + + + This is a sample conceptual topic. You can use this as a starting point for adding more conceptual +content to your help project. + + +
+ Getting Started + + To get started, add a documentation source to the project (a Visual Studio solution, project, or +assembly and XML comments file). See the Getting Started topics in the Sandcastle Help +File Builder's help file for more information. The following default items are included in this project: + + + + ContentLayout.content - Use the content layout file to manage the +conceptual content in the project and define its layout in the table of contents. + + + + The .\Media folder - Place images in this folder that you will reference +from conceptual content using medialLink or mediaLinkInline +elements. If you will not have any images in the file, you may remove this folder. + + + + The .\icons 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 Transform Args project properties page by removing or changing the filename in the +logoFile transform argument. Note that unlike images referenced from conceptual topics, +the logo file should have its BuildAction property set to Content. + + + + The .\Content 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. + + + + See the Conceptual Content topics in the Sandcastle Help File Builder's +help file for more information. See the Sandcastle MAML Guide for details on Microsoft +Assistance Markup Language (MAML) which is used to create these topics. + +
+ + + + +
+
diff --git a/Asterisk.2013/Documentation/ContentLayout.content b/Asterisk.2013/Documentation/ContentLayout.content new file mode 100644 index 0000000..da18f12 --- /dev/null +++ b/Asterisk.2013/Documentation/ContentLayout.content @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Asterisk.2013/Documentation/Documentation.shfbproj b/Asterisk.2013/Documentation/Documentation.shfbproj new file mode 100644 index 0000000..79d5213 --- /dev/null +++ b/Asterisk.2013/Documentation/Documentation.shfbproj @@ -0,0 +1,86 @@ + + + + + Debug + AnyCPU + 2.0 + 186124f7-82fa-4562-8b87-33d53a84e8ba + 1.9.9.0 + + Documentation + Documentation + Documentation + + .NET Framework 4.0 + .\Help\ + Documentation + en-US + + + + + + + + + + + + + + OnlyWarningsAndErrors + HtmlHelp1, Website + False + True + False + False + True + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AsterNET + {bc6e7dba-c05a-45fe-a2a3-b1637ce16274} + True + + + + + \ No newline at end of file diff --git a/Asterisk.2013/Documentation/icons/Help.png b/Asterisk.2013/Documentation/icons/Help.png new file mode 100644 index 0000000..945e89f Binary files /dev/null and b/Asterisk.2013/Documentation/icons/Help.png differ