Improved documentation.
authorphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Wed, 15 Jan 2014 20:24:51 +0000 (20:24 +0000)
committerphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Wed, 15 Jan 2014 20:24:51 +0000 (20:24 +0000)
git-svn-id: http://www.winterrodeln.org/svn/servermediawiki/mediawiki_extensions/wrreport/trunk@1883 7aebc617-e5e2-0310-91dc-80fb5f6d2477

wrreport.php

index f114af97a5b799109eb0fea06ca59437da53bbd0..30c33b774eb2d8474f574f997e051eb1e7ef0a8a 100644 (file)
@@ -22,6 +22,8 @@
 //
 // <rodelbahntabelle/>
 //     Generates a list of sledrun entries in a flexible way.
 //
 // <rodelbahntabelle/>
 //     Generates a list of sledrun entries in a flexible way.
+//     Each line (entry) either add sledruns or removes sledruns.
+//     Without entries, the table contains no sledruns.
 //
 //     Examples:
 //     Empty list:
 //
 //     Examples:
 //     Empty list:
 //             <rodelbahn>Rumer Alm</rodelbahn>
 //         </rodelbahntabelle>
 //
 //             <rodelbahn>Rumer Alm</rodelbahn>
 //         </rodelbahntabelle>
 //
-//     All sledruns in region Innsbruck
+//     All sledruns in region Innsbruck thats entries are not "under construction".
+//     The name of the region has to correspond to a name (column name)
+//     in the table wrregion.
 //         <rodelbahntabelle>
 //             <region>Innsbruck</region>
 //         </rodelbahntabelle>
 //
 //         <rodelbahntabelle>
 //             <region>Innsbruck</region>
 //         </rodelbahntabelle>
 //
-//     All sledruns in region Innsbruck thats entries are not "under construction"
+//     Same as above but excluding the sledrun "Rumer Alm":
 //         <rodelbahntabelle>
 //             <region>Innsbruck</region>
 //             <rodelbahn operation="-">Rumer Alm</rodelbahn>
 //         <rodelbahntabelle>
 //             <region>Innsbruck</region>
 //             <rodelbahn operation="-">Rumer Alm</rodelbahn>
@@ -50,9 +54,9 @@
 //         </rodelbahntabelle>
 //
 //     Attributes:
 //         </rodelbahntabelle>
 //
 //     Attributes:
-//         * in_arbeit: values "ja" "nein" (default for region and rodelbahnen), "*" (default for rodelbahn)
+//         * in_arbeit: values "ja", "nein" (default for <region> and <rodelbahnen>), "*" (default for <rodelbahn>)
 //             Just include the sledrun(s) if the condition is fulfilled.
 //             Just include the sledrun(s) if the condition is fulfilled.
-//         * operation: values "+" (add the sledrun to the set, default), "-" (subtract the sledrun from the set)
+//         * operation: values "+" (add the sledrun(s) to the set, default), "-" (subtract the sledrun(s) from the set)
 //     Attributes that may be implemented later
 //         * beleuchtungstage: values "0", "unknown" (is null), ">0" (excludes null), "7", "*" (includes null)
 //             Just include the sledrun(s) if the condition is fulfilled.
 //     Attributes that may be implemented later
 //         * beleuchtungstage: values "0", "unknown" (is null), ">0" (excludes null), "7", "*" (includes null)
 //             Just include the sledrun(s) if the condition is fulfilled.