From 9e55ba0e82f68702eeb5577998f597876edc15c9 Mon Sep 17 00:00:00 2001
From: Jason Woofenden <jason@jasonwoof.com>
Date: Sat, 27 Mar 2010 00:42:38 -0400
Subject: [PATCH] encode.php: update comments/examples

---
 encode.php |   27 +++++++++++++--------------
 1 file changed, 13 insertions(+), 14 deletions(-)

diff --git a/encode.php b/encode.php
index 6afcd41..b81a4fc 100644
--- a/encode.php
+++ b/encode.php
@@ -17,9 +17,9 @@
 
 
 # This file contains basic encodings. These are used by the encoder. You can
-# specify any template tag to be encoded with this syntax: ~variable.encoding~
+# specify any template tag to be encoded with this syntax: ~variable encoding~
 #
-# this example: <p>~foo.html~</p>
+# this example: <p>~foo html~</p>
 # will encode foo (using enc_html()) before displaying it, so that characters
 # such as < will display properly.
 
@@ -43,7 +43,7 @@ function enc_sql($str) {
 
 # Encode for output in html. does nothing with whitespace
 #
-# Example: <p>~foo.html~</p>
+# Example: <p>~foo html~</p>
 function enc_html($str) {
 	$str = str_replace('&', '&amp;', $str);
 	$str = str_replace('<', '&lt;', $str);
@@ -53,7 +53,7 @@ function enc_html($str) {
 
 # Encode for output in html. Convert newlines to <br />
 #
-# Example: <p>~foo.htmlbr~</p>
+# Example: <p>~foo htmlbr~</p>
 function enc_htmlbr($str) {
 	$str = enc_html($str);
 	$str = str_replace("\n", "<br />\n", $str);
@@ -63,7 +63,7 @@ function enc_htmlbr($str) {
 # Encode for output in html. Preserves newlines and indentation by converting
 # newlines to <br /> and spaces at the begining of lines to &nbsp;&nbsp;
 #
-# Example: <p>~foo.htmlbrtab~</p>
+# Example: <p>~foo htmlbrtab~</p>
 function enc_htmlbrtab($str) {
 	$str = enc_htmlbr($str);
 	$space_to_nbsp = create_function('$matches', 'return str_repeat(\'&nbsp;\', strlen($matches[0]) * 2);');
@@ -73,7 +73,7 @@ function enc_htmlbrtab($str) {
 
 # Encode for output in html. Spaces converted to &nbsp; and \n to <br />
 #
-# Example: <option value="12">~foo.htmlbrnbsp~</option>
+# Example: <option value="12">~foo htmlbrnbsp~</option>
 function enc_htmlbrnbsp($str) {
 	$str = enc_htmlbr($str);
 	$str = str_replace(' ', '&nbsp;', $str);
@@ -82,7 +82,7 @@ function enc_htmlbrnbsp($str) {
 
 # Encode for output in html. Spaces converted to &nbsp;
 #
-# Example: <option value="12">~foo.htmlnbsp~</option>
+# Example: <option value="12">~foo htmlnbsp~</option>
 function enc_htmlnbsp($str) {
 	$str = enc_html($str);
 	$str = str_replace(' ', '&nbsp;', $str);
@@ -92,7 +92,7 @@ function enc_htmlnbsp($str) {
 
 # HTML attribute.
 #
-# Example: <input name="foo" value="~foo.attr~">
+# Example: <input name="foo" value="~foo attr~">
 function enc_attr($str) {
 	$str = str_replace('&', '&amp;', $str);
 	$str = str_replace('"', '&quot;', $str);
@@ -101,7 +101,7 @@ function enc_attr($str) {
 
 # URI agument value.
 #
-# Example:  <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
+# 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);
 }
@@ -118,7 +118,7 @@ function enc_url_path($str) {
 #
 # Place the template marker just before a " somewhere.
 #
-# Example: <input type="checkbox" name="foo~foo.checked~">
+# Example: <input type="checkbox" name="foo~foo checked~">
 function enc_checked($str) {
 	if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
 		return '" checked="checked';
@@ -127,9 +127,8 @@ function enc_checked($str) {
 	}
 }
 
-# checkboxe values are stored in the db and handled in php as 0 or 1. When you
-# want it displayed as "Yes" or "No" use this:
-# Example: (displaying values from a form submission)  Over 60?: ~over_60.yesno~
+# normally, checkboxes values from get/post to 0 or 1, and stored in the database this way. enc_yesno() can be used in your templates to display this as "Yes" or "No".
+# Example template:  Subscribe to mailing list?: ~subscribe yesno~
 function enc_yesno($str) {
 	if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
 		return 'Yes';
@@ -380,7 +379,7 @@ function enc_thumb_height($str) {
 	return $height;
 }
 
-# example template: Length: ~length.html~ day~length.s~
+# example template: Length: ~length html~ day~length s~
 function enc_s($str) {
 	if($str == '1') {
 		return '';
-- 
1.7.10.4