github.com/Kindred87/Obsidian@v0.0.0-20210809203756-86936424b848/api/help.go (about)

     1  package api
     2  
     3  import "strings"
     4  
     5  func HTMLNodeRequestHelp() []string {
     6  	return []string{
     7  		"Here's your help for HTMLNodeHelper!  Disable the Help option to use the function normally.",
     8  		separationLine(),
     9  		"USAGE",
    10  		"HTMLNodeHelper's intended use is to assist in HTML search creation for those that aren't accustomed to HTML code.",
    11  		"This function identifies attributes of NODES containing unique values in an HTML datasource.",
    12  		"Information on the parent nodes are also given, so that common parents between nodes can be easily identified.",
    13  		"For that reason, it's recommended to search for multiple items grouped together, such as a row in a table.",
    14  		separationLine(),
    15  		"FIELDS",
    16  		"DatasourceAlias: The alias of the HTML datasource to search.",
    17  		"ParentLimit: The maximum number of parent nodes to display for each located match.",
    18  		"ValuesToFind: Unique values of interest, ideally clustered in a group that represents the groups you intend to eventually extract.",
    19  		separationLine(),
    20  		"RESULTS",
    21  		"Each node, and its parents (up to the given limit) containing the given values will " +
    22  			"be placed in a NodeList.",
    23  		"The name of the nodelist will be the value that was found.",
    24  		"Of the nodes shown, the first node is the one containing the matching value from ValuesToFind.",
    25  		"Nodes 2 and up represent the parents of the located node, with 2 being the direct parent.",
    26  		"Each node's ATTRIBUTE is shown following its number, with its CLASS(if available) shown after that",
    27  		"Ideally, you want to identify a node with a class that all of the located nodes share in common.  Then use the attributes of that node's children to identify",
    28  	}
    29  }
    30  
    31  func separationLine() string {
    32  	return strings.Repeat("-", 70)
    33  }