plugin-info.rng

<!-- This is the RelaxNG Schema for Wedge's plugin manifest - plugin-info.xml - files. -->

<!-- Define the initial structure of the root element. Other than the first items, everything is optional (one per), and in any order. -->
<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">

	<start>
		<element name="plugin">
			<attribute name="id">
				<text/>
			</attribute>
			<optional>
				<attribute name="maintenance">
					<text/>
				</attribute>
			</optional>
			<interleave>
				<ref name="name" />
				<ref name="author" />
				<ref name="description" />
				<ref name="version" />
				<optional>
					<ref name="website" />
				</optional>
				<optional>
					<ref name="min-versions" />
				</optional>
				<optional>
					<ref name="required-functions" />
				</optional>
				<optional>
					<ref name="settings" />
				</optional>
				<optional>
					<ref name="settings-page" />
				</optional>
				<optional>
					<ref name="database" />
				</optional>
				<optional>
					<ref name="hooks" />
				</optional>
				<optional>
					<ref name="newperms" />
				</optional>
				<optional>
					<ref name="scheduledtasks" />
				</optional>
				<optional>
					<ref name="actions" />
				</optional>
				<optional>
					<ref name="readmes" />
				</optional>
				<optional>
					<ref name="bbcodes" />
				</optional>
				<optional>
					<ref name="acp-url" />
				</optional>
			</interleave>
		</element>
	</start>

	<!-- Now the individual elements and their content. -->
	<!-- The plugin's name -->
	<define name="name">
		<element name="name">
			<text/>
		</element>
	</define>

	<!-- The plugin's author, plus optional details about them. -->
	<define name="author">
		<element name="author">
			<text/>
			<optional>
				<attribute name="url">
					<data type="string"/>
				</attribute>
			</optional>
			<optional>
				<attribute name="email">
					<data type="string"/>
				</attribute>
			</optional>
		</element>
	</define>

	<!-- The plugin's description. -->
	<define name="description">
		<element name="description">
			<text/>
		</element>
	</define>

	<!-- The plugin's version. -->
	<define name="version">
		<element name="version">
			<text/>
		</element>
	</define>

	<!-- A plugin may specify a dedicated website if it so wishes. -->
	<define name="website">
		<element name="website">
			<text/>
		</element>
	</define>

	<!-- Minimum versions for PHP and MySQL. -->
	<define name="min-versions">
		<element name="min-versions">
			<interleave>
				<optional>
					<element name="php">
						<text/>
					</element>
				</optional>
				<optional>
					<element name="mysql">
						<text/>
					</element>
				</optional>
			</interleave>
		</element>
	</define>

	<!-- Required PHP functions. -->
	<define name="required-functions">
		<element name="required-functions">
			<oneOrMore>
				<element name="php-function">
					<text/>
				</element>
			</oneOrMore>
		</element>
	</define>

	<!-- A plugin defining the settings it creates/uses. -->
	<define name="settings">
		<element name="settings">
			<oneOrMore>
				<element name="setting">
					<attribute name="name">
						<data type="string"/>
					</attribute>
					<attribute name="default">
						<data type="string"/>
					</attribute>
				</element>
			</oneOrMore>
		</element>
	</define>

	<!-- A simple settings page that is to be added. -->
	<define name="settings-page">
		<element name="settings-page">
			<attribute name="area">
				<text/>
			</attribute>
			<optional>
				<attribute name="icon">
					<text/>
				</attribute>
			</optional>
			<optional>
				<attribute name="bigicon">
					<text/>
				</attribute>
			</optional>
			<optional>
				<attribute name="permission">
					<text/>
				</attribute>
			</optional>
			<interleave>
				<zeroOrMore>
					<element name="language">
						<attribute name="file">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="desc">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="title">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="check">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="yesno">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="literal">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="email">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="password">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="text">
						<attribute name="name">
							<text/>
						</attribute>
						<optional>
							<attribute name="size">
								<data type="positiveInteger" />
							</attribute>
						</optional>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="large-text">
						<attribute name="name">
							<text/>
						</attribute>
						<optional>
							<attribute name="size">
								<data type="positiveInteger" />
							</attribute>
						</optional>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="select">
						<attribute name="name">
							<text/>
						</attribute>
						<oneOrMore>
							<element name="option">
								<attribute name="name">
									<text/>
								</attribute>
								<attribute name="value">
									<text/>
								</attribute>
							</element>
						</oneOrMore>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="multi-select">
						<attribute name="name">
							<text/>
						</attribute>
						<oneOrMore>
							<element name="option">
								<attribute name="name">
									<text/>
								</attribute>
								<attribute name="value">
									<text/>
								</attribute>
							</element>
						</oneOrMore>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="int">
						<attribute name="name">
							<text/>
						</attribute>
						<optional>
							<attribute name="min">
								<data type="integer" />
							</attribute>
						</optional>
						<optional>
							<attribute name="max">
								<data type="integer" />
							</attribute>
						</optional>
						<optional>
							<attribute name="step">
								<data type="positiveInteger" />
							</attribute>
						</optional>
						<optional>
							<attribute name="size">
								<data type="positiveInteger" />
							</attribute>
						</optional>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="float">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="percent">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="permissions">
						<attribute name="name">
							<text/>
						</attribute>
						<optional>
							<attribute name="noguests">
								<text/>
							</attribute>
						</optional>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="boards">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="bbc">
						<attribute name="name">
							<text/>
						</attribute>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="hr">
						<empty></empty>
					</element>
				</zeroOrMore>
			</interleave>
		</element>
	</define>

	<!-- The database changes a plugin wants to make. -->
	<define name="database">
		<element name="database">
			<interleave>
				<optional>
					<element name="tables">
						<interleave>
							<oneOrMore>
								<element name="table">
									<attribute name="if-exists">
										<choice>
											<value>update</value>
											<value>ignore</value>
										</choice>
									</attribute>
									<attribute name="name">
										<data type="string"/>
									</attribute>
									<element name="columns">
										<oneOrMore>
											<element name="column">
												<attribute name="name">
													<data type="string"/>
												</attribute>
												<attribute name="type">
													<choice>
														<value>tinyint</value>
														<value>smallint</value>
														<value>mediumint</value>
														<value>int</value>
														<value>bigint</value>
														<value>float</value>
														<value>real</value>
														<value>double</value>
														<value>char</value>
														<value>varchar</value>
														<value>text</value>
														<value>mediumtext</value>
														<value>set</value>
														<value>enum</value>
													</choice>
												</attribute>
												<optional>
													<attribute name="autoincrement">
														<choice>
															<value>yes</value>
															<value>no</value>
														</choice>
													</attribute>
												</optional>
												<optional>
													<attribute name="unsigned">
														<choice>
															<value>yes</value>
															<value>no</value>
														</choice>
													</attribute>
												</optional>
												<optional>
													<attribute name="size">
														<data type="integer"/>
													</attribute>
												</optional>
												<optional>
													<attribute name="values">
														<data type="string"/>
													</attribute>
												</optional>
												<optional>
													<attribute name="default">
														<data type="string"/>
													</attribute>
												</optional>
												<optional>
													<attribute name="null">
														<choice>
															<value>yes</value>
															<value>no</value>
														</choice>
													</attribute>
												</optional>
											</element>
										</oneOrMore>
									</element>
									<zeroOrMore>
										<element name="index">
											<attribute name="type">
												<choice>
													<value>primary</value>
													<value>unique</value>
													<value>index</value>
												</choice>
											</attribute>
											<optional>
												<attribute name="name">
													<text/>
												</attribute>
											</optional>
											<oneOrMore>
												<element name="field">
													<text/>
												</element>
											</oneOrMore>
										</element>
									</zeroOrMore>
								</element>
							</oneOrMore>
						</interleave>
					</element>
				</optional>
				<optional>
					<element name="columns">
						<oneOrMore>
							<element name="column">
								<attribute name="name">
									<data type="string"/>
								</attribute>
								<attribute name="table">
									<data type="string"/>
								</attribute>
								<attribute name="type">
									<choice>
										<value>tinyint</value>
										<value>smallint</value>
										<value>mediumint</value>
										<value>int</value>
										<value>bigint</value>
										<value>float</value>
										<value>real</value>
										<value>double</value>
										<value>char</value>
										<value>varchar</value>
										<value>text</value>
										<value>mediumtext</value>
										<value>set</value>
										<value>enum</value>
									</choice>
								</attribute>
								<optional>
									<attribute name="autoincrement">
										<choice>
											<value>yes</value>
											<value>no</value>
										</choice>
									</attribute>
								</optional>
								<optional>
									<attribute name="unsigned">
										<choice>
											<value>yes</value>
											<value>no</value>
										</choice>
									</attribute>
								</optional>
								<optional>
									<attribute name="size">
										<data type="integer"/>
									</attribute>
								</optional>
								<optional>
									<attribute name="values">
										<data type="string"/>
									</attribute>
								</optional>
								<optional>
									<attribute name="default">
										<data type="string"/>
									</attribute>
								</optional>
								<optional>
									<attribute name="null">
										<choice>
											<value>yes</value>
											<value>no</value>
										</choice>
									</attribute>
								</optional>
							</element>
						</oneOrMore>
					</element>
				</optional>
				<optional>
					<element name="indexes">
						<oneOrMore>
							<element name="index">
								<attribute name="type">
									<value>index</value>
								</attribute>
								<optional>
									<attribute name="name">
										<data type="string"/>
									</attribute>
								</optional>
								<attribute name="table">
									<data type="string"/>
								</attribute>
								<oneOrMore>
									<element name="field">
										<text/>
									</element>
								</oneOrMore>
							</element>
						</oneOrMore>
					</element>
				</optional>
				<optional>
					<element name="scripts">
						<optional>
							<element name="enable">
								<text/>
							</element>
						</optional>
						<optional>
							<element name="disable">
								<text/>
							</element>
						</optional>
						<optional>
							<element name="remove">
								<text/>
							</element>
						</optional>
						<optional>
							<element name="remove-clean">
								<text/>
							</element>
						</optional>
					</element>
				</optional>
			</interleave>
		</element>
	</define>

	<!-- The hooks a plugin wants to use. -->
	<define name="hooks">
		<element name="hooks">
			<interleave>
				<zeroOrMore>
					<element name="function">
						<attribute name="point">
							<data type="string"/>
						</attribute>
						<attribute name="function">
							<data type="string"/>
						</attribute>
						<optional>
							<attribute name="filename">
								<data type="string"/>
							</attribute>
						</optional>
						<optional>
							<attribute name="optional">
								<choice>
									<value>yes</value>
									<value>no</value>
								</choice>
							</attribute>
						</optional>
						<optional>
							<attribute name="priority">
								<data type="positiveInteger"/>
							</attribute>
						</optional>
					</element>
				</zeroOrMore>
				<zeroOrMore>
					<element name="language">
						<attribute name="point">
							<data type="string"/>
						</attribute>
						<attribute name="filename">
							<data type="string"/>
						</attribute>
					</element>
				</zeroOrMore>
				<optional>
					<element name="provides">
						<oneOrMore>
							<element name="hook">
								<text/>
								<attribute name="type">
									<choice>
										<value>function</value>
										<value>language</value>
									</choice>
								</attribute>
							</element>
						</oneOrMore>
					</element>
				</optional>
			</interleave>
		</element>
	</define>

	<!-- The permissions a plugin wants to make. -->
	<define name="newperms">
		<element name="newperms">
			<attribute name="filename">
				<data type="string"/>
			</attribute>
			<optional>
				<element name="groups">
					<oneOrMore>
						<element name="group">
							<attribute name="type">
								<choice>
									<value>membergroup</value>
									<value>board</value>
								</choice>
							</attribute>
							<optional>
								<attribute name="column">
									<choice>
										<value>left</value>
										<value>right</value>
									</choice>
								</attribute>
							</optional>
							<attribute name="name">
								<data type="string"/>
							</attribute>
						</element>
					</oneOrMore>
				</element>
			</optional>
			<element name="permissions">
				<oneOrMore>
					<element name="permission">
						<attribute name="type">
							<choice>
								<value>membergroup</value>
								<value>board</value>
							</choice>
						</attribute>
						<attribute name="name">
							<data type="string"/>
						</attribute>
						<attribute name="ownany">
							<choice>
								<value>true</value>
								<value>false</value>
							</choice>
						</attribute>
						<attribute name="group">
							<data type="string"/>
						</attribute>
					</element>
				</oneOrMore>
			</element>
		</element>
	</define>

	<!-- Any scheduled tasks a plugin makes use of. -->
	<define name="scheduledtasks">
		<element name="scheduledtasks">
			<oneOrMore>
				<element name="task">
					<attribute name="runevery">
						<data type="positiveInteger"/>
					</attribute>
					<attribute name="runfreq">
						<choice>
							<value>minute</value>
							<value>hour</value>
							<value>day</value>
							<value>week</value>
						</choice>
					</attribute>
					<attribute name="name">
						<data type="string"/>
					</attribute>
					<optional>
						<attribute name="file">
							<data type="string"/>
						</attribute>
					</optional>
				</element>
			</oneOrMore>
		</element>
	</define>

	<!-- A plugin may declare one or more actions that it wants to use. -->
	<define name="actions">
		<element name="actions">
			<oneOrMore>
				<element name="action">
					<attribute name="action">
						<data type="string"/>
					</attribute>
					<attribute name="function">
						<data type="string"/>
					</attribute>
					<attribute name="filename">
						<data type="string"/>
					</attribute>
					<optional>
						<attribute name="nolog">
							<data type="string"/>
						</attribute>
					</optional>
				</element>
			</oneOrMore>
		</element>
	</define>

	<!-- A plugin may declare some custom bbcode that it wants to use (or is, really) -->
	<define name="bbcodes">
		<element name="bbcodes">
			<oneOrMore>
				<element name="bbcode">
					<attribute name="tag">
						<text/>
					</attribute>
					<attribute name="type">
						<choice>
							<value>parsed</value>
							<value>unparsed_equals</value>
							<value>parsed_equals</value>
							<value>unparsed_content</value>
							<value>closed</value>
							<value>unparsed_commas</value>
							<value>unparsed_commas_content</value>
							<value>unparsed_equals_content</value>
						</choice>
					</attribute>
					<optional>
						<attribute name="block-level">
							<choice>
								<value>yes</value>
								<value>no</value>
							</choice>
						</attribute>
					</optional>
					<optional>
						<attribute name="quoted">
							<choice>
								<value>none</value>
								<value>optional</value>
								<value>required</value>
							</choice>
						</attribute>
					</optional>
					<optional>
						<attribute name="trim-wspace">
							<choice>
								<value>none</value>
								<value>inside</value>
								<value>outside</value>
								<value>both</value>
							</choice>
						</attribute>
					</optional>
					<optional>
						<element name="before-code">
							<text/>
						</element>
					</optional>
					<optional>
						<element name="after-code">
							<text/>
						</element>
					</optional>
					<optional>
						<element name="content">
							<text/>
						</element>
					</optional>
					<optional>
						<element name="test">
							<text/>
						</element>
					</optional>
					<optional>
						<element name="disabled">
							<optional>
								<element name="before-code">
									<text/>
								</element>
							</optional>
							<optional>
								<element name="after-code">
									<text/>
								</element>
							</optional>
							<optional>
								<element name="content">
									<text/>
								</element>
							</optional>
						</element>
					</optional>
					<optional>
						<element name="validate-func">
							<text/>
						</element>
					</optional>
					<optional>
						<element name="disallow-children">
							<oneOrMore>
								<element name="child">
									<text/>
								</element>
							</oneOrMore>
						</element>
					</optional>
					<optional>
						<element name="require-parents">
							<oneOrMore>
								<element name="parent-tag">
									<text/>
								</element>
							</oneOrMore>
						</element>
					</optional>
					<optional>
						<element name="require-children">
							<oneOrMore>
								<element name="child">
									<text/>
								</element>
							</oneOrMore>
						</element>
					</optional>
					<optional>
						<element name="parsed-tags-allowed">
							<oneOrMore>
								<element name="bbc">
									<text/>
								</element>
							</oneOrMore>
						</element>
					</optional>
					<optional>
						<element name="params">
							<oneOrMore>
								<element name="param">
									<attribute name="name">
										<text/>
									</attribute>
									<optional>
										<attribute name="quoted">
											<choice>
												<value>yes</value>
												<value>no</value>
											</choice>
										</attribute>
									</optional>
									<optional>
										<attribute name="optional">
											<choice>
												<value>yes</value>
												<value>no</value>
											</choice>
										</attribute>
									</optional>
									<optional>
										<element name="match">
											<text/>
										</element>
									</optional>
									<optional>
										<element name="validate">
											<text/>
										</element>
									</optional>
									<optional>
										<element name="value">
											<text/>
										</element>
									</optional>
								</element>
							</oneOrMore>
						</element>
					</optional>
				</element>
			</oneOrMore>
		</element>
	</define>

	<!-- A plugin may declare some readme files, in potentially multiple languages, but if 'readmes' is specified, at least one readme is required. -->
	<define name="readmes">
		<element name="readmes">
			<oneOrMore>
				<element name="readme">
					<text/>
					<attribute name="lang">
						<text/>
					</attribute>
				</element>
			</oneOrMore>
		</element>
	</define>

	<!-- A plugin may declare a partial URL (relative to Wedge installation's index.php) for its settings. -->
	<define name="acp-url">
		<element name="acp-url">
			<text/>
		</element>
	</define>
</grammar>