[Sommaire] [Imprimer]

   1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2  <html>
   3  <head>
   4    <title>Geeklog Documentation - Theme How-To</title>
   5    <link rel="stylesheet" type="text/css" href="docstyle.css" title="Dev Stylesheet">
   6  </head>
   7  
   8  <body>
   9  <table cellpadding="2" cellspacing="2" border="0" width="100%">
  10  <tr>
  11    <td valign="top"><img src="images/newlogo.gif" alt="Geeklog Documentation" width="243" height="90" border="0"></td>
  12  </tr>
  13  <tr>
  14    <td valign="top" class="menu"><a href="index.html">Geeklog Documentation</a> - Theme How-To</td>
  15  </tr>
  16  </table>
  17  
  18  <p><small>(see below for a list of <a href="#changes">theme changes</a> in
  19  recent Geeklog versions)</small></p>
  20  
  21  
  22  <h1>Creating a Theme for Geeklog</h1>
  23  
  24  <p>Creating a theme for Geeklog is easy and quite fast. If you can
  25  manipulate HTML files then you can create a theme! There's no need to learn
  26  PHP.
  27  
  28  <h2>Creating a theme</h2>
  29  
  30  <p>First, copy an existing theme that is most similar to what you want to
  31  implement (if one exists). If what you will do is radically different (and
  32  we hope so!) then copying any one will do. Copy the existing theme to the
  33  name you want your theme to have (please, <em>no</em> spaces in the theme name):
  34  
  35  <p><kbd>cp -R /path/to/geeklog/public_html/layout/Yahoo /path/to/geeklog/public_html/layout/My_Theme_Name_No_Spaces</kbd>
  36  
  37  <p>Change into your new theme directory:
  38  
  39  <p><kbd>cd /path/to/geeklog/public_html/layout/My_Theme_Name_No_Spaces</kbd>
  40  
  41  <p>Now edit the templates to suit your needs. Keep in mind that templates,
  42  generally are partial HTML files. The directory you just created holds ALL
  43  templates Geeklog needs but you will only need to modify a small few to
  44  make a huge impact on the look.
  45  
  46  <p>In particular these are the templates you will undoubtedly want to
  47  change:
  48  
  49  <ul>
  50  <li>header.thtml
  51  <li>footer.thtml
  52  <li>blockheader.thtml
  53  <li>blockfooter.thtml
  54  <li>storybody.thtml
  55  <li>storybodytext.thtml
  56  <li>featuredstorybody.thtml
  57  <li>featuredstorybodytext.thtml
  58  <li>archivestorybody.thtml
  59  <li>archivestorybodytext.thtml
  60  <li>style.css
  61  </ul>
  62  
  63  <h3><a name="how-themes-work">How themes work</a></h3>
  64  
  65  <p>When rendering a theme, Geeklog starts with <tt>header.thtml</tt> which
  66  builds the site's header and then goes on to include the left column of blocks
  67  (look for the variable {left_blocks} and the <tt>leftblocks.thtml</tt> file).
  68  The middle part of a site consists of the stories which are built using the
  69  <tt>storytext.thtml</tt> and <tt>storybodytext.thtml</tt> (for normal stories)
  70  and <tt>featuredstorytext.thtml</tt> and <tt>featuredstorybodytext.thtml</tt>
  71  (for featured stories) template files. The <tt>footer.thtml</tt> file then
  72  builds the right column of blocks (variable {right_blocks}, file
  73  <tt>right_blocks.thtml</tt>) and the site's footer. Blocks themselves consist
  74  of the <tt>blockheader.thtml</tt> and <tt>blockfooter.thtml</tt> files.
  75  
  76  <p>The above only describes how Geeklog's main page and stories are rendered.
  77  More templates exist for the various editors and lists you will see in Geeklog,
  78  as well as for the calendar and almost every other part of Geeklog.</p>
  79  
  80  <p>There is currently no complete list available that explains which template
  81  file is used for which part of Geeklog. However, in most cases the use should
  82  be obvious when you have a look at the file and directory names in your theme's
  83  layout directory. If you're unsure which template file is used to render a
  84  certain part of Geeklog, have a look at the URL. You will notice the name of
  85  a PHP file there, e.g. the <tt>users.php</tt> file when you view a user's
  86  profile. Open that file and search for '<kbd>.thtml</kbd>'. For the profile
  87  you will find these lines (in <code>function userprofile()</code>):</p>
  88  <blockquote><code>
  89      $user_templates = new Template ($_CONF['path_layout'] . 'users');<br>
  90      $user_templates->set_file (array ('profile'=>'profile.thtml', 'row'=>'commentrow.thtml', 'strow'=>'storyrow.thtml'));
  91  </code></blockquote>
  92  <p>You don't need to understand PHP code to see that this uses the template
  93  files <tt>profile.thtml</tt>, <tt>commentrow.thtml</tt>, and
  94  <tt>storyrow.thtml</tt>. The first line also indicates that these are taken
  95  from the <tt>users</tt> directory within the theme's layout directory.</p>
  96  
  97  <p>An <a href="themevars.html">incomplete list of variables</a> that can be
  98  used in templates files is also included.</p>
  99  
 100  <h3><a name="testing">Testing a theme and further information</a></h3>
 101  
 102  <p>After you have edited your themes, you are now ready to test it out.
 103  Simply go to http://mygeeklogsite/usersettings.php?mode=preferences - in the
 104  theme drop-down select your newly created theme (note the name of your theme is
 105  the <em>same</em> name as the directory for your theme).
 106  
 107  <p>Finally, you may want to update the logo and other images in your
 108  theme's images directory.
 109  
 110  <p>For the template system we are using PHPLib's template class (<a
 111  href="http://phplib.sourceforge.net/">http://phplib.sourceforge.net/</a>).
 112  Read their documentation and, optionally, look at
 113  /path/to/geeklog/system/classes/template.class.php to see how it is
 114  implemented. Even with this knowledge it may not be clear which templates
 115  are used in conjunction with one another (i.e. <tt>storybody.thtml</tt> and
 116  <tt>storybodytext.thtml</tt> together make up the complete format of a
 117  <em>single</em>
 118  story). If you have questions join our mailing list at <a
 119  href="http://lists.geeklog.net/listinfo/geeklog-users">http://lists.geeklog.net/listinfo/geeklog-users</a>
 120  or check us out in IRC at irc.freenode.net in #geeklog.</p>
 121  
 122  <h3><a name="tips">Tips and tricks</a></h3>
 123  
 124  <p><strong><a name="wysiwyg">Themes and WYSIWYG editors:</a></strong>
 125  The template files used by Geeklog are not complete HTML files - they contain
 126  only parts of the HTML that Geeklog puts together to build a proper HTML
 127  document. This, however, seems to confuse some WYSIWYG HTML editors and some of
 128  them tend to add the HTML which they think is missing from the file, thus
 129  making it unusable for Geeklog.<br>
 130  We suggest you use a simple text editor to edit your themes.</p>
 131  
 132  <p><strong><a name="php">PHP in themes:</a></strong>
 133  You can use PHP in the <em>header</em> of a theme, i.e. in the
 134  <tt>header.thtml</tt> file. If you want to use custom PHP functions, you can
 135  put them in the file <tt>functions.php</tt> within your themes directory.</p>
 136  
 137  <p><strong><a name="different-look">Different look for left and right blocks:</a></strong>
 138  You can give the blocks on the left and right a different look. See
 139  <a href="http://www.geeklog.net/forum/viewtopic.php?showtopic=21070">this story on the Geeklog homepage</a> for details.</p>
 140  
 141  <p><strong><a name="polls">Polls:</a></strong>
 142  To use multi-colored bars in the graphical display of poll results, you can use
 143  the <code>{answer_counter}</code> and <code>{answer_odd}</code> variables in
 144  the <tt>pollbooth/pollvotes_bar.thtml</tt> template file.
 145  <code>{answer_counter}</code> will be replaced with a running number for each
 146  answer, hence <code>bar{answer_counter}.gif</code> would result in
 147  <tt>bar1.gif</tt>, <tt>bar2.gif</tt>, etc. Giving each of those GIFs a different
 148  color would give you a different color for each answer.<br>
 149  <code>{answer_odd}</code> will alternate between 0 and 1 for every answer, hence
 150  <code>bar{answer_odd}.gif</code> will result in <tt>bar0.gif</tt> for the first,
 151  third, fifth, etc. answer and <tt>bar1.gif</tt> for the second, fourth, etc.
 152  answer.</p>
 153  
 154  <p><strong><a name="left-blocks">Left blocks in the right column:</a></strong>
 155  <code>$_CONF['left_blocks_in_footer']</code> (in <tt>config.php</tt>) is a
 156  rather curious option. It makes the <code>{left_blocks}</code> variable
 157  available in the site's footer (i.e. <tt>footer.thtml</tt>) while at the same
 158  time disabling it in the header (<tt>header.thtml</tt>).<br>
 159  The idea is that this can be used for two-column layouts (one column for the
 160  blocks and one column for the content) but when you want to have the blocks
 161  on the right side. Simply moving all blocks to the right will not work as
 162  expected, as you'd end up with <em>no blocks</em> at all on those pages that
 163  normally only display the left blocks (e.g. <tt>article.php</tt> or the
 164  admin pages). Setting <code>$_CONF['left_blocks_in_footer'] = 1</code> will
 165  fix this, so that the blocks, while internally still treated as <em>left</em>
 166  blocks, will actually be displayed on the <em>right</em>.<br>
 167  The theme's <tt>header.thtml</tt>, <tt>footer.thtml</tt>, and
 168  <tt>leftblocks.thtml</tt> will probably need some adjustments. It is also
 169  recommended to leave the <code>$_CONF</code> variable unchanged in
 170  <tt>config.php</tt> and overwrite it in the theme's <tt>functions.php</tt>
 171  instead. That way, you can even leave your users a choice between, for example,
 172  a "normal" theme and one with the blocks on the right.</p>
 173  
 174  <p><strong><a name="error-message">Error Message:</a></strong>
 175  Since Geeklog 1.4.1 it is possible to control what HTML is displayed to
 176  non-root users in the event of an error occurring (a crash bug). To do
 177  so, you need to change the function <code>CUSTOM_handleError</code> in
 178  lib-custom.php to output any HTML you like.</p>
 179  
 180  <h2><a name="changes">Theme changes in Geeklog 1.4.1</a></h2>
 181  
 182  <p>The css in 1.4.1 has been changed to a wider extent. More and more layout
 183  components are beeing moved to the stylesheet so more change in looks can be
 184  achieved with less change in the files. There is a reduction of tables and DIV,
 185  and a stronger focus on semantics and consistency. Please also notice that the
 186  styles.css includes additional documentation on the use of classes now.</p>
 187  
 188  <p>As usual, any missing new theme files can simply be copied over from the
 189  default theme (Professional) that ships with Geeklog.</p>
 190  
 191  <h3>Header-Tags</h3>
 192  
 193  <p>From now on, all headlines in blocks & stories are made with header-tags. The
 194  biggest title in a story is always h1, in a block always h2.</p>
 195  
 196  <h3>Story layout</h3>
 197  <p>The blocks for stories have no more tables, and the classes have been renamed
 198  for consistency. There is a box now around the story called class "story" or
 199  "story-featured". The components inside that box are story-icons,
 200  story-information, story-body and story-footer. The title is a h1-tag. For
 201  featured stories, only the outer box has a different class, the rest has to be
 202  cascaded for changes.</p>
 203  
 204  <h3>Blocks</h3>
 205  <p>The blocks changed in the same way as the stories. There are no more tables,
 206  only one div-tag as a frame around called block-box, block-box-left or
 207  block-box-right. The title is a h2-tag and the help icon for the block is a span
 208   with a class called block-helpicon. Sub-titles in blocks have the h3-tag (such
 209   such as in the What's new or Older Stories block). The changes affect (next to
 210   styles.css) the follwing files:</p>
 211  <ul>
 212  <li>blockfooter-left.thtml</li>
 213  <li>blockfooter-related.thtml</li>
 214  <li>blockfooter-right.thtml</li>
 215  <li>blockfooter.thtml</li>
 216  <li>blockheader-left.thtml</li>
 217  <li>blockheader-message.thtml</li>
 218  <li>blockheader-related.thtml</li>
 219  <li>blockheader-right.thtml</li>
 220  <li>blockheader.thtml</li>
 221  </ul>
 222  
 223  <h3>Admin templates</h3>
 224  
 225  <p>Many of the admin template files have had minor changes to tweak appearance
 226  or functionality. If you didn't modify the admin templates in your theme, the
 227  easiest way to upgrade your theme's admin templates is to simply replace the
 228  entire 'admin' directory with the one from Geeklog's Professional theme.</p>
 229  
 230  <ul>
 231  <li>All the "delete" buttons in the admin's editors (story editor, etc.) now
 232      pop up a JavaScript confirmation box as a simple measure against
 233      accidental deletion. If you'd rather not have that confirmation box,
 234      replace the <code>{delete_option}</code> variable with
 235      <code>{delete_option_no_confirmation}</code> in the admin templates.</li>
 236  <li>The order of the save / cancel / delete buttons is now consistent across
 237      all admin template files (changed <tt>group/groupeditor.thtml</tt> and
 238      <tt>user/edituser.thtml</tt>).</li>
 239  <li>Changed the top links in <tt>lists/topmenu_nosearch.thtml</tt> and
 240      <tt>topic/topiclist.thtml</tt> to be consistent with the other admin areas
 241      (i.e. the links are no longer enclosed in square brackets).</li>
 242  <li>To enable changing the group ownership of "gldefault" blocks, the
 243      <tt>defaultblockeditor.thtml</tt> has to be changed to include a
 244      <code>{group_dropdown}</code> variable.
 245  </ul>
 246  
 247  <h3>Other theme changes</h3>
 248  
 249  <ul>
 250  <li>There was a div for spreading the with of the blocks to a minimum in the
 251      files leftblocks.thtml and rightblocks.thtml. The format of those has been
 252      transferred to the stylesheet with the class name block-bg-spreader</li>
 253  <li>The template for the Polls-plugin has renamed classes block-vote-results to
 254      poll-vote-results and block-vote to poll-vote to avoid confustion with
 255      block-related classes.</li>
 256  <li>The template files used by the Calendar plugin are now located in the
 257      plugin's directory, (<tt>/path/to/geeklog/plugins/calendar/templates</tt>),
 258      so the entire 'calendar' directory can be removed from the theme
 259      directory.<br>
 260      The <tt>submitevent.thtml</tt>, <tt>editpersonalevent.thtml</tt>,
 261      <tt>admin/eventeditor.thtml</tt>, and <tt>dayview/quickaddform.thtml</tt>
 262      have also been changed to (optionally) support entering the time in <a
 263      href="calendar.html#desc_hour_mode">24 hour mode</a>: A hidden input field
 264      "hour_mode" is now required, the am/pm dropdowns are available as variables
 265      <code>{startampm_selection}</code>, <code>{endampm_selection}</code>,
 266      <code>{ampm_selection}</code>, depending on the template file), and the
 267      dropdowns for the minutes are available as variables
 268      (<code>{startminute_options}</code>, <code>{endminute_options}</code>,
 269      <code>{minute_options}</code>, depending on the template file).</li>
 270  <li>The variables <code>{author}</code> and <code>{owner}</code> are now
 271      available in every template where an object's author (e.g. story or
 272      comment author) or owner (e.g. owner of a block) name can be displayed.
 273      They will also respect the <a
 274      href="config.html#desc_show_fullname">$_CONF['show_fullname']</a> setting,
 275      i.e. display either the user's full name or username.</li>
 276  <li>The Article Author's tag in <tt>storytext.thtml</tt> and
 277      <tt>featuredstorytext.thtml</tt> is now called
 278      <code>{contributedby_author}.</code></li>
 279  <li>To enable a remarks field in the answer to polls, the
 280      <tt>pollvotes_bar.thtml</tt>, <tt>pollansweroption.thtml</tt> and
 281      <tt>polleditor.thtml</tt> were changed. The
 282      <tt>pollvotes_bar.thtml</tt> is now colored and has two lines, a class
 283      for color coding each line and the <code>{answer_text}</code>. The
 284      <tt>polleditor.thtml</tt> has an aditional field to enter the remarks,
 285      same as the <tt>pollansweroption.thtml</tt>.
 286  <li>A user's Account Information page has been redesigned. While there were no
 287      technical changes (i.e. template files from earlier versions will still
 288      work), some options have been rearranged and a note has been added to tell
 289      the user that the current password is required to change those. Affected
 290      files in the <tt>preferences</tt> directory: <tt>profile.thtml</tt>,
 291      <tt>username.thtml</tt>, and <tt>userphoto.thtml</tt>.</li>
 292  <li>The <tt>navbar</tt> directory now contains four files,
 293      <tt>menuitem.thtml</tt>,<tt>navbar.thtml</tt>,<tt>breadcrumbs.thtml</tt>,<tt>breadcrumb_link</tt> as well as two images,
 294      <tt>button.gif</tt> and <tt>button_over.gif</tt>.</li>
 295  <li>A <a name="captcha"><code>{captcha}</code></a> variable has been added to
 296      the following files:
 297      <ul>
 298      <li><tt>comment/commentform.thtml</tt></li>
 299      <li><tt>comment/commentform_advanced.thtml</tt></li>
 300      <li><tt>profiles/contactauthorform.thtml</tt></li>
 301      <li><tt>profiles/contactuserform.thtml</tt></li>
 302      <li><tt>submit/submitstory.thtml</tt></li>
 303      <li><tt>submit/submitstory_advanced.thtml</tt></li>
 304      <li><tt>users/registrationform.thtml</tt></li>
 305      </ul>
 306      This variable is supposed to be used by a plugin that implements <a
 307      href="http://en.wikipedia.org/wiki/Captcha">CAPTCHA</a>s and will simply be
 308      empty when no such plugin is installed.</li>
 309  </ul>
 310  
 311  <h3>Professional theme</h3>
 312  
 313  <p>The following changes are specific to the Professional theme. There is
 314  probably no need to port them over to other themes.</p>
 315  
 316  <ul>
 317  <li>The theme now uses CSS everywhere for spacing and dividers instead of
 318      relying on a 1x1 pixel transparent GIF image (<tt>speck.gif</tt>).</li>
 319  <li>The amount of nested tables has been reduced, e.g. in the block
 320      headers.</li>
 321  <li>Two unused template files, <tt>customlogin-header.thtml</tt> and
 322      <tt>customlogin-footer.thtml</tt>, have been removed.</li>
 323  </ul>
 324  
 325  
 326  <h2><a name="changes140">Theme changes in Geeklog 1.4.0</a></h2>
 327  
 328  <p>As usual, any missing new theme files can simply be copied over from the
 329  default theme (Professional) that ships with Geeklog.</p>
 330  
 331  <h3>Admin templates</h3>
 332  
 333  <p>Geeklog 1.4.0 comes with revamped Admin sections which required a lot of
 334  theme changes. We therefore suggest that you simply replace the entire
 335  <tt>admin</tt> directory of your theme with the <tt>admin</tt> directory
 336  from Geeklog's default theme (Professional) as it ships with Geeklog 1.4.0
 337  and apply any modfications you may have made to your Admin templates again
 338  afterwards.</p>
 339  
 340  <p><strong>Note:</strong> The new icons for "Command and Control"
 341  (<tt>moderation.php</tt>) in the Professional theme use a white background.
 342  For themes with a dark (or other non-white) background, you can <a
 343  href="http://www.geeklog.net/filemgmt/singlefile.php?lid=623">download</a> these
 344  icons as PNGs with alpha transparency (note that Internet Explorer can not
 345  display images with alpha transparency unless you include a JavaScript "<a
 346  href="http://homepage.ntlworld.com/bobosola/">hack</a>" into your theme, so you
 347  may want to convert those icons to normal transparency or simply set the
 348  background to that of your theme).</p>
 349  
 350  
 351  <h3>Advanced editor</h3>
 352  
 353  <p>To use the included advanced editor (FCKeditor) you will need the following
 354  new template files:</p>
 355  <ul>
 356  <li><tt>comment/commentform_advanced.thtml</tt> (for comments)</li>
 357  <li><tt>submit/submitstory_advanced.thtml</tt> (for story submissions)</li>
 358  <li><tt>admin/story/storyeditor_advanced.thtml</tt> (Admin's story editor)</li>
 359  <li><tt>staticpages/templates/admin/editor_advanced.thtml</tt> (for the Static
 360      Pages editor, located in <tt>/path/to/geeklog/plugins</tt>)</li>
 361  <li><tt>advanced_editor_header.thtml</tt> (included by all of the above)</li>
 362  </ul>
 363  <p>You also have to add <code>{advanced_editor}</code> to the <code>&lt;head&gt;</code> section of your theme's <tt>header.thtml</tt> file.</p>
 364  
 365  <h3>Other changes</h3>
 366  
 367  <ul>
 368  <li>The comment templates <tt>commentbar.thtml</tt> and <tt>thread.thtml</tt>
 369      have changed due to changes in the comment handling.</li>
 370  <li>New directories <tt>trackback</tt> and <tt>admin/trackback</tt> containing
 371      several new template files have been added for the trackback support.</li>
 372  <li>New variables <code>{send_trackback_link}</code>,
 373      <code>{send_trackback_url}</code>, and
 374      <code>{lang_send_trackback_text}</code> are available in the story and
 375      article template files. They provide a complete link as well as the URL and
 376      link text allowing you to send a trackback comment for the current
 377      story.</li>
 378  <li>The <tt>links</tt> and <tt>admin/link</tt> directories have been
 379      removed. Links are now a plugin and the plugin's templates can be found in
 380      <tt>/path/to/geeklog/plugins/links/templates</tt>.</li>
 381  <li>The <tt>pollbooth</tt> and <tt>admin/poll</tt> directories have been
 382      removed. Polls are now a plugin and the plugin's templates can be found in
 383      <tt>/path/to/geeklog/plugins/polls/templates</tt>.</li>
 384  <li>The <tt>preferences/profile.thtml</tt> template now has additional fields
 385      for the password change (old password, confirmation field for the new
 386      password).</li>
 387  <li>The search form, <tt>search/searchform.thtml</tt> has a new option for the
 388      number of search results per page, while the hard-coded option to search
 389      for links has been removed (since Links are in plugin now, it will show up
 390      as part of the <code>{plugin_types}</code> option).</li>
 391  <li>An additional variable, <code>{services}</code>, has to be added to the
 392      <tt>loginform.thtml</tt> template file if you plan to allow users to log in
 393      to your site using remote authentication.</li>
 394  <li>If you plan to enable Trackbacks on your site, you may want to add links to
 395      a story's trackbacks section to your story template files, e.g.
 396      <code>{start_trackbacks_anchortag}{trackbacks_with_count}{end_trackbacks_anchortag}</code>. See the Professional theme's story template files for
 397      examples.</li>
 398  <li>For the site statistics, the file <tt>stats/sitestatistics.thtml</tt> has
 399      changed (entries for the links and poll have been removed and a new entry
 400      for the number of active users has been added). There is also a new file,
 401      <tt>stats/singlesummary.thtml</tt>, that is used for plugin entries.</li>
 402  <li>The <tt>navbar</tt> directory is now part of a Geeklog theme (previously
 403      used by some plugins, e.g. the Forum plugin). It contains two files,
 404      <tt>menuitem.thtml</tt> and <tt>navbar.thtml</tt>, as well as two images,
 405      <tt>button.gif</tt> and <tt>button_over.gif</tt>.</li>
 406  </ul>
 407  
 408  
 409  <h2><a name="changes1311">Theme changes in Geeklog 1.3.11</a></h2>
 410  
 411  <p>There are no mandatory theme changes in Geeklog 1.3.11, so themes made for Geeklog 1.3.10 will work just fine without any modifications.</p>
 412  
 413  <p>A few minor additions / new options have been introduced:</p>
 414  <ul>
 415  <li>A new variable, <code>{camera_icon}</code>, can now be used in the story
 416      and comment template files to display the small camera icon (the same as in
 417      the Who's Online block) to link to the author's user profile (only if they
 418      uploaded a userphoto).</li>
 419  <li>The <code>{layout_url}</code> variable is now available in the templates
 420      for the story, link, and event submission forms.</li>
 421  <li>Also in the submission forms, a variable <code>{separator}</code> is now
 422      available in addition to the misspelled <code>{seperator}</code>
 423      variable.</li>
 424  <li>A new variable, <code>{calendar_mode}</code>, can be used in the
 425      <tt>calendar/events.thtml</tt> template file to ensure that the "add event"
 426      link will take the user to the proper event submission form for either the
 427      site calendar or the personal calendar.</li>
 428  </ul>
 429  
 430  <h2><a name="changes1310">Theme changes in Geeklog 1.3.10</a></h2>
 431  
 432  <p>General note: To upgrade your custom theme for use with Geeklog 1.3.10, you can simply copy over any new template files from the Geeklog default theme.</p>
 433  
 434  <p>The biggest change in Geeklog 1.3.10 is that we now ship it with only one
 435  default theme (the Professional theme, kindly provided by Victor B. Gonzalez)
 436  and that the previously included themes are now available as a separate
 437  download.</p>
 438  
 439  <h3>Admin templates</h3>
 440  
 441  <p>Most themes don't change the template files in the theme's <tt>admin</tt>
 442  directory, so you can often save yourself a bit of work by simply replacing
 443  the entire <tt>admin</tt> directory with the one from the Geeklog 1.3.10
 444  distribution.</p>
 445  
 446  <ul>
 447  <li>The story editor, <tt>admin/story/storyeditor.thtml</tt> includes new
 448      options for the story archiving and for editable story IDs. <em>It is
 449      recommended to make a copy of this file and re-apply any changes you may
 450      have made to your copy again afterwards!</em></li>
 451  <li>The list of polls, <tt>admin/poll/polllist.thtml</tt> now supports
 452      paging, i.e. uses the {google_paging} variable.</li>
 453  <li>The list of events uses paging and a row number now (files affected:
 454      <tt>admin/event/eventlist.thtml</tt> and
 455      <tt>admin/event/listitem.thtml</tt>).</li>
 456  <li>The plugin editor, <tt>admin/plugins/editor.thml</tt>, now displays 2
 457      version numbers for the plugin: The installed version and the (possibly
 458      differing) version of the actual code.  In the latter case, it will also
 459      display an update button.<br>
 460      The list of plugins, <tt>admin/plugins/pluginlist.thtml</tt> and
 461      <tt>admin/plugins/listitem.thtml</tt>, also displays the 2 version numbers
 462      and now supports paging when more than 25 plugins are installed.</li>
 463  <li>The topic editor, <tt>admin/topic/topiceditor.thtml</tt>, contained a
 464      hard-coded "10" for the default number of stories per pages. The new
 465      variable {default_limit} provides the actual default value now.</li>
 466  <li><tt>admin/mail/mailform.thtml</tt> has been changed to look slightly less
 467      ugly ...</li>
 468  </ul>
 469  
 470  <h3>Other templates</h3>
 471  
 472  <ul>
 473  <li>Added two new templates for the new story archive feature. This allows you
 474      to theme olderstories differently. By default Geeklog 1.3.10 ships with
 475      these template files not themed and the same as a standard story. The new
 476      template files are <ul><li>archivestorytext.thtml</li>
 477      <li>archivestorybodytext.thtml</li></ul></li>
 478  <li>Due to various changes in the comment engine, it is recommended that you
 479      copy over all the comment template files from the <tt>comment</tt> directory
 480      (<tt>comment/reportcomment.thtml</tt> is actually a new file).</li>
 481  <li>In <tt>calendar/dayview/dayview.thtml</tt>, i.e. in the calendar's day
 482      view, the hard-coded am/pm times have been replaced by variables of the
 483      form {xx_hour} (where 'xx' is 0-23).</li>
 484  <li>In the event details template, i.e. in <tt>calendar/eventdetails.thtml</tt>,
 485      the event type and an edit icon were added (this change was only made in
 486      Geeklog 1.3.10rc3).</li>
 487  <li>A "location" field was added in the user's profile: Added {lang_location}
 488      and {user_location} in <tt>users/profile.thtml</tt> and {lang_location},
 489      {lang_location_text}, and {location_value} in
 490      <tt>preferences/profile.thtml</tt>.</li>
 491  </ul>
 492  
 493  <h3>Optional changes</h3>
 494  
 495  <p>The following is a list of optional changes (mostly new variables that are
 496  now available). This information is mostly of interest for those who want to
 497  develop their own themes.</p>
 498  
 499  <ul>
 500  <li>{article_url}, i.e. the full URL to an article, is now also available in
 501      <tt>article/printable.thtml</tt>.</li>
 502  <li>In <tt>links/linkdetails.thtml</tt> the new variable {link_actual_url} now
 503      contains the actual link URL (instead of a link to Geeklog's
 504      <tt>portal.php</tt>).</li>
 505  <li>The following variables are now available in <tt>calendar/eventdetails.thtml</tt>:
 506      {event_state_name} (full name of the state), {event_state_only} and
 507      {event_state_name_only} (abbreviated and full state name without the comma),
 508      {event_edit} (link to edit the event, if allowed for the current user),
 509      {edit_icon} (same, but with the edit icon instead of a text link),
 510      {lang_event_type} and {event_type} for the event type
 511  <li>The topic image is now available through the {topic_image} variable in
 512      <tt>topicoption.thtml</tt> and <tt>topicoption_off.thtml</tt></li>
 513  <li>Several class names have been introduced so that the various lists that
 514      Geeklog uses can now be styled individually: list-feed, list-new-comments,
 515      list-new-links, list-new-plugins, list-older-stories, list-personal-events,
 516      list-site-events, list-story-options, list-whats-related (the names should
 517      be self-explanatory).<br>
 518      Use {list_class_name} to get the actual class name, and {list_class} to get
 519      class="classname".</li>
 520  <li>Several class names have been introduced so that the 2 small calendars
 521      in the calendar's month view can be styled: .smallcal, .smallcal-headline,
 522      .smallcal-week-even, .smallcal-week-odd, .smallcal-week-empty,
 523      .smallcal-day-even, .smallcal-day-odd, and .smallcal-day-empty</li>
 524  </ul>
 525  
 526  
 527  <h2><a name="changes139">Theme changes in Geeklog 1.3.9</a></h2>
 528  
 529  <ul>
 530  <li>In <tt>header.thtml</tt>, you can now use the new variable
 531      <code>{allowed_menu_elements}</code> as an alternative to using
 532      <code>{menu_elements}</code>. The new variable takes the
 533      <code>$_CONF['<i>XXX</i>loginrequired']</code> settings into account, i.e.
 534      it will only list those entries that the current user has access to.</li>
 535  <li>The <tt>admin/syndication</tt> directory, containing
 536      <tt>feededitor.thtml</tt>, <tt>listfeeds.thtml</tt>,
 537      <tt>listitem.thtml</tt>, and <tt>selecttype.thtml</tt> has been added.</li>
 538  <li>Template files <tt>comment/comment.thtml</tt> and
 539      <tt>comment/thread.thtml</tt> have been added and
 540      <tt>comment/startcomment.thtml</tt> has been changed to implement
 541      template-driven comments.<br>
 542      Please note that <tt>comment/comment.thtml</tt> was changed <em>again</em>
 543      in Geeklog 1.3.9rc2.</li>
 544  <li>A <code>{link_edit}</code> variable has been added to
 545      <tt>links/linkdetails.thtml</tt> so that admins can edit links directly
 546      from the links section.</li>
 547  <li>An "edit" icon has been added: <tt>images/edit.gif</tt>. The new variable
 548      <code>{edit_icon}</code> can be used as an alternative to
 549      <code>{edit_link}</code> in the story template files and in
 550      <tt>links/linkdetails.thtml</tt>.</li>
 551  <li>In the <tt>calendar/calendar.thtml</tt> file, the "mode" parameter has been
 552      added to the &lt;&lt; and &gt;&gt; buttons, so that users stay in their
 553      personal calendar when browsing through months.</li>
 554  <li>A new file, <tt>admin/group/groupmembers.thtml</tt>, has been added and
 555      <tt>admin/group/listitem.thtml</tt> has been changed for the new
 556      alternative option to add users to groups.</li>
 557  <li>A new file, <tt>admin/block/listside.thtml</tt>, has been added and
 558      <tt>admin/block/listitem.thtml</tt> and <tt>admin/block/listblocks.thtml</tt>
 559      have been changed for the enhanced block list.</li>
 560  <li>A <code>{google_paging}</code> variable has been added to
 561      <tt>admin/link/linklist.thtml</tt>. Also added a column number to
 562      <tt>linklist.thtml</tt> and <tt>admin/link/listitem.thtml</tt>.</li>
 563  <li>All template files where the user can enter a URL are now using a new
 564      variable, <code>{max_url_length}</code>, instead of a hard-coded number of
 565      characters for the max. length of the URL. Files affected:
 566      <tt>admin/block/blockeditor.thtml</tt>,
 567      <tt>admin/event/eventeditor.thtml</tt>,
 568      <tt>admin/link/linkeditor.thtml</tt>,
 569      <tt>admin/topic/topiceditor.thtml</tt>,
 570      <tt>submit/submitevent.thtml</tt>, <tt>submit/submitlink.thtml</tt>.</li>
 571  <li>The hard-coded <code>&amp;nbsp;</code> has been removed from the
 572      <code>{welcome_msg}</code> variable. The blank was then added to the
 573      <tt>header.thtml</tt> of the Classic, XSilver, and Yahoo themes (the other
 574      themes either look fine without it or didn't use <code>{welcome_msg}</code>
 575      in the first place).</li>
 576  <li>An extra <code>table</code> has been removed from the
 577      <tt>users/profile.thtml</tt> file of the XSilver theme so that the
 578      username now lines up properly with the other entries.</li>
 579  </ul>
 580  
 581  <h2><a name="changes138">Theme changes in Geeklog 1.3.8</a></h2>
 582  
 583  <p>Theme changes in Geeklog 1.3.8 were mostly aimed at moving as much of the
 584  hard-coded HTML into template files as possible. Other changes were made to
 585  give theme authors better control over the layout and a small portion of changes
 586  were done to incorporate new Geeklog features.</p>
 587  
 588  <h3>New template files</h3>
 589  
 590  <p>This is a list of the new files. You can safely copy these over from one of
 591  the standard themes that ship with Geeklog (most of these files contain HTML
 592  that was previously hard-coded into Geeklog).</p>
 593  
 594  <pre>
 595  adminoption_off.thtml
 596  loginform.thtml
 597  topicoption.thtml
 598  topicoption_off.thtml
 599  useroption_off.thtml
 600  admin/database/listbackups.thtml
 601  admin/database/listitem.thtml
 602  admin/user/edituser.thtml
 603  admin/user/plainlist.thtml
 604  comment/commentbar.thtml
 605  comment/startcomment.thtml
 606  pollbooth/pollanswer.thtml
 607  pollbooth/pollblock.thtml
 608  pollbooth/pollcomments.thtml
 609  pollbooth/pollresult.thtml
 610  pollbooth/pollvotes_bar.thtml
 611  pollbooth/pollvotes_num.thtml
 612  preferences/boxesblock.thtml
 613  preferences/commentblock.thtml
 614  preferences/deleteaccount.thtml
 615  preferences/digestblock.thtml
 616  preferences/displayblock.thtml
 617  preferences/displayprefs.thtml
 618  preferences/excludeblock.thtml
 619  preferences/language.thtml
 620  preferences/privacyblock.thtml
 621  preferences/profile.thtml
 622  preferences/theme.thtml
 623  preferences/username.thtml
 624  preferences/userphoto.thtml
 625  search/resultauthdatehits.thtml
 626  search/resultrowenhanced.thtml
 627  search/resultsummary.thtml
 628  search/resulttitle.thtml
 629  users/newpassword.thtml
 630  </pre>
 631  
 632  <p>Note: <tt>preferences</tt> and <tt>admin/database</tt> are new directores.</p>
 633  
 634  
 635  <h3>Changed / updated template files</h3>
 636  
 637  <p>These files have changed since Geeklog 1.3.7, i.e. they may contain new
 638  variables, table columns, etc. If you haven't changed these files in your
 639  existing theme, it is probably best to simply copy them over from one of the
 640  themes that ship with Geeklog (with the exception of <tt>style.css</tt> and
 641  <tt>header.thtml</tt>, see below).</p>
 642  
 643  <pre>
 644  style.css <em>(see below)</em>
 645  header.thtml <em>(see below)</em>
 646  admin/block/blockeditor.thtml
 647  admin/block/listblocks.thtml
 648  admin/block/listitem.thtml
 649  admin/event/eventeditor.thtml
 650  admin/event/eventlist.thtml
 651  admin/event/listitem.thtml
 652  admin/group/grouplist.thtml
 653  admin/group/listitem.thtml
 654  admin/story/liststories.thtml
 655  admin/topic/listitem.thtml
 656  admin/topic/topiceditor.thtml
 657  admin/topic/topiclist.thtml
 658  calendar/editpersonalevent.thtml
 659  calendar/eventdetails.thtml
 660  search/searchform.thtml
 661  search/searchresults.thtml
 662  submit/submitevent.thtml
 663  users/getpasswordform.thtml
 664  </pre>
 665  
 666  <p>In <tt>style.css</tt>, four classes have been added that are used in the
 667  new search code of Geeklog 1.3.8. Instead of copying over the entire file, you
 668  will probably only want to copy over the code for those four classes:
 669  <tt>searchAuth</tt>, <tt>searchDate</tt>, <tt>searchHits</tt>,
 670  <tt>highlight</tt>.</p>
 671  
 672  <p>If the <tt>header.thtml</tt> of your theme is using the
 673  <tt>{menu_elements}</tt> variable, then you do <em>not</em> need to make any
 674  changes to it. If it is not using that variable, then you will need to make one
 675  change to it. In that case, search your <tt>header.thtml</tt> for the link
 676  to the story submission form, i.e. something like</p>
 677  <pre>
 678      &lt;a href="{site_url}/submit.php?type=story"&gt;
 679  </pre>
 680  <p>and change it to read</p>
 681  <pre>
 682      &lt;a href="{site_url}/submit.php?type=story{current_topic}"&gt;
 683  </pre>
 684  
 685  
 686  <h3>Removed template files</h3>
 687  
 688  <p>If you have a file named <tt>commentheader.thtml</tt> in your theme
 689  directory, you can safely remove it. It isn't used at all.</p>
 690  
 691  
 692  <h2><a name="changes137">Theme changes in Geeklog 1.3.7</a></h2>
 693  
 694  <p>Please note that all the following changes are <em>optional</em>. Themes
 695  made for Geeklog 1.3.6 will work just fine with Geeklog 1.3.7 - no changes
 696  are necessary.</p>
 697  
 698  <h3>New features and improvements</h3>
 699  
 700  <ul>
 701    <li>Theme-based topic icons are now supported by setting <tt>$_THEME_URL</tt>
 702      in the theme's <tt>functions.php</tt> file. The variable should point to
 703      a directory that has the same hierarchy as Geeklog's images directory
 704      (note that the path to topic images is stored relative to Geeklog's
 705      public_html directory).<br>
 706      <strong>Example:</strong>
 707      <code>$_THEME_URL = $_CONF['layout_url'];</code></li>
 708    <li>The <code>$_BLOCK_TEMPLATE</code> "hack" can now be applied to the
 709      What's Related and Story Options blocks, as well. Use
 710      <tt>whats_related_block</tt> and <tt>story_options_block</tt> as the block
 711      names.</li>
 712    <li>The What's Related and Story Options blocks are now available as
 713      separate variables using <tt>{whats_related}</tt> and
 714      <tt>{story_options}</tt>, respectively
 715      (the <tt>{whats_related_story_options}</tt> variable for both blocks is
 716      still available).</li>
 717    <li>Several new variables can now be used in the story templates, e.g.
 718      <tt>{contributedby_fullname}</tt> for the full name of a story author and
 719      <tt>{contributedby_photo}</tt> for his/her user photo.</li>
 720    <li>When the new config variable <tt>$_CONF['showfirstasfeatured']</tt> is set
 721      to 1, then the first story on <em>every</em> page is rendered using the
 722      template files for featured stories, even when the story is not marked as
 723      featured.</li>
 724  </ul>
 725  
 726  <h3>Other changes</h3>
 727  
 728  <ul>
 729    <li>The template file <tt>admin/plugins/installform.thtml</tt> has been
 730      removed since it isn't used any more.</li>
 731    <li>Two new <em>optional</em> template files,
 732      <tt>admin/plugins/newpluginlist.thtml</tt> and
 733      <tt>admin/plugins/newlistitem.thml</tt>, have been added to support
 734      formatting of the list of plugins which haven't been installed yet. If
 735      these files do not exist, hard-coded HTML is used to present the list.</li>
 736    <li>The template file <tt>admin/link/listitem.thtml</tt> has been changed
 737      so that all the links are clickable.</li>
 738    <li><code>COM_pollResults()</code> doesn't use the side block templates any
 739      more when called from <tt>pollbooth.php</tt>. Therefore, you can now use
 740      different layouts whether the poll results are displayed in a side block
 741      or on the separate poll results and comments page.</li>
 742    <li>Removed the Normal / Archive / Refreshing drop down menus from the admin
 743      story and poll editors of the themes that ship with Geeklog. The setting
 744      of this dropdown isn't used in Geeklog anyway and has just confused users
 745      in the past ... (files <tt>admin/story/storyeditor.thtml</tt> and
 746      <tt>admin/poll/polleditor.thtml</tt>)</li>
 747  </ul>
 748  
 749  
 750  <h2><a name="changes136">Theme changes in Geeklog 1.3.6</a></h2>
 751  
 752  <p>There have been a lot of changes in the themes for 1.3.6 to get rid of the
 753  last pieces of hard-coded english texts so as to make localisation easier.
 754  Most of these changes have been made in the Admin editors (<tt>admin</tt>
 755  directory) and the calendar (<tt>calendar</tt> directory). If you created
 756  your own theme for an earlier version of Geeklog, we recommend that you copy
 757  over these two directories from one of the themes that come with Geeklog
 758  (choose one that is similar to your own theme or which it was originally based
 759  on). It seems like most Geeklog themes didn't change these files anyway, so
 760  this shouldn't be too much of a hassle ...</p>
 761  
 762  <h3>Other changes</h3>
 763  <ul>
 764    <li>The template file <tt>admin/mail/mailform.thtml</tt> has been added.
 765      This form for sending emails to other users of the site was previously
 766      hard-coded into Geeklog.<br>
 767      If you followed the above advice and copied over the <tt>admin</tt>
 768      directory to your theme, you got this file already.</li>
 769    <li>Two new files <tt>menuitem_last.thtml</tt> and
 770      <tt>menuitem_none.thtml</tt> have been added to give theme authors better
 771      control over the items in menu bars ({menu_elements} and {plg_menu_elements}
 772      variables in <tt>header.thtml</tt>). The template file
 773      <tt>menuitem.thtml</tt> is now used to render the first and any following
 774      menu items - with the exception of the last menu item, which is rendered
 775      using <tt>menuitem_last.thtml</tt>. If there are no menu elements for a
 776      menu bar, <tt>menuitem_none.thtml</tt> is used.</li>
 777    <li>New files have been added and the existing files have been changed for
 778      the links section (<tt>links</tt> directory). Again, we recommend to just
 779      copy over those files from one of the themes that ship with Geeklog.<br>
 780      The new files are: <tt>categoryactivecol.thtml</tt>,
 781      <tt>categorycol.thtml</tt>, <tt>categorynavigation.thtml</tt>,
 782      <tt>categoryrow.thtml</tt>, <tt>pagenavigation.thtml</tt></li>
 783    <li>The user profile has been extended to include a list of the last 10
 784      stories as well as the total numbers of stories and comments posted by that
 785      user. Have a look at the file <tt>users/profile.thtml</tt> to see the
 786      changes or just copy that file over from one of the themes that ship with
 787      Geeklog. You should also copy over the file <tt>users/storyrow.thtml</tt>
 788      which describes the block for the last 1o stories.</li>
 789    <li>The Classic theme has been updated to have an "Edit" link (for
 790      StoryAdmins) in every story now.<br>
 791      Files changed: <tt>storybodytext.thtml</tt>,
 792      <tt>featuredstorybodytext.thtml</tt></li>
 793    <li>In the Classic and Digital Monochrome themes the "contact" link now
 794      points to the form to send an email to the admin user instead of using a
 795      <code>mailto:</code> link with the site's email address from
 796      <tt>config.php</tt>.</li>
 797  </ul>
 798  
 799  <h3>CSS changes</h3>
 800  <ul>
 801  <li>The underscore '_' is not a valid character in CSS. Therefore, some class names used by the Geeklog calendar have been changed to use the dash '-' instead. You may need to change your stylesheet accordingly.<br>
 802  Names that changed: <b>cal-oldday</b>, <b>cal-today</b>,
 803  <b>cal-futureday</b>, <b>cal-nullday</b>, <b>weekview-curday</b>,
 804  <b>weekview-offday</b></li>
 805  <li>A new class named <b>pagenav</b> can be used to format the paged
 806    navigation.<br>
 807    Please note that this change was made <em>after</em> the release of Geeklog
 808    1.3.6rc1 and affects the use of the paged navigation in
 809    <tt>admin/user/userslist.thtml</tt> and <tt>links/links.thtml</tt>: In
 810    1.3.6rc1, the navigation was wrapped in &lt;p&gt; tags in those files. As
 811    of Geeklog 1.3.6 however, the function producing the navigation will wrap
 812    it in a &lt;div&gt; automatically.</li>
 813  </ul>
 814  
 815  <p><strong>Note:</strong> Theme authors are encouraged to specify a character
 816  set in the <tt>header.thtml</tt> of their themes like this:</p>
 817  <blockquote><code>
 818  &lt;meta http-equiv="Content-Type" content="text/html; charset={charset}"&gt;
 819  </code></blockquote>
 820  <p>Geeklog will replace the <code>{charset}</code> variable with the proper
 821  character set based on the currently used language file. Also make sure that
 822  you put the above line <em>before</em> the <code>&lt;title&gt;</code> tag in
 823  the <code>&lt;head&gt;</code> section of your <tt>header.thtml</tt> file.</p>
 824  
 825  <table border="0" width="100%" class="footer">
 826  <tr valign="top">
 827    <td colspan="2"><a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
 828      All trademarks and copyrights on this page are owned by their respective owners. GeekLog is copyleft.</td>
 829  </tr>
 830  </table>
 831  
 832  </body>
 833  </html>