TopicCollection.AddTopicsFromFolder Method

Definition

Namespace

Sandcastle.Core.ConceptualContent

Assembly

Sandcastle.Core.dll

Add all topics from the specified folder recursively to the collection and to the given project file

public void AddTopicsFromFolder(string folder, string basePath, ISandcastleProject project)

Parameters

folder string

The folder from which to get the files

basePath string

The base path to remove from files copied from another folder into the project folder. On the first call, this should match the folder value.

project ISandcastleProject

The project to which the files are added

Remarks

Only actual conceptual content topic files are added. They must have a ".aml" extension and must be one of the valid document types. Folders will be added as sub-topics recursively. If a file with the same name as the folder exists, it will be associated with the container node. If no such file exists, an empty container node is created.