X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=encode.php;h=ab2c2715ad1767dec0f157de69043ebd56e7465b;hb=af5b67ada7a9801a6ed36df4026a2a09110700e6;hp=5b8eadf9426beb13051670821f51991f8f4bf25d;hpb=130669e105c06dbfa3272ae9a2c41d5f11003a80;p=wfpl.git

diff --git a/encode.php b/encode.php
index 5b8eadf..ab2c271 100644
--- a/encode.php
+++ b/encode.php
@@ -4,20 +4,19 @@
 #
 #  This file is part of wfpl.
 #
-#  wfpl is free software; you can redistribute it and/or modify it
-#  under the terms of the GNU General Public License as published by
-#  the Free Software Foundation; either version 2, or (at your option)
+#  wfpl is free software; you can redistribute it and/or modify it under the
+#  terms of the GNU Lesser General Public License as published by the Free
+#  Software Foundation; either version 2.1 of the License, or (at your option)
 #  any later version.
 #
-#  wfpl is distributed in the hope that it will be useful, but
-#  WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  General Public License for more details.
+#  wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
+#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
+#  more details.
 #
-#  You should have received a copy of the GNU General Public License
-#  along with wfpl; see the file COPYING.  If not, write to the
-#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-#  MA 02111-1307, USA.
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with wfpl; if not, write to the Free Software Foundation, Inc., 51
+#  Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 
 # This file contains basic encodings. These are used by the encoder. You can
@@ -35,7 +34,9 @@ function enc_sql($str) {
 	return $str;
 }
 
-# encode for output in html. does nothing with whitespace
+# Encode for output in html. does nothing with whitespace
+#
+# Example: <p>~foo.html~</p>
 function enc_html($str) {
 	$str = str_replace('&', '&amp;', $str);
 	$str = str_replace('<', '&lt;', $str);
@@ -44,14 +45,27 @@ function enc_html($str) {
 }
 
 
-# html attributes (eg  <input value="...."
+# HTML attribute.
+#
+# Example: <input name="foo" value="~foo.attr~">
 function enc_attr($str) {
 	$str = str_replace('&', '&amp;', $str);
 	$str = str_replace('"', '&quot;', $str);
 	return $str;
 }
 
-# this is a stupid hack to work around html's stupid syntax for checkboxes
+# URI agument value.
+#
+# Example:  <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
+function enc_url_val($str) {
+	return rawurlencode($str);
+}
+
+# This is a hack to work around html's stupid syntax for checkboxes.
+#
+# Place the template marker just before a " somewhere.
+#
+# Example: <input type="checkbox" name="foo~foo.checked~">
 function enc_checked($str) {
 	if($str == 'Yes') {
 		return '" checked="checked';