Re: Module: CarCost (Car Operating Costs and Mileage Statistics)

Oliver Riesen-Mallmann — Thu, 20 Aug 2015 06:39:59 -0500

New version 1.0.2:

2015/08/20 version 1.0.2 by Oliver Riesen 
- Rewrite of install file.

Re: Module: CarCost (Car Operating Costs and Mileage Statistics)

Oliver Riesen-Mallmann — Mon, 25 Aug 2008 17:04:17 -0500

New version 1.0.1:

2008/08/26 version 1.0.1 by Oliver Riesen 
- Bug fix undefined index in template read.tpl.

Module: CarCost (Car Operating Costs and Mileage Statistics)

Oliver Riesen-Mallmann — Wed, 28 May 2008 09:11:37 -0500

Module: CarCost
Version: 1.0.2
Author: Oliver Riesen <oliver@riesen.org>

Adds link to CarCost (Car Operating Costs and Mileage Statistics) to user profile.

Tested on version 5.2.20.

License:

Free to use, modify, or redistribute this code so long as I am given credit for the original development somewhere. This code comes with absolutly no warranty.

Requirements:

Minimum Phorum version: 5.2.0.

Installation:

1. Unpack the archive.

2. Move the directory "carcost" to the directory "mods" within your Phorum installation. Don't change the directory name!

3. Login as administrator in Phorum's administrative interface and go to the "Modules" section.

4. Enable the module "CarCost".

5. Templates must be configured to show mileage link. Suggested template changes are included below.

Module settings:

This module doesn't have settings.

Language support:

This module supports multiple languages.

The following languages are included:

- English
- German (formal)
- German (informal) male
- German (informal) female

If you want to translate the module to a new language, you'll have to do the following:

Copy lang/english.php to lang/yourlang.php (yourlang.php must have the same name as Phorum's main language file that you use). After this, translate the strings in lang/yourlang.php.

If you have created a translation for this module, please post a zip file containing lang/yourlang.php in this module thread at phorum.org, so the translation can be added to the module package.

Main template customization:

To display the mileage link on various Phorum pages, you will have to edit the Phorum template files. Here is a description of the files and some sample implementations for the emerald template. The added code is shown here inside the a box.

* read.tpl (flat read mode)

Incorporate the code for example like below, to make it show up under the user details.


...
...

    
        {IF MESSAGES->URL->PROFILE}{/IF}{MESSAGES->author}{IF MESSAGES->URL->PROFILE}{/IF}
        {IF MESSAGES->URL->PM}[ {LANG->PrivateReply} ]{/IF}
    
    ______________________________________________________________
   |                                                              |
    {IF MESSAGES->user->mod_carcost}{INCLUDE "carcost::read"}{/IF}
   |______________________________________________________________|

    
    {MESSAGES->subject} {IF MESSAGES->new}{MESSAGES->new}{/IF}

    {MESSAGES->datestamp}
    

...
...

* read_hybrid.tpl (hybrid read mode)

Incorporate the code for example like below, to make it show up under the user details.


...
...

    
        {IF MESSAGES->URL->PROFILE}{/IF}{MESSAGES->author}{IF MESSAGES->URL->PROFILE}{/IF}
        {IF MESSAGES->URL->PM}[ {LANG->PrivateReply} ]{/IF}
    
    _____________________________________________________________________
   |                                                                     |
    {IF MESSAGES->user->mod_carcost}{INCLUDE "carcost::read_hybrid"}{/IF}
   |_____________________________________________________________________|

    
    {MESSAGES->subject} {IF MESSAGES->new}{MESSAGES->new}{/IF}

    {MESSAGES->datestamp}
    

...
...

* read_threads.tpl (threaded read mode)

Incorporate the code for example like below, to make it show up under the user details.


...
...

    
        {IF MESSAGE->URL->PROFILE}{/IF}{MESSAGE->author}{IF MESSAGE->URL->PROFILE}{/IF}
        {IF MESSAGE->URL->PM}[ {LANG->PrivateReply} ]{/IF}
    

    _____________________________________________________________________
   |                                                                     |
    {IF MESSAGE->user->mod_carcost}{INCLUDE "carcost::read_threads"}{/IF}
   |_____________________________________________________________________|
    {MESSAGE->datestamp}

...
...

* profile.tpl (if you want the user's mileage link to appear in the profile
page)

Incorporate the code for example like below, to make it show up under the user details.


...
...
    {IF PROFILE->date_last_active}
        {LANG->DateActive}: 
        {PROFILE->date_last_active}
    {/IF}
    __________________________________________________________
   |                                                          |
    {IF PROFILE->mod_carcost}{INCLUDE "carcost::profile"}{/IF}
   |__________________________________________________________|

...
...

Module template customization:

By default, this module will use the template files from the directory "templates/emerald".

If you want to modify the templates to make them work better for your site's template, then do not edit the template files that were in the module distribution. Instead, copy the full directory

  mods/carcost/templates/emerald

  mods/carcost/templates/yourtemplatename

(asuming that your active site's template is stored as "templates/yourtemplatename") and edit the files in the new directory. Phorum will automatically recognize that you have created a specific template set to use for your site's active template.

Sanity Checks:

If you have problems with this module login as administrator in Phorum's administrative interface and go to the "System Sanity Checks" section. Check for warnings or errors for the CarCost Module.

The following checks are performed:

- Exists custom profile field?
- Exists default language file?
- Exists forum specific language file(s)?
- Custom language file(s) contains same array keys as the english file?
- Templates contain includes?

GitHub:

Contribute on GitHub: langzeittest/phorum-module-carcost

Changelog:

2015/08/20 version 1.0.2 by Oliver Riesen
- Rewrite of install file.

2008/08/26 version 1.0.1 by Oliver Riesen
- Bug fix undefined index in template read.tpl.

2008/05/25 version 1.0.0 by Oliver Riesen
- Initial release for Phorum 5.2.