[geeklog-cvs] Geeklog-1.x/public_html/docs calendar.html, 1.10, 1.11 links.html, 1.4, 1.5 theme.html, 1.78, 1.79

Sat May 10 11:02:16 EDT 2008

Update of /cvsroot/geeklog/Geeklog-1.x/public_html/docs
In directory qs1489.pair.com:/tmp/cvs-serv86375

Modified Files:
	calendar.html links.html theme.html 
Log Message:
Documentation updates - configuration and such

Index: links.html
===================================================================
RCS file: /cvsroot/geeklog/Geeklog-1.x/public_html/docs/links.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** links.html	5 Aug 2007 09:33:02 -0000	1.4
--- links.html	10 May 2008 15:02:14 -0000	1.5
***************
*** 14,20 ****
  <p>The links section used to be an integral part of the Geeklog core code, but have been moved to a plugin as of Geeklog 1.4.0.</p>

! <h2><a name="config.php">Configuration File</a></h2>

! <p>The links plugin has its own configuration file, located at <tt>/path/to/geeklog/plugins/links/config.php</tt>. There you will find the following options:</p>

  <table>
--- 14,22 ----
  <p>The links section used to be an integral part of the Geeklog core code, but have been moved to a plugin as of Geeklog 1.4.0.</p>

! <h2><a name="config.php">Configuration</a></h2>

! <p>The configuration of the Links plugin can be changed from the Configuration admin panel:</p>
! 
! <h3><a name="public">Public Links List Settings</a></h3>

  <table>
***************
*** 24,52 ****
  </tr>
  <tr>
-   <td><a name="desc_delete_links">delete_links</a></td>
-   <td>0</td>
-   <td>Defines what to do when a user is deleted that is the owner of a link.
-     When set to 0, all links owned by the deleted user will be assigned to a
-     user of the "Root" group (e.g. the site admin). When set to 1, the links
-     are deleted.</td>
- </tr>
- <tr class="r2">
-   <td><a name="desc_hidelinksmenu">hidelinksmenu</a></td>
-   <td>0</td>
-   <td>Whether to hide the "Links" entry from Geeklog's menu bar (when set to 1)
-     or to show it (when set to 0).</td>
- </tr>
- <tr>
-   <td><a name="desc_hidenewlinks">hidenewlinks</a></td>
-   <td>0</td>
-   <td>Whether new links should be hidden from the "What's New" block (when set
-     = 1) or whether to list them there (when set to = 0).</td>
- </tr>
- <tr class="r2">
-   <td><a name="desc_linkcols">linkcols</a></td>
-   <td>3</td>
-   <td>The number of link categories to display per column.</td>
- </tr>
- <tr>
    <td><a name="desc_linksloginrequired">linksloginrequired</a></td>
    <td>0</td>
--- 26,29 ----
***************
*** 60,72 ****
  </tr>
  <tr class="r2">
    <td><a name="desc_linksperpage">linksperpage</a></td>
    <td>10</td>
    <td>The number of links to show per page.</td>
  </tr>
  <tr>
!   <td><a name="desc_linksubmission">linksubmission</a></td>
!   <td>1</td>
!   <td>Whether links submitted by users will have to be approved by an admin
!     first (when set = 1) or show up immediately (when set = 0).</td>
  </tr>
  <tr class="r2">
--- 37,77 ----
  </tr>
  <tr class="r2">
+   <td><a name="desc_linkcols">linkcols</a></td>
+   <td>3</td>
+   <td>The number of link categories to display per column.</td>
+ </tr>
+ <tr>
    <td><a name="desc_linksperpage">linksperpage</a></td>
    <td>10</td>
    <td>The number of links to show per page.</td>
  </tr>
+ <tr class="r2">
+   <td><a name="desc_show_top10">show_top10</a></td>
+   <td><code>true</code></td>
+   <td>When both <code>$_LI_CONF['linkcols']</code> and
+     <code>$_LI_CONF['linksperpage']</code> are <em>not</em> 0, the plugin will
+     show a list of the 10 most clicked-on links on the Links plugin's index
+     page automatically. If you do not want that "top 10" list there, set this
+     option to <code>false</code>.</td>
+ </tr>
  <tr>
!   <td><a name="desc_show_category_descriptions">show_category_descriptions</a></td>
!   <td><code>true</code></td>
!   <td>Whether to show subcategory descriptions when viewing a category or not.</td>
! </tr>
! </table>
! 
! <h3><a name="admin">Links Admin Settings</a></h3>
! 
! <table>
! <tr><th width="25%">Variable</th>
!     <th width="25%">Default Value</th>
!     <th width="50%">Description</th>
! </tr>
! <tr>
!   <td><a name="desc_hidenewlinks">hidenewlinks</a></td>
!   <td>0</td>
!   <td>Whether new links should be hidden from the "What's New" block (when set
!     = 1) or whether to list them there (when set to = 0).</td>
  </tr>
  <tr class="r2">
***************
*** 78,81 ****
--- 83,98 ----
  </tr>
  <tr>
+   <td><a name="desc_hidelinksmenu">hidelinksmenu</a></td>
+   <td>0</td>
+   <td>Whether to hide the "Links" entry from Geeklog's menu bar (when set to 1)
+     or to show it (when set to 0).</td>
+ </tr>
+ <tr class="r2">
+   <td><a name="desc_linksubmission">linksubmission</a></td>
+   <td>1</td>
+   <td>Whether links submitted by users will have to be approved by an admin
+     first (when set = 1) or show up immediately (when set = 0).</td>
+ </tr>
+ <tr>
    <td><a name="desc_notification">notification</a></td>
    <td>0</td>
***************
*** 84,94 ****
  </tr>
  <tr class="r2">
!   <td><a name="desc_show_top10">show_top10</a></td>
!   <td><code>true</code></td>
!   <td>When both <code>$_LI_CONF['linkcols']</code> and
!     <code>$_LI_CONF['linksperpage']</code> are <em>not</em> 0, the plugin will
!     show a list of the 10 most clicked-on links on the Links plugin's index
!     page automatically. If you do not want that "top 10" list there, set this
!     option to <code>false</code>.</td>
  </tr>
  </table>
--- 101,127 ----
  </tr>
  <tr class="r2">
!   <td><a name="desc_delete_links">delete_links</a></td>
!   <td>0</td>
!   <td>Defines what to do when a user is deleted that is the owner of a link.
!     When set to 0, all links owned by the deleted user will be assigned to a
!     user of the "Root" group (e.g. the site admin). When set to 1, the links
!     are deleted.</td>
! </tr>
! <tr>
!   <td><a name="desc_aftersave">aftersave</a></td>
!   <td>'list'</td>
!   <td>Which page to go to after a links has been saved:
!     <ul>
!     <li>'item': go to the linked site(!)</li>
!     <li>'list': show admin's list of links (default)</li>
!     <li>'plugin': display the public list of links</li>
!     <li>'home': display the site's homepage</li>
!     <li>'admin': go to the "Admin Home" page, i.e. Command & Control</li>
!     </ul></td>
! </tr>
! <tr class="r2">
!   <td><a name="desc_root">root</a></td>
!   <td>'site'</td>
!   <td>ID to use for the root of the link categories tree.</td>
  </tr>
  </table>

Index: calendar.html
===================================================================
RCS file: /cvsroot/geeklog/Geeklog-1.x/public_html/docs/calendar.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** calendar.html	2 Feb 2008 15:04:37 -0000	1.10
--- calendar.html	10 May 2008 15:02:14 -0000	1.11
***************
*** 15,21 ****
  but have been moved to a plugin as of Geeklog 1.4.1.</p>

! <h2><a name="config.php">Configuration File</a></h2>

! <p>The calendar plugin has its own configuration file, located at <tt>/path/to/geeklog/plugins/calendar/config.php</tt>. There you will find the following options:</p>

  <table>
--- 15,24 ----
  but have been moved to a plugin as of Geeklog 1.4.1.</p>

! <h2><a name="config.php">Configuration</a></h2>

! <p>The calendar's configuration can be changed from the Configuration admin
! panel:</p>
! 
! <h3><a name="general">General Calendar Settings</a></h3>

  <table>
***************
*** 36,48 ****
  </tr>
  <tr class="r2">
!   <td><a name="desc_delete_event">delete_event</a></td>
    <td>0</td>
!   <td>Defines what to do when a user is deleted that is the owner of an event.
!     When set to 0, all events owned by the deleted user will be assigned to a
!     user of the "Root" group (e.g. the site admin). When set to 1, the events
!     are deleted. This only applies to site events - a user's personal events
!     are always deleted.</td>
  </tr>
  <tr>
    <td><a name="desc_eventsubmission">eventsubmission</a></td>
    <td>1</td>
--- 39,53 ----
  </tr>
  <tr class="r2">
!   <td><a name="desc_hidecalendarmenu">hidecalendarmenu</a></td>
    <td>0</td>
!   <td>Whether to hide the "Calendar" entry from Geeklog's menu bar (when set to
!     1) or to show it (when set to 0).</td>
  </tr>
  <tr>
+   <td><a name="desc_personalcalendars">personalcalendars</a></td>
+   <td>0</td>
+   <td>Allow account holders to have a personal calendar</td>
+ </tr>
+ <tr class="r2">
    <td><a name="desc_eventsubmission">eventsubmission</a></td>
    <td>1</td>
***************
*** 50,66 ****
      first (when set = 1) or show up immediately (when set = 0).</td>
  </tr>
- <tr class="r2">
-   <td><a name="desc_event_types">event_types</a></td>
-   <td>Anniversary, Appointment, Birthday, Business, Education, Holiday, Meeting, Miscellaneous, Personal, Phone Call, Special Occasion, Travel, Vacation</td>
-   <td>The set of event types that are used both on the public calendar and the
-     user's personal calendar.</td>
- </tr>
  <tr>
!   <td><a name="desc_hidecalendarmenu">hidecalendarmenu</a></td>
!   <td>0</td>
!   <td>Whether to hide the "Calendar" entry from Geeklog's menu bar (when set to
!     1) or to show it (when set to 0).</td>
  </tr>
  <tr class="r2">
    <td><a name="desc_hour_mode">hour_mode</a></td>
    <td>12</td>
--- 55,71 ----
      first (when set = 1) or show up immediately (when set = 0).</td>
  </tr>
  <tr>
!   <td><a name="desc_showupcomingevents">showupcomingevents</a></td>
!   <td>1</td>
!   <td>Whether to show upcoming events (0 = no, 1 = yes) in a separate
!     block.</td>
  </tr>
  <tr class="r2">
+   <td><a name="desc_upcomingeventsrange">upcomingeventsrange</a></td>
+   <td>14</td>
+   <td>Number of days that the "Upcoming Events" block will look
+     ahead.</td>
+ </tr>
+ <tr>
    <td><a name="desc_hour_mode">hour_mode</a></td>
    <td>12</td>
***************
*** 70,73 ****
--- 75,84 ----
      href="config.html#desc_hour_mode">$_CONF['hour_mode']</a> by default.</td>
  </tr>
+ <tr class="r2">
+   <td><a name="desc_event_types">event_types</a></td>
+   <td>Anniversary, Appointment, Birthday, Business, Education, Holiday, Meeting, Miscellaneous, Personal, Phone Call, Special Occasion, Travel, Vacation</td>
+   <td>The set of event types that are used both on the public calendar and the
+     user's personal calendar.</td>
+ </tr>
  <tr>
    <td><a name="desc_notification">notification</a></td>
***************
*** 78,96 ****
  </tr>
  <tr class="r2">
!   <td><a name="desc_personalcalendars">personalcalendars</a></td>
    <td>0</td>
!   <td>Allow account holders to have a personal calendar</td>
  </tr>
  <tr>
!   <td><a name="desc_showupcomingevents">showupcomingevents</a></td>
!   <td>1</td>
!   <td>Whether to show upcoming events (0 = no, 1 = yes) in a separate
!     block.</td>
! </tr>
! <tr class="r2">
!   <td><a name="desc_upcomingeventsrange">upcomingeventsrange</a></td>
!   <td>14</td>
!   <td>Number of days that the "Upcoming Events" block will look
!     ahead.</td>
  </tr>
  </table>
--- 89,111 ----
  </tr>
  <tr class="r2">
!   <td><a name="desc_delete_event">delete_event</a></td>
    <td>0</td>
!   <td>Defines what to do when a user is deleted that is the owner of an event.
!     When set to 0, all events owned by the deleted user will be assigned to a
!     user of the "Root" group (e.g. the site admin). When set to 1, the events
!     are deleted. This only applies to site events - a user's personal events
!     are always deleted.</td>
  </tr>
  <tr>
!   <td><a name="desc_aftersave">aftersave</a></td>
!   <td>'list'</td>
!   <td>Which page to go to after an event has been saved:
!     <ul>
!     <li>'item': display the event details</li>
!     <li>'list': show admin's list of events (default)</li>
!     <li>'plugin': display the calendar</li>
!     <li>'home': display the site's homepage</li>
!     <li>'admin': go to the "Admin Home" page, i.e. Command & Control</li>
!     </ul></td>
  </tr>
  </table>

Index: theme.html
===================================================================
RCS file: /cvsroot/geeklog/Geeklog-1.x/public_html/docs/theme.html,v
retrieving revision 1.78
retrieving revision 1.79
diff -C2 -d -r1.78 -r1.79
*** theme.html	3 May 2008 20:01:58 -0000	1.78
--- theme.html	10 May 2008 15:02:14 -0000	1.79
***************
*** 172,175 ****
--- 172,199 ----
  lib-custom.php to output any HTML you like.</p>

+ <p><strong><a name="permalink">Adding a "permalink" to stories:</a></strong>
+ Many websites offer a so-called permalink, i.e. a link to a permanent URL for
+ the story. In Geeklog's default Professional theme, the article's headline
+ already provides the same functionality - it links to a permanent URL for the
+ story (pointing to article.php). However, since this is not very obvious and
+ since visitors often expect to find a "permalink" somewhere on the page, here's
+ how to add one yourself:</p>
+ <ol>
+ <li>Find a place in the story template files. The "story-footer" section in
+ <tt>storytext.thtml</tt> may be a good place since it already contains quite a
+ few story-related links.</li>
+ <li>Once you've found a place to put the permalink entry, enter this piece of
+ code:<br>
+ <code style="margin-left:2em"><a href="{article_url}">{lang_permalink}<a></code><br>
+ This will add a link to the article (<code>article_url</code>) using the word
+ "Permalink" from the current language file (<code>lang_permalink</code>).</li>
+ <li>Try it out. Be aware that at this point, your permalink entry only shows up
+ for non-featured articles. You may want to tweak the appearance a bit (using
+ CSS) or move the link around.</li>
+ <li>Add the same piece of code to the <tt>featuredstorytext.thtml</tt> and
+ <tt>archivestorytext.thtml</tt> templates so that the link also appears for
+ featured and archived stories.</li>
+ </ol>
+ 

  <h2><a name="changes">Theme changes in Geeklog 1.5.0</a></h2>