FileTopicHelper.ConstructHierarchyByFilenamePrefix Method

public static IEnumerable<FileTopic> ConstructHierarchyByFilenamePrefix(IEnumerable<FileTopic> topics, char delimiter)

This method creates parent-child relationships by analyzing file name prefixes separated by the specified delimiter. Files with fewer delimiter segments become parents of files with more segments that share the same prefix. File name comparison is case-insensitive.

In this method, directories of files are ignored, and only the filenames are considered for hierarchy construction. This means that files with the same name but located in different directories will be treated as if they were in the same directory, and in such cases, an exception will be thrown.

Caution

This method assumes that the input topics do not have any existing parent-child relationships. If such relationships exist, they will be overwritten.

Tip

The method preserves the order of topics as they were provided in the input collection. Therefore, sort the input collection if you want to control the order of top-level topics and their subtopics.

Example file structure with delimiter = '.':

Input files (directories ignored):
  docs/guides.md
  help/guides.installation.md
  guides.advanced.md
  other/guides.advanced.scripting.md
  tutorials.md
  tutorials.setup.md

Resulting hierarchy:
  guides.md (parent)
  ├── guides.installation.md
  └── guides.advanced.md (parent)
      └── guides.advanced.scripting.md
  tutorials.md (parent)
  └── tutorials.setup.md