C# Class StorytellerDocGen.Topics.Topic

Datei anzeigen Open project: storyteller/Storyteller Class Usage Examples

Public Properties

Property	Type	Description
Substitutions	string>.LightweightCache

Public Methods

Method	Description
AddChild ( Topic topic ) : void
AddChildren ( IEnumerable children ) : void
AllTopicsInOrder ( ) : IEnumerable
Ancestors ( ) : IEnumerable
Descendents ( ) : IEnumerable
FileExportPath ( ) : string
FindByKey ( string key ) : Topic
FindComments ( string text ) : IEnumerable
FindNext ( ) : Topic
FindPrevious ( ) : Topic
FindTop ( ) : Topic
HasExplicitUrl ( ) : bool
IsSplashPage ( ) : bool
ParseAndOrder ( ) : System.Threading.Tasks.Task
ParseFile ( ) : void
PrependKey ( string key ) : void
ToString ( ) : string
Topic ( string key, string file ) : System
WebsiteExportPath ( ) : string

Private Methods

Method	Description
OrderChildren ( ) : void
anscestors ( ) : IEnumerable
applyExplicitTitle ( IEnumerable comments, Topic topic ) : void
applyExplicitUrlSegment ( IEnumerable comments, Topic topic ) : void
determineUrlSegmentFromFile ( string file, bool isIndex, bool isRoot ) : string
findComments ( string file ) : IEnumerable
findNextTopicNotChild ( ) : Topic

Method Details

AddChild() public method

public AddChild ( Topic topic ) : void
topic	Topic
return	void

AddChildren() public method

public AddChildren ( IEnumerable children ) : void
children	IEnumerable
return	void

AllTopicsInOrder() public method

public AllTopicsInOrder ( ) : IEnumerable
return	IEnumerable

Ancestors() public method

public Ancestors ( ) : IEnumerable
return	IEnumerable

Descendents() public method

public Descendents ( ) : IEnumerable
return	IEnumerable

FileExportPath() public method

public FileExportPath ( ) : string
return	string

FindByKey() public method

public FindByKey ( string key ) : Topic
key	string
return	Topic

FindComments() public static method

public static FindComments ( string text ) : IEnumerable
text	string
return	IEnumerable

FindNext() public method

public FindNext ( ) : Topic
return	Topic

FindPrevious() public method

public FindPrevious ( ) : Topic
return	Topic

FindTop() public method

public FindTop ( ) : Topic
return	Topic

HasExplicitUrl() public method

public HasExplicitUrl ( ) : bool
return	bool

IsSplashPage() public method

public IsSplashPage ( ) : bool
return	bool

ParseAndOrder() public method

public ParseAndOrder ( ) : System.Threading.Tasks.Task
return	System.Threading.Tasks.Task

ParseFile() public method

public ParseFile ( ) : void
return	void

PrependKey() public method

public PrependKey ( string key ) : void
key	string
return	void

ToString() public method

public ToString ( ) : string
return	string

Topic() public method

public Topic ( string key, string file ) : System
key	string
file	string
return	System

WebsiteExportPath() public method

public WebsiteExportPath ( ) : string
return	string

Property Details

Substitutions public_oe property

public LightweightCache Substitutions
return	string>.LightweightCache