Sandcastle Help File Builder Documentation
Toc
Add all topics from the specified folder recursively to the collection and to the given project file
Definition
Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.9.12.0
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.9.12.0
C#
public void AddTopicsFromFolder(
string folder,
string basePath,
SandcastleProject project
)VB
Public Sub AddTopicsFromFolder (
folder As String,
basePath As String,
project As SandcastleProject
)C++
public:
void AddTopicsFromFolder(
String^ folder,
String^ basePath,
SandcastleProject^ project
)F#
member AddTopicsFromFolder :
folder : string *
basePath : string *
project : SandcastleProject -> unit 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 SandcastleProject
- The project to which the files are added
Remarks
Only actual HTML and markdown content topic files are added. They must have a ".htm?" or
"*.md" extension. 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.