private void LoadCommands()
{
//load all commands
var commandClasses = TypeMethods.GenerateCommandTypes(AContainer);
_uiImages = new ImageList();
_automationCommands = TypeMethods.GenerateAutomationCommands(_uiImages, commandClasses);
var groupedCommands = _automationCommands.Where(x => x.Command.CommandName != "BrokenCodeCommentCommand")
.GroupBy(f => f.DisplayGroup);
tvCommands.Nodes.Clear();
foreach (var cmd in groupedCommands)
{
TreeNode newGroup = new TreeNode(cmd.Key);
foreach (var subcmd in cmd)
{
TreeNode subNode = new TreeNode(subcmd.ShortName);
subNode.ToolTipText = subcmd.Description;
newGroup.Nodes.Add(subNode);
}
tvCommands.Nodes.Add(newGroup);
}
tvCommands.Sort();
_tvCommandsCopy = new TreeView();
_tvCommandsCopy.ShowNodeToolTips = true;
CopyTreeView(tvCommands, _tvCommandsCopy);
txtCommandSearch.Text = _txtCommandWatermark;
}
/// <summary>
/// Returns a path that contains the generated markdown files
/// </summary>
/// <returns></returns>
public string GenerateMarkdownFiles(AContainer container, string basePath)
{
//create directory if required
var docsFolderName = "docs";
var docsPath = Path.Combine(basePath, docsFolderName);
if (!Directory.Exists(docsPath))
{
Directory.CreateDirectory(docsPath);
}
var commandClasses = TypeMethods.GenerateCommandTypes(container);
var highLevelCommandInfo = new List <CommandMetaData>();
StringBuilder stringBuilder;
string fullFileName;
//loop each command
foreach (var commandClass in commandClasses)
{
//instantiate and pull properties from command class
ScriptCommand instantiatedCommand = (ScriptCommand)Activator.CreateInstance(commandClass);
var groupName = GetClassValue(commandClass, typeof(CategoryAttribute));
var classDescription = GetClassValue(commandClass, typeof(DescriptionAttribute));
var commandName = instantiatedCommand.SelectionName;
stringBuilder = new StringBuilder();
//create string builder to build markdown document and append data
stringBuilder.AppendLine("<!--TITLE: " + commandName + " Command -->");
stringBuilder.AppendLine("<!-- SUBTITLE: a command in the " + groupName + " group. -->");
stringBuilder.AppendLine("[Go To Automation Commands Overview](/automation-commands)");
stringBuilder.AppendLine(Environment.NewLine);
stringBuilder.AppendLine("# " + commandName + " Command");
stringBuilder.AppendLine(Environment.NewLine);
//append more
stringBuilder.AppendLine("## What does this command do?");
stringBuilder.AppendLine(classDescription);
stringBuilder.AppendLine(Environment.NewLine);
//build parameter table based on required user inputs
stringBuilder.AppendLine("## Command Parameters");
stringBuilder.AppendLine("| Parameter Question | What to input | Sample Data | Remarks |");
stringBuilder.AppendLine("| --- | --- | --- | --- |");
//loop each property
foreach (var prop in commandClass.GetProperties().Where(f => f.Name.StartsWith("v_")).ToList())
{
//pull attributes from property
var commandLabel = CleanMarkdownValue(GetPropertyValue(prop, typeof(DisplayNameAttribute)));
var helpfulExplanation = CleanMarkdownValue(GetPropertyValue(prop, typeof(DescriptionAttribute)));
var sampleUsage = CleanMarkdownValue(GetPropertyValue(prop, typeof(SampleUsage)));
var remarks = CleanMarkdownValue(GetPropertyValue(prop, typeof(Remarks)));
//append to parameter table
stringBuilder.AppendLine("|" + commandLabel + "|" + helpfulExplanation + "|" + sampleUsage + "|" + remarks + "|");
}
stringBuilder.AppendLine(Environment.NewLine);
stringBuilder.AppendLine("## Developer/Additional Reference");
stringBuilder.AppendLine("Automation Class Name: " + commandClass.Name);
stringBuilder.AppendLine("Parent Namespace: " + commandClass.Namespace);
stringBuilder.AppendLine("This page was generated on " + DateTime.Now.ToString("MM/dd/yy hh:mm tt"));
stringBuilder.AppendLine(Environment.NewLine);
stringBuilder.AppendLine("## Help");
stringBuilder.AppendLine("[Open/Report an issue on GitHub](https://github.com/OpenBotsAI/OpenBots.Studio/issues/new)");
stringBuilder.AppendLine("[Ask a question on the OpenBots Forum](https://openbots.ai/forums/)");
//create kebob destination and command file name
var kebobDestination = groupName.Replace(" ", "-").Replace("/", "-").ToLower();
var kebobFileName = commandName.Replace(" ", "-").Replace("/", "-").ToLower() + "-command.md";
//create directory if required
var destinationdirectory = Path.Combine(docsPath, kebobDestination);
if (!Directory.Exists(destinationdirectory))
{
Directory.CreateDirectory(destinationdirectory);
}
//write file
fullFileName = Path.Combine(destinationdirectory, kebobFileName);
File.WriteAllText(fullFileName, stringBuilder.ToString());
//add to high level
var serverPath = "/automation-commands/" + kebobDestination + "/" + kebobFileName.Replace(".md", "");
highLevelCommandInfo.Add(
new CommandMetaData()
{
Group = groupName,
Description = classDescription,
Name = commandName,
Location = serverPath
});
}
stringBuilder = new StringBuilder();
stringBuilder.AppendLine("<!--TITLE: Automation Commands -->");
stringBuilder.AppendLine("<!-- SUBTITLE: an overview of available commands in OpenBots. -->");
stringBuilder.AppendLine("## Automation Commands");
stringBuilder.AppendLine("| Command Group | Command Name | Command Description |");
stringBuilder.AppendLine("| --- | --- | --- |");
foreach (var cmd in highLevelCommandInfo)
{
stringBuilder.AppendLine("|" + cmd.Group + "|[" + cmd.Name + "](" + cmd.Location + ")|" + cmd.Description + "|");
}
stringBuilder.AppendLine(Environment.NewLine);
stringBuilder.AppendLine("## Help");
stringBuilder.AppendLine("[Open/Report an issue on GitHub](https://github.com/OpenBotsAI/OpenBots.Studio/issues/new)");
stringBuilder.AppendLine("[Ask a question on the OpenBots forum](https://openbots.ai/forums/)");
//write file
fullFileName = Path.Combine(docsPath, "automation-commands.md");
File.WriteAllText(fullFileName, stringBuilder.ToString());
return(docsPath);
}