FolderStructure

References
public sealed class FolderStructure
Represents the canonical folder layout for the folder in which documentation content is made.

Constructors

FolderStructure

#
public FolderStructure(string baseFolder)
Create a new canonical documentation folder structure. This constructor will throw if the base folder does not exist.
Parameters:
baseFolder (string)The base folder. Use Folders.DocumentationAuthoringFolder if unsure.

Properties

Base

#
public string Base { get; }
Gets the base folder for this structure.

ExamplesFolder

#
public string ExamplesFolder { get; }
Gets the folder in which the example file content is made.

SpecsFolder

#
public string SpecsFolder { get; }
Gets the folder in which the component specification content is made.

TermsFolder

#
public string TermsFolder { get; }
Gets the folder in which the glossary content is made.

TopicsFolder

#
public string TopicsFolder { get; }
Gets the folder in which the in-depth topic content is made.

Methods

CompleteFolderStructure

#
public static string[] CompleteFolderStructure(string baseFolder, params ProcessState[] states)
Create a list of all the subfolders that represent a standard folder structure.
Parameters:
baseFolder (string)Base folder.
states (params ProcessState[])Optional list of stated to include. If omitted, all states are included.

CreateExamplesFolderPath

#
public static string CreateExamplesFolderPath(string baseFolder)
Given a (presumably well-formed) directory uri, create the appropriate Examples subfolder uri.
Parameters:
baseFolder (string)

CreateSpecFolderPath

#
public static string CreateSpecFolderPath(string baseFolder, ProcessState state)
Given a (presumably well-formed) directory uri, create the appropriate Specs subfolder uri.
Parameters:
baseFolder (string)
state (ProcessState)

CreateTermFolderPath

#
public static string CreateTermFolderPath(string baseFolder, ProcessState state)
Given a (presumably well-formed) directory uri, create the appropriate Terms subfolder uri.
Parameters:
baseFolder (string)
state (ProcessState)

CreateTopicFolderPath

#
public static string CreateTopicFolderPath(string baseFolder, ProcessState state)
Given a (presumably well-formed) directory uri, create the appropriate Topics subfolder uri.
Parameters:
baseFolder (string)
state (ProcessState)

ExampleFiles

#
public IEnumerable<string> ExampleFiles(ProcessState folder)
Enumerate over all topic files in the given folder.
Parameters:
folder (ProcessState)

GetExampleFolder

#
public string GetExampleFolder(ProcessState folder)
Gets (and creates if need be) the specified subfolder for the example files.
Parameters:
folder (ProcessState)

GetSpecFolder

#
public string GetSpecFolder(ProcessState folder)
Gets (and creates if need be) the specified subfolder for the specifications.
Parameters:
folder (ProcessState)

GetTermFolder

#
public string GetTermFolder(ProcessState folder)
Gets (and creates if need be) the specified subfolder for the terms.
Parameters:
folder (ProcessState)

GetTopicFolder

#
public string GetTopicFolder(ProcessState folder)
Gets (and creates if need be) the specified subfolder for the topics.
Parameters:
folder (ProcessState)

PickExampleFile

#
public string PickExampleFile(string title, string prompt, params ProcessState[] states)
Parameters:
title (string)
prompt (string)
states (params ProcessState[])

PickSpecFile

#
public string PickSpecFile(string title, string prompt, params ProcessState[] states)
Parameters:
title (string)
prompt (string)
states (params ProcessState[])

PickTermFile

#
public string PickTermFile(string title, string prompt, params ProcessState[] states)
Parameters:
title (string)
prompt (string)
states (params ProcessState[])

PickTopicFile

#
public string PickTopicFile(string title, string prompt, params ProcessState[] states)
Parameters:
title (string)
prompt (string)
states (params ProcessState[])

SpecFiles

#
public IEnumerable<string> SpecFiles()
Enumerate over all spec files in all folders.

SpecFiles

#
public IEnumerable<string> SpecFiles(ProcessState folder)
Enumerate over all spec files in the given folder.
Parameters:
folder (ProcessState)

TermFiles

#
public IEnumerable<string> TermFiles()
Enumerate over all term files in all foldes.

TermFiles

#
public IEnumerable<string> TermFiles(ProcessState folder)
Enumerate over all term files in the given folder.
Parameters:
folder (ProcessState)

TopicFiles

#
public IEnumerable<string> TopicFiles()
Enumerate over all topic files in all folders.

TopicFiles

#
public IEnumerable<string> TopicFiles(ProcessState folder)
Enumerate over all topic files in the given folder.
Parameters:
folder (ProcessState)