Glossary - HTML to MAML Converter Documentation

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

conceptual build: A build that uses Sandcastle to produce help file topics using information extracted from conceptual content topics and their related files.

See Also: reference build, Sandcastle
conceptual content: A topic file that contains conceptual content. These can be used to add usage notes, walkthroughs, tutorials, etc. to a help file.

Globally Unique Identifier, GUID: A unique value that is associated with each conceptual topic and image in a project. When inserting links to topics or images, the ID is used to refer to them. This allows you to alter the names or locations of the topic files without having to change the name or location in each topic that references them.

MAML: An acronym that stands for Microsoft Assistance Markup Language. Conceptual content topics are composed of MAML elements.
media content file: This file contains information about the images referenced in mediaLink and mediaLinkInline elements in conceptual content.

reference build: A build that uses Sandcastle to produce help file topics using information extracted from managed assemblies and their associated XML comments files.

See Also: conceptual build, Sandcastle

Sandcastle: Sandcastle is a set of tools originally produced by Microsoft that can be used to build help files for .NET managed libraries, conceptual content, or a mix of both. Microsoft officially discontinued development in October 2012. The Sandcastle tools have been merged with the Sandcastle Help File Builder project and are developed and supported there now as part of that project.

See Also: Sandcastle Help File Builder
Sandcastle Help File Builder, SHFB: The Sandcastle Help File Builder is a standalone tool used to automate Sandcastle. It consists of a GUI front end that helps you manage and build help file projects. It uses a standard MSBuild format project file which can also by built from the command line using MSBuild or integrated into Visual Studio builds or other build scripts to produce a help file when your application projects are built. In addition, it provides a set of additional features beyond those supplied with Sandcastle that can improve your help file and make it easier to deploy.

See Also: Sandcastle

token, token file: A token is used as a replaceable tag within a topic and is represented using a token element. The inner text of the element is a token name. The tokens are defined in a separate token file. They are an easy way to represent common items that you use regularly such as a common phrase or external link.