wagesj45/CapyKit
wagesj45/CapyKit
1
0
Fork 0
mirror of https://github.com/wagesj45/CapyKit.git synced 2025-08-02 01:28:23 -05:00
Code Issues Projects Releases Packages 1 Wiki Activity

Documentation + Unfinished SecurityHelper

Browse source 
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
This commit is contained in:
Jordan Wages 2024-04-19 23:12:24 -05:00
commit 735d7c4c91
155 changed files with 13030 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" 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="fa7407d1-9116-4ad7-a9ab-ed094685b070" /></para>
</listItem>
<listItem>
<para>[TODO: Add links to each specific version page]</para>
</listItem>
</list>
</content>
</section>
<relatedTopics>
<link xlink:href="849aa079-3d64-4cf1-966f-44af23c73160" />
</relatedTopics>
</developerConceptualDocument>
</topic>

28
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="fa7407d1-9116-4ad7-a9ab-ed094685b070" 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="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" />
</relatedTopics>
</developerConceptualDocument>
</topic>

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

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="849aa079-3d64-4cf1-966f-44af23c73160" 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="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" />
</relatedTopics>
</developerConceptualDocument>
</topic>