author: madmaxoft <github@xoft.cz> 2014-06-13 00:09:01 +0200
committer: madmaxoft <github@xoft.cz> 2014-06-13 00:10:01 +0200
commit: 72043f5b0cc2e930c2a616d84a8fea25f7224c59 (patch)
tree: c065315ffef3ba8afc500c4a2e061c438498a067 /MCServer/Plugins/APIDump/InfoFile.html
parent: Typo Correction (diff)
download: cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar
cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.gz
cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.bz2
cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.lz
cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.xz
cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.zst
cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.zip
1 files changed, 246 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/InfoFile.html b/MCServer/Plugins/APIDump/InfoFile.html
new file mode 100644
index 000000000..3fff06d20
--- /dev/null
+++ b/MCServer/Plugins/APIDump/InfoFile.html
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>MCServer - Info.lua file</title>
+		<link rel="stylesheet" type="text/css" href="main.css" />
+		<link rel="stylesheet" type="text/css" href="prettify.css" />
+		<script src="prettify.js"></script>
+		<script src="lang-lua.js"></script>
+		<meta charset="UTF-8">
+	</head>
+	<body>
+		<div id="content">
+			<h1>Info.lua file</h1>
+			<h2>Contents</h2>
+			<ul>
+				<li><a href="#Introduction">Introduction</a></li>
+				<li><a href="#Overall">The overall structure</a></li>
+				<li><a href="#AdditionalInformation">AdditionalInformation table</a></li>
+				<li><a href="#Commands">Commands table</a></li>
+				<li><a href="#ConsoleCommands">ConsoleCommands table</a></li>
+				<li><a href="#Permissions">Permissions table</a></li>
+				<li><a href="#Using">Using the file in code</a></li>
+				<li><a href="#Examples">Examples</a></li>
+			</ul>
+			
+			
+			<hr />
+			<a name="Introduction"><h2>Introduction</h2></a>
+			
+			<p>For a long time MCServer plugins were plagued by poor documentation. The plugins worked, people who wrote them knew how to use them, but for anyone new to the plugin it was a terrible ordeal learning how to use it. Most of the times, the plugin authors only wrote what commands the plugin supported, sometimes not even that. Then, there was a call to action to put an end to this, to make documenting the plugins easy and at the same time centralized. Thus, the Info.lua file was born.</p>
+			
+			<p>Most plugins have some parts that are the same across all the plugins. These are commands, console commands and their permissions. If a plugin implemented a command, it would practically copy &amp; paste the same code over and over again. So it makes sense to extract only unique information, centralize it and automate all the parts around it. This was another reason for the Info.lua file - it is a central hub of commands, console commands and their permissions.</p>
+			
+			<p>Last, but not least, we want to make a plugin repository on the web in the future, a repository that would store plugins, their descriptions, comments. It makes sense that the centralized information can be parsed by the repository automatically, so that advanced things, such as searching for a plugin based on a command, or determining whether two plugins collide command-wise, are possible.</p>
+			
+			<p>After this file format has been devised, a tool has been written that allows for an easy generation of the documentation for the plugin in various formats. It outputs the documentation in a format that is perfect for pasting into the forum. It generates documentation in a Markup format to use in README.md on GitHub and similar sites. The clever thing is that you don't need to keep all those formats in sync manually - you edit the Info.lua file and this tool will re-generate the documentation for you.</p>
+			
+			<p>So to sum up, the Info.lua file contains the plugins' commands, console commands, their permissions and possibly the overall plugin documentation, in a structured manner that can be parsed by a program, yet is human readable and editable.</p>
+			
+			
+			<hr />
+			<a name="Overall"><h2>The overall structure</h2></a>
+			
+			<p>The file consist of a declaration of a single Lua table, g_PluginInfo. This table contains all the information, structured, as its members. Each member can be a structure by itself. The entire file is a valid Lua source file, so any tool that syntax-checks Lua source can syntax-check this file. The file is somewhat forward- and backward- compatible, in the sense that it can be extended in any way without breaking.</p>
+			<p>Here's a skeleton of the file:</p>
+<pre class="prettyprint lang-lua">
+g_PluginInfo =
+{
+	Name = "Example Plugin",
+	Date = "2014-06-12",
+	Description = "This is an example plugin that shows how to use the Info.lua file",
+	
+	-- The following members will be documented in greater detail later:
+	AdditionalInformation = {},
+	Commands = {},
+	ConsoleCommands = {},
+	Permissions = {},
+}
+</pre>
+			<p>As you can see, the structure is pretty straightforward. Note that the order of the elements inside the table is not important (Lua property).</p>
+			
+			<p>The first few elements are for book-keeping. They declare the plugin's name, the date in ISO-format, representing the version of the plugin, and the description. The idea is that the description sums up what the plugin is all about, within some two or three sentences.</p>
+			
+			
+			<hr />
+			<a name="AdditionalInformation"><h2>AdditionalInformation table</h2></a>
+			
+			<p>This table is used for more detailed description of the plugin. If there is any non-trivial setup process, dependencies, describe them here. This is where the description should get detailed. Don't worry about using several paragraphs of text here, if it makes the plugin easier to understand.</p>
+			
+			<p>The table should have the following layout:</p>
+<pre class="prettyprint lang-lua">
+AdditionalInformation =
+{
+	{
+		Title = "Chapter 1",
+		Contents = "Describe one big aspect of the plugin here",
+	},
+	{
+		Title = "Chapter 2",
+		Contents = "Describe another big topic",
+	},
+}
+</pre>
+			<p>The idea here is that the tool that is used to generate the documentation from the Info.lua file will create a linkified table of contents and then each of the information elements' contents. This information should be all that is needed to successfully configure, run and manage the plugin.</p>
+			
+			
+			<hr />
+			<a name="Commands"><h2>Commands table</h2></a>
+			
+			<p>The commands table lists all the commands that the plugin implements, together with their handler functions, required permissions, help strings and further information. The table supports recursion, which allows plugins to create multi-word commands easily (such as "//schematic load" and "//schematic save"), each having its own separate handler.</p>
+			
+			<p>The table uses structure similar to the following:</p>
+<pre class="prettyprint lang-lua">
+Commands =
+{
+	["/cmd1"] =
+	{
+		HelpString = "Performs the first action",
+		Permission = "firstplugin.cmds.1",
+		Alias = "/c1",
+		Handler = HandleCmd1,
+		ParameterCombinations =
+		{
+			{
+				Params = "x y z",
+				Help = "Performs the first action at the specified coordinates",
+			},
+			{
+				Params = "-p",
+				Help = "Performs the first action at the player's coordinates",
+			}
+		},
+	},
+	["/cmd2"] =
+	{
+		Alias = {"/c2", "//c2" },
+		Subcommands =
+		{
+			sub1 =  -- This declares a "/cmd2 sub1" command
+			{
+				HelpString = "Performs the second action's first subcommand",
+				Permission = "firstplugin.cmds.2.1",
+				Alias = "1",
+				Handler = HandleCmd2Sub1,
+				ParameterCombinations =
+				{
+					{
+						Params = "x y z",
+						Help = "Performs the second action's first subcommand at the specified coordinates",
+					},
+					{
+						Params = "-p",
+						Help = "Performs the second action's first subcommand at the player's coordinates",
+					}
+				},
+			},
+			sub2 =  -- Declares a "/cmd2 sub2" command
+			{
+				HelpString = "Performs the second action's second subcommand",
+				Permission = "firstplugin.cmds.2.2",
+				Handler = HandleCmd2Sub2,
+			},
+		},
+	},
+}
+</pre>
+		
+		<p>Although it may seem overwhelming at first, there is a "method to this madness". Each element of the Commands table defines one command. Most commands start with a slash, so the special Lua syntax for table elements with non-standard names needs to be applied (<code>["/cmd1"] =</code>). The command can either specify subcommands, or a handler function (specifying both is UndefinedBehavior). Subcommands uses the same structure as the entire Commands table, recursively.</p>
+		
+		<p>The permission element specifies that the command is only available with the specified permission. Note that the permission for subcommand's parent isn't checked when the subcommand is called. This means that specifying the permission for a command that has subcommands has no effect whatsoever, but is discouraged because we may add processing for that in the future.</p>
+		
+		<p>The ParameterCombinations table is used only for generating the documentation, it lists the various combinations of parameters that the command supports. It's worth specifying even if the command supports only one combination, because that combination will get documented this way.</p>
+		
+		<p>The Alias member specifies any possible aliases for the command. Each alias is registered separately and if there is a subcommand table, it is applied to all aliases, just as one would expect. You can specify either a single string as the value (if there's only one alias), or a table of strings for multiple aliases. Commands with no aliases do not need to specify this member at all.</p>
+		
+		
+		<hr />
+		<a name="ConsoleCommands"><h2>ConsoleCommands table</h2>
+		
+		<p>This table serves a purpose similar to that of the Commands table, only these commands are provided for the server console. Therefore, there are no permissions specified for these commands. Since most console commands don't use a leading slash, the command names don't need the special syntax. Also, the handler function doesn't receive the Player parameter.</p>
+		
+		<p>Here's an example of a ConsoleCommands table:</p>
+<pre class="prettyprint lang-lua">
+ConsoleCommands =
+{
+	concmd =
+	{
+		HelpString = "Performs the console action",
+		Subcommands =
+		{
+			sub1 =
+			{
+				HelpString = "Performs the console action's first subcommand",
+				Handler = HandleConCmdSub1,
+				ParameterCombinations =
+				{
+					{
+						Params = "x y z",
+						Help = "Performs the console action's first subcommand at the specified coordinates",
+					},
+				},
+			},
+			sub2 =
+			{
+				HelpString = "Performs the console action's second subcommand",
+				Handler = HandleConCmdSub2,
+			},
+		},
+	},
+}
+</pre>
+
+
+			<hr />
+			<a name="Permissions"><h2>Permissions table</h2></a>
+			
+			<p>The purpose of this table is to document permissions that the plugin uses. The documentation generator automatically collects the permissions specified in the Command table; the Permissions table adds a description for these permissions and may declare other permissions that aren't specifically included in the Command table.</p>
+		
+<pre class="prettyprint lang-lua">
+Permissions =
+{
+	["firstplugin.cmd.1.1"] =
+	{
+		Description = "Allows the players to build high towers using the first action.",
+		RecommendedGroups = "players",
+	},
+	["firstplugin.cmd.2.1"] =
+	{
+		Description = "Allows the players to kill entities using the second action. Note that this may be misused to kill other players, too.",
+		RecommendedGroups = "admins, mods",
+	},
+}
+</pre>
+
+			<p>The RecommendedGroup element lists, in plain English, the intended groups for which the permission should be enabled on a typical server. Plugin authors are advised to create reasonable defaults, prefering security to openness, so that admins using these settings blindly don't expose their servers to malicious users.</p>
+
+
+			<hr />
+			<a name="Using"><h2>Using the file in code</h2></a>
+			
+			<p>Just writing the Info.lua file and saving it to the plugin folder is not enough for it to actually be used. Your plugin needs to include the following boilerplate code, preferably in its Initialize() function:</p>
+<pre class="prettyprint lang-lua">
+-- Use the InfoReg shared library to process the Info.lua file:
+dofile(cPluginManager:GetPluginsPath() .. "/InfoReg.lua")
+RegisterPluginInfoCommands()
+RegisterPluginInfoConsoleCommands()
+</pre>
+
+			<p>Of course, if your plugin doesn't have any console commands, it doesn't need to call the RegisterPluginInfoConsoleCommands() function, and similarly if it doesn't have any in-game commands, it doesn't need to call the RegisterPluginInfoCommands() function.</p>
+			
+			
+			<hr />
+			<a name="Examples"><h2>Examples</h2></a>
+			
+			<p>There are several plugins that already implement this approach. You can visit them for inspiration and to see what the generated documentation looks like:</p>
+			<ul>
+				<li>Gallery plugin: <a href="https://github.com/mc-server/Gallery/blob/master/Info.lua">Info.lua</a>, <a href="http://forum.mc-server.org/showthread.php?tid=1306">Forum</a> documentation</li>
+				<li>WorldEdit plugin: <a href="https://github.com/mc-server/WorldEdit/blob/master/Info.lua">Info.lua</a>, <a href="http://forum.mc-server.org/showthread.php?tid=870">Forum</a> and <a href="https://github.com/mc-server/WorldEdit">MarkDown</a> documentation</li>
+			</ul>
+
+			<script>
+				prettyPrint();
+			</script>
+		</div>
+	</body>
+</html>
author	madmaxoft <github@xoft.cz>	2014-06-13 00:09:01 +0200
committer	madmaxoft <github@xoft.cz>	2014-06-13 00:10:01 +0200
commit	72043f5b0cc2e930c2a616d84a8fea25f7224c59 (patch)
tree	c065315ffef3ba8afc500c4a2e061c438498a067 /MCServer/Plugins/APIDump/InfoFile.html
parent	Typo Correction (diff)
download	cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.gz cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.bz2 cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.lz cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.xz cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.tar.zst cuberite-72043f5b0cc2e930c2a616d84a8fea25f7224c59.zip