./nugetz

#readme

12 packages tagged with “readme

pkg

FileInclude

A library to generate a file from template which can include placeholder sections that reference other file (i.e., file includes). The referenced files can include similar sections to reference other files. The library was motivated by the need to reference other files in README.md file (other MD files, example code files, etc.). The method GenerateFileFromTemplate in interface FileInclude.ITemplateProcessor recursively compiles the template file specified in parameter templateFilePath, and all the files directly or indirectly referenced by the template file into a single file and returns the file contents in output parameter generatedFileContents. The default implementation of FileInclude.ITemplateProcessor is FileInclude.TemplateProcessor and it uses IncludedFilePlaceHolder element tag to locate the include place-holders. However the tag name can be changed by overriding the virtual property TemplateProcessor.FileIncludeTagName. The method FileInclude.ITemplateProcessor.GenerateFileFromTemplate returns errors as a list of FileInclude.IErrorData objects that contain error details. Also, the method checks and reports any possible circular references, to prevent infinite processing. There is also an extension method FileInclude.TemplateProcessorExtensions.GenerateFileFromTemplateAndSave which saves the file generated from the template. The extension method checks if the generated file was modified by other applications (say manually edited) since it was auto-generated last time, to prevent data loss.

v1.3.14.0K
FileincludereadmeMD