What is it, and why?

Conversation Viewer is a WordPress 1.2 2.5 plugin that pulls a external text file into a post and formats it into a defined list, keeping you from having to manually code the conversation into a defined list, ordered list, or Heaven forbid, a ghastly table. I wanted to be able to easily and quickly include conversations into posts, while still keeping the code nice and clean. I tried this manually once with a table, and while the result looked good, the code was rather sloppy and very cumbersome to compose.

How it works

Basically, you tell the plugin the path to your conversation text files, and to insert a conversation, you simply call the text file(s) containing the conversation(s), and it (they) will appear in the post. You can call as many different conversations in one post as you want, just name them uniquely. The nitty gritty of how the plugin works is commented in the plugin code.

Usage

You need three things to get this up and running: the plugin, a text file of a conversation (with proper syntax), and some CSS for styling. Get the plugin here. Change $default_conv_path to the absolute path of the directory you plan on storing your text files of conversations (mine is something like http://www.super-cooper.com/conversations/), then slap it into your plugins folder and activate it. Next, construct your conversation file, which should look something like this:

1. Me,Why did the chicken cross the road?
2. The Wife,Why?.
3. Me,To get to the other side.
4. The Wife,You're crazy.
5. Download this code: conversation-viewer-example-1.txt

Now let’s break this down. This is a conversation between the Wife and I where I am showing off my joke-telling prowess, and she is obviously very impressed. There a basically two parts to the conversation: who’s talking and what they are saying, which are separated by a comma. The plugin looks for the occurence of the first comma, assumes everything to the left of it is the person, and everything to the right of it is what that person is saying. Call the text file in your post like so:

<conversation src="http://www.super-cooper.com/snippets/conversation-viewer-example-1.txt" />

I like to arrange mine in subdirectories by date, and if you have more than one to include in a post, just add the numbers on the end and call them accordingly. Note that this path is relative, you set the root of this path in $default_conv_path in the plugin earlier. The above text conversation, parsed through the browser, would look like so with the plugin and my CSS:

Me:

Why did the chicken cross the road?

The Wife:

Why?.

Me:

To get to the other side.

The Wife:

You’re crazy.

And the code that produced it would look like so:

1. <dl class="conversation">
2. <dt>Me:</dt>
3. <dd>Why did the chicken cross the road?</dd>
4. <dt>The Wife:</dt>
5. <dd>Why?.</dd>
6. <dt>Me:</dt>
7. <dd>To get to the other side.</dd>
8. <dt>The Wife:</dt>
9. <dd>You&#8217;re crazy.</dd>
10. </dl>

The definition term is the person’s name, and what they said is the definition.

Mixing it up

Let’s say you want to emphasize what someone is saying. I like to do this with italics. Well, to style what the person is saying in italics, simply add a pound sign (#) before the person’s name, like so:

1. The Son,I'm having a horndog for dinner.
2. #Me,Really?
3. The Son,U-huh.
4. Me,Don't you mean a corndog?
5. The Son,That's what I said, a corndog.

Which, when called through the plugin and parsed, would look like this:

The Son:

I’m having a horndog for dinner.

Me:

Really?

The Son:

U-huh.

Me:

Don’t you mean a corndog?

The Son:

That’s what I said, a corndog.

And the code that produced it would look like this:

1. <dl class="conversation">
2. <dt>The Son:</dt>
3. <dd>I&#8217;m having a horndog for dinner.</dd>
4. <dt>Me:</dt>
5. <dd class="emphasis">Really?</dd>
6. <dt>The Son:</dt>
7. <dd>U-huh.</dd>
8. <dt>Me:</dt>
9. <dd>Don&#8217;t you mean a corndog?</dd>
10. <dt>The Son:</dt>
11. <dd>That&#8217;s what I said, a corndog.</dd>
12. </dl>

Finally, here’s my CSS that I use for styling my conversations:

1. dl.conversation dt {
2. clear:left;
3. float:left;
4. text-align:right;
5. width:9em;
6. line-height:1.8em;
7. font-weight:bold;
8. }
9. dl.conversation dd {
10. margin:0 7px 0 10em;
11. padding:0;
12. vertical-align:top;
13. line-height:1.8em;
14. }
15. dl dd.emphasis {
16. font-style:italic;
17. }
18. Download this code: conversation-viewer-example-css.txt

Some other examples of this plugin in use can be found here and here.

Other stuff

This plugin was designed for WP 1.2 (yeah, I know I should migrate to 1.5, but I don’t have the time or desire to do so anytime soon), so I have no idea if it will work in 1.5. If it does or doesn’t, please let me know. EDIT: This works in 2.5 as of 2008-04-22. Also works on 2.7 as of 2009-01-02 Any feedback is appreciated, but remember, most of the code I just hacked up from Code Viewer.

1. <?php
2. // convert decimal degrees to degrees/minutes/seconds \\
3. //      some definitions:
4. //      DD=decimal degrees
5. //      DMS=degrees/minutes/seconds
6. //
7. // How this works:
8. // Say you have 32.872352 lat and -91.632563 long
9. // The whole units of the decimal will remain the same, so
10. // 1) multiply the decimal by 60 (0.872352 * 60 = 52.34112), the whole number becomes the minutes (52)
11. // 2) take the remaining decimal (0.34112) and multiply by 60, this is now the seconds, round this to two decimal places (0.34221 * 60 = 20.53)
12. // 3) string them all together 32 52 20.53
13. //
14. // ** LATITUDE ** \\
15. // DEGREES \\
16. // get integer value of latitude from db -> where $lat_dd is a floating point number like 32.872352
17. $lat_dd_int = intval("$lat_dd");
18. //  MINUTES \\
19. //  get DD minutes (whats after the decimal point)-> Lat DD floating point - lat DD integer
20. $lat_dd_m = $lat_dd - $lat_dd_int;
21. // get DMS minutes as floating point -> 60 * DD minutes floating
22. $lat_dms_m_float = 60 * $lat_dd_m;
23. // get int value of lat DMS floating point
24. $lat_dms_m_int = intval("$lat_dms_m_float");
25. // SECONDS \\
26. // get DD seconds -> DMS minutes floating - DMS minutes integer
27. $lat_dd_s = $lat_dms_m_float - $lat_dms_m_int;
28. // convert DD secs to DMS secs -> 60 * DD seconds
29. $lat_dms_s = 60 * $lat_dd_s;
30. // ** LONGITUDE ** \\
31. // DEGREES \\
32. // get integer value of longitude from db -> where $long_dd is a floating point number like -91.632563
33. // this number remains negative
34. $long_dd_int = intval("$long_dd");
35. //  MINUTES \\
36. //  get DD minutes (whats after the decimal point)-> Long DD floating point - long DD integer
37. //  use abs to get rid of the negative sign
38. $long_dd_m = abs($long_dd - $long_dd_int);
39. // get DMS minutes as floating point -> 60 * DD minutes floating
40. $long_dms_m_float = 60 * $long_dd_m;
41. // get int value of long DMS floating
42. $long_dms_m_int = intval("$long_dms_m_float");
43. // SECONDS \\
44. // get DD seconds -> DMS minutes floating - DMS minutes integer
45. $long_dd_s = $long_dms_m_float - $long_dms_m_int;
46. // convert DD secs to DMS secs -> 60 * DD seconds
47. $long_dms_s = 60 * $long_dd_s;
48. // end conversion of lat/long \\
49. // next just echo the output with the degree/minute/second symbols in place
50. ?>
51. Latitude: <?php echo $lat_dd_int; ?>&#176; <?php echo $lat_dms_m_int; ?>&#8217; <?php echo round($lat_dms_s, 2); ?>&#8221;
52. Longitude: <?php echo $long_dd_int; ?>&#176; <?php echo $long_dms_m_int; ?>&#8217; <?php echo round($long_dms_s, 2); ?>&#8221;
53. Download this code: dd-dms-1.txt

Another thing is adding the last modified date to the pages. In the old version, I used some JavaScript I found somewhere to accomplish this. I looks like so:

1. <script language="JavaScript">
2. <!--
3. function getLongDateString()
4. {   //method defined on class Date.
5. //Returns a date string of the form: Day DD Month,YYYY
6. //(e.g. Sunday 27 September, 1998)
7. monthNames = new Array("January","February","March","April", "May","June","July","August","September", "October","November","December");
8. dayNames = new Array("Sunday","Monday","Tuesday","Wednesday", "Thursday","Friday","Saturday");
9. dayOfWeek = this.getDay();
10. day = dayNames[dayOfWeek];
11. dateOfMonth = this.getDate();
12. monthNo = this.getMonth();
13. month = monthNames[monthNo];
14. year = this.getYear();
15. if (year < 2000)
16. year = year + 1900;
17. dateStr = day+", "+month+" "+dateOfMonth+", "+year;
18. return dateStr;
19. }
20. //register the  method in the class Date
21. Date.prototype.getLongDateString=getLongDateString;
22. function DocDate()
23. { //return the document modification date (excl.time)
24. //as a string
25. DateTimeStr = document.lastModified;
26. secOffset = Date.parse(DateTimeStr);
27. if (secOffset == 0 || secOffset == null) //Opera3.2
28. dateStr = "Unknown";
29. else
30. {
31. aDate = new Date();
32. aDate.setTime(secOffset);
33. //use method defined above
34. datestr = aDate.getLongDateString();
35. }
36. return dateStr;
37. }
38. document.write("<center> Last Updated: ");
39. document.writeln(DocDate(),"</center>");
40. //
41. -->
42. </script>

Kinda ridiculously long, eh? Then today I ran across this sweet little piece o’ PHP code that I actually inserted into my footer include file that all of my pages will call. This inserts the last modified date of the template neatly onto my pages, and the date format is, of course, customizable:

1. <?php
2. putenv("TZ=America/Chicago");
3. echo "Page last modified on " . date( "F d, Y", getlastmod() );
4. ?>
5. Download this code: php-vs-asp-2.txt

So what does all of this mean, and why am I seemingly on a soapbox? Well, I’m very pleased so far with PHP (any surprises there?), what it can do, and the ease of getting it do those tasks. Oh yeah, and what is even better is that I am getting paid to do this. Ain’t life grand?