Simplified and more clearer infodump for Github.
This commit is contained in:
parent
854cf9df99
commit
0c8d08cb09
@ -317,26 +317,19 @@ local function WriteCommandsCategoryGithub(a_Category, f)
|
|||||||
if (CategoryName == "") then
|
if (CategoryName == "") then
|
||||||
CategoryName = "General";
|
CategoryName = "General";
|
||||||
end
|
end
|
||||||
f:write("\n## ", GithubizeString(a_Category.DisplayName or CategoryName), "\n");
|
f:write("\n### ", GithubizeString(a_Category.DisplayName or CategoryName), "\n");
|
||||||
|
|
||||||
-- Write description:
|
-- Write description:
|
||||||
if (a_Category.Description ~= "") then
|
if (a_Category.Description ~= "") then
|
||||||
f:write(GithubizeString(a_Category.Description), "\n");
|
f:write(GithubizeString(a_Category.Description), "\n\n");
|
||||||
end
|
end
|
||||||
|
|
||||||
|
f:write("| Command | Permission | Discription | \n")
|
||||||
|
f:write("| ------- | ---------- | ----------- | \n")
|
||||||
|
|
||||||
-- Write commands:
|
-- Write commands:
|
||||||
f:write("\n");
|
|
||||||
for idx2, cmd in ipairs(a_Category.Commands) do
|
for idx2, cmd in ipairs(a_Category.Commands) do
|
||||||
f:write("\n### ", cmd.CommandString, "\n", GithubizeString(cmd.Info.HelpString or "UNDOCUMENTED"), "\n\n");
|
f:write("|", cmd.CommandString, " | ", cmd.Info.Permission or "", " | ", GithubizeString(cmd.Info.HelpString or "UNDOCUMENTED"), "| \n")
|
||||||
if (cmd.Info.Permission ~= nil) then
|
|
||||||
f:write("Permission required: **", cmd.Info.Permission, "**\n\n");
|
|
||||||
end
|
|
||||||
if (cmd.Info.DetailedDescription ~= nil) then
|
|
||||||
f:write(GithubizeString(cmd.Info.DetailedDescription));
|
|
||||||
end
|
|
||||||
if (cmd.Info.ParameterCombinations ~= nil) then
|
|
||||||
WriteCommandParameterCombinationsGithub(cmd.CommandString, cmd.Info.ParameterCombinations, f);
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
f:write("\n\n")
|
f:write("\n\n")
|
||||||
end
|
end
|
||||||
@ -601,7 +594,7 @@ local function DumpPluginInfoGithub(a_PluginFolder, a_PluginInfo)
|
|||||||
f:write(GithubizeString(a_PluginInfo.Description), "\n");
|
f:write(GithubizeString(a_PluginInfo.Description), "\n");
|
||||||
DumpAdditionalInfoGithub(a_PluginInfo, f);
|
DumpAdditionalInfoGithub(a_PluginInfo, f);
|
||||||
DumpCommandsGithub(a_PluginInfo, f);
|
DumpCommandsGithub(a_PluginInfo, f);
|
||||||
DumpPermissionsGithub(a_PluginInfo, f);
|
--DumpPermissionsGithub(a_PluginInfo, f); -- Seems a little overkill since they are already mentioned in the commands.
|
||||||
|
|
||||||
f:close();
|
f:close();
|
||||||
end
|
end
|
||||||
|
Loading…
Reference in New Issue
Block a user