mambax7/wflinks

View on GitHub
docs/english/__prefs.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="robots" content="nofollow,noindex">
    <title>Preferences</title>
</head>

<body>
<p><span style="text-decoration: underline;"><strong><span
        style="font-size: 144%; font-family: Verdana, Arial, Helvetica, sans-serif; ">Preferences</span></strong></span>
</p>
<p>&nbsp;</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">First we pay a visit to the Preferences of WF-Links to configure the module.</span>
</p>
<p>&nbsp;</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Link popular count</span></strong><br>
  Set here the amount of hits needed for a link for setting it as being a popular link.<br>
  Default: <em>100</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Links popular and new</span></strong>  <br>
  Here you can set how a link will be displayed as popular and new.<br>
There are the following options:</span></p>
<ul>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Display as icons</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Display as text</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Do not display</span>
    </li>
</ul>
<p><span
        style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default: <em>Display as icons</em> </span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Links days new</span></strong><br>
The number of days a link status will be considered as new.<br>
Default: <em>10</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Links days updated</span></strong><br>
  The amount of days a link status will be   considered as updated.<br>
  Default: <em>10</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Link listing count</span></strong><br>
Number of links to display in each category   listing.<br>
Default: <em>10</em> </span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Admin index links count</span></strong><br>
Number of new links to display in module admin area.<br>
Default: <em>10</em> </span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Default link order</span></strong><br>
Select the default order for the link listings.</span></p>
<ul>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Title </span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Submission date</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Rating</span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Popularity</span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Country  </span></li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Each option can be set to ascending (A) or descending (D).<br>
    Default: <em>Title (A)</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Sort categories by</span></strong><br>
Select how categories and sub-categories are   sorted.</span></p>
<ul>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Title</span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Weight</span></li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default:<em> Title</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Sub-Categories</span></strong><br>
  Select <em>Yes</em> to display sub-categories. Selecting <em>No</em> will hide sub-categories from the listings.<br>
  Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Editor to use (admin)</span></strong><br>
  Select the editor to use for admin side.<br>
  If   you have a 'simple' install (e.g you use only XOOPS core editor class, provided   in the standard xoops core package), then you can just select DHTML and   Compact.<br>
  When selecting <em>DHTML</em> than this might be overruled by the setting <em>Default Editor</em> in ImpressCMS Preferences.<br>
  Default: <em>DHTML</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Editor to use (user)</span></strong><br>
Select the editor to use for user side.<br>
If   you have a 'simple' install (e.g you use only XOOPS core editor class, provided   in the standard xoops core package), then you can just select DHTML and   Compact.<br>
When selecting <em>DHTML</em> than this might be overruled by the setting <em>Default Editor</em> in ImpressCMS Preferences.<br>
Default: <em>DHTML</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Display screenshot images</span></strong><br>
  Select <em>Yes</em> to display screenshot images for   each link item.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Use thumb nails</span></strong><br>
  Supported link types: JPG, GIF, PNG.<br>
  WF-Links will use thumb nails for images. Set to <em>No</em> to use orginal image if   the server does not support this option.<br>
Default:<em> No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Update thumbnails</span></strong><br>
  If selected Thumbnail images will be updated   at each page render, otherwise the first thumbnail image will be used   regardless.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Thumb nail quality</span></strong><br>
Quality: </span></p>
<ul>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Lowest: 0 </span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Highest: 100<br>
    </span></li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default: <em>100</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Keep image aspect ratio</span></strong><br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Image display width</span></strong><br>
  Display width (px) for screenshot image.<br>
Default: <em>100</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Image display height</span></strong><br>
  Display height (px) for screenshot image.<br>
Default: <em>79</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Upload size (KB)</span></strong><br>
Maximum link size permitted with link uploads.<br>
Default: <em>200000</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Upload image width</span></strong><br>
  Maximum image width (px) permitted when uploading image links<br>
Default: <em>600</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Upload image height</span></strong><br>
Maximum image height (px) permitted when uploading image links.<br>
Default: <em>600</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Use auto screenshot</span></strong><br>
  This will automatically create a screenshot   based on the url. This overrules uploaded screenshots and might not work for all   websites.<br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Main image directory</span></strong><br>
  Enter the url without a trailing slash.<br>
Default: <em><span style="font-family: Courier New, Courier, monospace; ">modules/wflinks/images</span></em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Screenshots upload directory</span></strong><br>
  Enter the url without a trailing slash.<br>
Default: <em><span style="font-family: Courier New, Courier, monospace; ">uploads/images/screenshots</span></em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Category image upload directory</span></strong><br>
  Enter the url without a trailing slash.<br>
Default: <em><span style="font-family: Courier New, Courier, monospace; ">uploads/images/category</span></em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Country flag image directory</span></strong><br>
  Enter the url without a trailing slash.<br>
Default: <span
            style="font-family: Courier New, Courier, monospace; "><em>uploads/images/flags/flags_small</em></span></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Timestamp</span></strong><br>
  Default timestamp for WF-links.<br>
  Here you can configure how the date is formatted.
  This setting is not for the WF-Links blocks.<br>
  See also the <strong><a href="http://jp.php.net/manual/en/function.date.php"
                          target="_blank">PHP Manual</a></strong>.<br>
Default: <em>D, d-M-Y</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Timestamp administration</span></strong><br>
Default admininstration timestamp for WF-Links.<br>
Here you can configure how the date is formatted for the WF-Links administration.<br>
See also the <strong><a href="http://jp.php.net/manual/en/function.date.php"
                        target="_blank">PHP Manual</a></strong>.<br>
Default: <em>D, d-M-Y - G:i</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><span
        style="text-decoration: underline;"><strong>Set total amount of characters for description</strong></span><br>
Set total amount of characters for description in category view.<br>
Default: <em>200</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Enter max. characters for meta keywords</span></strong><br>
  This is maximum amount of characters that can be used for meta keywords.<br>
  See <strong><a href="http://en.wikipedia.org/wiki/Meta_element#The_keywords_attribute"
                 target="_blank">Wikipedia</a></strong> for more information.<br>
Default: <em>255</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Show other links submitted by Submitter</span></strong><br>
  Select <em>Yes</em> if other links of the submitter will be   displayed.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><span
        style="text-decoration: underline;"><strong>Show Quick View option</strong></span><br>
  Select <em>Yes</em> to turn  the Quick View   option on.<br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Show Social Bookmarks</span></strong><br>
  Select <em>Yes</em> if you want Social Bookmark icons   to be displayed under article.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Show Google PageRankā„¢</span></strong><br>
  Select Yes if you want Google PageRankā„¢ to be   displayed.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">User can submit Tags</span></strong><br>
  Select <em>Yes</em> if user is allowed to submit   tags.<br>
  Note: The Tag module needs to be installed otherwise the form doesn't show in the submit form.<br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><span
        style="text-decoration: underline;"><strong>Use address and map options</strong></span><br>
  Select <em>Yes</em> to use the address and maps   feature in submit forms.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><span
        style="text-decoration: underline;"><strong>Print page footer</strong></span><br>
  Footer that will be printed for each   link.<br>
Default: <em><span style="font-family: Courier New, Courier, monospace; "><website_url></span></em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Logo print url</span></strong><br>
  Url of the logo that will be printed at the   top of the page.<br>
Default: <em><span style="font-family: Courier New, Courier, monospace; "><website_url>/modules/wflinks/assets/images/logo-en.gif</span></em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><span
        style="text-decoration: underline;"><strong>Show disclaimer before user submission</strong></span><br>
  Before a user can submit a link show the entry   regulations.<br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Enter submission disclaimer text</span></strong><br>
Default: <em>We have the right, but not the obligation to monitor and review submissions submitted by users, in the forums. We shall not be responsible for any of the content of these messages. We further reserve the right, to delete, move or edit submissions that the we, in its exclusive discretion, deems abusive, defamatory, obscene or in violation of any Copyright or Trademark laws or otherwise objectionable.</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Show disclaimer before user link</span></strong><br>
  Show link regulations before open a link.<br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Enter link disclaimer text</span></strong><br>
Default: <em>The links on this site are provided as is without warranty either expressed or implied. linkloaded files should be checked for possible virus infection using the most up-to-date detection and security packages. If you have a question concerning a particular piece of software, feel free to contact the developer. We refuse liability for any damage or loss resulting from the use or misuse of any software offered from this site for linkloading. If you have any doubt at all about the safety and operation of software made available to you on this site, do not linkload it. Contact us if you have questions concerning this disclaimer.</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Copyright notice</span></strong><br>
  Select to display a copyright notice on link   page.<br>
Default: <em>Yes</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Select forum</span></strong><br>
Select the forum you have installed and will   be used by WF-Links.</span></p>
<ul>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Newbb</span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">IPB Forum</span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">PHPBB Module</span></li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Newbbex</span></li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default: <em>Newbb</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Comment rules</span></strong></span></p>
<ul>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Disable comments</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Comments are always approved</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Comments by registered users are always approved</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">All comments need to be approved by administrators</span>
    </li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default: <em>Comments are always approved</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><span
        style="text-decoration: underline;"><strong>Allow anonymous post in comments</strong></span><br>
Default: <em>No</em></span></p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Enable notification</span></strong><br>
This module allows users to be notified when   certain events occur. Select if users should be presented with notification   options in a Block (Block-style), within the module (Inline-style), or both. For   block-style notification, the Notification Options block must be enabled for   this module.</span>
</p>
<ul>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Disable notification</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Enable only block-style</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Enable only inline-syle</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Enable notification (both styles)</span>
    </li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default: <em>Enable notification (both styles)</em></span>
</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; "><strong><span
        style="text-decoration: underline;">Enable specific events</span></strong><br>
Select which notification events to which your   users may subscribe.</span></p>
<ul>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Global : New category</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Global : Modify link requested</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Global : Broken link submitted</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Global : Link submitted</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Global : New link</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Category : Link Submitted</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Category : New Link</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Category : Bookmark</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Link : Comment added</span>
    </li>
    <li><span
            style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Link : Comment submitted</span>
    </li>
    <li><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Link : Bookmark</span>
    </li>
</ul>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Default: <em>All selected</em></span>
</p>
<p>&nbsp;</p>
<p><span style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">Click the <em>Go!</em> button to save the preferences in the database</span><span
        style="font-size: smaller; font-family: Verdana, Arial, Helvetica, sans-serif; ">.</span></p>
<p><br>
</p>
</body>
</html>