Click here to Skip to main content
15,896,154 members
Articles / Programming Languages / Forth.NET

DocMounter 2: A tool to build VS.NET documentation (now with Sandcastle)

,
Rate me:
Please Sign up or sign in to vote.
4.94/5 (29 votes)
15 Nov 2010GPL314 min read 139.6K   1.4K   99  
Tool for creating MS Visual Studio documentation files - XML Summaries, HxS/MSHC help solutions and manuals.
using System;

// The global constants shared among different modules.

namespace TenTec.Utils
{
	/// <summary>
	/// Constants used to work with the Xml project file.
	/// </summary>
	internal static class ConstsProjectXml
	{
		// root element
		public const string cNodeRoot = "DocMounterProject";
		// assemblies
		public const string cNodeLibPaths = "LibPaths";
		public const string cNodeLibPath = "LibPath";
		// project properties
		public const string cNodeProjProperties = "Properties";
		public const string cNodeProjPropTitle = "Title";
		public const string cNodeProjPropCompany = "Company";
		public const string cNodeProjPropFeedbackEmail = "FeedbackEmail";
		public const string cNodeProjPropDocSetList = "DocSetList";
		public const string cNodeProjPropVersion = "Version";
		public const string cNodeProjPropDirMedia = "DirMedia";
		public const string cNodeProjPropHelpNamespace = "HelpNamespace";
		public const string cNodeProjPropOutDirXmlSummaries = "OutDirXmlSummaries";
		public const string cNodeProjPropOutDirXmlComplete = "OutDirXmlComplete";
		public const string cNodeProjPropOutDirHelpSolution = "OutDirHelpSolution";
		public const string cNodeProjPropOutDirManual = "OutDirManual";
		public const string cNodeProjPropCustomDictionary = "CustomDictionary";
		// member and conceptual topic nodes
		public const string cNodeNamespaces = "Namespaces";
		public const string cNodeNamespace = "Namespace";
		public const string cNodeConceptualTopics = "ConceptualTopics";
		public const string cNodeConceptualTopic = "ConceptualTopic";
		public const string cNodeTypes = "Types";
		public const string cNodeType = "Type";
		public const string cNodeFields = "Fields";
		public const string cNodeField = "Field";
		public const string cNodeSummary = "Summary";
		public const string cNodeRemarks = "Remarks";
		public const string cNodeExample = "Example";
		public const string cNodeSeeAlsos = "SeeAlsos";
		public const string cNodeSeeAlso = "SeeAlso";
		public const string cNodeMethods = "Methods";
		public const string cNodeMethod = "Method";
		public const string cNodeExceptions = "Exceptions";
		public const string cNodeException = "Exception";
		public const string cNodeParams = "Parameters";
		public const string cNodeParam = "Parameter";
		public const string cNodeTypeParams = "TypeParameters";
		public const string cNodeTypeParam = "TypeParameter";
		public const string cNodeProps = "Properties";
		public const string cNodeProp = "Property";
		public const string cNodeEvents = "Events";
		public const string cNodeEvent = "Event";
		// topic attributes
		public const string cAttributeName = "Name";
		public const string cAttributeDisplayName = "DisplayName";
		public const string cAttributeType = "Type";
		public const string cAttributeId = "Id";
		public const string cAttributeVersion = "DocumentVersion";
		// used to create display labels
		public const string cSymbolMethodStartParams = "(";
		public const string cSymbolMethodEndParams = ")";
		public const string cSymbolGenericStartParams = "<";
		public const string cSymbolGenericEndParams = ">";
		public const string cSymbolMethodParamsDelimiter = ", ";
		public const string cGenericNameEndSymbol = "`";
	}

	/// <summary>
	/// Constants used to create Xml source help files.
	/// </summary>
	internal static class ConstsXmlHelp
	{
		public const string cTopicNodeName = "topic";
		public const string cTopicAttributeIdName = "id";
		public const string cTopicAttributeRevisionNumberName = "revisionNumber";
		public const string cTopicAttributeRevisionNumberDefaultValue = "0";
		public const string cDeveloperConceptualDocument = "developerConceptualDocument";
		public const string cTopicTitle = "title";
		public const string cAssembly = "assembly";
		public const string cMembers = "members";
		public const string cMember = "member";
		public const string cDocument = "doc";
		public const string cName = "name";
		public const string cSummary = "summary";
		public const string cRemarks = "remarks";
		public const string cSee = "see";
		public const string cCodeReference = "codeReference";
		public const string cCodeEntityReference = "codeEntityReference";
		public const string cApplication = "application";
		public const string cCodeInline = "codeInline";
		public const string cCommand = "command";
		public const string cComputerOutputInline = "computerOutputInline";
		public const string cDatabase = "database";
		public const string cEnvironmentVariable = "environmentVariable";
		public const string cErrorInline = "errorInline";
		public const string cFictitiousUri = "fictitiousUri";
		public const string cForeignPhrase = "foreignPhrase";
		public const string cHardware = "hardware";
		public const string cLegacyBold = "legacyBold";
		public const string cLegacyItalic = "legacyItalic";
		public const string cLegacyUnderline = "legacyUnderline";
		public const string cLiteral = "literal";
		public const string cLocalUri = "localUri";
		public const string cMarkup = "markup";
		public const string cMath = "math";
		public const string cNewTerm = "newTerm";
		public const string cPhrase = "phrase";
		public const string cPlaceholder = "placeholder";
		public const string cQuoteInline = "quoteInline";
		public const string cReplaceable = "replaceable";
		public const string cSubscript = "subscript";
		public const string cSuperscript = "superscript";
		public const string cSystem = "system";
		public const string cUi = "ui";
		public const string cUnmanagedCodeEntityReference = "unmanagedCodeEntityReference";
		public const string cUserInput = "userInput";
		public const string cImage = "image";
		public const string cSeeAlso = "seealso";
		public const string cParagraph = "para";
		public const string cExample = "example";
		public const string cCode = "code";
		public const string cSeeTopic = "see-topic";
		public const string cImg = "img";
		public const string cParamRef = "paramref";
		public const string cTypeParamRef = "typeparamref";
		public const string cB = "b";
		public const string cReference = "cref";
		public const string cParameter = "param";
		public const string cTypeParameter = "typeparam";
		public const string cReturns = "returns";
		public const string cValue = "value";
		public const string cException = "exception";
		public const string cDelimiter = ".";
		public const string cNestedClassDelimiter = "+";
		public const string cPointerSuffix = "@";
		public const string cOpenBracket = "(";
		public const string cCloseBracket = ")";
		public const string cOpenSquareBrackets = "[";
		public const string cCloseSquareBrackets = "]";
		public const string cArrayLowerBoundAndSize = "0:";
		public const string cArrayDimensionDelimeter = ",";
		public const string cParameterDelimeter = ",";

		public const string cPropertyPrefix = "P:";
		public const string cMethodPrefix = "M:";
		public const string cEventPrefix = "E:";
		public const string cFieldPrefix = "F:";
		public const string cTypePrefix = "T:";
		public const string cNamespacePrefix = "N:";

		public const string cPropertyTopicSeeAlsoAdd = "Property";
		public const string cMethodTopicSeeAlsoAdd = "Method";
		public const string cEventTopicSeeAlsoAdd = "Event";
		public const string cFieldTopicSeeAlsoAdd = "Field";
		public const string cTypeTopicSeeAlsoAdd = "Type";
		public const string cNamespaceTopicSeeAlsoAdd = "Namespace";

		public const string cGenericTypeParameterPrexif = "`";
		public const string cGenericMethodParameterPrefix = "``";
		public const string cGenericMethodParameterArgumentListStart = "{";
		public const string cGenericMethodParameterArgumentListEnd = "}";

		public const char cStartTag = '<';
		public const char cEndTag = '>';
		public const char cSlash = '/';
		public const char cUnderline = '_';

		public static readonly string[,] cSubstitutes = new string[,] { { "<", "&lt;" }, { ">", "&gt;" }, { "&", "&amp" } };
	}

	/// <summary>
	/// Items of the XML Linking Language (XLink)
	/// </summary>
	internal static class ConstsXLink
	{
		public const string cXmlnsXlinkAttrName = "xmlns:xlink";
		public const string cXmlnsXlinkAttrValue = "http://www.w3.org/1999/xlink";
	}	
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The GNU General Public License (GPLv3)


Written By
Software Developer (Senior)
Canada Canada
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Written By
Ukraine Ukraine
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.
This is a Organisation

2 members

Comments and Discussions