/Main/Source/HtmlToMaml/Doc/Content/Glossary.aml
Unknown | 136 lines | 112 code | 24 blank | 0 comment | 0 complexity | 54da39f238764e598547d0e4a301fe85 MD5 | raw file
Possible License(s): CC-BY-SA-3.0
1<?xml version="1.0" encoding="utf-8"?> 2<topic id="0da4eb05-808e-4323-9a62-28ba912125ff" revisionNumber="1"> 3 <developerGlossaryDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink"> 4 <glossary> 5 6 <glossaryEntry> 7 <terms> 8 <term termId="ConceptualBuild">conceptual build</term> 9 </terms> 10 11 <definition> 12 <para>A build that uses Sandcastle to produce help file topics using 13information extracted from conceptual content topics and their related files.</para> 14 </definition> 15 16 <relatedEntry termId="ReferenceBuild" /> 17 <relatedEntry termId="Sandcastle" /> 18 </glossaryEntry> 19 20 <glossaryEntry> 21 <terms> 22 <term>conceptual content</term> 23 </terms> 24 25 <definition> 26 <para>A topic file that contains conceptual content. These can be used 27to add usage notes, walkthroughs, tutorials, etc. to a help file.</para> 28 </definition> 29 </glossaryEntry> 30 31 <glossaryEntry> 32 <terms> 33 <term>Globally Unique Identifier</term> 34 <term>GUID</term> 35 </terms> 36 37 <definition> 38 <para>A unique value that is associated with each conceptual topic 39and image in a project. When inserting links to topics or images, the ID is 40used to refer to them. This allows you to alter the names or locations of the 41topic files without having to change the name or location in each topic that 42references them.</para> 43 </definition> 44 </glossaryEntry> 45 46 <glossaryEntry> 47 <terms> 48 <term>MAML</term> 49 </terms> 50 51 <definition> 52 <para>An acronym that stands for Microsoft Assistance Markup 53Language. Conceptual content topics are composed of MAML elements.</para> 54 </definition> 55 </glossaryEntry> 56 57 <glossaryEntry> 58 <terms> 59 <term>media content file</term> 60 </terms> 61 62 <definition> 63 <para>This file contains information about the images referenced in 64<codeInline>mediaLink</codeInline> and <codeInline>mediaLinkInline</codeInline> 65elements in conceptual content.</para> 66 </definition> 67 </glossaryEntry> 68 69 <glossaryEntry> 70 <terms> 71 <term termId="ReferenceBuild">reference build</term> 72 </terms> 73 74 <definition> 75 <para>A build that uses Sandcastle to produce help file topics using 76information extracted from managed assemblies and their associated XML comments 77files.</para> 78 </definition> 79 80 <relatedEntry termId="ConceptualBuild" /> 81 <relatedEntry termId="Sandcastle" /> 82 </glossaryEntry> 83 84 <glossaryEntry> 85 <terms> 86 <term termId="Sandcastle">Sandcastle</term> 87 </terms> 88 89 <definition> 90 <para><token>Sandcastle</token> is a set of tools produced by 91Microsoft that can be used to build help files for .NET managed libraries, 92conceptual content, or a mix of both.</para> 93 </definition> 94 95 <relatedEntry termId="SHFB" /> 96 </glossaryEntry> 97 98 <glossaryEntry> 99 <terms> 100 <term termId="SHFB">Sandcastle Help File Builder</term> 101 <term>SHFB</term> 102 </terms> 103 104 <definition> 105 <para>The <token>SHFB</token> is a standalone tool used to automate 106Sandcastle. It consists of a GUI front end that helps you manage and build 107help file projects. It uses a standard MSBuild format project file which can 108also by built from the command line using MSBuild or integrated into Visual 109Studio builds or other build scripts to produce a help file when your 110application projects are built. In addition, it provides a set of additional 111features beyond those supplied with Sandcastle that can improve your help file 112and make it easier to deploy.</para> 113 </definition> 114 115 <relatedEntry termId="Sandcastle" /> 116 </glossaryEntry> 117 118 <glossaryEntry> 119 <terms> 120 <term>token</term> 121 <term>token file</term> 122 </terms> 123 124 <definition> 125 <para>A token is used as a replaceable tag within a topic and is 126represented using a <codeInline>token</codeInline> element. The inner 127text of the element is a token name. The tokens are defined in a separate 128token file. They are an easy way to represent common items that you use 129regularly such as a common phrase or external link.</para> 130 </definition> 131 132 </glossaryEntry> 133 </glossary> 134 135 </developerGlossaryDocument> 136</topic>