C# Class Microsoft.DocAsCode.Build.Engine.TemplateProcessor

Inheritance: IDisposable
Show file Open project: dotnet/docfx Class Usage Examples

Public Properties

Property Type Description
DefaultProcessor TemplateProcessor

Public Methods

Method Description
Dispose ( ) : void
GetTemplateBundle ( string documentType ) : TemplateBundle
TemplateProcessor ( ResourceCollection resourceProvider, DocumentBuildContext context, int maxParallelism ) : System

TemplateName can be either file or folder 1. If TemplateName is file, it is considered as the default template 2. If TemplateName is a folder, files inside the folder is considered as the template, each file is named after {DocumentType}.{extension}
TryGetFileExtension ( string documentType, string &fileExtension ) : bool

Private Methods

Method Description
LoadTokenJson ( ResourceCollection resource ) : string>.IDictionary
Process ( List manifest, DocumentBuildContext context, ApplyTemplateSettings settings, object>.IDictionary globals = null ) : List
ProcessCore ( List items, DocumentBuildContext context, ApplyTemplateSettings settings, object>.IDictionary globals ) : List
ProcessDependencies ( string outputDirectory, IEnumerable templateBundles ) : void
ProcessSingleDependency ( Stream stream, string outputDirectory, string filePath ) : void

Method Details

Dispose() public method

public Dispose ( ) : void
return void

GetTemplateBundle() public method

public GetTemplateBundle ( string documentType ) : TemplateBundle
documentType string
return TemplateBundle

TemplateProcessor() public method

TemplateName can be either file or folder 1. If TemplateName is file, it is considered as the default template 2. If TemplateName is a folder, files inside the folder is considered as the template, each file is named after {DocumentType}.{extension}
public TemplateProcessor ( ResourceCollection resourceProvider, DocumentBuildContext context, int maxParallelism ) : System
resourceProvider ResourceCollection
context DocumentBuildContext
maxParallelism int
return System

TryGetFileExtension() public method

public TryGetFileExtension ( string documentType, string &fileExtension ) : bool
documentType string
fileExtension string
return bool

Property Details

DefaultProcessor public static property

public static TemplateProcessor,Microsoft.DocAsCode.Build.Engine DefaultProcessor
return TemplateProcessor