Initial public release<\/p>\n
The Travelog plugin provides several functions for interacting with your Travelog. There are three sets of functions provided; General Functions, Advanced Functions and Internal Functions:<\/p>\n
These functions allow for basic retrieval and output of location information for posts<\/p>\n
travelog_summary_info() Outputs a string with location information about the post. It shows the location name (which is linked to a GoogleMap of the location) as well as the coordinates of the location in degree-minute-second format. This is meant to be used on your index.php page right below the post title. If there is no location associated with the post, nothing is displayed.<\/p>\n
the_latitude() Outputs the latitude of the location associated with the post in decimal degree format.<\/p>\n
the_latitudeDMS() Outputs the latitude of the location associated with the post in degree-minute-second format (dd? mm' ss\").<\/p>\n
the_longitude() Outputs the longitude of the location associated with the post in decimal degree format.<\/p>\n
the_longitudeDMS() Outputs the longitude of the location associated with the post in degree-minute-second format (dd? mm' ss\").<\/p>\n
the_location_name() Outputs the name of the location associated with the post.<\/p>\n
the_location_description() Outputs the description of the location associated with the post.<\/p>\n
get_latitude() Returns the value of the latitude for the location associated with the post in decimal degree format, with north latitudes being positive and south latitudes being negative. This can be used if you want to display the latitude in some other format, check to make sure there is a latitude for the post or output different latitudes differently.<\/p>\n
get_longitude() Returns the value of the longitude for the location associated with the post in decimal degree format, with east longitudes being positive and west longitudes being negative. This can be used if you want to display the longitudes in some other format, check to make sure there is a longitudes for the post or output different longitudes differently.<\/p>\n
get_location_name() Returns the name of the location associated with the post.<\/p>\n
get_location_description() Returns the description of the location associated with the post.<\/p>\n
map_location_url($map, $location_id) Returns the URL for a map of the location whose ID is passed as $location_id. $map lets you choose which mapping service to use. Acceptable values for $map are: * 'GoogleMaps' * 'MapQuest' * 'AcmeMap' * 'GeoURL' * 'GeoCache' * 'SideBit' * 'DegreeConfluence' * 'TopoZone' * 'FindU' * 'MapTech'<\/p>\n
distance_between($id1, $id2, $unit) Calculates the distance between the two locations whose ids are passed as $id1 and $id2 (using their latitudes & longitudes), and returns the value as a number in terms of the units specified in the $unit parameter. For kilometers use 'k', for miles use 'm' and for nautical miles use 'n'.<\/p>\n
These functions control the inner workings of the Travelog plugin, and provide advanced access to the information contained in your Travelog. You should have at least moderate experience working with PHP if you want to use these functions.<\/p>\n
NOTE: All the advanced functions are contained in the static class 'Travelog'. To call them in your templates, you must add 'Travelog::' in front of their names (eg. to call get_categories(), you would use **<\/p>\n
add_location($location) Adds a location to your Travelog based on information passed in the $location parameter. $location must be an object with variables for each of the Travelog database fields.<\/p>\n
get_locations($category, $limit, $order) Returns an array of objects, one object for each location in your travelog, and each object has a set of variables containing the all information about that location.<\/p>\n
get_location($id) Returns a location object with all the information for the location whose id is passed as the id parameter.<\/p>\n
get_post_location() Returns a location object with all the information for the location associated with the post. If no location is associated with the post and a default location is set, the location object will contain information about the default location.<\/p>\n
get_categories() Returns an numerically-indexed array of all of the Travelog category names<\/p>\n
coordinate_DMS($value, $coordinate) Returns a HTML string showing the value of the coordinate passed as $value in the degrees-minutes-seconds format. $coordinate must be either 'latitude' or 'longitude' to tell the function which direction (N\/S or E\/W) to append on the end.<\/p>\n
These functions control the inner workings of the Travelog plugin, and should not be used in your templates. If you want to make changes to how the Travelog plugin works, this is where it should be done, but only if you have an advanced understanding of PHP, as making any changes could destroy your Travelog. The functions are just listed briefly here to let you know generally what they do.<\/p>\n
inline_locations($content) Used to process travelog tags that appear within posts<\/p>\n
update_post($post_id) Does the processing of associating a location with a post<\/p>\n
add_menus() Displays the Travelog links in the Options and Manage sub-menus in the WordPress Site Admin<\/p>\n
install_db() Create the travelog database table and initializes the Travelog's WordPress options<\/p>\n
edit_form_advanced() Controls what is shown on the Edit Post Page<\/p>\n
show_adminheader() CSS and HTML to create the submenu on the Manage page<\/p>\n
manage_locations() Handles the addition, updating and removal of locations and categories<\/p>\n
manage_options() Handles the updating of Travelog's options<\/p>\n
googlemaps_javahook() Outputs a javascript link in the page headers to allow [http:\/\/maps.google.com\/ GoogleMaps] to be embedded.<\/p>\n
coordinate_metatags() Outputs some standard meta tags with location information<\/p>\n\n\n
<!-- by --><\/p>\n
to be:<\/p>\n <a href="\" rel=\"bookmark\" title=\"Permanent Link to \"> <\/a>\n
\n <!-- by --><\/p>\n
Make similar modifications to archive.php and search.php. Alternatively, You can create your own customized location information output using the Travelog's PHP functions, which are listed and described below. 4. Modify your WordPress theme so that location information is displayed for posts in detail view. The easiest way to do this is to use the standard Travelog output function, travelog_single_info(). This is done by adding the following code to your single.php file, right after the post date information. For the default theme, you would change:<\/p>\n
on at \nand is filed under .<\/p>\n
to be:<\/p>\n
on at \n and is filed under .<\/p>\n
Again, you can create your own custom output using Travelog's PHP functions listed and described below. 5. Review the Travelog options by clicking on Travelog on the Options page sub-menu of WordPress's Site Admin. 6. Start adding locations to your Travelog by clicking on Travelog on the Manage page sub-menu of WordPress's Site Admin<\/p>\n
The Travelog plugin is licensed under the GPL (the same license that WordPress uses), and to sum it up, you can freely use, distribute and modify this plugin however you desire. If you do use it on your site, I'd appreciate you [http:\/\/www.sublimity.ca\/2005\/09\/01\/travelog\/#coments leaving a comment on my site] telling me what you think about it, but it's more to satisfy my curiousity about what ends up happening to this little project of mine than anything else, so it's not a big deal.<\/p>\n
If you find any bugs (I'm sure there are some in here), or have ideas about things you'd like to see in future releases of this plugin, [http:\/\/www.sublimity.ca\/2005\/09\/01\/travelog\/#coments please let me know] (especially if you'd like to help implement them). I'll do my best to implement suggestions, but I can't make any rock-solid promises as there is more to life than coding...<\/p>\n