*****************************************************
* Topic description - Modification for SMF          *
* version 1.1                                       *
* © 2007, Rudolf Martincsek                         *
*****************************************************
Please read thoroughly this file, because it contains vital information on how to use and/or customize other themes to use with this mod. If still in trouble visit the official thread over the official SMF support forum.

Table of contents
  1. Description
  2. Installation
  3. Customizing
  4. Final notes
  5. Changelog

1. Description

This mod will add a Description field to the topics. When posting a new topic you will be supplied with an extra field to insert your short description of the topic. Maximum of 200 characters.
You can edit the topic description from the board index using the quick edit feature, or from the topic page quick- or normal editing the first post.

2. Installation

This mod has been tested with SMF versions 1.1.1
Install using the Package Manager in your forum's Admin section. Before you install this version make sure you uninstall any previous versions. This will not remove your settings.
This mod supports only the 'default' theme. (Note: The "default" one that came with SMF, and not your forum's default!) If you are using another theme or a modified version of this one, consult the "4. Customizing" section below.
Uninstalling the mod will *not* remove your settings! Reinstalling or upgrading your mod will use the already existing settings.

3. Customizing

This mod changes the 'default' theme. If you're using a different theme, you will have to apply the theme modifications for every theme where you want this feature to work. Not modifying a theme to support this mod will *not* break your forum, said theme, or computer. However there are a couple of files you need to modify for the various quick edit functions to work: Display.template.php and MessageIndex.template.php
If you want to modify a theme there are two ways you can do it.
a) Open the package and look at the theme.xml file. If you understand the format you can apply the changes to your theme following the operations done there. Obviously this is the hard way.
b) The normal way would be to search for the default template files open it and copy over your themes the modified parts.

The template files would be: Display.template.php, MessageIndex.template.php and Post.template.php. You can find these in 'Themes\default' folder.
You will find sections between //-Topic description MOD- Start and //-Topic description MOD- End. The code betwen this you'll have to copy in the template files of the other theme, in the same place. Occasionally you will find a simple //--Topic description MOD- something comment. In this case only the line is added/modified.
Note: The code in other template files could look different. If it's so you'll have to figure out the correct place where to put the code. Experiment. If everything else fails, ask for support.

This mod is language customizeable. That is if you are using another language then english you can and you will have to translate it.
How to translate:
The only language file modified is: index.english.php. Add the following line at the end (but before the "?>" part) of index.your_language.php: 
$txt['topic_description'] = 'translation_of_the word_"Description"_here'; //-Topic description MOD-

4. Final notes

  1. The description is added to the description meta tag of the pages.

5. Changelog:

Topic description 1.1 - 14th january 2007
! Description field not set in quick reply form (Display.template.php)

Topic description 1.0 - 7th january 2007
! Wrong database prefix used in a query (Post.php)

Topic description 1.0 - 1th january 2007
+ First release