XoopsModules25x/xoopspartners

View on GitHub
language/english/help/help.html

Summary

Maintainability
Test Coverage
<div id="help-template" class="outer">
    <h1 class="head">Help:
        <a class="ui-corner-all tooltip" href="<{$xoops_url}>/modules/xoopspartners/admin/index.php"
           title="Back to the administration of Partners"> Partners <img src="<{xoAdminIcons home.png}>"
                                                                         alt="Back to the Administration of Partners">
        </a></h1>
    <!-- -----Help Content ---------- -->

    <h4 class="odd">Description</h4>
    <div class="even marg10 boxshadow1"><p>
        The Partners module provides a page and a block for displaying links to the websites of cooperating
        organizations, together with short descriptions and optionally logos. Typical usage includes recognition of
        websites that refer a lot of traffic to your own and 'thank you' pages for sponsors.</p></div>

    <h4 class="odd">Install/uninstall</h4>
    <div class="even marg10 boxshadow1"><p>
    No special measures necessary, follow the standard installation process - extract the xoopspartners folder into the
    ../modules directory. Install the module through Admin -> System Module -> Modules. <br><br>
    Detailed instructions on installing modules are available in the <a href="https://xoops.gitbook.io/xoops-operations-guide/" target="_blank">XOOPS Operations
    Manual</a></p></div>

    <h4 class="odd">Operating instructions</h4>
    <div class="even marg10 boxshadow1"><p>
    To set up this module you need to:<br>
    <ol>
    <li>Enter your partner's details - including a URL for their website and (optionally) logo plus a short description
    (see 'Adding a partner')</li>
    <li>Configure your preferences for the module (see 'Preferences') and optionally the Partners block if you intend to
    use it (see 'Blocks')</li>
    <li> Check that you have given your user groups the necessary module and block access rights to use this module.
    Group permissions are set through the Administration Menu -> System -> Groups. <br><br>Detailed instructions on
    configuring the access rights for user groups are available in the <a href="https://xoops.gitbook.io/xoops-operations-guide/" target="_blank">XOOPS Operations
    Manual</a></li>
    </ol></p></div>

    <h4 class="odd">TUTORIAL</h4>
    <div class="even marg10 boxshadow1"><p>
        Tutorial has been started, but we need your help! Please check it out the status of the tutorial <a href="https://xoops.gitbook.io/xoopspartners-tutorial/" target="_blank">here </a>.
        <br><br>To contribute to this Tutorial, <a href="https://github.com/XoopsDocs/xoopspartners-tutorial/" target="_blank">please fork it on GitHub</a>.
        <br> This document describes our <a href="https://xoops.gitbook.io/xoops-documentation-process/details/" target="_blank">Documentation Process</a> and it will help you to understand how to contribute.
        <br><br>
        There are more XOOPS Tutorials, so check them out in our <a href="https://www.gitbook.com/@xoops/" target="_blank">XOOPS Tutorial Repository on GitBook</a>.
    </p></div>

    <h4 class="odd">TRANSLATIONS</h4>
    <div class="even marg10 boxshadow1"><p>
        Translations are on <a href="https://www.transifex.com/xoops/" target="_blank">Transifex</a> and in our <a href="https://github.com/XoopsLanguages/" target="_blank">XOOPS Languages Repository on GitHub</a>.</p></div>

    <h4 class="odd">SUPPORT</h4>
    <div class="even marg10 boxshadow1"><p>
        If you have questions about this module and need help, you can visit our <a href="https://xoops.org/modules/newbb/index.php?cat=2" target="_blank">Support Forums on XOOPS Website</a></p></div>

    <h4 class="odd">DEVELOPMENT</h4>
    <div class="even marg10 boxshadow1"><p>
        This module is Open Source and we would love your help in making it better! You can fork this module on <a href="https://github.com/XoopsModules25x/xoopspartners" target="_blank">GitHub</a><br><br>
        But there is more happening on GitHub:<br><br>
        <ul>
        <li><a href="https://github.com/xoops" target="_blank">XOOPS Core</a></li>
        <li><a href="https://github.com/XoopsModules25x" target="_blank">XOOPS Modules</a></li>
        <li><a href="https://github.com/XoopsThemes" target="_blank">XOOPS Themes</a><br></li>
        </ul>
        Go check it out, and <strong>GET INVOLVED</strong>
    </p></div>
    <!-- -----Help Content ---------- -->
</div>