Skip to content
This repository was archived by the owner on May 2, 2025. It is now read-only.

Multi-target / Cross-platform conversion: .NET 4.0, .NET 4.5 and .NET… #8

Open
gorangrubic wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Multi-target / Cross-platform conversion: .NET 4.0, .NET 4.5 and .NET… #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10d252f
Multi-target / Cross-platform conversion: .NET 4.0, .NET 4.5 and .NET…
hardyVeles Jun 18, 2018
c33887d
Documentation and exception mute function
hardyVeles Jun 20, 2018
b332ad2
Expanded debugging capability
hardyVeles Jun 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 135 additions & 0 deletions BibtexLibrary.Documentation/BibtexLibrary.Documentation.shfbproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<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>617b9073-b902-49a2-b28d-4d790595d7cd</ProjectGuid>
<SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
<AssemblyName>BibtexLibrary.Documentation</AssemblyName>
<RootNamespace>BibtexLibrary.Documentation</RootNamespace>
<Name>BibtexLibrary.Documentation</Name>
<!-- SHFB properties -->
<FrameworkVersion>.NET Framework 4.5</FrameworkVersion>
<OutputPath>..\..\doc\BibTex\</OutputPath>
<HtmlHelpName>BibtexLibrary.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="..\BibtexLibrary.Standard\BibtexLibrary.Standard.csproj" xmlns="" />
</DocumentationSources>
<HelpFileFormat>Website</HelpFileFormat>
<SyntaxFilters>C#</SyntaxFilters>
<PresentationStyle>VS2013</PresentationStyle>
<CleanIntermediates>True</CleanIntermediates>
<KeepLogFile>True</KeepLogFile>
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
<IndentHtml>False</IndentHtml>
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
<SaveComponentCacheCapacity>100</SaveComponentCacheCapacity>
<HelpTitle>BibtexLibrary</HelpTitle>
<HelpFileVersion>1.0.0.0</HelpFileVersion>
<NamingMethod>MemberName</NamingMethod>
<ContentPlacement>AboveNamespaces</ContentPlacement>
<RootNamespaceContainer>False</RootNamespaceContainer>
<NamespaceGrouping>True</NamespaceGrouping>
<MaximumGroupParts>2</MaximumGroupParts>
<Preliminary>False</Preliminary>
<SdkLinkTarget>Blank</SdkLinkTarget>
<MissingTags>AutoDocumentCtors, AutoDocumentDispose</MissingTags>
<WarnOnMissingSourceContext>False</WarnOnMissingSourceContext>
<ComponentConfigurations>
<ComponentConfig id="API Token Resolution" enabled="True" xmlns="">
<component id="API Token Resolution">{@TokenFiles}
<replace elements="/*//token" item="string(.)" /></component>
</ComponentConfig>
<ComponentConfig id="Code Block Component" enabled="True" xmlns=""><component id="Code Block Component">
<basePath value="{@HtmlEncProjectFolder}" />
<outputPaths>{@HelpFormatOutputPaths}</outputPaths>
<allowMissingSource value="false" />
<removeRegionMarkers value="false" />
<colorizer syntaxFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xml" styleFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xsl" stylesheet="{@SHFBFolder}PresentationStyles\Colorizer\highlight.css" scriptFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.js" disabled="{@DisableCodeBlockComponent}" language="cs" tabSize="0" numberLines="true" outlining="false" keepSeeTags="false" defaultTitle="true" />
</component></ComponentConfig>
<ComponentConfig id="Syntax Component" enabled="True" xmlns=""><component id="Syntax Component">
<syntax input="/document/reference" output="/document/syntax" renderReferenceLinks="false" />
<generators>
{@SyntaxFilters}
</generators>
<containerElement name="codeSnippetGroup" addNoExampleTabs="true" includeOnSingleSnippets="false" groupingEnabled="{@CodeSnippetGrouping}" />
<configurations>
<generator id="C#" />
<generator id="Visual Basic">
<includeLineContinuation value="false" />
</generator>
<generator id="Visual Basic Usage">
<includeLineContinuation value="false" />
</generator>
<generator id="Managed C++" />
<generator id="F#" />
<generator id="J#" />
<generator id="JScript" />
<generator id="JavaScript" />
<generator id="XAML Usage" />
<generator id="ASP.NET" />
<generator id="X#" />
</configurations>
</component></ComponentConfig></ComponentConfigurations>
</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\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>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
<!-- The pre-build and post-build event properties must appear *after* the targets file import in order to be
evaluated correctly. -->
<PropertyGroup>
<PreBuildEvent>
</PreBuildEvent>
<PostBuildEvent>
</PostBuildEvent>
<RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
</PropertyGroup>
</Project>
33 changes: 33 additions & 0 deletions BibtexLibrary.Documentation/Content/VersionHistory/VersionHistory.aml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="267c32d7-f06d-4450-8fb7-e89c52895a49" 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="81d11c8d-f80e-49ec-af9e-670bd133a03b" /></para>
</listItem>

<listItem>
<para>[TODO: Add links to each specific version page]</para>
</listItem>

</list>

</content>
</section>

<relatedTopics>
<link xlink:href="a72b1851-c205-47cc-a5d3-bfa1cb1d5b00" />
</relatedTopics>

</developerConceptualDocument>
</topic>
28 changes: 28 additions & 0 deletions BibtexLibrary.Documentation/Content/VersionHistory/v1.0.0.0.aml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="81d11c8d-f80e-49ec-af9e-670bd133a03b" 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="267c32d7-f06d-4450-8fb7-e89c52895a49" />
</relatedTopics>

</developerConceptualDocument>
</topic>
55 changes: 55 additions & 0 deletions BibtexLibrary.Documentation/Content/Welcome.aml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="a72b1851-c205-47cc-a5d3-bfa1cb1d5b00" 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="267c32d7-f06d-4450-8fb7-e89c52895a49" />
</relatedTopics>
</developerConceptualDocument>
</topic>
18 changes: 18 additions & 0 deletions BibtexLibrary.Documentation/ContentLayout.content
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<Topics>
<Topic id="a72b1851-c205-47cc-a5d3-bfa1cb1d5b00" visible="True" isDefault="true" isSelected="true" title="Welcome to the [TODO: Add project name]">
<HelpKeywords>
<HelpKeyword index="K" term="Welcome" />
</HelpKeywords>
</Topic>
<Topic id="267c32d7-f06d-4450-8fb7-e89c52895a49" visible="True" isExpanded="true" title="Version History">
<HelpKeywords>
<HelpKeyword index="K" term="version, history" />
</HelpKeywords>
<Topic id="81d11c8d-f80e-49ec-af9e-670bd133a03b" visible="True" title="Version 1.0.0.0">
<HelpKeywords>
<HelpKeyword index="K" term="version, 1.0.0.0" />
</HelpKeywords>
</Topic>
</Topic>
</Topics>
Binary file added BibtexLibrary.Documentation/icons/Help.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions BibtexLibrary.Standard/BibtexEntry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
using System.Collections.Generic;

namespace BibtexLibrary
{
/// <summary>
/// Single entry in Bibtex file
/// </summary>
public class BibtexEntry
{
/// <summary>
/// The tags
/// </summary>
private Dictionary<string, string> _tags = new Dictionary<string, string>();
/// <summary>
/// Gets or sets the type.
/// </summary>
/// <value>
/// The type.
/// </value>
public string Type { get; set; }

/// <summary>
/// Gets or sets the key.
/// </summary>
/// <value>
/// The key.
/// </value>
public string Key { get; set; }

/// <summary>
/// Gets or sets the tags.
/// </summary>
/// <value>
/// The tags.
/// </value>
public Dictionary<string, string> Tags
{
get { return _tags; }
set { _tags = value; }
}
}
}
45 changes: 45 additions & 0 deletions BibtexLibrary.Standard/BibtexFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
using System.Collections.Generic;

namespace BibtexLibrary
{
/// <summary>
/// Collection of Bibtex entries
/// </summary>
public class BibtexFile
{
private ICollection<BibtexEntry> _entries = new List<BibtexEntry>();
private Dictionary<string, string> _stringDefinitions = new Dictionary<string, string>();

/// <summary>
/// Gets or sets the string definitions.
/// </summary>
/// <value>
/// The string definitions.
/// </value>
public Dictionary<string, string> StringDefinitions
{
get { return _stringDefinitions; }
set { _stringDefinitions = value; }
}

/// <summary>
/// Gets or sets the preamble.
/// </summary>
/// <value>
/// The preamble.
/// </value>
public ICollection<string> Preamble { get; set; }

/// <summary>
/// Gets or sets the entries.
/// </summary>
/// <value>
/// The entries.
/// </value>
public ICollection<BibtexEntry> Entries
{
get { return _entries; }
set { _entries = value; }
}
}
}
Loading