diff options
Diffstat (limited to 'config/schema')
-rw-r--r-- | config/schema/packages.dtd | 224 |
1 files changed, 224 insertions, 0 deletions
diff --git a/config/schema/packages.dtd b/config/schema/packages.dtd new file mode 100644 index 00000000..abb4cd6a --- /dev/null +++ b/config/schema/packages.dtd @@ -0,0 +1,224 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- ...................................................................... --> +<!-- pfSense Package DTD V1.0 ............................................. --> +<!-- File package.dtd ..................................................... --> +<!-- +/* $Id$ */ +/* ========================================================================== */ +/* + package.dtd + part of pfSense (http://www.pfSense.com) + Copyright (C) 2007 Daniel S. Haischt <me@daniel.stefan.haischt.name> + All rights reserved. + + Based on m0n0wall (http://m0n0.ch/wall) + Copyright (C) 2003-2006 Manuel Kasper <mk@neon1.net>. + All rights reserved. + */ +/* ========================================================================== */ +/* + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY + AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, + OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. + */ +/* ========================================================================== */ +--> +<!-- + | + | May be parsed using http://dtdparse.sourceforge.net/ to generate an + | HTML document that describes this DTD. + | +--> +<!-- Indicates the version of a package --> +<!ELEMENT version (#PCDATA)> +<!-- Indicates where to get more informations about this package --> +<!ELEMENT url (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT depends_on_service (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT tooltiptext (#PCDATA)> +<!-- The title of a particular package --> +<!ELEMENT title (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT textneeded (#PCDATA)> +<!-- Categroy of a particular package (e.g. System) --> +<!ELEMENT category (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT note (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT savetext (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT preoutput (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT donotsave (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT text (#PCDATA)> +<!-- Container element. Contains several tab elements --> +<!ELEMENT tabs ((tab*))> +<!-- A specific tab that is part of a tab pane --> +<!ELEMENT tab ((text, url, active?))> +<!-- A service that may be executed while starting the system --> +<!ELEMENT service ((name, rcfile?, executable?, description?))> +<!-- needs to be documented --> +<!ELEMENT section (#PCDATA)> +<!-- Indicates what particular kind of components may be required to run this package --> +<!ELEMENT requirements (#PCDATA)> +<!-- Shell script that is beeing used to start and stop a service --> +<!ELEMENT rcfile (#PCDATA)> +<!-- Executable that represents a service --> +<!ELEMENT executable (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT prefix (#PCDATA)> +<!-- Root node of a package definition. Container element --> +<!ELEMENT packagegui ((copyright, description, requirements, faq, name, version, title, category?, note?, savetext?, preoutput?, donotsave?, aftersaveredirect?, include_file?, backup_file?, delete_string?, addedit_string?, menu*, service*, modify_system?, tabs?, configpath?, adddeleteeditpagefields?, additional_files_needed*, fields?, custom_php_global_functions?, custom_php_command_before_form?, custom_delete_php_command?, custom_add_php_command?, custom_php_resync_config_command?, custom_php_validation_command?, custom_add_php_command_late?, start_command?, restart_command?, process_kill_command?, custom_php_after_form_command?, custom_php_resync_config_command?, custom_php_install_command?, custom_php_deinstall_command?, custom_php_before_form_command?, custom_php_after_head_command?, templates?))> +<!-- A particular name --> +<!ELEMENT name (#PCDATA)> +<!-- Menu item. Container element --> +<!ELEMENT menu ((name, tooltiptext?, section?, configfile?, url?, depends_on_service?))> +<!-- needs to be documented --> +<!ELEMENT modifyitem ((modifyfilename?, textneeded?))> +<!-- needs to be documented --> +<!ELEMENT item (#PCDATA)> +<!-- A PHP file that needs to be included prior to executing arbitrary PHP code --> +<!ELEMENT include_file (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT backup_file (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT delete_string (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT addedit_string (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT aftersaveredirect (#PCDATA)> +<!-- FAQ items or an URL that points to certain FAQ items --> +<!ELEMENT faq (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT modifyfilename (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT modify_system ((modifyitem+))> +<!-- needs to be documented --> +<!ELEMENT rowhelperfield ((fielddescr, fieldname, description, type, size?, options?))> +<!-- needs to be documented --> +<!ELEMENT rowhelper ((rowhelperfield+))> +<!-- needs to be documented --> +<!ELEMENT size (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT donotdisable (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT enablefields (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT required EMPTY> +<!-- needs to be documented --> +<!ELEMENT multiple (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT default_value (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT value (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT type (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT cols (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT rows (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT combinefieldsbegin (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT combinefieldsend (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT dontdisplayname (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT dontcombinecells (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT onchange (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT encoding (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT typehint (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT options ((option+))> +<!-- needs to be documented --> +<!ELEMENT option ((name, value))> +<!-- needs to be documented --> +<!ELEMENT fields ((field*))> +<!-- needs to be documented --> +<!ELEMENT filename (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT fieldname (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT fielddescr (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT validationtype (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT field ((fielddescr, fieldname, description?, type, donotdisable?, enablefields?, size?, required?, default_value?, value?, multiple?, options?, cols?, rows?, typehint?, onchange?, encoding?, combinefieldsend?, combinefieldsbegin?, rowhelper?, dontdisplayname?, dontcombinecells?, validationtype?))> +<!-- needs to be documented --> +<!ELEMENT description (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_global_functions (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_command_before_form (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_delete_php_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_add_php_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_resync_config_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_validation_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_add_php_command_late (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT process_kill_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT start_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT restart_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_after_form_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_install_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_deinstall_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_after_head_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT custom_php_before_form_command (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT copyright (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT configpath (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT configfile (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT chmod (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT columnitem ((fielddescr, fieldname))> +<!-- needs to be documented --> +<!ELEMENT adddeleteeditpagefields ((columnitem+))> +<!-- needs to be documented --> +<!ELEMENT additional_files_needed ((prefix?, chmod?, item))> +<!-- needs to be documented --> +<!ELEMENT active EMPTY> +<!-- needs to be documented --> +<!ELEMENT templates ((template+))> +<!-- needs to be documented --> +<!ELEMENT templatecontents (#PCDATA)> +<!-- needs to be documented --> +<!ELEMENT template ((filename, templatecontents))> +<!-- End of pfSense package DTD V1.0 ...................................... --> +<!-- ...................................................................... --> |