[Sommaire] [Imprimer]

   1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2  <html>
   3  <head>
   4    <title>Geeklog Documentation - Links Plugin</title>
   5    <link rel="stylesheet" type="text/css" href="docstyle.css" title="Dev Stylesheet">
   6  </head>
   7  
   8  <body>
   9  <table>
  10  <tr>
  11    <td><a href="index.html" style="background:transparent"><img src="images/newlogo.gif" alt="Geeklog Documentation" width="243" height="90" border="0"></a></td>
  12  </tr>
  13  <tr>
  14    <td class="menu"><a href="index.html">Geeklog Documentation</a> - Links Plugin</td>
  15  </tr>
  16  </table>
  17  
  18  <h1>Links Plugin</h1>
  19  
  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>
  21  
  22  <h2><a name="config.php">Configuration File</a></h2>
  23  
  24  <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>
  25  
  26  <table>
  27  <tr><th width="25%">Variable</th>
  28      <th width="25%">Default Value</th>
  29      <th width="50%">Description</th>
  30  </tr>
  31  <tr>
  32    <td><a name="desc_delete_links">delete_links</a></td>
  33    <td>0</td>
  34    <td>Defines what to do when a user is deleted that is the owner of a link.
  35      When set to 0, all links owned by the deleted user will be assigned to a
  36      user of the "Root" group (e.g. the site admin). When set to 1, the links
  37      are deleted.</td>
  38  </tr>
  39  <tr class="r2">
  40    <td><a name="desc_hidelinksmenu">hidelinksmenu</a></td>
  41    <td>0</td>
  42    <td>Whether to hide the "Links" entry from Geeklog's menu bar (when set to 1)
  43      or to show it (when set to 0).</td>
  44  </tr>
  45  <tr>
  46    <td><a name="desc_hidenewlinks">hidenewlinks</a></td>
  47    <td>0</td>
  48    <td>Whether new links should be hidden from the "What's New" block (when set
  49      = 1) or whether to list them there (when set to = 0).</td>
  50  </tr>
  51  <tr class="r2">
  52    <td><a name="desc_linkcols">linkcols</a></td>
  53    <td>3</td>
  54    <td>The number of link categories to display per column.</td>
  55  </tr>
  56  <tr>
  57    <td><a name="desc_linksloginrequired">linksloginrequired</a></td>
  58    <td>0</td>
  59    <td>When set to 1, only registered users can access the links section.<br>
  60      Please note that <code>$_CONF['<a
  61      href="config.html#desc_loginrequired">loginrequired</a>']</code> in
  62      <tt>config.php</tt> takes precedence over this setting. So when
  63      <code>'loginrequired'</code> is set to 1, anonymous users can not access
  64      the links section even when <code>'linksloginrequired'</code> is set
  65      to 0.</td>
  66  </tr>
  67  <tr class="r2">
  68    <td><a name="desc_linksperpage">linksperpage</a></td>
  69    <td>10</td>
  70    <td>The number of links to show per page.</td>
  71  </tr>
  72  <tr>
  73    <td><a name="desc_linksubmission">linksubmission</a></td>
  74    <td>1</td>
  75    <td>Whether links submitted by users will have to be approved by an admin
  76      first (when set = 1) or show up immediately (when set = 0).</td>
  77  </tr>
  78  <tr class="r2">
  79    <td><a name="desc_newlinksinterval">newlinksinterval</a></td>
  80    <td>1209600</td>
  81    <td>For how long a link should be considered "new" and show up in the "What's
  82      New" block on the site. The interval is given in seconds, so the default
  83      value equals 14 days.</td>
  84  </tr>
  85  <tr>
  86    <td><a name="desc_notification">notification</a></td>
  87    <td>0</td>
  88    <td>Whether to send an email notification when a new link was submitted (when
  89      set to = 1) or not (when set to = 0).</td>
  90  </tr>
  91  <tr class="r2">
  92    <td><a name="desc_show_top10">show_top10</a></td>
  93    <td><code>true</code></td>
  94    <td>When both <code>$_LI_CONF['linkcols']</code> and
  95      <code>$_LI_CONF['linksperpage']</code> are <em>not</em> 0, the plugin will
  96      show a list of the 10 most clicked-on links on the Links plugin's index
  97      page automatically. If you do not want that "top 10" list there, set this
  98      option to <code>false</code>.</td>
  99  </tr>
 100  </table>
 101  
 102  
 103  <h2><a name="layout">Layout of the Links plugin's index page</a></h2>
 104  
 105  <p>The general layout of the index page of the Links plugin is defined by the
 106  options <code>$_LI_CONF['linkcols']</code> and <code>$_LI_CONF['linksperpage']</code>, as explained above.</p>
 107  
 108  <p>If you'd rather have a straight list of all your links, you can set both
 109  of these options to 0. This probably makes the most sense when you only have
 110  a few links. Setting only <code>$_LI_CONF['linksperpage']</code> to 0 zero will
 111  list all the links of the current category on one page. Setting only
 112  <code>$_LI_CONF['linkcols']</code> to 0 will hide the categories and will
 113  display all your links spread over several pages.</p>
 114  
 115  
 116  <h3><a name="templates">Template files</a></h3>
 117  
 118  <p>To further change the layout of your Links section, you can change the
 119  template files. Please note that they are now located in the plugin's directory,
 120  i.e. in</p>
 121  <p align="center"><tt>/path/to/geeklog/plugins/links/templates/</tt></p>
 122  <p>If you're using a theme that was made for an older version of Geeklog (prior
 123  to Geeklog 1.4.0), you may still have a "links" directory in your theme's
 124  directory - but that is not used any more and can be safely removed.</p>
 125  
 126  
 127  <table class="footer">
 128  <tr>
 129    <td colspan="2"><a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
 130      All trademarks and copyrights on this page are owned by their respective owners. GeekLog is copyleft.</td>
 131  </tr>
 132  </table>
 133  
 134  </body>
 135  </html>